Exibir origem

CONTEÚDO

Visão Geral
Exemplo de utilização
1. companies
2. contracts
3. subcontracts
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

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

hasNext	boolean	Indica se ainda existem registros a serem retornados
remainingRecords	integer	Quantidade de registros ainda existem para retorno
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)	BG9_TIPO	*required
items.use	string	Uso	BG9_USO	*required
items.links	array	links relacionados ao recurso companies (Padrão HATEOAS)

{
    "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=0001"
                }
            ]
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

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.

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

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

Empresas (BG9)