Ir para o conteúdo

5.2. Upload de Arquivo

🔗 Endpoint

Método URL
POST /public/api/v1/duplicata-escritural/escrituracoes/arquivo

🧾 Descrição

Realiza a escrituração em lote de duplicatas por meio do upload de um arquivo. O arquivo deve conter as duplicatas no formato esperado pelo sistema (XML), e o tipo do documento fiscal informado será aplicado a todas as duplicatas contidas no arquivo.


📤 Requisição

📋 Payload (multipart/form-data)

Campo Tipo Obrigatório Descrição
TipoDocumentoFiscal integer Sim Tipo do documento fiscal das duplicatas no arquivo (ver enumerador abaixo)
Arquivo file Sim Arquivo com as duplicatas a escriturar (XML)

🔢 TipoDocumentoFiscal

Código Significado
1 NF-e (Nota Fiscal Eletrônica)
2 CF-e (Cupom Fiscal Eletrônico)

🧪 Exemplo de cURL

curl -X POST https://api.vehub.com.br/public/api/v1/duplicata-escritural/escrituracoes/arquivo \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -F "TipoDocumentoFiscal=1" \
  -F "Arquivo=@/caminho/para/arquivo-duplicatas.xml"

📥 Responses

✅ 200 OK

{
  "mensagem": "Arquivo recebido e duplicatas escrituradas com sucesso!",
  "identificador": "5174568D-9FFE-4C10-9FC2-B0F4E7F8D1B6",
  "identificadorProcessamento": null
}

✅ 202 Accepted

{
  "mensagem": "Arquivo recebido e será processado em breve.",
  "identificadorProcessamento": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890"
}

❌ 400 Bad Request

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "Arquivo inválido ou formato não suportado.",
    "Campo 'TipoDocumentoFiscal' é obrigatório."
  ]
}

🕒 Observações

  • O arquivo deve estar no formato esperado pela plataforma para o tipo de documento fiscal informado, XML.
  • Quando o retorno for 202 Accepted, o processamento do arquivo ocorrerá de forma assíncrona.
  • O campo TipoDocumentoFiscal define o tipo de documento fiscal para todas as duplicatas contidas no arquivo.