Diferencia entre revisiones de «API LaFactura.co:Email»
(→Campos) |
|||
| Línea 35: | Línea 35: | ||
! Campo !! Descripción !! Tipo !! Obligatorio | ! Campo !! Descripción !! Tipo !! Obligatorio | ||
|- | |- | ||
| − | | body || Contenido del correo que vas a enviar al cliente final<br/> | + | | body || Contenido del correo que vas a enviar al cliente final<br/>* Debe estar codificado en base64<br/>* El contenido debe tener HTML sintácticamte correcto<br/> Debe incluir las variables explicadas en la siguiente sección || cadena || SI |
|} | |} | ||
Revisión del 12:58 14 ene 2023
Sumario
cadena: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
Objeto enviando la información que va en el cuerpo del correo
"email":{
"body":"ioeuwroiweruoeiw ..... [Codificado Base64] ......... oiuewroiueroieruiouTx=="
}
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: Este objeto no es obligatorio. Nuestro sistema tiene formatos preestablecidos para el envio de correos. En caso de que desees usar este objeto, debes informarnos primero.
| Campo | Descripción | Tipo | Obligatorio |
|---|---|---|---|
| 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 incluir las variables explicadas en la siguiente sección |
cadena | SI |
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
