Histórico da Página

...

Visão Geral
Exemplo de utilização
incomeTax/base64 - Retorna o pdf da declaração de imposto de renda do beneficiário em base64
1. financeStatetment/base64 - Retorna o pdf do extrato financeiro do beneficiário em base64
2. annualStatementDischargeDebts/base64 - Retorna o pdf da declaração anual de quitação de débitos do beneficiário em base64
Tela api beneficiaries
1. Outras Ações / Ações relacionadas
Tela api beneficiaries
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

API para a entidade beneficiaries (Beneficiários) do produto TOTVS Saúde Planos Linha Protheus.

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

Dica

title	Autenticação das APIs

API para obtenção do token de acesso às API’s REST no Protheus

De posse então do access_token obtido na api token, basta fazer a requisição à API desejada incluindo no cabeçalho o parâmetro Authorization com o valor Bearer mais o token de acesso.

Informações

title	Nomenclatura das APIs

Para nome composto, as APIs utilizam o padrão camelCase e quando a houver paginação será utilizado o padrão tudo minúsculo separado por hífen para os campos dentro do array items

02. EXEMPLO DE UTILIZAÇÃO

Âncora

	beneficiaries
	beneficiaries

Painel

titleColor	Orange
borderStyle	solid
title	beneficiaries - Retorna os beneficiários cadastros na operadora de saúde

Retorna os beneficiários cadastrados na operadora de saúde.

/totvsHealthPlans/familyContract/v1/beneficiaries

GET

Nota

Expandir

title	Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
health-insurer-code (query)	string	Código da operadora (BA1_CODINT)	*required
login-user (query)	string	Filtro de beneficiários pelo usuário de login do portal (BSW_LOGUSR)
all-family (query)	string	Define se será retornado todos os beneficiários do login, quando utilizado o query param login-user, sendo: 0 - Não 1 - Sim
company-code (query)	string	Filtro de beneficiários por empresa (BA1_CODEMP)
contract-code (query)	string	Filtro de beneficiários por contrato (BA1_CONEMP)
contract-version-code (query)	string	Filtro de beneficiários por versão do contrato (BA1_VERCON)
subcontract-code (query)	string	Filtro de beneficiários por subcontrato (BA1_SUBCON)
subcontract-version-code (query)	string	Filtro de beneficiários por versão do subcontrato (BA1_VERSUB)
family-code (query)	string	Filtro de beneficiários por código da família (BA1_MATRIC)
name (query)	string	Filtro de beneficiários por nome
social-name (query)	string	Filtro de beneficiários por nome social
beneficiary-type (query)	string	Filtro de beneficiários por tipo (BA1_TIPUSU), sendo: T - Titular D - Dependente A - Agregado
situation (query)	string	Filtro de beneficiários por situação, sendo: 1 - Ativo 2 - Inclusão futura 3 - Bloqueio futuro 4 - Bloqueado
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizada com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de beneficiários retornados
items.company-code	string	Código da empresa do beneficiário	BA1_CODEMP	*required
items.contract-code	string	Código do contrato (Pessoa jurídica)	BA1_CONEMP
items.contract-version-code	string	Versão do contrato (Pessoa jurídica)	BA1_VERCON
items.subcontract-code	string	Código do subcontrato (Pessoa jurídica)	BA1_SUBCON
items.subcontract-version-code	string	Versão do subcontrato (Pessoa jurídica)	BA1_VERSUB
items.family-code	string	Código da família do beneficiário	BA1_MATRIC	*required
items.subscriber-id	string	Matricula do beneficiário	BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO	*required
items.name	string	Nome do beneficiário	BA1_NOMUSR	*required
items.social-name	string	Nome social do beneficiário	BA1_NOMSOC
items.birth-date	string (date)	Data de nascimento do beneficiário	BA1_DATNAS	*required
items.effective-date	string (date)	Data de inclusão do beneficiário	BA1_DATINC	*required
items.beneficiary-type	string	Tipo do beneficiário, sendo: T - Titular D - Dependente A - Agregado	BA1_TIPUSU	*required
items.situation	string	Situação do beneficiário, sendo: 1 - Ativo 2 - Inclusão futura 3 - Bloqueio futuro 4 - Bloqueado	BA1_DATINC e BA1_DATBLO	*required
items.block-date	string (date)	Data de bloqueio do beneficiário	BA1_DATBLO
items.beneficiary-cpf	string	Numero do CPF do beneficiário	BA1_CPFUSR

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "company-code": "1008",
            "contract-code": "000000000001",
            "contract-version-code": "001",
            "subcontract-code": "000000001",
            "subcontract-version-code": "001",
            "family-code": "000001",
            "subscriber-id": "00011008000001010",
            "name": "CLODOALDO SILVA",
            "social-name": "",
            "birth-date": "1970-10-10",
            "effective-date": "2021-02-12",
            "beneficiary-type": "T",
            "situation": "1",
            "block-date": "",
            "beneficiary-cpf": "51351540009"
        },
        {
            "company-code": "1008",
            "contract-code": "000000000001",
            "contract-version-code": "001",
            "subcontract-code": "000000002",
            "subcontract-version-code": "001",
            "family-code": "000002",
            "subscriber-id": "00011008000002017",
            "name": "FABIANA SOPHIA MELO",
            "social-name": "",
            "birth-date": "1986-12-12",
            "effective-date": "2021-03

...

-08",
            "beneficiary-type": "T",
            "situation": "1",
            "block-date": "",
            "beneficiary-cpf": "77476519965"
        },
        {
            "company-code": "1008",
            "contract-code": "000000000001",
            "contract-version-code": "001",
            "subcontract-code": "000000003",
            "subcontract-version-code": "001",
            "family-code": "000003",
            "subscriber-id": "00011008000003013",
            "name": "PAULO AZEVEDO",
            "social-name": "",
            "birth-date": "1980-10-13",
            "effective-date": "2021-04-05",
            "beneficiary-type": "T",
            "situation": "1",
            "block-date": "",
            "beneficiary-cpf": "55555555555"
        },
        {
            "company-code": "1008",
            "contract-code": "000000000001",
            "contract-version-code": "001",
            "subcontract-code": "000000003",
            "subcontract-version-code": "001",
            "family-code": "000004",
            "subscriber-id": "00011008000004010",
            "name": "ANDRE",
            "social-name": "",
            "birth-date": "1985-01-17",
            "effective-date": "2021-04-27",
            "beneficiary-type": "T",
            "situation": "1",
            "block-date": "",
            "beneficiary-cpf": "53017895890"
        }
    ],
    "hasNext": true,
    "remainingRecords": 37
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave health-insurer-code obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave health-insurer-code."
        }
    ]
}

03. TELA API BENEFICIARIES

Outras Ações / Ações relacionadas

Ação	Descrição
Não se aplica	Não se aplica

04. TELA

...

BENEFICIARIES

Principais Campos e Parâmetros

Campo	Descrição

Card documentos

Informacao	Use esse box para destacar informações relevantes e/ou de destaque.
Titulo	IMPORTANTE!

BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO

Matricula do beneficiário no sistema

05. TABELAS UTILIZADAS

Beneficiários (BA1)
Usuário Portal x Empresa (B40)
Usuário Portal x Beneficiário (B49)
Formas de Bloqueios Famílias (BG1)
Formas de Bloqueios da Família (BG3)
Usuários do Portal (BSW)

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

03. TELA API BENEFICIARIES

04. TELA

BENEFICIARIES

05. TABELAS UTILIZADAS