Histórico da Página

...

Informações
Pode-se enviar o arquivo CSV dos beneficiários via file (form-data) ou fileBase64 (body) com o fileName.

Bloco de código

language	c#
theme	Midnight
title	Exemplo de Body
collapse	true

{
  "healthInsurerCode": "0001",
  "companyCode": "1017",
  "contractCode": "000000000001",
  "contractVersion": "001",
  "subcontractCode": "000000001",
  "subcontractVersion": "001",
  "loginUser": "TOTVS",
  "fileBase64": "QjJOX0NPRFNFUTtCMk5fQ1BGVVNSO0IyTl9OT01VU1I7QjJOX0RBVE5BUztCMk5...",
  "fileName": "modelo-importacao-beneficiarios.csv"
}

04. RESPOSTA

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.

Aviso
400 - Erro ao processar o arquivo CSV.

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 - Parâmetro obrigatório não informado.

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 4

Nova versão 5

Chave

04. RESPOSTA

201 - Operação realizada com sucesso

404 - Contrato informado não encontrado.

400 - Erro ao processar o arquivo CSV.

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 - Parâmetro obrigatório não informado.