Envio de email

Envia um documento por email. Existem três formas de filtrar os documentos que serão enviados:

1. Por chaves de acesso. Informe as chaves de acesso, separadas por ponto, vírgula, ponto e vírgula, quebra de linha ou um caractere de espaço | . | , | ; | \n |

2. Pelo número do documento. Informe obrigatóriamente um número final, um número inicial, ano da emissão do documento, dígitos do mês de emissão do documento, o número de série, o código do modelo do documento, o(s) cnpj(s) relacionado(s) (sem máscara) e o tipo de relação do(s) cnpj(s) com os documentos.

3. Pela data de emissão. Informe obrigatóriamente uma data final de emissão, uma data inicial de emissão, o número de série, o código do modelo dos documentso, o(s) cnpj(s) relacionado(s) (sem máscara) e o tipo de relação do(s) cnpj(s) com os documentos.

Em todos os casos o tipo de ambiente é obrigatório. No caso de faltar agum campo ou algum campo for inválido o filtro não será aplicado.

Os tipos de relação permitidos entre um cnpj e um documento são: emitente, destinatario, autorizado, tomador, expedidor, transportador, remetente e recebedor.

O campo 'reenvia' é resposável por indicar se o documento deve ser enviado para os emails contidos no xml do dcumento. Se este campo estiver nulo ou marcado como 'false', o campo de 'destinatarios' se torna obrigatório.

O campo 'anexos' pode receber até quatro valores válidos, que representam os anexos contidos nos emails enviados: procDFe, dadfe, procEvento e dacce. Os valores são, respectivamente, o XML do documento, o PDF do documento auxiliar, o XML do evento e o PDF do documento auxiliar da carta de correção (válido para NFe e CTe). O valor padrão desse campo, caso seja nulo, é procDFe, dadfe e procEvento. Qualquer outro valor será ignorado.

Os campos de assunto e mensagem são opcionais e caso não venham preenchidos o conteúdopadrão será adicionado de acordo com o modelo do monitor

O máximo de emails que podem ser enviados seguem o valor definido no parametro PAINEL_QTDE_MAXIMA_EMAILS_DFE

O retorno do endpoint contém um array com as chaves de acesso de documentos enviados e um map contendo a chaves de acesso de documentos não enviados juntamente com a sua justificativa. Documentos não encontrados não serão referenciados no retorno. Caso nenhum documento sea encontrado, o status do retorno será 404

Header Parameters

x-auth-token string required
identificador de sessão

application/json

Request Body required

emailDto

ambiente string
anexos string[]
ano int32
assunto string
chavesAcesso string
cnpjs string[]
codigoModelo int32
dataFinal date-time
dataInicial date-time
destinatarios string[]
mensagem string
mes int32
numeroFinal int64
numeroInicial int64
reenvia boolean
serie int64
tipoRelacao string

Responses

Schema
Example (from schema)

Schema

body object
statusCode string
Possible values: [100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511]
statusCodeValue int32

{
  "body": {},
  "statusCode": "100",
  "statusCodeValue": 0
}

Envio de email​

Envio de email