API Lotes de Importação - Consultar Beneficiários de um Lote de Importação - Versão 1.0

CONTEÚDO

Introdução
Endpoint
Parâmetros
Resposta

01. INTRODUÇÃO

Esta API retorna a lista de beneficiários associados a um lote de importação específico. A consulta traz informações detalhadas dos beneficiários, incluindo CPF, nome, grau de parentesco, protocolo e observações de críticas quando existentes.

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

02. ENDPOINT

GET /totvsHealthPlans/familyContract/v1/beneficiaries/importBatches/{batchCode}/beneficiaries

03. PARÂMETROS

Nome	Tipo	Localização	Descrição
Content-Type	string	header	multipart/form-data ou application/json (dependendo 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>. REQUIRED
batchCode	string	path	Código identificador do lote de importação. REQUIRED
status	string	query	Filtra beneficiários pelo status da importação.
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	BOOLEAN	Indica se ainda existem registros a serem retornados
remainingRecords	INTEGER	Quantidade de registros ainda existentes para retorno
items	ARRAY	Lista de beneficiários do lote de importação.

Estrutura do objeto items
Campo	Tipo	Descrição	Campo (Protheus)
familyId	STRING	Código da família no lote	BJ6_CODFAM
cpf	STRING	CPF do beneficiário	BJ6_CPFBEN
name	STRING	Nome do beneficiário	BJ6_NOMBEN
kinship	STRING	Grau de parentesco	BJ6_GRAUPA
status	STRING	Status da importação	BJ6_STATUS
protocol	STRING	Número do protocolo gerado na análise	BJ6_PROTOC
protocolStatus	STRING	Status do protocolo na análise	BBA_STATUS
observation	STRING	Observações e críticas do beneficiário	BJ6_OBSBEN

Exemplo

{
    "items": [
        {
            "familyId": "000001",
            "cpf": "30870587501",
            "name": "RYAN LORENZO CAMPOS",
            "kinship": "TITULAR",
            "status": "3",
            "protocol": "88888820250806102191",
            "protocolStatus": "7",
            "observation": ""
        },
        {
            "familyId": "000001",
            "cpf": "77561672950",
            "name": "CAUÊ ERICK ASSUNÇÃO",
            "kinship": "SOGRO",
            "status": "3",
            "protocol": "88888820250806102191",
            "protocolStatus": "7",
            "observation": ""
        }
    ],
    "hasNext": false,
    "remainingRecords": 0,
    "total": 2
}

Exemplo JSON de Resposta (sem registros)

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

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

404 - O lote informado não foi encontrado. Verifique o código e tente novamente.
Lote de beneficiários com o código informado não localizado na tabela BJ5 (campo BJ5_CODLOT) durante o processo de importação.

Campo	Tipo	Descrição
code	INTEGER	Código identificador do erro.
message	STRING	Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage	STRING	Mensagem técnica e mais detalhada do erro.

Exemplo JSON de Erro

{
  "status": 404,
  "message": "O lote informado não foi encontrado. Verifique o código e tente novamente.",
  "detailedMessage": "Lote de beneficiários com o código informado não localizado na tabela BJ5 (campo BJ5_CODLOT) durante o processo de importação."
}

Árvore de páginas