CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. companies
    2. contracts
    3. subcontracts
  3. Tela api companies
    1. Outras Ações / Ações relacionadas
  4. Tela api companies
    1. Principais Campos e Parâmetros
  5. 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

Retorna o Cadastro de Empresas

Retorna as empresas cadastradas da operadora informada.

/totvsHealthPlans/familyContract/v1/companies

GET



Authorization (header)

string

Cabeçalho usado para autorização das requisições*required

Content-Type (header)

string

'application/json' é o formato do conteúdo*required
health-insurer-code (query)stringPaginação da Coleção*required
login-user (query)stringPaginação da Coleção
group-type (query)stringPaginação da Coleção
page (query)

string

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

string

Quantidade de Itens por Página
order (query)

string

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

string

Filtro de campos dos registros
filter (query)

string

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



Body

Não possui body!


hasNextbooleanIndica se ainda existem registros a serem retornados

remainingRecordsintegerQuantidade de registros ainda existem para retorno

itemsarrayLista de empresas retornadas

items.company-codestringCódigoBG9_CODIGO*required
items.descriptionstringDescriçãoBG9_DESCRI*required
items.group-typestringTipo de grupo (Pessoa física ou jurídica)BG9_TIPO*required
items.usestringUsoBG9_USO*required





03. TELA API COMPANIES

Outras Ações / Ações relacionadas

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

04. TELA API COMPANIES

Principais Campos e Parâmetros

CampoDescrição
Inclua o campo Inclua a descrição relacionada
Inclua o campo Inclua a descrição relacionada
Inclua o campo Inclua a descrição relacionada

05. TABELAS UTILIZADAS