Á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 - Retorna os beneficiários da operadora de saúde
    2. SupplementaryHealth - Retorna os dados de saúde suplementar do beneficiário
    3. Eligibility - Retorna a elegibilidade do beneficiário
    4. RescissionFine - Retorna a multa contratual do beneficiário
    5. UtilizationStatement/base64 - Retorna pdf do extrato de utilização do beneficiário
    6. ReadjustmentStatementReadjustment/base64 - Retorna o pdf do extrato de reajuste do beneficiário
    7. IncomeTax/base64 - Retorna o pdf da declaração de imposto de renda do beneficiário
    8. FinanceStatement/base64 - Retorna o pdf do extrato financeiro do beneficiário
    9. AnnualStatementDebts/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
titleSupplementaryHealth - Retorna os dados pessoais

Retorna os dados pessoais de saúde suplementar do beneficiário

/totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/supplementaryHealth

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
Dica
Expandir
titleRequest

Body


Não possui body!

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

name

stringNome do beneficiárioBA1_NOMUSR*required

subscriberId

stringMatrícula do beneficiárioBA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO*required

birthdate

string(date)Data de nascimento
*required

nationalHealthCard

string

Cartão nacional de saúde


*required

registrationPlanAns

string

Cod. plano na ANS


*required

assistSegmentationPlan

stringSegmentação Assistencial do Plano
*required

operatorRegistrationAns

stringCod. registro da operadora na ANS
*required

carrierContactInformation

stringInf. de contato com a Ope.
*required

ansContactInformation

stringInf. de contato ANS
*required

TemporaryPartialCoverageEndDate

string(date)

Dt. término da cobertura parcial temporária


*required

AccommodationStandard

stringPadrão de acomodação
*required

hiringType

stringTipo de contratação
*required

geographicCoverageArea

stringÁrea de abrangência geográfica
*required

productName

stringNome do produto
*required

carrierTradeName

string

Nome fantasia da operadora


*required

benefitAdministratorTradeName

string

Nome fantasia da administradora de benefícios


*required

nameLegalEntityContractingCollectivePlan

stringNome pessoa jurídica contratante do plano coletivo
*required

effectiveDatePlan

string(date)Dt. início da vigência do plano
*required

contractPolicyNumber

stringNúmero contrato/apólice
*required

dateContractingHealthPlan

stringDt. contratação do plano de saúde
*required

maximumPeriodProvidedContractGracePeriod

stringPrazo máximo previsto no contrato de carência
*required

planInformation

stringInformações do plano
*required

information

stringInformações
*required

timeOutpatientProcedures

stringCarência procedimentos ambulatoriais

waitingHospitalProcedures

stringCarência procedimentos hospitalares

termDeliveryProcedures

stringCarência procedimentos parto a termo

deficiencyDentalProcedures

stringCarência procedimentos odontológicos

socialName

stringNome social

Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "name": "SHELDON COOPER",
    "subscriberId": "00011077000001013",
    "birthdate": "1990-05-01",
    "nationalHealthCard": "169217132120001",
    "registrationPlanAns": "123456",
    "assistSegmentationPlan": "AMBULATORIAL + HOSPITALAR COM OBSTETRICIA",
    "operatorRegistrationAns": "417505",
    "carrierContactInformation": "<strong>Endereço:</strong> Av. , nº  - Bairro  - São Paulo-SP -CEP: 00000-000 <br><strong>Disque: </strong>0800 000 0000<br><strong>Site: </strong>www.operadora.org.br",
    "ansContactInformation": "<strong>Endereço:</strong> Av. Bela Cintra, nº 986 - 9º andar - Edifício Rachid Saliba - Bairro Jardim Paulista -São Paulo-São Paulo-CEP: 01415-000 <br><strong>Disque ANS: </strong>0800 701 9656<br><strong>Site: </strong>www.ans.gov.br",
    "TemporaryPartialCoverageEndDate": "",
    "AccommodationStandard": "APARTAMENTO SIMPLES",
    "hiringType": "COLETIVO EMPRESARIAL",
    "geographicCoverageArea": "NACIONAL",
    "productName": "REDE CREDENCIADA",
    "carrierTradeName": "OPERADORA 417505",
    "benefitAdministratorTradeName": "GCG PJ",
    "nameLegalEntityContractingCollectivePlan": "CLIENTE PADRAO",
    "effectiveDatePlan": "2022-02-01",
    "contractPolicyNumber": "123456",
    "dateContractingHealthPlan": "2022-02-01",
    "maximumPeriodProvidedContractGracePeriod": "",
    "planInformation": "Plano Regulamentado",
    "information": "Informações",
    "timeOutpatientProcedures": "",
    "waitingHospitalProcedures": "",
    "termDeliveryProcedures": "",
    "deficiencyDentalProcedures": "",
    "socialName": ""
}
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 subscriberId obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave  subscriberId."
        }
    ]
}
Aviso
Expandir
title(404) - Usuá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": "Usuário não encontrado.",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}

...

Painel
titleColorOrange
borderStylesolid
titleRescissionFine - Retorna os dados da rescisão do beneficiário

Retorna os dados de rescisão de contrato do beneficiário informado em base 64.

/totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/rescissionFine

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
allFamily (query)stringRescisão de toda família ( 1- Sim)
Dica
Expandir
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
productstringCod. produto
*required
productDescriptionstringDesc. produto
*required
inclusionDatestring(date)Data de inclusão
*required
fidelityMonthsstringMeses de fidelidade
*required
fidelityFinalDatestring(date)Data final da fidelidade
*required
totalAmountFinestringValor total da multa
*required
beneficiariesarrayBeneficiários
*required
subscriberIdstringMatricula do beneficiário
*required
namestringNome do beneficiário
*required
amountFinestringValor multa
*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "product": "0001",
    "productDescription": "PRODUTO EXEMPLO 1",
    "inclusionDate": "2023-04-18",
    "fidelityMonths": 12,
    "fidelityFinalDate": "2024-04-18",
    "totalAmountFine": 363,
    "beneficiaries": [
        {
            "subscriberId": "00011078000002018",
            "name": "FABIO ANDERSON",
            "amountFine": 363
        }
    ]
}
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(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": "E002",
    "message": "Usuário não encontrado",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}

...

Painel
titleColorOrange
borderStylesolid
titleReadjustmentStatementReadjustment/base64 - Retorna o pdf do extrato de reajuste do beneficiário

Retorna o pdf do extrato de reajuste do beneficiário informado em base 64.

/totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/readjustmentStatementreadjustment/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)DateAno de referência*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": "extreajsc954870.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": "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": "E001A-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": "E001",
    "message": "Beneficiário não encontrado.",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}

...