API Lotes de Importação - Consultar Lote de Importação de Beneficiários - Versão 1.0

CONTEÚDO

Introdução
Endpoint
Parâmetros
Resposta

01. INTRODUÇÃO

Esta API permite consultar os detalhes de um lote de importação de beneficiários a partir do seu código identificador. As informações retornadas incluem dados gerais do lote, como status de processamento, quantidade de registros processados, data de criação e outras informações relevantes.

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

02. ENDPOINT

GET /totvsHealthPlans/familyContract/v1/beneficiaries/importBatches/{batchCode}

03. PARÂMETROS

Nome	Tipo	Localização	Descrição
Content-Type	string	header	multipart/form-data ou application/json (dependendo do formato do corpo da requisição).
Authorization	string	header	Token de acesso obtido via a API de autenticação, no formato Bearer <access_token>. REQUIRED
batchCode	string	path	Código do lote a ser consultado. REQUIRED

04. RESPOSTA

200 - Operação realizada com sucesso

Campo	Tipo	Descrição	Campo (Protheus)
batchCode	STRING	Código do Lote	BJ5_CODLOT
status	STRING	Status do Lote	BJ5_STATUS
importDate	STRING (DATE)	Data da importação	BJ5_DATIMP
importTime	STRING	Hora da importação	BJ5_HORIMP
loginUser	STRING	Usuário que gerou o lote	BJ5_USRLOG
healthInsurerCode	STRING	Código da operadora	BJ5_CODOPE
companyCode	STRING	Código da empresa	BJ5_CODEMP
contractCode	STRING	Código do contrato	BJ5_CONEMP
contractVersion	STRING	Versão do contrato	BJ5_VERCON
subcontractCode	STRING	Código do subcontrato	BJ5_SUBCON
subcontractVersion	STRING	Versão do subcontrato	BJ5_VERSUB
subcontractDescription	STRING	Descrição do subcontrato	BQC_DESCRI
totalCount	INTEGER	Total de beneficiários do lote	BJ5_QTDTOT
importedCount	INTEGER	Total de beneficiários importados (em processamento, pode variar)	BJ5_QTDIMP
errorCount	INTEGER	Total de beneficiários com erro (em processamento, pode variar)	BJ5_QTDERR

Exemplo

{
    "batchCode": "00000155",
    "status": "1",
    "importDate": "2025-08-22",
    "importTime": "17:07:17",
    "loginUser": "VINIEMP",
    "healthInsurerCode": "0001",
    "companyCode": "1017",
    "contractCode": "000000000001",
    "contractVersion": "001",
    "subcontractCode": "000000001",
    "subcontractVersion": "001",
    "subcontractDescription": "CONTRATO DE IMPOT. DE BENEFICIARIOS",
    "totalCount": 8,
    "importedCount": 0,
    "errorCount": 0
}

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

404 - O lote informado não foi encontrado. Verifique o código e tente novamente.
Lote de beneficiários com o código informado não localizado na tabela BJ5 (campo BJ5_CODLOT) durante o processo de importação.

Campo	Tipo	Descrição
code	INTEGER	Código identificador do erro.
message	STRING	Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage	STRING	Mensagem técnica e mais detalhada do erro.

Exemplo JSON de 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."
}

Árvore de páginas