Árvore de páginas

Versões comparadas

Chave

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


CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. beneficiaries Beneficiaries - Retorna os beneficiários cadastros na 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 - Retorna a multa contratual do beneficiário
    5. utilizationStatetmentUtilizationStatement/base64 - Retorna pdf do extrato de utilização do beneficiário em base64
    6. rescissionFine - Retorna a multa contratual do beneficiário
    7. ReadjustmentreadjustmentStatement/base64 - Retorna o pdf do extrato de reajuste do beneficiário em base64
    8. incomeTaxIncomeTax/base64 - Retorna o pdf da declaração de imposto de renda do beneficiário em base64
    9. financeStatetmentFinanceStatement/base64 - Retorna o pdf do extrato financeiro do beneficiário em base64
    10. annualStatementDischargeDebtsAnnualStatementDebts/base64 - Retorna o pdf da declaração anual de quitação de débitos do beneficiário
    11. BlockContracts - Realiza o bloqueio direto do beneficiário em base64/família
  3. Tela api beneficiaries
    1. Outras Ações / Ações relacionadas
  4. Tela api beneficiaries
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

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

...

Dica
titleAutenticaçã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.


02.

...

 EXEMPLO DE UTILIZAÇÃO

Âncora
beneficiaries
beneficiaries

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

Retorna os

Informações
titleNomenclatura 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

...

Painel
titleColorOrange
borderStylesolid
titlebeneficiaries - 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
titleParameters
health-insurer-code all-family login-usercompany-code contract-code contract-version-code (querysubcontract-code subcontract-version-code family-code social-name beneficiary-type
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
healthInsurerCode (query)stringCódigo da operadora (BA1_CODINT)*required
login-user (query)stringFiltro de beneficiários pelo usuário de login do portal (BSW_LOGUSR)
allFamily (query)string

Define se será retornado todos os beneficiários do login, quando utilizado o query param

loginUser, sendo:

  • 0 - Não
  • 1 - Sim

companyCode (query)stringFiltro de beneficiários por empresa (BA1_CODEMP)
contractcode (query)string

Filtro de beneficiários por contrato (BA1_CONEMP)


contractVersionCode (query)string

Filtro de beneficiários por versão do contrato (BA1_VERCON)


subcontractCode (query)string

Filtro de beneficiários por subcontrato (BA1_SUBCON)


subcontractVersioncode (query)string

Filtro de beneficiários por versão do subcontrato (BA1_VERSUB)


familycode (query)stringFiltro de beneficiários por código da família (BA1_MATRIC)
name (query)stringFiltro de beneficiários por nome
socialName (query)stringFiltro de beneficiários por nome social
beneficiaryType (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

subscriberId (query)string

Filtro de beneficiários pela carteirinha (BA1_CODINT+BA1_CODEMP+BA1_TIPREG+BA1_DIGITO)


subscriberIdOrCpfstring

Filtro de beneficiários pela carteirinha ou cpf


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-codehasNext": "1008"true,
            "contract-code": "000000000001",
            "contract-version-code": "001",
            "subcontract-code": "000000003"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   "subcontract-version-code": "001foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details  "family-code": "000003para mais detalhes.",
    "details": [
       "subscriber-id": "00011008000003013", {
            "namecode": "PAULO AZEVEDOE001-406",
            "social-namemessage": "Chave health-insurer-code obrigatória",
            "birth-datedetailedMessage": "1980-10-13",
            "effective-date": "2021-04-05",Não foi informado no queryParams da requisição a chave health-insurer-code."
            "beneficiary-type": "T",}
    ]
}


Âncora
supplementaryHealth
supplementaryHealth

Painel
titleColorOrange
borderStylesolid
titleSupplementaryHealth - Retorna os dados pessoais

Retorna os dados 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."
}


Âncora
eligibility
eligibility

Painel
titleColorOrange
borderStylesolid
titleEligibility - Retorna a elegibilidade do beneficiário

Retorna a elegibilidade do beneficiário

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

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
subscriberIdstringMatrícula do beneficiárioBA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO*required
oldSubscriberIdstringMatrícula antiga do beneficiárioBA1_MATANT
namestringNome do BeneficiárioBA1_NOMUSR*required
socialNamestring

Nome social do beneficiário

BA1_NOMSOC
interChangestring

Intercambio



originHealthInsurerCodestringOperadora OrigemBA1_OPEORI*required
healthPlanstringProdutoBA1_CODPLA*required

cardValidity

string(date)Validade do cartãoBA1_DTVLCR

nationalHealthCard

stringCartão nacional de saúdeBA1_NRCRNA*required

cardCopy

string

Via do cartão

BA1_VIACAR*required

coverage

stringAbrangência
*required

holder

stringTitular
*required

company

stringEmpresaBA1_CODEMP*required

blockDate

string (date)Data de bloqueioBA1_DATBLO

ansHealthInsurerCode

string

Reg. Operadora ANS


*required

eligible

string

Elegível


*required

negativeReasonCode

stringCod. motivo negativa

negativeReasonDescription

stringDesc. motivo negativa

Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
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": "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."
}


Âncora
rescissionFine
rescissionFine

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

Retorna os dados de rescisão de contrato do beneficiário

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

Âncora
utilizationStatement/base64
utilizationStatement/base64

Painel
titleColorOrange
borderStylesolid
titleUtilizationStatement/base64 - Retorna o pdf do extrato de utilização do beneficiário

Retorna o pdf do Extrato de Utilização do beneficiário informado em base 64.

/totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/utilizationStatement/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
dateOf (query)DateDe Ano /Mês/Dia de referência da declaração

*required

Se o semester não for informado

untilDate (query)DateAté Ano /Mês/Dia de referência da declaração

*required

Se o semester não for informado

semester (query)string

Busca pelo semestre do ano informado.

Deve ser informado o seguinte formado S/YYYY. onde S pode ser 1 (primeiro semestre) e 2 (segundo semestre) e YYYY corresponde ao ano. Exemplo: 2/2023


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": "plsr022_20230616_183833.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 date-of não informado",
            "detailedMessage": "Não foi informado o campo date-of."
        },
        {
            "code": "E001A-406",
            "message": "Campo until-date não informado",
            "detailedMessage": "Não foi informado o campo unilt-date."
        }
    ]
}
Aviso
Expandir
title(400) - Extrato não disponível
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": "Extrato não disponível",
    "detailedMessage": "Não foi possível realizar a impressão do Extrato de Utilização. Verificar o período informado."
}
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": "Usuá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(400) - Período informado não permitido
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": "E004",
    "message": "Período informado não permitido.",
    "detailedMessage": "Período permitido somente para o mesmo ano. EX: dE 01/01/2023 A 31/12/2023."
}
Aviso
Expandir
title(400) - Intervalo de dias não permitido
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": "Intervalo de dias não permitido.",
    "detailedMessage": "Permitido somente intervalo de no máximo 180 dia(s)."
}

Âncora
readjustmentStatement/base64
readjustmentStatement/base64

Painel
titleColorOrange
borderStylesolid
titleReadjustment/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}/readjustment/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."
}


Âncora
incomeTax/base64
incomeTax/base64

Painel
titleColorOrange
borderStylesolid
titleIncomeTax/base64 - Retorna o pdf do imposto de renda do beneficiário

Retorna o pdf do imposto de renda do beneficiário informado em base 64.

/totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/incomeTax/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": "plsr99720230620174340.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(400) - Demonstrativo não disponível
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": "Demonstrativo não disponível.",
    "detailedMessage": "Não encontrado imposto de renda referente ano informado."
}
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": "Usuário não encontrado",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}


Âncora
financeStatement/base64
financeStatement/base64

Painel
titleColorOrange
borderStylesolid
titleFinanceStatement/base64 - Retorna o pdf do extrato financeiro do beneficiário

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

/totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/financeStatement/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
dateOf (query)stringDe Ano/ Mês/Dia de referência do extrato*required
untilDate (query)stringAté Ano/ Mês/Dia de referência do extrato*required
expenseDate (query)stringTipo de lançamento*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": "extfinancsc957850.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 dateOf não informado",
            "detailedMessage": "Não foi informado o campo dateOf."
        },
        {
            "code": "E001A-406",
            "message": "Campo untilDate não informado",
            "detailedMessage": "Não foi informado o campo untilDate."
        },
        {
            "code": "E001A-406",
            "message": "Campo expenseType não informado",
            "detailedMessage": "Não foi informado o campo expenseType."
        }
    ]
}
Aviso
Expandir
title(400) - Extrato não disponível
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": "Extrato não disponível.",
    "detailedMessage": "Não foi possível realizar a impressão do Extrato Financeiro. Verificar o período informado e tipo de despesa."
}
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) - Tipo de lançamento 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": "E004",
    "message": "Tipo de lançamento não encontrado",
    "detailedMessage": "Não foi possível retornar os dados do lançamento através do código informado."
}

Âncora
annualStatementDischargeDebts/base64
annualStatementDischargeDebts/base64

Painel
titleColorOrange
borderStylesolid
titleAnnualStatementDebts/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": ""
}


Âncora
blockContracts
blockContracts

Painel
titleColorOrange
borderStylesolid
titleBlockContracts - Realiza o Bloqueio direto do Beneficiário/família

Realiza o bloqueio do contrato do beneficiário ou da família

/totvsHealthPlans/familyContract/v1/beneficiaries/blockContracts

POST

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 (body)stringMatricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)*required
dateBlock (body)string(date)Data do bloqueio ("21-09-2023")*required
reason (body)stringCódigo do motivo de bloqueio*required
observation (body)stringObservação sobre o bloqueio
deathCodeSIP (body)stringCódigo do óbito SIP
dateRequested (body)string(date)Data da requisição do bloqueio ("12-09-2023")
blockFamily (body)booleanCampo lógico sobre bloqueio da família
Dica
Expandir
titleRequest

Body


{
    "subscriberId": "00011078000002018",
    "dateBlock": "2023-09-12",
    "reason": "001",
    "observation": "Bloqueio por pedido do Titular",
    "deathCodeSIP": "1.32",
    "dateRequested": "2023-09-12",
    "blockFamily": "false"
}

Dica
Expandir
title(200) - Operação realizada com sucesso
beneficiariesarrayBeneficiários
*required
subscriberIdstringMatricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)
*required
namestringNome do beneficiário
*required
datestring(date)Data do bloqueio
*required
reasonstringCódigo do motivo de bloqueio
*required
reasonDescriptionstringDescrição do motivo de bloqueio
*required
observationarrayObservação sobre o bloqueio
*required
blockInvoicingstringBloqueia Faturamento (1=Sim, 0=Nao)
*required
dateRequestedstring(date)Data de requisição do bloqueio
*required
dateEntrystring(date)Data de lançamento do bloqueio
*required
hourRequestedstringHora do lançamento do bloqueio
*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "beneficiaries": [
        {
            "subscriberId": "00011078000002034",
            "name": "ISABELLA YASMIN MELO",
            "date": "20230920",
            "reason": "001",
            "reasonDescription": "FIM DA RELACAO BENEF X TITULAR",
            "observation": "Bloqueio por pedido do Titular",
            "blockInvoicing": "1        "situation": "1",
            "block-date": "",
            "beneficiary-cpf": "55555555555"
        },
        {
            "company-code": "1008",
            "contract-codedateRequested": "00000000000120230912",
            "contract-version-codedateEntry": "00120230922",
            "subcontract-codehourRequested": "000000003",
            "subcontract-version-code": "001",
            "family-code": "000004",
            "subscriber-id": "00011008000004010",
            "name": "ANDRE",
            "social-name": "",
            "birth-date": "1985-01-1715:16:13"
        }
    ]
}
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": [
     "effective-date": "2021-04-27",   {
            "beneficiary-typecode": "TE001B-406",
            "situationmessage": "1Campo subscriberId obrigatório",
            "block-datedetailedMessage": "",
     Não foi informado valor do campo subscriberId."
       "beneficiary-cpf": "53017895890" },
        }{
        ],
    "hasNextcode": true"E001E-406",
     "remainingRecords": 37
}
Aviso
       "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",
    
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 possível retornar informadoos nodados queryParamsdo dabeneficiário requisiçãoatravés ada chave health-insurer-code."
        }
    ]matrícula informada."
}

03. TELA API BENEFICIARIES

Outras Ações / Ações relacionadas

AçãoDescrição
Não se aplicaNão se aplica

04. TELA BENEFICIARIES

Principais Campos e Parâmetros

CampoDescrição
BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITOMatricula 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)

...