Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  1. Visão Geral
  2. Exemplo de utilização
    1. beneficiaries Beneficiaries - Retorna os beneficiários da operadora de saúde
    2. supplementaryHealth SupplementaryHealth - Retorna os dados de saúde suplementar do beneficiário
    3. eligibility Eligibility - Retorna a elegibilidade do beneficiário
    4. rescissionFine RescissionFine - Retorna a multa contratual do beneficiário
    5. utilizationStatementUtilizationStatement/base64 - Retorna pdf do extrato de utilização do beneficiário
    6. readjustmentStatementReadjustmentStatement/base64 - Retorna o pdf do extrato de reajuste do beneficiário
    7. incomeTaxIncomeTax/base64 - Retorna o pdf da declaração de imposto de renda do beneficiário
    8. financeStatementFinanceStatement/base64 - Retorna o pdf do extrato financeiro do beneficiário
    9. annualStatementDebtsAnnualStatementDebts/base64 - Retorna o pdf da declaração anual de quitação de débitos do beneficiário
  3. Tela api beneficiaries
    1. Outras Ações / Ações relacionadas
  4. Tela api beneficiaries
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas

...

Painel
titleColorOrange
borderStylesolid
titlebeneficiaries Beneficiaries - Retorna os beneficiários da operadora de saúde

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

/totvsHealthPlans/familyContract/v1/beneficiaries

GET

Nota
Expandir
titleParameters
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)stringCódigo da operadora (BA1_CODINT)*required
login-user (query)stringFiltro 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)stringFiltro 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)stringFiltro de beneficiários por código da família (BA1_MATRIC)
name (query)stringFiltro de beneficiários por nome
social-name (query)stringFiltro 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
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsnumeric (integer)Quantidade de registros ainda existem para retorno
*required
itemsarrayLista de beneficiários retornados

items.company-codestring

Código da empresa do beneficiário

BA1_CODEMP*required
items.contract-codestring

Código do contrato (Pessoa jurídica)

BA1_CONEMP
items.contract-version-codestringVersão do contrato (Pessoa jurídica)BA1_VERCON
items.subcontract-codestringCódigo do subcontrato (Pessoa jurídica)BA1_SUBCON
items.subcontract-version-codestringVersão do subcontrato (Pessoa jurídica)BA1_VERSUB
items.family-codestringCódigo da família do beneficiárioBA1_MATRIC*required
items.subscriber-idstring

Matricula do beneficiário

BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO*required
items.namestringNome do beneficiárioBA1_NOMUSR*required
items.social-namestringNome social do beneficiárioBA1_NOMSOC
items.birth-datestring (date)Data de nascimento do beneficiárioBA1_DATNAS*required
items.effective-datestring (date)Data de inclusão do beneficiárioBA1_DATINC*required
items.beneficiary-typestring

Tipo do beneficiário, sendo:

  • T - Titular
  • D - Dependente
  • A - Agregado
BA1_TIPUSU*required
items.situationstring

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-datestring (date)Data de bloqueio do beneficiárioBA1_DATBLO
items.beneficiary-cpfstringNumero do CPF do beneficiárioBA1_CPFUSR
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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."
        }
    ]
}

...

Painel
titleColorOrange
borderStylesolid
titleannualStatementDebtsAnnualStatementDebts/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}/annualStatementDebts/base64

GET

Nota
Expandir
titleParameters
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
subscriberId (path)stringMatricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)*required
year (query)stringAno de referência da declaração*required
Dica
Expandir
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
fileNamestringNome do arquivo em PDF
*required
filestringString do arquivo em base 64
*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "fileName": "quitacao_13_6_2023_15_09_52.pdf",
	"file" : "JVBERi0xLjMKJbe+raoKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9L..."
}
Aviso
Expandir
title(406) - Parâmetros obrigatórios
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E005",
    "message": "Não encontrado Declaração referente ao ano informado.",
    "detailedMessage": ""
}

...