CONTEÚDO

  1. Introdução
  2. Endpoint
  3. Parâmetros
  4. Resposta


01. INTRODUÇÃO

Esta API permite reprocessar um lote de beneficiários enviando um novo arquivo CSV com os registros a serem corrigidos. O status do lote será atualizado para Em Processamento durante a execução.
O processamento é assíncrono, iniciando imediatamente a validação e geração dos beneficiários contidos no arquivo enviado.

Clique aqui para detalhes sobre como habilitar o serviço de APIs no Protheus.

02. ENDPOINT

 /totvsHealthPlans/familyContract/v1/beneficiaries/importBatches/reprocess

03. PARÂMETROS

NomeTipoLocalizaçãoDescrição

Content-Type

string

headermultipart/form-data ou application/json (body)
Authorizationstring

header

Token de acesso obtido via a API de autenticação, no formato Bearer <access_token>.

importBatchCodestring

body/form

Código do lote que será reprocessado

filefile

form-data

Arquivo CSV com os beneficiários

fileBase64string

body

Arquivo CSV em Base64

fileNamestring

body

Nome do arquivo CSV

Pode-se enviar o arquivo CSV dos beneficiários via file (form-data) ou fileBase64 (body) com o fileName.

{
  "importBatchCode": "00000155",
  "fileBase64": "QjJOX0NPRFNFUTtCMk5fQ1BGVVNSO0IyTl9OT01VU1I7QjJOX0RBVE5BUztCMk5...",
  "fileName": "modelo-importacao-beneficiarios.csv"
}

04. RESPOSTA

202 - Operação aceita para processamento

O lote iniciou o reprocessamento de forma assíncrona. Durante o processamento, o status do lote será atualizado para Em Processamento, além de anexar o arquivo CSV de correção ao banco de conhecimento do lote.

400 - Formato de JSON inválido.
O corpo da requisição não está em um formato JSON válido. Verifique a estrutura e tente novamente.

400 - O parâmetro não foi informado.
O parâmetro obrigatório deve ser enviado na requisição.

400 - O parâmetro não foi informado.
O parâmetro obrigatório deve ser enviado na requisição.

400 - Este lote não pode ser ajustado, pois não está com erro de importação.
O reprocessamento foi recusado. O lote informado não possui status (BJ5_STATUS) de erro de importação.

400 - Erro ao processar o arquivo CSV
Não foi possível obter o arquivo CSV. Verifique se o arquivo está disponível e se está em um formato válido.

406 - Formato de dados inválido.
Os dados enviados não estão no formato form-data. Verifique se o Content-Type da requisição está definido como multipart/form-data e se os campos foram corretamente estruturados.

CampoTipoDescrição
code

Código identificador do erro.
message

Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage

Mensagem técnica e mais detalhada do erro.
{
  "status": 400,
  "message": "Erro ao processar o arquivo CSV",
  "detailedMessage": "Não foi possível obter o arquivo CSV. Verifique se o arquivo está disponível e se está em um formato válido."
}