TOConline - Documentação API
  • Introdução
  • Setup do Postman
  • Autenticação Simplificada
  • Autenticação Detalhada
  • Características dos pedidos
  • APIs
    • Empresa
      • Clientes, Morada e E-mail
      • Fornecedores, Morada e E-mail
      • Produtos e Serviços
    • Vendas
      • Documentos de Venda
      • Documentos Retificativos
      • Recibos de Venda
      • Descarregar PDF de Documentos de Venda
      • Descarregar PDF de Recibo
      • Comunicação de documentos à AT
      • Envio de Documentos por email
      • Envio de Recibos por email
    • Compras
      • Documentos de Compra
      • Pagamentos
      • Descarregar PDF de Documentos de Compra
      • Descarregar PDF de Pagamentos
      • Comunicação de documentos à AT
    • Versões Anteriores
      • Vendas
        • Documentos de Venda
        • Recibos de Venda
      • Compras
        • Documentos de Compra
        • Pagamentos
    • APIs Auxiliares
      • Descritores de Taxa
      • Família de Itens
      • Países
      • Unidades de Medida
      • Contas Bancárias
      • Caixa Associada
      • Unidade Monetária
      • Taxas
      • Categorias de Despesa
      • Documentos de Série
Powered by GitBook
On this page
  1. APIs
  2. Vendas

Envio de Documentos por email

Envio de email de documentos via API. Inclui instruções de uso, headers e um exemplo de JSON payload para definição de emails e conteúdo.

PreviousComunicação de documentos à ATNextEnvio de Recibos por email

Last updated 8 months ago

curl -v -X PATCH -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:

Payload
{
  "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.do.destinatario@mail.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": "email.do.remetente@mail.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...)")
    }
  }
}
Exemplo de Response
{
    "success": true,
    "to_addresses": "email.do.destinatario@mail.mail"
}

Envio de Documentos por email

patch

Envio de Documentos por email

Authorizations
Body
Responses
200Success
patch
PATCH /api/email/document HTTP/1.1
Host: {{base_url}}
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "data": {
    "attributes": {
      "from_email": "email.do.remetente@mail.mail",
      "from_name": "Nome do remetente",
      "subject": "Assunto da mensagem",
      "to_email": "mail.do.destinatario@mail.mail",
      "type": "Document"
    },
    "id": 3,
    "type": "email/document"
  }
}
200Success

No content