Comment on page

Envio de documentos e recibos por email

Esta rota permite o envio por email de (links para) documentos de venda — orçamentos, faturas-proforma, guias, faturas e notas — e recibos.
patch
https://4290048310-files.gitbook.io/
/email/document/{id}
curl -v -X POST -H 'Content-Type: application/vnd.api+json' -H 'Accept: application/json' -H 'Authorization: Bearer <access_token>' -d '<payload JSON>' '<API_URL>/email/document/<id do documento ou recibo>'
No pedido acima, o access_token é o token de acesso válido devolvido pelo serviço de OAuth e o id do documento ou recibo é o "id" interno do documento ou do recibo (cabeçalho), o devolvido no campo "id" da resposta ao seu pedido de criação. O payload JSON a enviar contém a seguinte informação:
{
"data": {
"type": "email/document", // [OBRIGATÓRIO]
"id": "<id do documento ou do recibo>", // [OBRIGATÓRIO] Este "id" é o devolvido na resposta ao pedido de criação do cabeçalho do documento ou do recibo, ver acima
"attributes": {
"type": "Document|Receipt", // [OPCIONAL] Por omissão "Document": "Document" para documentos de venda, "Receipt" para recibos
"to_email": "[email protected]", // [OPCIONAL] Por omissão é o endereço de email do cliente; se não existir tem que ser indicado. Podem ser vários, separados por ,
"from_email": "[email protected]", // [OPCIONAL] Por omissão é o endereço no-reply de email do sistema (TOConline, Business...)
"from_name": "Nome do remetente", // [OPCIONAL]
"subject": "Assunto da mensagem" // [OPCIONAL] Por omissão é o assunto padrão do sistema ("(Nome da empresa) enviou-lhe um documento/recibo através do (TOConline, Business...)")
}
}
}