Histórico da Página

...

Painel

titleColor	Orange
borderStyle	solid
title	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

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."
        }
    ]
}

Âncora

	supplementaryHealth
	supplementaryHealth

Painel

titleColor	Orange
borderStyle	solid
title	supplementaryHealth - Retorna os dados pessoais

Retorna os dados pessoais do beneficiário

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

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
subscriberId (Path)	string	Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)	*required

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

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

name	string	Nome do beneficiário	BA1_NOMUSR	*required
subscriberId	string	Matrícula do beneficiário	BA1_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	string	Segmentação Assistencial do Plano		*required
operatorRegistrationAns	string	Cod. registro da operadora na ANS		*required
carrierContactInformation	string	Inf. de contato com a Ope.		*required
ansContactInformation	string	Inf. de contato ANS		*required
TemporaryPartialCoverageEndDate	string(date)	Dt. término da cobertura parcial temporária		*required
AccommodationStandard	string	Padrão de acomodação		*required
hiringType	string	Tipo de contratação		*required
geographicCoverageArea	string	Área de abrangência geográfica		*required
productName	string	Nome do produto		*required
carrierTradeName	string	Nome fantasia da operadora		*required
benefitAdministratorTradeName	string	Nome fantasia da administradora de benefícios		*required
nameLegalEntityContractingCollectivePlan	string	Nome pessoa jurídica contratante do plano coletivo		*required
effectiveDatePlan	string(date)	Dt. início da vigência do plano		*required
contractPolicyNumber	string	Número contrato/apólice		*required
dateContractingHealthPlan	string	Dt. contratação do plano de saúde		*required
maximumPeriodProvidedContractGracePeriod	string	Prazo máximo previsto no contrato de carência		*required
planInformation	string	Informações do plano		*required
information	string	Informações		*required
timeOutpatientProcedures	string	Carência procedimentos ambulatoriais
waitingHospitalProcedures	string	Carência procedimentos hospitalares
termDeliveryProcedures	string	Carência procedimentos parto a termo
deficiencyDentalProcedures	string	Carência procedimentos odontológicos
socialName	string	Nome social

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

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

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 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

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": "Usuário não encontrado.",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}

Âncora

	eligibility
	eligibility

Painel

titleColor	Orange
borderStyle	solid
title	Eligibility - Retorna a elegibilidade do beneficiário

Retorna a elegibilidade do beneficiário

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

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
subscriberId (Path)	string	Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)	*required

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

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

subscriberId	string	Matrícula do beneficiário	BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO	*required
oldSubscriberId	string	Matrícula antiga do beneficiário	BA1_MATANT
name	arraystring	Nome do Beneficiário	BA1_NOMUSR	*required
socialName	string	Nome social do beneficiário	BA1_NOMSOC
interChange	string	Intercambio
originHealthInsurerCode	string	Operadora Origem	BA1_OPEORI	*required
healthPlan	string	Produto	BA1_CODPLA	*required
cardValidity	string(date)	Validade do cartão	BA1_DTVLCR
nationalHealthCard	string	Cartão nacional de saúde	BA1_NRCRNA	*required
cardCopy	string	Via do cartão	BA1_VIACAR	*required
coverage	string	Abrangência		*required
holder	string	Titular		*required
company	string	Empresa	BA1_CODEMP	*required
blockDate	string (date)	Data de bloqueio	BA1_DATBLO
ansHealthInsurerCode	string	Reg. Operadora ANS		*required
eligible	string	Elegível		*required
negativeReasonCode	string	Cod. motivo negativa
negativeReasonDescription	string	Desc. motivo negativa

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "subscriberId": "00011009000003020",
    "oldSubscriberId": "131664697",
    "name": "MARIO IGOR RAFAEL CARDOSO",
    "socialName": "",
    "interChange": "NAO",
    "originHealthInsurerCode": "0001",
    "healthPlan": "REDE CREDENCIADA",
    "cardValidity": "",
    "nationalHealthCard": "223868970650002",
    "cardCopy": "0",
    "coverage": "01",
    "holder": "BRYAN RENATO RAUL DA PAZ",
    "company": "EMPRESA PTU A100 XML",
    "blockDate": "2021-03-10",
    "ansHealthInsurerCode": "417505",
    "eligible": "NAO",
    "negativeReasonCode": "1016",
    "negativeReasonDescription": "BENEFICIARIO COM ATENDIMENTO SUSPENSO"
}

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 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

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": "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."
}

...

Árvore de páginas

Versões comparadas

Versão antiga 14

Nova versão 15

Chave