CONTEÚDO

  1. Introdução
  2. Endpoint
  3. Parâmetros
  4. 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

/totvsHealthPlans/familyContract/v1/beneficiaries/importBatches

03. PARÂMETROS

NomeTipoLocalizaçãoDescrição

Content-Type

string

headermultipart/form-data ou application/json (dependendo do formato do corpo da requisição)
Authorizationstring

header

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

loginUserstringqueryFiltro dos lotes pelo usuário do portal (BSW)
pagestringqueryValor numérico (maior que zero) representando a página solicitada
pageSizestringqueryValor numérico (maior que zero) representando o total de registros retornados na consulta
orderstringqueryLista de campos para ordenação, separada por vírgula (,)
fieldsstringqueryLista com o nome das propriedades JSON que serão retornadas
filterstringqueryFiltros seguindo o padrão ODATA

04. RESPOSTA

200 - Operação realizada com sucesso

CampoTipoDescriçã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
CampoTipoDescriçãoCampo (Protheus)
batchCode

Código do Lote

BJ5_CODLOT

status

Status do LoteBJ5_STATUS
importDate

Data da importaçãoBJ5_DATIMP
importTime

Hora da importaçãoBJ5_HORIMP
loginUser

Usuário que gerou o loteBJ5_USRLOG
healthInsurerCode

Código da operadoraBJ5_CODOPE
companyCode

Código da empresaBJ5_CODEMP
contractCode

Código do contratoBJ5_CONEMP
contractVersion

Versão do contratoBJ5_VERCON
subcontractCode

Código do subcontratoBJ5_SUBCON
subcontractVersion

Versão do subcontratoBJ5_VERSUB
subcontractDescription

Descrição do subcontratoBQC_DESCRI
totalCount

Total de beneficiários do loteBJ5_QTDTOT
importedCount

Total de beneficiários importadosBJ5_QTDIMP
errorCount

Total de beneficiários com erroBJ5_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": []
}