{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/contacts/:id/notify-payment","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n    \"code\": \"200\",\n    \"message\": \"Se ha envíado un correo a la compañia con la notificación\" \n}","language":"json","status":200}]},"params":[{"name":"client","type":"object","default":"","desc":"Objeto client, el cual contiene el parametro `email` con el correo electrónico del cual se enviará la notificación de pago..","required":true,"in":"body","ref":"","_id":"5e8c9dd6a41f020036cc8485"},{"name":"document","type":"object","default":"","desc":"Objeto document, el cual contiene el parámetro `id`el cual es el identificador de la factura o de la nota de crédito y `type` donde se describe el tipo del documento `invoice` o `credit-note`.","required":true,"in":"body","ref":"","_id":"5e8c9f21b7bfa700353d9c86"},{"name":"emailTemplate","type":"object","default":"","desc":"Objeto emailTemplate, el cual contiene `subject` donde se describe el asunto del correo y `message` donde se enuncia la descripción del correo electrónico.","required":true,"in":"body","ref":"","_id":"5e8c9f21b7bfa700353d9c85"}],"examples":{"codes":[{"code":"{\n\t\"client\" : { \n\t\t\"email\": \"usuario:::at:::alegra.com\"\n\t},\n\t\"document\": {\n\t\t\"id\": 10,\n\t\t\"type\": \"invoice\"\n\t},\n\t\"emailTemplate\": {\n  \t\t\"subject\":\"Notificación pago factura de venta folio Q41\",\n  \t\t\"message\":\"Cordial saludo, se envia la notificación del pago\"\n\t}\n}","language":"json","name":"Envío de notificación"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"Envío de Notificación de Pago","type":"endpoint","slug":"envio-de-notificacion-de-pago","excerpt":"Endpoint para realizar el envio de correo electrónico notificando un pago","body":"","updates":[],"order":9,"isReference":true,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"5e8c9dd6a41f020036cc8484","createdAt":"2020-04-07T15:35:50.624Z","user":"56abd213d4432d1900eed227","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Contactos","slug":"contactos","order":2,"from_sync":false,"reference":true,"_id":"56b4b2faeed075230097d688","__v":0,"project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","createdAt":"2016-02-05T14:34:34.496Z"},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56abd2444e4b730d009eb10e","56abd4c8f25f160d00e17f81","56abd72ff25f160d00e17f84","56b3b8ea9f97020d0012d936","56b3b91ac25dea2b00b0cac9","56b4b2faeed075230097d688","56b4b32deed075230097d689","56b4b37327d9c00d005d6bc4","56b4b3bf3d5f130d00dad120","56b4b3d9eed075230097d68a","56b4b3eb7bccae0d00e9a12e","56b4b4085997532100bc6b61","56fbce6e2885e80e006c855f","5739ed9aad40e23200f674b6","573dd672b3f88f0e00dcae1c","58ad0922e570c62500512a82","58ad092b55018f1900218fda","58e412a5aa544d1b0005f7da","59e62c2a3ccab100263e800a","59e63126b4f8b0002edbe92c","5b5bbc98eaf71700031c2fda","5bedb529a56934002ee522b9","5c3e39454d3006001420f73e","5c4f5c0e1555130014796daa","5c6ac741acb04f003f927fa7","5c7e9c7c412d4c003f750162","5d055915910ab30020e5bc06","5d76e2018e0ce7006c82dbe1","5d9ca92eac34370012872d08","5d9f8149103b9f006c1421e0","5e3098aba5919200612d0c33","5e8ca028538a310018ccd2df","5e9f0d4c720ad8006c6c7dc1","5ea9c2f382fcd2003df9f412","5ec7defc6aa2be001e7504f5","5ed8f716a8308c0412b5473a","5ed9274fe5a9b8041fd1df43","5ed92afa0d09d60253220b3f","5efcff9cd7e1be00118e8272","5f172282d7522c03be08713f","5f3c4814ac3e6209c38b7615","5f4fbe7281626c006887f104","5f5242887d2f8701ff580d22","5fc1133c51c8370081b28e2a","60807d7adc33b10010370740"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":45,"createdAt":"2016-01-29T20:57:39.712Z"},"project":"56abd2434e4b730d009eb10a","__v":6,"parentDoc":null}

getEnvío de Notificación de Pago

Endpoint para realizar el envio de correo electrónico notificando un pago

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

client:
required
object
Objeto client, el cual contiene el parametro `email` con el correo electrónico del cual se enviará la notificación de pago..
document:
required
object
Objeto document, el cual contiene el parámetro `id`el cual es el identificador de la factura o de la nota de crédito y `type` donde se describe el tipo del documento `invoice` o `credit-note`.
emailTemplate:
required
object
Objeto emailTemplate, el cual contiene `subject` donde se describe el asunto del correo y `message` donde se enuncia la descripción del correo electrónico.

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}