API Lotes de Importação - Consultar Lotes 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 lotes de importação de beneficiários criados na rotina PLCTO001, possibilitando acompanhar o status de processamento e os detalhes de cada lote.

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

02. ENDPOINT

GET /totvsHealthPlans/familyContract/v1/beneficiaries/importBatches

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
loginUser	string	query	Filtro dos lotes pelo usuário do portal (BSW)
page	string	query	Valor numérico (maior que zero) representando a página solicitada
pageSize	string	query	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order	string	query	Lista de campos para ordenação, separada por vírgula (,)
fields	string	query	Lista com o nome das propriedades JSON que serão retornadas
filter	string	query	Filtros seguindo o padrão ODATA

04. RESPOSTA

200 - Operação realizada com sucesso

Campo	Tipo	Descrição
hasNext	BOOLEAN	Indica se ainda existem registros a serem retornados
remainingRecords	INTEGER	Quantidade de registros ainda existentes para retorno
items	ARRAY	Lista de lotes de importação de beneficiários

Estrutura do objeto items
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	BJ5_QTDIMP
errorCount	INTEGER	Total de beneficiários com erro	BJ5_QTDERR

Exemplo

{
  	"hasNext": false,
  	"remainingRecords": 0,
  	"items": [
		{
    		"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
		}
	]
}

Exemplo JSON de Resposta (sem registros)

{
  "hasNext": false,
  "remainingRecords": 0,
  "items": []
}

Árvore de páginas