{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/credit-notes/:id/email","auth":"required","params":[{"name":"id","type":"int","default":"","desc":"Identificador de la nota de crédito que se desea enviar por correo. Este parámetro se debe incluir en la URL.","required":true,"in":"path","ref":"","_id":"56b21cef3b6f690d00bdb6bb"},{"name":"emails","type":"array_string","default":"","desc":"Indica a cuales correos se desea enviar la factura. Si se desea enviar solo a un correo se puede enviar el correo directamente en el parámetro.  Este parámetro se debe incluir en el POST.","required":true,"in":"body","ref":"","_id":"56b21cef3b6f690d00bdb6ba"},{"name":"sendCopyToUser","type":"boolean","default":"false","desc":"Enviar en true si se quiere enviar una copia del correo al usuario que está realizando la acción. Este parámetro se debe incluir en el POST.","required":false,"in":"body","ref":"","_id":"56b21cef3b6f690d00bdb6b9"}],"results":{"codes":[{"language":"json","code":"{\n  \"code\":200,\n  \"message\":\"La nota de crédito fue enviada exitosamente\"\n}\n","name":"","status":200}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X POST  https://api.alegra.com/api/v1/credit-notes/120/email -u 'micorreo:::at:::alegra.com:mitoken12345' -d '{\"emails\":[\"[email protected]\"], \"sendCopyToUser\":true }'"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Enviar nota de crédito por correo","type":"endpoint","slug":"enviar-nota-de-crédito-por-correo","excerpt":"Enpoint para envíar una nota de crédito por correo","body":"","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f7e1ddd1b13e9006386b139","createdAt":"2020-10-07T19:58:21.612Z","user":"5a2184feb778240012e38415","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Notas Crédito","slug":"notas-crédito","order":22,"from_sync":false,"reference":false,"_id":"5e8ca028538a310018ccd2df","createdAt":"2020-04-07T15:45:44.192Z","version":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":0},"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"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":43,"createdAt":"2016-01-29T20:57:39.712Z"},"project":"56abd2434e4b730d009eb10a","__v":1,"parentDoc":null}

postEnviar nota de crédito por correo

Enpoint para envíar una nota de crédito por correo

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Identificador de la nota de crédito que se desea enviar por correo. Este parámetro se debe incluir en la URL.

Body Params

emails:
required
array of strings
Indica a cuales correos se desea enviar la factura. Si se desea enviar solo a un correo se puede enviar el correo directamente en el parámetro. Este parámetro se debe incluir en el POST.
sendCopyToUser:
booleanfalse
Enviar en true si se quiere enviar una copia del correo al usuario que está realizando la acción. Este parámetro se debe incluir en el POST.

Examples


Result Format


User Information

Try It Out

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