CONTEÚDO
- Visão Geral
- Exemplo de utilização
- beneficiaries - Retorna os beneficiários da operadora de saúde
- supplementaryHealth - Retorna os dados de saúde suplementar do beneficiário
- eligibility - Retorna a elegibilidade do beneficiário
- rescissionFine - Retorna a multa contratual do beneficiário
- utilizationStatetment/base64 - Retorna pdf do extrato de utilização do beneficiário
- readjustmentStatement/base64 - Retorna o pdf do extrato de reajuste do beneficiário
- incomeTax/base64 - Retorna o pdf da declaração de imposto de renda do beneficiário
- financeStatetment/base64 - Retorna o pdf do extrato financeiro do beneficiário
- annualStatementDebts/base64 - Retorna o pdf da declaração anual de quitação de débitos do beneficiário
- Tela api beneficiaries
- Outras Ações / Ações relacionadas
- Tela api beneficiaries
- 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.
...
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 | annualStatementDischargeDebts/base64 - Retorna o pdf da declaração anual de quitação de débitos do beneficiário |
---|
|
Retorna o pdf da declaração anual de quitação de débitos do beneficiário informado em base 64. /totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/annualStatementDischargeDebts/base64 | |
Nota |
---|
Expandir |
---|
| Authorization (header) | | Cabeçalho usado para autorização das requisições (Bearer token) | *required | Content-Type (header) | | 'application/json' é o formato do conteúdo | *required | subscriberId (path) | string | Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO) | *required | year (query) | string | Ano de referência da declaração | *required |
|
|
Dica |
---|
Expandir |
---|
| Body
Não possui body! |
|
Dica |
---|
Expandir |
---|
title | (200) - Operação realizada com sucesso |
---|
| fileName | string | Nome do arquivo em PDF |
| *required | file | string | String do arquivo em base 64 |
| *required |
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"fileName": "quitacao_13_6_2023_15_09_52.pdf",
"file" : "JVBERi0xLjMKJbe+raoKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9L..."
} |
|
|
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": "Os campos do json no body estão inválidos",
"detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
"details": [
{
"code": "E001B-406",
"message": "Campo subscriberId obrigatório",
"detailedMessage": "Não foi informado valor do campo subscriberId."
},
{
"code": "E001E-406",
"message": "Tamanho inválido para o campo subscriberId",
"detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
}
]
} |
|
|
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": "E002",
"message": "Os campos do json no body estão inválidos",
"detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
"details": [
{
"code": "E002A-406",
"message": "Campo year não informado",
"detailedMessage": "Não foi informado o campo year."
}
]
} |
|
|
Aviso |
---|
Expandir |
---|
title | (404) - Beneficiário não encontrado |
---|
| 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. |
|
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"code": "E003",
"message": "Beneficiário não encontrado",
"detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
} |
|
|
Aviso |
---|
Expandir |
---|
title | (404) - Declaração não encontrada |
---|
| 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. |
|
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"code": "E005",
"message": "Não encontrado Declaração referente ao ano informado.",
"detailedMessage": ""
} |
|
|
|
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 |
---|
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)
...