CONTEÚDO
- Visão Geral
- Exemplo de utilização
- companies
- contracts
- subcontracts
- Tela api companies
- Outras Ações / Ações relacionadas
- Tela api companies
- 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
Retorna o Cadastro de Empresas
Retorna as empresas cadastradas da operadora informada.
| /totvsHealthPlans/familyContract/v1/companies | |
| Authorization (header) | | Cabeçalho usado para autorização das requisições | *required | Content-Type (header) | | 'application/json' é o formato do conteúdo | *required | | health-insurer-code (query) | string | Paginação da Coleção | *required | | login-user (query) | string | Paginação da Coleção |
| | group-type (query) | string | Paginação da Coleção |
| | page (query) | | Paginação da Coleção |
| | pageSize (query) | | Quantidade de Itens por Página |
| | order (query) | | Ordenação da Coleção |
| | fields (query) | | Filtro de campos dos registros |
| | filter (query) | | Indica o filtro querystring recebido (pode se utilizar um filtro oData) |
|
|
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 |
|---|
| 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