Histórico da Página

CONTEÚDO

Visão Geral
Exemplo de utilização
1. companies
2. contracts
3. Companies - Retorna o cadastro de empresas
4. Contracts - Retorna os contratos da empresa
5. Subcontracts - Retorna os subcontratos do contrato da empresasubcontracts
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.

Clique aqui para detalhes sobre como habilitar o serviço de APIs

02. EXEMPLO DE UTILIZAÇÃO

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.

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

Painel

Retorna o Cadastro de Empresas

Retorna as empresas cadastradas da operadora informada.

/totvsHealthPlans/familyContract/v1/companies

GET

Expandir

title	PARAMETERS

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

Paginação da Coleção

Código da operadora no sistema (BG9_CODINT)

*required

login-user

loginUser (query)

string

Paginação da Coleçãogroup-type

Filtro de empresas pelo usuário de login do portal (BSW_LOGUSR)
groupType (query)	string

Paginação da Coleção

Filtro de empresas pelo tipo de grupo (BG9_TIPO): 1=Pessoa Física e 2=Pessoa Jurídica
page (query)	string

Paginação da Coleção

Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string

Quantidade de Itens por Página

Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string

Ordenação da Coleçãofields (query)

string

Filtro de campos dos registros

Lista de campos para ordenação, separada por virgula (,).
fields

filter

(query)

string

Indica o filtro querystring recebido (pode se utilizar um filtro oData)

Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

REQUEST

Dica

Expandir

title

Request

Body

Não possui body!

OPERAÇÃO REALIZADA COM SUCESSO

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

:

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

theme
language	c#

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

healthInsurerCode=0001"
                }
            ]
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

PARÂMETROS OBRIGATÓRIOS

Aviso

Expandir

title	(406) -

Midnight

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

theme
language	c#

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

	contracts
	contracts

Painel

title
titleColor	Orange
borderStyle	solid

Retorna o Cadastro de Empresas

...

PARAMETERS

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

Paginação da Coleção

Código da operadora no sistema (BT5_CODINT)

*required

login-user

companyCode (

query

path)

string

Paginação da Coleção

group-type (query)

string

Código da empresa no sistema (BT5_CODIGO)	*required
loginUser

Paginação da Coleçãopage

(query)

string

Paginação da ColeçãopageSize (query)

string

Quantidade de Itens por Página

Filtro de contratos pelo usuário de login do portal (BSW_LOGUSR)
page

order

(query)

string

Ordenação da Coleção

Valor numérico (maior que zero) representando a página solicitada
pageSize

fields

(query)

string

Filtro de campos dos registros

Valor numérico (maior que zero) representando o total de registros retornados na consulta
order

filter

(query)

string

Indica o filtro querystring recebido (pode se utilizar um filtro oData)

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

Request

Body

Não possui body!

Dica

Expandir

title	(200) -

OPERAÇÃO REALIZADA COM SUCESSO

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

contratos retornados
items.company

-

_code

string

Código da empresa

BG9

BT5_CODIGO	*required
items.

description

contract_code

string

Descrição

Número do contrato

BG9

BT5_

DESCRI

NUMCON	*required
items.

group-type

contract_version_code

string

Tipo de grupo (Pessoa física ou jurídica)

Versão do contrato

BT5_VERSAO

BG9_TIPO

	*required
items.

use

contract_date	string (date)	Data do contrato	BT5_DATCON	*required
items.contract_type	string	Tipo do contrato	BT5_TIPCON	*required
items.description_contract_type	string	Descrição do tipo do contrato	BII_DESCRI

stringUsoBG9_USO

	*required
items.links	array	links relacionados ao recurso

companies

contracts (Padrão HATEOAS)

codeMidnight

:

rel: subcontracts

*required

Bloco de código

theme
language	c#

Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "company

-

_code": "

0001

1008",
            "

description

contract_code": "

CONTRATOS PESSOA FISICA

000000000001",
            "

group-type

contract_version_code": "

1

001",
            "

use

contract_date": "

1

2021-02-12",

}

    "contract_type": "3",

{

"company-code

"description_contract_type": "

0002

COLETIVO EMPRESARIAL",
            "

description

links": [

"CONTRATOS

PESSOA

JURIDICA",

"group-type": "2",

"use

        "rel": "

1

subcontracts",

"links": [

"href": "/totvsHealthPlans/familyContract/v1/companies/1008/contracts/000000000001001/subcontracts?healthInsurerCode=0001"

{

"rel": "contracts",

]
        }
    ],
    "hasNext": false,
    "

href

remainingRecords":

"/totvsHealthPlans/familyContract/v1/companies/0002/contracts?health-insurer-code=0001" }

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

Âncora

	subcontracts
	subcontracts

406 PARÂMETROS OBRIGATÓRIOS

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
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
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	Emacs
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	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 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 healthInsurerCode obrigatória",

}

],

hasNext

detailedMessage":

false,

"Não foi informado no queryParams da requisição a chave health-insurer-code."

"remainingRecords": 0

}
    ]
}

Aviso

Expandir

title	(

404) -

Midnight

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

theme
language	c#

Emacs
title	Exemplo
linenumbers	true

{
    "code": "

E001

E002",
    "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

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

{
    "code": "E003",

"detailedMessage

"message": "

Não foi informado no queryParams

Contrato da

requisição

empresa

a chave health-insurer-code

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

Principais Campos e Parâmetros

Descrição

Campo

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 22

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

02. EXEMPLO DE UTILIZAÇÃO

Retorna o Cadastro de Empresas

Retorna o Cadastro de Empresas

03. TELA API COMPANIES

04. TELA API

COMPANIES

05. TABELAS UTILIZADAS