Histórico da Página

...

Introdução
Endpoint
Parâmetros
Resposta

01. INTRODUÇÃO

Esta API cria permite criar um novo lote de importação de beneficiários em massa na operadora.
Os beneficiários serão gerados com um protocolo ao serem importados na rotina de análise de beneficiários (PLSA977AB), permitindo que a operadora análise analise e aprove a inclusão no grupo familiar (PLSA174).

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

...

Nome

Tipo

Localização

Descrição

Content-Type

string

header

multipart/form-data ou application/json (body)dependendo do formato do corpo da requisição).

Authorization

string

Headerheader

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

Estado

subtle	true
colour	Red
title	Required

healthInsurerCode

string

body/form

Código da operadora

Estado

subtle	true
colour	Red
title	Required

companyCode

string

body/form

Código da empresa

Estado

subtle	true
colour	Red
title	Required

contractCode

string

body/form

Código do contrato

Estado

subtle	true
colour	Red
title	Required

contractVersion

string

body/form

Versão do contrato

Estado

subtle	true
colour	Red
title	Required

subcontractCode

string

body/form

Código do subcontrato

Estado

subtle	true
colour	Red
title	Required

subcontractVersion

string

body/form

Versão do subcontrato

Estado

subtle	true
colour	Red
title	Required

loginUser

string

body/form

Login do portal

Estado

subtle	true
colour	Red
title	Required

file

form-data

Arquivo CSV com os beneficiários

Estado

subtle	true
colour	Red
title	Required

fileBase64

string

body

Arquivo CSV em Base64

Estado

subtle	true
colour	Red
title	Required

fileName

string

body

Nome do arquivo CSV

Estado

subtle	true
colour	Red
title	Required

...

Informações

icon	false

Dica
201 - Operação realizada com sucesso

O sistema cria um novo lote na rotina de Lotes de Importação de Beneficiários (PLCTO001) com status Recebido, e anexa o arquivo CSV ao banco de conhecimento do lote.

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 (em processamento, pode variar)

BJ5_QTDIMP

errorCount

Estado


subtle	true
title	INTEGER

Total de beneficiários com erro (em processamento, pode variar)

BJ5_QTDERR

Bloco de código

language	c#
theme	Midnight
title	Exemplo
collapse	true

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

Informações

icon	false

Aviso
404 - Contrato informado não encontrado 400 - Formato de JSON inválido. O corpo da requisição não está em um formato JSON válido. Verifique a estrutura e tente novamente.

Aviso
400 - Erro ao processar o arquivo CSV. Não foi possível obter o arquivo CSV. Verifique se o arquivo está disponível e se está em um formato válido.

Aviso
400 - Os campos do cabeçalho do arquivo não correspondem ao modelo esperado para a importação de beneficiários.

Aviso
400 - O arquivo CSV do lote está vazio e não contém dados de beneficiários para processar.

Aviso
400 - Falha na validação dos dados. "Mensagem de erro do MVC"

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

Aviso
404 - Contrato informado não encontrado. O contrato informado não foi encontrado na tabela BQC. Verifique se o número do contrato está correto e devidamente cadastrado no sistema.

Aviso
406 - Formato de dados inválido. Os dados enviados não estão no formato form-data. Verifique se o Content-Type da requisição está definido como multipart/form-data e se os campos foram corretamente estruturados.

Campo

Tipo

Descrição

code

Estado


subtle	true
title	INTEGER

Código identificador do erro.

message

Estado

subtle	true
title	string

Literal no idioma da requisição descrevendo o erro para o usuário.

detailedMessage

Estado

subtle	true
title	string

Mensagem técnica e mais detalhada do erro.

Bloco de código

language	c#
theme	Midnight
title	Exemplo JSON de Erro
collapse	true

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

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

01. INTRODUÇÃO

201 - Operação realizada com sucesso

400 - Formato de JSON inválido.
O corpo da requisição não está em um formato JSON válido. Verifique a estrutura e tente novamente.

400 - Erro ao processar o arquivo CSV.
Não foi possível obter o arquivo CSV. Verifique se o arquivo está disponível e se está em um formato válido.

400 - Os campos do cabeçalho do arquivo não correspondem ao modelo esperado para a importação de beneficiários.

400 - O arquivo CSV do lote está vazio e não contém dados de beneficiários para processar.

400 - Falha na validação dos dados.
"Mensagem de erro do MVC"

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

404 - Contrato informado não encontrado.
O contrato informado não foi encontrado na tabela BQC. Verifique se o número do contrato está correto e devidamente cadastrado no sistema.

406 - Formato de dados inválido.
Os dados enviados não estão no formato form-data. Verifique se o Content-Type da requisição está definido como multipart/form-data e se os campos foram corretamente estruturados.

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

01. INTRODUÇÃO

201 - Operação realizada com sucesso

400 - Formato de JSON inválido.O corpo da requisição não está em um formato JSON válido. Verifique a estrutura e tente novamente.

400 - Erro ao processar o arquivo CSV.Não foi possível obter o arquivo CSV. Verifique se o arquivo está disponível e se está em um formato válido.

400 - Os campos do cabeçalho do arquivo não correspondem ao modelo esperado para a importação de beneficiários.

400 - O arquivo CSV do lote está vazio e não contém dados de beneficiários para processar.

400 - Falha na validação dos dados."Mensagem de erro do MVC"

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

404 - Contrato informado não encontrado.O contrato informado não foi encontrado na tabela BQC. Verifique se o número do contrato está correto e devidamente cadastrado no sistema.

406 - Formato de dados inválido.Os dados enviados não estão no formato form-data. Verifique se o Content-Type da requisição está definido como multipart/form-data e se os campos foram corretamente estruturados.

400 - Formato de JSON inválido.
O corpo da requisição não está em um formato JSON válido. Verifique a estrutura e tente novamente.

400 - Erro ao processar o arquivo CSV.
Não foi possível obter o arquivo CSV. Verifique se o arquivo está disponível e se está em um formato válido.

400 - Falha na validação dos dados.
"Mensagem de erro do MVC"

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

404 - Contrato informado não encontrado.
O contrato informado não foi encontrado na tabela BQC. Verifique se o número do contrato está correto e devidamente cadastrado no sistema.

406 - Formato de dados inválido.
Os dados enviados não estão no formato form-data. Verifique se o Content-Type da requisição está definido como multipart/form-data e se os campos foram corretamente estruturados.