Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. documents - Retorna os documentos do reembolso
  3. Tela api documentsTela XXX
    1. Outras Ações / Ações relacionadas
  4. Tela XXXapi documents
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

API para a entidade documents (Documentos da configuração do reembolso) do produto TOTVS Saúde Planos Linha Protheus.

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


Dica
titleAutenticaçã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
titleNomenclatura das APIs

Para nome composto, as APIs utilizam o padrão camelCase e quando a houver paginação será utilizado o padrão tudo minúsculo separado por hífen para os campos dentro do array items


02. EXEMPLO DE UTILIZAÇÃO

Âncora
documents
documents

Painel
titleColorOrange
borderStylesolid
titledocuments - Retorna os documentos do reembolso

Retorna os documentos (Tipos de comprovantes) utilizado na solicitação de reembolso do beneficiário.

/totvsHealthPlans/refundSetup/v1/documents

GET

Nota
Expandir
titleParameters
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
city-code (query)string

Filtro de municípios pelo código IBGE


city-description (query)string

Filtro de municípios pela nome/descrição


state-abbreviation (query)stringFiltro de municípios pelo estado
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
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsnumeric (integer)Quantidade de registros ainda existem para retorno
*required
itemsarrayLista de documentos de reembolso

items.codestring

Código do documento no sistema

BBS_COD*required
items.descriptionstring

Descrição do documento

BBS_DESCRI*required
items.image-hrefstring

Caminho no servidor da imagem vinculada ao documento.

BBS_IMG
items.requiredstring

Indica se o documento é obrigatório na solicitação de reembolso, sendo:

  • 0 - Não
  • 1 - Sim
BBS_OBRIGA*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "items": [
        {
            "code": "01",
            "description": "CNPJ",
            "image-href": "",
            "required": "1"
        },
        {
            "code": "02",
            "description": "NOTA FISCAL",
            "image-href": "",
            "required": "1"
        },
        {
            "code": "03

...

",
            "description": "RECIBO",
            "image-href": "",
            "required": "1"
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

03. TELA API DOCUMENTS

Outras Ações / Ações relacionadas

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

04. TELA

...

API DOCUMENTS

Principais Campos e Parâmetros

CampoDescrição

...

BBS_CODCódigo do documento no sistema
BBS_OBRIGAIndica se o documento é obrigatório na solicitação de reembolso

...

05. TABELAS UTILIZADAS

  • Documentos/Tipos de Comprovantes (BBS)