Histórico da Página

CONTEÚDO

Visão Geral
Exemplo de utilização
Tela api companies
1. Outras Ações / Ações relacionadas
Tela api companies
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

API para a entidade companies (Empresas) do produto TOTVS Saúde Planos Linha Protheus.

...

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 ou tudo minúsculo separado por hífen para o query param e o json do body.

02. EXEMPLO DE UTILIZAÇÃO

Âncora

	companies
	companies

Painel

titleColor	Orange
borderStyle	solid
title	Companies - Retorna o cadastro de empresas

Retorna as empresas cadastradas da operadora informada.

/totvsHealthPlans/familyContract/v1/companies

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 healthInsurerCode (query)	string	Código da operadora no sistema (BG9_CODINT)	*required
login-user loginUser (query)	string	Filtro de empresas pelo usuário de login do portal (BSW_LOGUSR)
group-type groupType (query)	string	Filtro de empresas pelo tipo de grupo (BG9_TIPO): 1=Pessoa Física e 2=Pessoa Jurídica
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	integer	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de empresas retornadas
items.company-_code	string	Código	BG9_CODIGO	*required
items.description	string	Descrição	BG9_DESCRI	*required
items.group-_type	string	Tipo de grupo (Pessoa física ou jurídica) : 1 = Pessoa Física 2 = Pessoa Juridica	BG9_TIPO	*required
items.use	string	Uso: 1 = Normal 2 = Usuários Admissionais/Contratos não cadastrados	BG9_USO	*required
items.links	array	links relacionados ao recurso companies (Padrão HATEOAS): rel: contracts (somente para pessoa jurídica).

Bloco de código

language	c#
theme	RDarkEmacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "company-_code": "0001",
            "description": "CONTRATOS PESSOA FISICA",
            "group-_type": "1",
            "use": "1"
        },
        {
            "company-_code": "0002",
            "description": "CONTRATOS PESSOA JURIDICA",
            "group-_type": "2",
            "use": "1",
            "links": [
                {
                    "rel": "contracts",
                    "href": "/totvsHealthPlans/familyContract/v1/companies/0002/contracts?health-insurer-codehealthInsurerCode=0001"
                }
            ]
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

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	RDarkEmacs
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	Contracts - Retorna os contratos da empresa

Retorna os contratos da empresa informada (somente para empresa do tipo pessoa jurídica)

/totvsHealthPlans/familyContract/v1/companies/{companyCode}/contracts

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 healthInsurerCode (query)	string	Código da operadora no sistema (BT5_CODINT)	*required
companyCode (path)	string	Código da empresa no sistema (BT5_CODIGO)	*required
login-user loginUser (query)	string	Filtro de contratos pelo usuário de login do portal (BSW_LOGUSR)
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	integer	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de contratos retornados
items.company-_code	string	Código da empresa	BT5_CODIGO	*required
items.contract-_code	string	Número do contrato	BT5_NUMCON	*required
items.contract-_version-_code	string	Versão do contrato	BT5_VERSAO	*required
items.contract-_date	string (date)	Data do contrato	BT5_DATCON	*required
items.contract -type _type	string	Tipo do contrato	BT5_TIPCON	*required
items.description -contract- _contract_type	string	Descrição do tipo do contrato	BII_DESCRI	*required
items.links	array	links relacionados ao recurso contracts (Padrão HATEOAS): rel: subcontracts		*required

Bloco de código

language	c#
theme	RDarkEmacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "company-_code": "1008",
            "contract-_code": "000000000001",
            "contract-_version-_code": "001",
            "contract-_date": "2021-02-12",
            "contract-_type": "3",
            "description-_contract-_type": "COLETIVO EMPRESARIAL",
            "links": [
                {
                    "rel": "subcontracts",
                    "href": "/totvsHealthPlans/familyContract/v1/companies/1008/contracts/000000000001001/subcontracts?health-insurer-code?healthInsurerCode=0001"
                }
            ]
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

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	RDarkEmacs
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 companyCode obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave companyCode."
        },
        {
            "code": "E001-406",
            "message": "Chave health-insurer-codehealthInsurerCode obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave health-insurer-code."
        }
    ]
}

Aviso

Expandir

title	(404) - Empresa não encontrada

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	RDarkEmacs
title	Exemplo
linenumbers	true

{
    "code": "E002",
    "message": "Empresa não encontrada na operadora.",
    "detailedMessage": "Não foi encontrada na tabela BG9 a empresa de código 1098 (BG9_CODIGO)."
}

...

Painel

titleColor	Orange
borderStyle	solid
title	Subcontracts - Retorna os subcontratos do contrato da empresa

Retorna os subcontratos do contrato informado da empresa (somente para empresa do tipo pessoa jurídica)

/totvsHealthPlans/familyContract/v1/companies/{companyCode}/contracts/{contractCode}/subcontracts

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 healthInsurerCode (query)	string	Código da operadora no sistema (BQC_CODIGO)	*required
companyCode (path)	string	Código da empresa no sistema (BQC_CODIGO)	*required
contractCode (path)	string	Contrato da empresa (BQC_NUMCON+BQC_VERCON)	*required
login-user loginUser (query)	string	Filtro de subcontratos pelo usuário de login do portal (BSW_LOGUSR)
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	integer	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de subcontratos retornados
items.subcontract-_code	string	Numero do subcontrato	BQC_SUBCON	*required
items.subcontract-_version-_code	string	Versão do subcontrato	BQC_VERSUB	*required
items.description	string	Descrição do subcontrato	BQC_DESCRI	*required
items.subcontract-_date	string (date)	Data do subcontrato	BQC_DATCON	*required
items.expiration-_date	string (date)	Data de validade do subcontrato	BQC_VALID

Bloco de código

language	c#
theme	RDarkEmacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "subcontract-_code": "000000001",
            "subcontract-_version-_code": "001",
            "description": "SUBCONTRATO USO GERAL",
            "subcontract-_date": "2021-02-12",
            "expiration-_date": ""
        },
        {
            "subcontract-_code": "000000002",
            "subcontract-_version-_code": "001",
            "description": "COBRANCA PATRONAL COMPARTILHADA",
            "subcontract-_date": "2021-02-12",
            "expiration-_date": ""
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

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	RDarkEmacs
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 companyCode obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave companyCode."
        },
        {
            "code": "E001-406",
            "message": "Chave contractCode obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave contractCode."
        },
        {
            "code": "E001-406",
            "message": "Chave health-insurer-codehealthInsurerCode obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave health-insurer-code."
        }
    ]
}

Aviso

Expandir

title	(404) - Empresa 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	RDarkEmacs
title	Exemplo
linenumbers	true

{
    "code": "E002",
    "message": "Empresa não encontrada na operadora.",
    "detailedMessage": "Não foi encontrada na tabela BG9 a empresa de código 1098 (BG9_CODIGO)."
}

Aviso

Expandir

title	(404) - Contrato 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	RDarkEmacs
title	Exemplo
linenumbers	true

{
    "code": "E003",
    "message": "Contrato da empresa não encontrado.",
    "detailedMessage": "Não foi encontrado na tabela BT5 o contrato de código 000000000003001 (BT5_NUMCON+BT5_VERSAO)."
}

03. TELA API COMPANIES

Outras Ações / Ações relacionadas

Ação	Descrição
Não se aplica	Não se aplica

04. TELA API COMPANIES

Principais Campos e Parâmetros

Campo	Descrição
BG9_CODIGO	Código da empresa no sistema
BG9_CODINT	Código da operadora saúde no sistema
BQC_NUMCON+BQC_VERCON	Chave do contrato

05. TABELAS UTILIZADAS

Empresas (BG9)
Usuário Portal x Empresa (B40)
Usuarios do Portal (BSW)
Grupo de Empresa Contrato (BT5)
Tipos de Contratos (BII)
Subcontrato (BQC)

...

Árvore de páginas

Versões comparadas

Versão antiga 71

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

03. TELA API COMPANIES

04. TELA API COMPANIES

05. TABELAS UTILIZADAS