DOCUMENTACION API COMERCIAL

Guías para facturar desde tu sistema o aplicación
  1. Inicio
  2. Documentación
  3. Tutoriales
  4. Envía tu Comprobante

ENVIA TU COMPROBANTE

Con nuestra API puedes automatizar el envío ilimitado de tus Comprobantes Fiscales Digitales (CFDI) a tus clientes por correo electrónico de manera segura y escalable. Nuestra infraestructura maximiza la capacidad de entrega y protege la reputación del emisor para que el envío de correo transaccional no llegue a la bandeja de correos no deseados.

La API Comercial te permite enviar el comprobante en formatos PDF y XML a tus clientes de dos maneras:

  • Haciendo una petición al endpoint POST enviarCorreo
  • Agregando parámetros a una petición de timbrado al endpoint POST generarCfdi

Contenido de la página

En esta página encontrarás el siguiente contenido:

Petición    POST enviarCorreo

La petición POST enviarCorreo solicita el envío por correo electrónico de las ligas para descargar un CFDI. El siguiente diagrama representa el proceso de envío mediante la API Comercial.



Para enviar un CFDI mediante este endpoint, es necesario haber generado previamente el CFDI que se desea enviar.

Requisitos

Este tutorial asume que ya tienes los siguientes elementos:

  • Una cuenta configurada con la modalidad de API activada. Si aún no tienes tu cuenta configurada, consulta la Guía de Inicio Rápido.
  • Tus credenciales para consumir la API. Para más información sobre cómo obtener y utilizar tus credenciales en el encabezado de tu petición, consulta la sección de Autenticación.
  • Un CFDI previamente emitido con la API. Si aún no has generado un CFDI, consulta el tutorial para timbrar tu comprobante.

Puedes enviar comprobantes fiscales digitales en los siguientes casos:

  • Si tienes una cuenta gratis: Puedes enviar una cantidad ilimitada de CFDI generados en el entorno de prueba. Además, puedes enviar hasta 5 CFDI con validez fiscal dentro de los 30 días después de la creación de la cuenta gratis y antes de pasar al esquema de prepago.
  • Si tienes saldo en tu cuenta: Puedes enviar la cantidad de CFDI que requieras mientras tengas saldo en tu cuenta para consumir la API, tanto en el entorno de prueba como en el entorno de producción. No se cobra el envío por comprobante. Para consultar tu saldo disponible, puedes utilizar el API Endpoint POST https://api.enlacefiscal.com/v6/obtenerSaldo.

Endpoint

POST https://api.enlacefiscal.com/v6/enviarCorreo

Elementos de la petición

La siguiente tabla describe los parámetros en formato JSON que debes enviar dentro de tu petición.

Parámetro                           Tipo de Dato Ocurrencia Descripción
Solicitud Objeto Requerido Encabezado de la solicitud.
    modo Enum Opcional Entorno de la API en la que se va a generar el CFDI, siendo las opciones posibles: debug o produccion. El valor predeterminado es produccion.
    rfc String Requerido RFC del emisor del CFDI. No debe contener guiones ni espacios.
    accion Enum Requerido Método que queremos consumir vía la API. El valor requerido para este endpoint es enviarCorreo.
    CFDi Objeto Requerido Encabezado del comprobante.
        serie String Requerido Serie de comprobantes del CFDI que se desea enviar.Se trata de un identificador interno que fue asignado a un tipo de comprobante para distinguir rápidamente entre diferentes conjuntos de comprobantes.
        folio String Requerido Folio interno del CFDI que se desea enviar. Se trata de un código que tu sistema o aplicación asignó a un CFDI único para identificarlo fácilmente.
        EnviarCFDi Objeto Requerido Contiene la información necesaria para enviar el CFDI por correo electrónico a los clientes.
            Correos Array Requerido Contiene la dirección a la cual se enviará el correo electrónico para descargar los archivos PDF y XML del CFDI. Si quieres enviar tus CFDI a más de un correo electrónico, es necesario separar cada dirección con una coma.
            mensajeCorreos String Opcional Contiene el mensaje que puedes incluir en el correo electrónico enviado al cliente para descargar el CFDI.

Ejemplo de petición

A continuación encontrarás un ejemplo de código para la petición de envío del comprobante.


curl "https://api.enlacefiscal.com/v6/generarCfdi"
--request "POST"
--header "Content-Type:application/json"
--header "x-api-key:<X-API-KEY>"
--user "<USUARIO>:<TOKEN>"
--data '{
  "Solicitud": {
    "modo": "debug",
    "rfc": "AAA010101AAA",
    "accion": "enviarCorreo",
    "CFDi": {
      "serie": "FL",
      "folio": "10",
      "EnviarCFDI": {
            "Correos": [
                "facturas@enlacefiscal.com",
                "cuentasxpagar@enlacefiscal.com"
            ],
            "mensajeCorreo": "Mensaje personalizado del correo a enviar."
        }
    }
  }
}

Respuesta

La respuesta en formato JSON que recibes de nuestra API te indica si el CFDI fue enviado exitosamente por correo electrónico a tu cliente.

Elementos de la respuesta

Los elementos que componen la respuesta son:

Elemento Descripción Tipo
AckEnlaceFiscal Nombre del objeto confirmando la recepción exitosa de la petición. Object
        numeroReferencia Número de referencia que distingue cada petición. Permite identificar la petición en caso de error. Number
        estatusDocumento Información sobre el éxito o el rechazo de la petición. Los dos valores posibles son: "aceptado" o "rechazado". String
        fechaMensaje Fecha de la respuesta a la petición. String
        version Versión del formato de respuesta de la API. String
        estatus Estatus de la petición de envío del CFDI. Los valores posibles son Enviado por correo electrónico o ?. String
Ejemplo de respuesta

El siguiente es un código de ejemplo de la respuesta a la petición de envío de CFDI por correo electrónico. 


{
    "AckEnlaceFiscal": {
        "numeroReferencia": 62549,
        "estatusDocumento": "aceptado",
        "fechaMensaje": "2021-12-27 09:55:55",
        "version": "1.0",
        "estatus": "Enviado por correo electrónico"
    }
}

Petición   POST generarCfdi

Para enviar un CFDI a tu cliente al momento de generar el CFDI, solo necesitas agregar parámetros en formato JSON dentro de tu petición de timbrado. El siguiente diagrama representa el proceso de timbrado con envío del CFDI al receptor.




Requisitos

Este tutorial asume que ya tienes los siguientes elementos:

  • Una cuenta configurada con la modalidad de API activada. Si aún no tienes tu cuenta configurada, consulta la Guía de Inicio Rápido.
  • Tus credenciales para consumir la API. Para más información sobre cómo obtener y utilizar tus credenciales en el encabezado de tu petición, consulta la sección de Autenticación.

Puedes enviar comprobantes fiscales digitales en los siguientes casos:

  • Si tienes una cuenta gratis: Puedes enviar una cantidad ilimitada de CFDI generados en el entorno de prueba. Además, puedes enviar hasta 5 CFDI con validez fiscal dentro de los 30 días después de la creación de la cuenta gratis y antes de pasar al esquema de prepago.
  • Si tienes saldo en tu cuenta: Puedes enviar la cantidad de CFDI que requieras mientras tengas saldo en tu cuenta para consumir la API, tanto en el entorno de prueba como en el entorno de producción. No se cobra el envío por comprobante. Para consultar tu saldo disponible, puedes utilizar el API Endpoint POST https://api.enlacefiscal.com/v6/obtenerSaldo.

Endpoint

POST https://api.enlacefiscal.com/v6/generarCfdi

Elementos de la petición

La siguiente tabla describe los parámetros que debes agregar a la petición de timbrado.

Parámetro                         Tipo de Dato Ocurrencia Descripción
CFDi Objeto Requerido para generar y timbrar el comprobante Encabezado del comprobante.
    EnviarCFDi Objeto Requerido si quieres enviar el comprobante al cliente Contiene la información necesaria para enviar el comprobante por correo electrónico a los clientes. Los correos adoptan el diseño del comprobante (indicado en el nodo nombreDiseno) e incluyen el logotipo en caso de que el diseño cuente con uno.
        Correos Array Requerido Contiene la dirección de correo electrónico a la cual se enviará el correo para descargar los archivos PDF y XML del comprobante. Si quieres enviar tus comprobantes a más de un correo electrónico, es necesario separar cada dirección con una coma.
        mensajeCorreos String Opcional Contiene el mensaje que puedes incluir en el correo electrónico enviado al cliente para descargar el comprobante

Ejemplo de petición

A continuación encontrarás un extracto de código donde se solicita el envío del comprobante por correo electrónico dentro de una petición de timbrado. Los puntos suspensivos (...) representan parámetros en formato JSON con datos generales y adicionales de la petición de timbrado, por ejemplo el desglose de las partidas y los impuestos.


curl "https://api.enlacefiscal.com/v6/generarCfdi"
--request "POST"
--header "Content-Type:application/json"
--header "x-api-key:<X-API-KEY>"
--user "<USUARIO>:<TOKEN>"
--data '{
    "CFDi": {
		...
        "EnviarCFDI": {
            "Correos": [
                "facturas@enlacefiscal.com",
                "cuentasxpagar@enlacefiscal.com"
            ],
            "mensajeCorreo": "Mensaje personalizado que se incluirá en el cuerpo del correo a enviar."
        	},
        ...
		}
	}
}

Respuesta

La respuesta que recibes de nuestra API está en formato JSON.

¿Tienes preguntas?

Consulta nuestros artículos con preguntas frecuentes sobre facturación electrónica o contáctanos por correo.