WS320 - Enviar anexos a uma chave fiscal

WS320 - Nosso serviço para envios de anexos a uma chave fiscal

Esta integração tem por objetivo abrir solicitação para anexar arquivos a um documento na Comprovei

Clique aqui para ver histórico de versões

Data de atualização	Data de publicação do serviço	Alterações
17/04/2026	17/04/2026	Disponibilização do webservice

Autenticação

• As chamadas terão autenticação a nível de transporte (Basic Authentication);
• Solicite o user / password ao administrador da conta.

Características

• URL

  <https://entregas-api.comprovei.com/v2/ws320>

• Método:

  POST

Esta integração retorna um protocolo para acompanhamento - WS301

Parâmetros

Exemplo

{
    "documents": [{
        "key": "",
        "attachments": [{
            "filename": "arquivo.pdf",
            "link": "http://myurl/arquivo.pdf",
            "emission_date": "2026-03-23 00:00:00",
            "description": "Meu arquivo para anexar"
        }]
    }]
}

Parâmetro	Tipo	Descrição
key	Alfanumérico	(Obrigatório) Chave da nota fiscal enviada à Comprovei
attachments	Array	(Obrigatório) Array de objeto do tipo Anexo

Anexo

Parâmetro	Tipo	Descrição
description	Alfanumérico	(Obrigatório) Descrição do arquivo sendo anexado
emission_date	Alfanumérico	(Obrigatório) Data de emissão do anexo
filename	Alfanumérico	(Obrigatório) Nome do arquivo
link	Uri	(Obrigatório) Url de acesso ao arquivo

Importante

Todos os campos opcionais serão validados caso sejam enviados, ou seja não podem estar em branco, caso não deseje enviar as informações opcionais, não acrescente os campos.

• Sucesso:

  • Código: 202
    Conteúdo:

    {
        "message" : "OK",
        "protocol" : "<protocol>"
    }
    

• Erro:

  • Código: 400
    Conteúdo:

    {
        "message": "Corpo da requisição está vazio"
    }
    

    {
        "message" : "Documento não encontrada" 
    }
    

    { 
        "message" : "Campos obrigatórios não preenchidos" 
    }