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//email/document/{id}

Path parameters

id*integer

id of the document or receipt to send by email

Body

application/json

data*object

Response

200

OK

Body

application/json

dataobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('//email/document/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": {
        "type": "email/document",
        "id": "1",
        "attributes": {}
      }
    }),
});
const data = await response.json();

Response

200

{
  "data": {
    "success": true,
    "to_addresses": "[e-mail]"
  }
}

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": "[e-mail]",           // [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": "[e-mail]",            // [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...)")
    }
  }
}