Exibir origem

CONTEÚDO

Introdução
Endpoint
Parâmetros
Resposta

01. INTRODUÇÃO

Esta API retorna os lotes de importação de beneficiários criados (PLCTO001), permitindo 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

/totvsHealthPlans/familyContract/v1/beneficiaries/importBatches

03. PARÂMETROS

Nome	Tipo	Localização	Descrição
Content-Type	string	header	multipart/form-data ou application/json (body)
Authorization	string	header	Token de acesso obtido via a API de autenticação, no formato Bearer <access_token>.
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		Indica se ainda existem registros a serem retornados
remainingRecords		Quantidade de registros ainda existentes para retorno
items		Lista de lotes de importação de beneficiários

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

{
  	"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
		}
	]
}

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