Exibir origem

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

/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>.
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		Indica se ainda existem registros a serem retornados
remainingRecords		Quantidade de registros ainda existentes para retorno
items		Lista de beneficiários do lote de importação.

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

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

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.

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

Campo	Tipo	Descrição
code		Código identificador do erro.
message		Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage		Mensagem técnica e mais detalhada do 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."
}