API LaFactura.co:Email
Sumario
objeto:email
Es una objeto usado en invoice/additional. Contiene la información a ser enviada en el correo al cliente final codificado en base64 y que corresponde al cuerpo del correo en HTML.
Ejemplo (1)
Objeto enviando la información que va en el cuerpo del correo
"email":{
"developer_email":"[email protected]",
"body":"ioeuwroiweruoeiw ..... [Codificado Base64] ......... oiuewroiueroieruiouTx=="
}
Ejemplo (2)
Objeto enviando la información de un formato almacenado en nuestro sistema
"email":{
"developer_email":"[email protected]",
"internalFormat":"fmt-0293482098234903284093284-v100"
}
Ejemplo Contenido de Body
Contenido ejemplo de la informacion enviada en el campo "body"
| Campo body | |
|---|---|
| Contenido enviado Codificado Base64 |
PGJvZHk+CiA8aDE+SG9sYTwvaDE+CiA8cD5Fc3RlIGVzIHVuIHRleHRvPC9wPgo gRG9jdW1lbnRvOiB7UHJlZmlqb0RvY3VtZW50b30te051bWVyb0RvY3VtZW50b30 8YnIvPgogVmFsb3IgVG90YWw6IHtWYWxvckRvY3VtZW50b308YnIvPgogTm9tYn JlIGRlbCBDbGllbnRlOiB7Tm9tYnJlQ2xpZW50ZX08YnIvPgogQWNlcHRhcjoge0xp bmtBY2VwdGFyfTxici8+CiBSZWNoYXphcjoge0xpbmtSZWNoYXphcn08YnIvPgog Q29ycmVvIENvbnRhY3RvOiB7Q29ycmVvQ29udGFjdG99PGJyLz4KIFRlbMOpZm 9ubyBDb250YWN0bzoge1RlbGVmb25vQ29udGFjdG99PGJyLz4KIDxici8+CjwvYm 9keT4g |
| Contenido decodificado |
<body> <h1>Hola</h1><p>Este es un texto</p> Documento: {PrefijoDocumento}-{NumeroDocumento}<br/> Valor Total: {ValorDocumento}<br/> Nombre del Cliente: {NombreCliente}<br/> Aceptar: {LinkAceptar}<br/> Rechazar: {LinkRechazar}<br/> Correo de Contacto: {CorreoContacto}<br/> Telefono de Contacto: {TelefonoContacto} </body> |
Explicacion
El sistema recibe el contenido del documento completo a ser enviado en el cuerpo del correo electronico al cliente. Debe incluir algunas variables de manera obligatoria que serán reemplazadas durante el proceso de envio.
Campos
Los campos requeridos para el envio del correo.
Importante: Nuestro sistema tiene formatos preestablecidos para el envio de correos por lo que el uso de esta opción no es obligatoria. En caso de que desees usar este objeto, debes informarnos primero.
| Campo | Descripción | Tipo | Obligatorio |
|---|---|---|---|
| developer_email | Correo electrónico para enviar las pruebas durante "desarrollo" Importante: - Este elemento es indispensable en desarrollo - No es tenido encuenta en producción |
cadena | -Obligatorio en desarrollo -En producción no afecta |
| body | Contenido del correo que vas a enviar al cliente final * Debe estar codificado en base64 * El contenido debe tener HTML sintácticamte correcto * Debe contener un y solo un elemento <body> * Debe incluir las variables explicadas en la siguiente sección Importante: - Cualquier elemento por fuera de <body> será eliminado. - Los saltos de línea y tabuladores por no ser parte de HTML serán eliminados -Si utilizas body no puedes usar internalFormat |
cadena | Debes enviar body o internalFormat |
| internalFormat | Código del formato almacenado en nuestro sistema que va a ser utilizado para el envio de este documento Importante: - Si utilizas internalFormat no puedes usar body |
cadena | Debes enviar body o internalFormat |
Variables
Recuerda: Nuestro sistema reemplazará las variables por su valor apropiado en el momento en que envía el correo al cliente final. Deben enviarse las variables no valores.
| Variables | Descripción | Tipo | Obligatorio |
|---|---|---|---|
| {PrefijoDocumento} | Prefijo del documento adjunto | cadena | SI |
| {NumeroDocumento} | Numero del documento adjunto | cadena | SI |
| {ValorDocumento} | Valor Total del documento | cadena | SI |
| {NombreCliente} | Nombre del cliente final | cadena | SI |
| {LinkAceptar} | Enlace de aceptacion del cliente | cadena | SI |
| {LinkRechazar} | Enlace de rechazo del cliente | cadena | SI |
| {CorreoContacto} | Correo de contacto de tu empresa | cadena | SI |
| {TelefonoContacto} | Telefono de contacto de tu empresa | cadena | SI |
A Tener presente
- Tu cuenta debe estar autorizada para usar este servicio
Objetos empleados
Usado por
Los siguientes recursos:
Los siguientes objetos:
- invoice (Factura)
Temas complementarios
Enlaces
- LaFactura.co: https://lafactura.co
- GitHub: https://github.com/FacturacionElectronicaColombia/lafactura.co
