Histórico da Página

...

Introdução
Endpoint
Parâmetros
Resposta

01. INTRODUÇÃO

Esta API retorna permite consultar os lotes de importação de beneficiários criados (na rotina PLCTO001), permitindo possibilitando acompanhar o status de processamento e os detalhes de cada lote.

...

Nome

Tipo

Localização

Descrição

Content-Type

string

header

multipart/form-data ou application/json (bodydependendo 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>.

Estado

subtle	true
colour	Red
title	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

...

Informações

icon	false

Dica
200 - Operação realizada com sucesso

Campo

Tipo

Descrição

hasNext

Estado


subtle	true
title	boolean

Indica se ainda existem registros a serem retornados

remainingRecords

Estado


subtle	true
title	integer

Quantidade de registros ainda existentes para retorno

items

Estado


subtle	true
title	array

Lista de lotes de importação de beneficiários

Estrutura do objeto items

Campo

Tipo

Descrição

Campo (Protheus)

batchCode

Estado

subtle	true
title	string

Código do Lote

BJ5_CODLOT

status

Estado

subtle	true
title	string

Status do Lote

BJ5_STATUS

importDate

Estado


subtle	true
title	string (DATE)

Data da importação

BJ5_DATIMP

importTime

Estado

subtle	true
title	string

Hora da importação

BJ5_HORIMP

loginUser

Estado

subtle	true
title	string

Usuário que gerou o lote

BJ5_USRLOG

healthInsurerCode

Estado

subtle	true
title	string

Código da operadora

BJ5_CODOPE

companyCode

Estado

subtle	true
title	string

Código da empresa

BJ5_CODEMP

contractCode

Estado

subtle	true
title	string

Código do contrato

BJ5_CONEMP

contractVersion

Estado

subtle	true
title	string

Versão do contrato

BJ5_VERCON

subcontractCode

Estado

subtle	true
title	string

Código do subcontrato

BJ5_SUBCON

subcontractVersion

Estado

subtle	true
title	string

Versão do subcontrato

BJ5_VERSUB

subcontractDescription

Estado

subtle	true
title	string

Descrição do subcontrato

BQC_DESCRI

totalCount

Estado


subtle	true
title	INTEGER

Total de beneficiários do lote

BJ5_QTDTOT

importedCount

Estado


subtle	true
title	INTEGER

Total de beneficiários importados

BJ5_QTDIMP

errorCount

Estado


subtle	true
title	INTEGER

Total de beneficiários com erro

BJ5_QTDERR

Bloco de código

language	c#
theme	Midnight
title	Exemplo
collapse	true

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

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

01. INTRODUÇÃO

200 - Operação realizada com sucesso