Herramientas de usuario

Herramientas del sitio


web-service-retenciones

Diferencias

Muestra las diferencias entre dos versiones de la página.

Enlace a la vista de comparación

Ambos lados, revisión anterior Revisión previa
Próxima revisión
Revisión previa
web-service-retenciones [2015/01/25 03:30]
web-service-retenciones [2016/01/05 23:15] (actual)
Línea 189: Línea 189:
 |  pfx_pass ​ |Llave publica usada para abrir el PFX. | |  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. | |  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. |
-|  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.. |+
  
 ==== Ejemplos Cancelación ==== ==== Ejemplos Cancelación ====
Línea 212: Línea 212:
 </​file>​ </​file>​
  
-**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>​ 
  
 ==== Respuesta ==== ==== Respuesta ====
Línea 234: Línea 220:
 |  result ​ |Un arreglo dentro del cual se encuentran el resto de los parámetros que se describen abajo. | |  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. | |  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  |Acuse del SAT en caso de que retcode sea 1 y que dentro del arreglo folios haya al menos un UUID cancelado. | 
 |  acuse_cancelacion ​ |Parámetro de retenciones y pagos , donde regresa el acuse del SAT cuando es exitosa. | |  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. | |  fecha  |Fecha en que el SAT cancela el CFDI, en caso de existir acuse. |
Línea 241: Línea 226:
 |  folio_seguimiento ​ |Parámetro de retenciones y pagos, este parametro se regresa cuando se activa la cancelación asincrona brindando un folio de seguimiento. | |  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 del manejo de los folios: 
  
-<code PHP> 
-$primer_folio = $folios[0] -> UUID; 
-$estatus_primer_folio = $folios[0] -> status; 
-$segundo_folio = $folios[1] -> UUID; 
-$estatus_segundo_folio = $folios[1] -> status; 
-</​code>​ 
  
 **Ejemplo de respuesta válida arrojada por el Web Service para retenciones y pagos (un folio)**: **Ejemplo de respuesta válida arrojada por el Web Service para retenciones y pagos (un folio)**:
Línea 273: Línea 251:
 </​file>​ </​file>​
  
-=== Códigos de Respuesta de Estatus UUID ( Para retenciones y pagos) ​===+=== Códigos de Respuesta de Estatus UUID  ===
  
 ^  Código ​ ^  Validación ​ | ^  Código ​ ^  Validación ​ |
Línea 281: Línea 259:
 |  1205  |UUID no existe. | |  1205  |UUID no existe. |
  
-=== Códigos de Respuesta a nivel petición ​(Para retenciones y pagos) ​===+=== Códigos de Respuesta a nivel petición ​ ===
  
 ^  Código ​ ^  Validación ​ | ^  Código ​ ^  Validación ​ |
Línea 297: Línea 275:
 \\ \\
  
 +====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>​
web-service-retenciones.1422156633.txt.gz · Última modificación: 2016/01/05 23:15 (editor externo)