====== Web Service Timbrado Retenciones y Pagos ======

====== Introducción ======

Como proveedor autorizado de certificación con el número 68934, **iTimbre** realiza la validación y certificación (**timbrado**) de Comprobantes Fiscales Digitales generados por Internet (//**CFDI**//) conforme a las especificaciones requeridas por el SAT a través de su Web Service (Software como Servicio) de una manera rápida y segura.
====== Servicio ======

La característica principal de la arquitectura del Web Service de iTimbre es que utiliza JSON+REST en lugar del tradicional XML+SOAP. Por lo tanto es importante tener conocimientos del formato JSON para poder crear los mensajes que serán enviados al Web Service. Afortunadamente JSON es mucho más fácil de entender e implementar.

====== Registro ======

Antes de comenzar a realizar pruebas con el Web Service de iTimbre es necesario registrarse a través de las siguientes ligas:

**Pruebas:** [[https://pruebas.itimbre.com/registro/index.php?servicio=timbrado|https://pruebas.itimbre.com/registro/index.php?servicio=timbrado]]

Es necesario que en el campo de “Servicio deseado” se mantenga seleccionada la opción de “Solo timbrado”, para que se habiliten en el Web Service las conexiones externas. También es importante distinguir entre la versión de pruebas y la de producción, ya que **son sistemas totalmente independientes aunque sean idénticos**. La única diferencia es la validez de los comprobantes certificados. La versión de pruebas utiliza un CSD de pruebas para validar los comprobantes, pero al igual que la versión de producción, también verifica el RFC y el certificado del CFDI en la lista de contribuyentes del SAT. Por esta razón no es posible utilizar certificados de pruebas para enviar comprobantes a la versión de pruebas del Web Service, ya que generarán el código de error correspondiente.

Al realizar el registro recibirá un correo electrónico de confirmación con la liga hacia el Portal de iTimbre y una contraseña temporal. En caso de no recibir el correo electrónico busque en su carpeta de “Spam” o “Correo no deseado”.

Cuando ingrese al sistema por primera vez, éste le pedirá que cambie su contraseña temporal por una personalizada que cumpla con los requisitos de seguridad establecidos. La contraseña debe contener al menos 8 caracteres e incluir al menos una mayúscula, una minúscula, un número y un carácter especial (@#$).

Posteriormente, el sistema lo llevará a la página de inicio, donde podrá ver sus datos personales, editarlos, cambiar su contraseña, y descargar las políticas de uso, el acuerdo de confidencialidad y el presente manual de integración.

En el sub-módulo de “Emisores” aparece la lista de los emisores registrados. El sistema actualmente no cuenta con un límite de emisores, así que puede registrar todos los que desee siempre y cuando no hayan sido registrados en la aplicación gratuita. Para dar de alta un nuevo emisor dar clic en “Agregar Emisor”.

Agregue los datos de la empresa y al terminar haga clic en “Aceptar”. Si los datos fueron llenados correctamente se registrará el emisor en el sistema y se generará una contraseña aleatoria, la cual necesitará al momento de hacer el llamado al Web Service de iTimbre. La contraseña aparecerá en el campo correspondiente.

En caso de necesitar ayuda vaya al módulo de “Soporte” y llene el formulario. En breve nos comunicaremos con usted.

====== Conexión al Web Service Retenciones y Pagos ======

Para realizar la conexión con el Web Service de iTimbre es necesario proveer los siguientes datos en el llamado:

  * **Usuario**. El usuario es el correo electrónico utilizado al momento de crear la cuenta en el Portal de iTimbre. El mismo con el que se ingresa al sistema.
  * **RFC**  del emisor.
  * **Contraseña del emisor**. La contraseña generada al registrar al emisor en el sistema, como se mostró anteriormente. Nota: no confundir con la contraseña utilizada para acceder al Portal de iTimbre.
  * **Método**. El método es la función a realizar. Actualmente se cuenta con los siguientes métodos:
      * **enviarRetencion**  → método que se utiliza para validar y timbrar un CFDI.
      * **cancelarRetencion**  →método utilizado para cancelar un CFDI.
      * **verificarEstatusRetencion**→ Para recibir un acuse utilizando el parametro folio_seguimiento.
  * **Parámetros**. Los parámetros son datos adicionales que deben enviarse y dependen del método utilizado, los cuales se describen más adelante.
Al realizar el llamado, las variables se deben serializar en formato JSON y almacenarse en una variable llamada “q”, la cual se debe enviar por HTTP.

Las ligas del Web Service se enlistan a continuación.

**Direcciones del servicio:**

Pruebas:[[http://portalws1.itimbre.com/itimbreprueba.php?q=|http://portalws1.itimbre.com/itimbreprueba.php?q=]]

====== Timbrado de Retenciones y Pagos ======

Las siguientes validaciones se realizan al XML:

  * La estructura del XML cumple con las especificaciones del SAT.
  * El Certificado de Sello Digital (CSD) del emisor haya sido emitido por el SAT.
  * El CSD esté vigente en la fecha de generación del Comprobante.
  * El Comprobante no haya sido validado previamente.
  * Que el RFC y número de certificado se encuentren en las lista de contribuyentes del SAT.
  * El periodo de tiempo entre la fecha de expedición del documento y la fecha en la que se pretende certificar no exceda de 72 horas.
  * El CSD con el que se sello el documento corresponda al contribuyente que aparece como emisor del CFDI y que el sello digital corresponda al documento enviado.

En caso que el XML cumpla con las validaciones mencionadas, el Web Service lo devolverá al contribuyente con la información contenida y el Timbre Fiscal Digital, este incluye:

  * El número de folio fiscal asignado.
  * Fecha y hora de Validación.
  * El número de serie del certificado del SAT con el que se realizó la validación.
  * El sello digital del Timbre Fiscal Digital.

===== Llamado =====

Para realizar la validación y certificación de un CFDI se deben utilizar los métodos “**enviarRetencion**”. Los parámetros a ser enviados por el Web Service para realizar la función de validación de los comprobantes fiscales están estructurados de la siguiente manera:

==== Parámetros de la llamada ====

^  PARÁMETRO  ^  DESCRIPCIÓN  |
|  id  |Identificador de referencia asignado por el cliente. Este parámetro no es requerido por el Web Service de iTimbre, sino que tiene como propósito ser utilizado por el cliente como método de control para asegurarse de recibir la respuesta solicitada. Se recomienda utilizar el número de folio interno del XML. **Por defecto se asignará 0**.  |
|  method  |Este parámetro consiste en el tipo de petición solicitado para generar el CFDI. Los valores posibles se encuentran en el catálogo de métodos. |
|  params  |Debe contener un arreglo con los parámetros: **user**, **pass**, **RFC**, y **xmldata**.  |
|  user  |Usuario del Portal de iTimbre con el que se ingresa al sistema (correo electrónico con el que se registró). |
|  pass  |Contraseña generada por iTimbre asignada al emisor de manera automática. Se puede utilizar la **contraseña máster** del administrador de los emisores para cualquier RFC.  |
|  RFC  |RFC del emisor del CFDI. Nota: es el único parámetro que debe estar en mayúsculas. |
|  xmldata  |Contenido del XML con la información del comprobante. |

==== Ejemplos ====

**Ejemplo de codificación del llamado en formato JSON para certificación de retenciones**:

<file JSON llamado-retenciones.json>
{
    "id":"101",
    "method":"enviarRetencion",
    "params": {
        "user":"miemail@midominio.com",
        "pass":"cabb17fb8536180e11af6dff0da42132",
        "RFC":"EEM010101XYZ",
        "xmldata":"<cfdi></cfdi>"
    }
}
</file>

===== Respuesta =====

En caso de validación del XML o que surja algún error en el proceso, el Web Service de iTimbre le enviará una respuesta.

==== Parámetros de la Respuesta ====

^  PARÁMETROS  ^  DESCRIPCIÓN  |
|  id  |El mismo id que fue enviado en el llamado. |
|  result  |Un arreglo dentro del cual se encuentran el resto de los parámetros que se describen abajo. |
|  retcode  |Código de retorno, si es 1, la repuesta es exitosa. Si es diferente de 1, el número es el código de error. |
|  UUID  |Identificador único del CFDI timbrado. Nota: es el único parámetro que se regresa en mayúsculas. |
|  data  |XML timbrado. |
|  acuse  |Acuse que proporciona el SAT como comprobante de que el CFDI fue recibido satisfactoriamente. Nota: este parámetro pudiera no ser regresado si el servicio de recepción del SAT no se encuentre disponible en el momento de la llamada. |
|  error  |En caso de existir, una descripción del error regresado al intentar validar el XML. |
|  Otros  |Otros parámetros en caso de que se ocupen como referencia, por ejemplo el usuario que hizo el llamado, o algún **timestamp**.  |

==== Ejemplos ====

**Ejemplo de respuesta válida arrojada por el Web Service**:

<file JSON respuesta.json>
{
    "id":"101",
    "result": {
        "retcode":1,
        "UUID":"63C2042F-FAF0-48A0-A9AF-0304813D2528",
        "data":"<cfdi></cfdi>",
        "acuse":"<xml></xml>"
    }
}
</file>

**Ejemplos de errores**:

<file JSON error1.json>
{
    "id":0,
    "result":
    {
        "retcode":-1,
        "error":"Variable q faltante."
    }
}
</file>

<file JSON error2.json>
{
    "id":0,
    "result":    {
        "retcode":-1,
        "error":"Los datos recibidos no cumplen con el formato JSON correcto."
    }
}
</file>

==== Códigos de Respuesta ====

^  Código  ^  Validación  |
|  1002  |El PAC envía versión del estándar no existente. |
|  1004  |La estructura del comprobante recibido no es válida. |
|  1006  |El Timbre proporcionado ya existe. UUID: <UUID>. |
|  1009  |El documento de retenciones no cuenta con los datos mínimos. |
|  1010  |Sello de certificación inválido. |
|  1011  |Sello del documento de retenciones inválido. |
|  1012  |TFD no válido. |
|  1013  |Versión del estándar no vigente. |
|  1014  |Comprobante con envío extemporáneo por vigencia de versión. |
|  1015  |Uso del complemento no vigente. |
|  1016  |Uso de complemento no permitido. |
|  1017  |Uso del certificado de FIEL no válido. |

===== Cancelación de CFDI =====

Para cancelar algún CFDI no se necesita que éste haya sido certificado por iTimbre. No obstante, se requiere que el mensaje enviado al SAT incluya cierta información firmada por el emisor del CFDI, por lo que es necesario que se proporcione el sello digital (CSD) con el que fue firmado el CFDI en un archivo PFX. Para más detalle consulte el documento “Manual de Generación del PFX”.

===== Llamado =====

Los parámetros a ser enviados para realizar la Cancelación del XML están estructurados de la siguiente manera:

==== Parámetros enviados para la cancelación ====

^  PARÁMETRO  ^  DESCRIPCIÓN  |
|  id  |Identificador de referencia asignado por el cliente. Este parámetro no es requerido por el Web Service de iTimbre, sino que tiene como propósito ser utilizado por el cliente como método de control para asegurarse de recibir la respuesta solicitada. Se recomienda utilizar el número de folio interno del XML. |
|  method  |El nombre del método para cancelar : **cancelarRetencion**.  |
|  params  |Debe contener un arreglo con los parámetros: user, pass, RFC, y folios. |
|  user  |Usuario del Portal de iTimbre con el que se ingresa al sistema (correo electrónico con el que se registró). |
|  pass  |Contraseña generada por iTimbre al momento de registrar al emisor. |
|  RFC  |RFC del emisor del CFDI. Nota: es el único parámetro que debe estar en mayúsculas. |
|  pfx_pass  |Llave publica usada para abrir el PFX. |
|  pfx_pem  |Archivo resultante de convertir el certificado (.cer) y la llave (.key) a PEM. Para generar este archivo puede consultar el documento “Manual de Generación del PFX” ofrecido por iTimbre. |


==== Ejemplos Cancelación ====

**Ejemplo de codificación de llamado en formato JSON (Un solo folio) para retenciones y pagos**:

<file JSON llamada-001cancelacion.json>
{
    "id":1001,
    "method":"cancelarRetencion",
    "params": {
        "user":"miemail@midominio.com",
        "pass":"cabb17fb8536180e11af6dff0da42132",
        "RFC":"EEM010101XYZ",
        "pfx_pass":"Clave de mi archivo PFX",
        "pfx_pem":"<<Archivo PFX de mi CSD>>",
        "folios": [
            "25916C58-672A-43CD-96EE-F14E0FDD4378",
        ]
    }
}
</file>



==== Respuesta ====

^  PARÁMETROS  ^  DESCRIPCIÓN  |
|  id  |El mismo id que fue enviado en el llamado. |
|  result  |Un arreglo dentro del cual se encuentran el resto de los parámetros que se describen abajo. |
|  retcode  |Código de retorno, : \\ Si es 1 –> La cancelación ha sido exitosa y el acuse se regresa en el parámetro **acuse_cancelacion** \\ ​Si la respuesta es 2 –> Significa que se activo la cancelación asincrona,entonces se regresa un folio de seguimiento en la variable **folio_seguimiento**. \\ Si es -1 –>Entonces hubo un error genérico y la descripción se reflejara en la variable error. Cualquier otro valor en el retcode será uno de los códigos del catalogo. |
|  acuse_cancelacion  |Parámetro de retenciones y pagos , donde regresa el acuse del SAT cuando es exitosa. |
|  fecha  |Fecha en que el SAT cancela el CFDI, en caso de existir acuse. |
|  signature  |Firma del acuse del SAT, en caso de existir. Esta firma es parte del acuse, pero aquí se proporciona por separado por simplificación. |
|  error  |En caso de existir, descripción del error. NOTA: es importante que no exista ningún error para considerar que la cancelación fue exitosa. |
|  folio_seguimiento  |Parámetro de retenciones y pagos, este parametro se regresa cuando se activa la cancelación asincrona brindando un folio de seguimiento. |



**Ejemplo de respuesta válida arrojada por el Web Service para retenciones y pagos (un folio)**:

<file JSON respuesta-01cancelacion.json>
{
    {
        "id":1001,
        "result": {
            "acuse_cancelacion":"<s:Envelope>Acuse del SAT<\/s:Envelope>",
            "id":1001,
            "fecha":"2013-04-15T20:48:39.7200698",
            "retcode":1,
            "signature":"AuPN3mjhCjI2NYiif2Mdtdib9nxhTOw5jf7TPIloqqv2RHnsJ5XnHAdkf5A9ccfXJ4fpJNY0k3kNHkwFRQmhXw==",
            "folios": [
                {
                "UUID":"48D57A35-48BB-4C4B-AB44-678FCBF74D93",
                "status":"201"
                }
            ]
        }
    }
}
</file>

=== Códigos de Respuesta de Estatus UUID  ===

^  Código  ^  Validación  |
|  1201  |UUID Cancelado. |
|  1202  |UUID Previamente cancelado. |
|  1203  |UUID no corresponde con el emisor. |
|  1205  |UUID no existe. |

=== Códigos de Respuesta a nivel petición  ===

^  Código  ^  Validación  |
|  1300  |Autenticación no valida. |
|  1301  |XML mal formado. |
|  1302  |Estructura de folios no válida. |
|  1303  |Estructura de RFC no válida. |
|  1304  |Estructura de fecha no válida. |
|  1305  |Certificado no correspondiente al emisor. |
|  1306  |Certificado no vigente. |
|  1307  |Uso de la FIEL no permitido. |
|  1308  |Certificado revocado o caduco. |
|  1309  |Firma mal formada o invalida. |

\\

====Método para Consulta de estatus de cancelación====

Al intentar efectuar una cancelación entre 2 y 10,000 folios como respuesta se recibirá un folio de seguimiento, como se explico anteriormente. Para finalmente recibir un acuse es necesario conectarse nuevamente pero ahora llamando al método **verificarEstatusRetencion**.El único parámetro que deben mandar es 'folio_seguimiento'. La respuesta es idéntica a la de la cancelación solo que aquí nunca recibirían el retcode 2.

^  PARÁMETRO  ^  DESCRIPCIÓN  |
|  id  |Identificador de referencia asignado por el cliente. Este parámetro no es requerido por el Web Service de iTimbre, sino que tiene como propósito ser utilizado por el cliente como método de control para asegurarse de recibir la respuesta solicitada. Se recomienda utilizar el número de folio interno del XML. |
|  method  |El nombre del método para cancelar : **verificarEstatusRetencion**.  |
|  params  |Debe contener un arreglo con los parámetros: user, pass, RFC, y folio de seguimiento. |
|  user  |Usuario del Portal de iTimbre con el que se ingresa al sistema (correo electrónico con el que se registró). |
|  pass  |Contraseña generada por iTimbre al momento de registrar al emisor. |
|  RFC  |RFC del emisor del CFDI. Nota: es el único parámetro que debe estar en mayúsculas. |
|  folio_seguimiento  |Parámetro de retenciones y pagos, este parámetro se envia cuando se desea recuperar un acuse de cancelación brindando un folio de seguimiento.. |


**Ejemplo de codificación de llamado en formato JSON para recuperar acuse de cancelación de retenciones y pagos**:

<file JSON llamada-0001cancelacion.json>
{
    "id":1001,
    "method":"verificarEstatusRetencion",
    "params": {
        "user":"miemail@midominio.com",
        "pass":"cabb17fb8536180e11af6dff0da42132",
        "RFC":"EEM010101XYZ",
        "folio_seguimiento":"005",

    }
}
</file>