Histórico da Página

...

Dica

title	Autenticaçã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.

Informações

title	Nomenclatura das APIs

Para nome composto, as APIs utilizam o padrão camelCase e quando a houver paginação será utilizado o padrão tudo minúsculo separado por hífen para os campos dentro do array items

02. EXEMPLO DE UTILIZAÇÃO

...

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

health-insurer-code all-family login-usercompany-code contract-code contract-version-code subcontract-code subcontract-version-code family-code social-name beneficiary-type page

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)	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)
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)	string	Filtro 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)	string	Filtro de beneficiários por código da família (BA1_MATRIC)
name (query)	string	Filtro de beneficiários por nome
socialName (query)	string	Filtro 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
Valor numérico (maior que zero) representando a página solicitada
Filtro de beneficiários pela carteirinha (BA1_CODINT+BA1_CODEMP+BA1_TIPREG+BA1_DIGITO)
subscriberIdOrCpf	string	Filtro de beneficiários pela carteirinha ou cpf
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (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_CPFUSR

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [

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": "000000003000000001",
            "subcontract-_version-_code": "001",
            "family-_code": "000003000001",
            "subscriber-_id": "0001100800000301300011008000001010",
            "name": "PAULOCLODOALDO AZEVEDOSILVA",
            "social-_name": "",
            "birth-_date": "19801970-10-1310",
            "effective-_date": "2021-0402-0512",
            "beneficiary-_type": "T",
            "situation": "1",
            "block-_date": "",
            "beneficiary-_cpf": "5555555555551351540009"
        },
        {
            "company-_code": "1008",
            "contract-_code": "000000000001",
            "contract-_version-_code": "001",
            "subcontract-_code": "000000003000000002",
            "subcontract-_version-_code": "001",
            "family-_code": "000004000002",
            "subscriber-_id": "0001100800000401000011008000002017",
            "name": "ANDREFABIANA SOPHIA MELO",
            "social-_name": "",
            "birth-_date": "19851986-0112-1712",
            "effective-_date": "2021-0403-2708",
            "beneficiary-_type": "T",
            "situation": "1",
            "block-_date": "",
            "beneficiary-_cpf": "5301789589077476519965"
        }
    ],
    "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."
        }
    ]
}

...

Painel

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

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

date-of

dateOf (query)

Date

De Ano /Mês/Dia de referência da declaração

*required

until-date

Se o semester não for informado

untilDate (query)

Date

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

title	Request

Body

Não possui body!

Dica

Expandir

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

fileName	string	Nome do arquivo em PDF		*required
file	string	String do arquivo em base 64		*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "fileName": "plsr022_20230616_183833.pdf",
	"file" : "JVBERi0xLjMKJbe+raoKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9L..."
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001B-406",
            "message": "Campo subscriberId obrigatório",
            "detailedMessage": "Não foi informado valor do campo subscriberId."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo subscriberId",
            "detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
        }
    ]
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

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

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

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

Aviso

Expandir

title	(400) - Período informado não permitido

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

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E005",
    "message": "Intervalo de dias não permitido.",
    "detailedMessage": "Permitido somente intervalo de no máximo 180 dia(s)."
}

...

Árvore de páginas

Versões comparadas

Versão antiga 31

Nova versão Atual

Chave

02. EXEMPLO DE UTILIZAÇÃO