Dispara um job de ação em massa (upload de planilha)
POST/job
Cria um job para processar em lote a ação indicada por IDTypeJob. O envio do arquivo pode ser feito de duas formas: diretamente na requisição, em multipart/form-data; ou em dois passos, enviando Action RequestUploadUrl para obter uma URL de envio temporária e depois Action ConfirmUpload com a chave devolvida — o caminho recomendado para arquivos grandes, já que o conteúdo não trafega pela API. O envio em dois passos aceita arquivos até o tamanho máximo configurado, 50 MB por padrão, e a URL temporária vale 1 hora; o envio direto fica limitado ao tamanho máximo de requisição aceito pela API. Em qualquer um dos dois, se a empresa já tem um job em processamento com o mesmo arquivo, o job existente é reaproveitado e nenhum processamento novo é disparado. O processamento é assíncrono: a resposta traz o IDJob e o resultado real é acompanhado em GET /job/{idjob} ou recebido por e-mail.
Request
Responses
- 200
- 400
- 404
- 500
Job criado (ou reaproveitado). Devolve IDJob para acompanhamento — o identificador pode ser o de um job já existente, tanto quando o mesmo arquivo já foi confirmado antes quanto quando outro job com o mesmo conteúdo ainda está em processamento. O processamento é assíncrono: o resultado vem por e-mail e pode ser acompanhado em GET /job/{idjob}. No modo Action=RequestUploadUrl o corpo é outro — um objeto com UploadUrl (endereço temporário para enviar o arquivo), Key (chave a devolver em ConfirmUpload), Name, Method (sempre PUT), Headers (cabeçalhos obrigatórios no envio), SizeBytes e ExpiresIn (validade em segundos, 3600 por padrão).
Falha de validação. O corpo traz errorMessage com o prefixo [BadRequest] - seguido de uma das mensagens:
Ação não encontrada(IDTypeJob inválido)Erro ao processar ação em massa(combinação rota/tipo não mapeada)IDBankAccount é obrigatórioIDCompanyIntegration é obrigatórioCorpo da requisição inválidoSelecione um arquivo para enviarNão foi possível identificar o tipo do arquivo selecionadoNão foi possível identificar o tamanho do arquivo selecionadoO arquivo selecionado excede o tamanho máximo permitidoNão foi possível validar o arquivo selecionado. Selecione-o novamente e tente de novoFalha ao gerar o link de upload: <detalhe>Não foi possível identificar o arquivo enviado. Solicite um novo envioNão foi possível localizar o arquivo enviado. Envie-o novamenteO arquivo enviado não corresponde ao arquivo selecionado. Envie-o novamenteNão foi possível validar o arquivo enviado. Envie-o novamenteNão foi possível ler o arquivo enviado. Envie-o novamenteNão foi possível confirmar o envio do arquivo. Tente novamenteNão foi possível processar o arquivo enviado. Envie-o novamente
Empresa do accountname não localizada (404 sem corpo).
Erro interno (prefixo Error:).