API Documents - v1.000 (Refund Setup)

CONTEÚDO

Visão Geral
Exemplo de utilização
1. Documents - Retorna os documentos do reembolso
Tela api documents
1. Outras Ações / Ações relacionadas
Tela api documents
1. Principais Campos e Parâmetros
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

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

documents - 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

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
code (query)	string	Filtro de documentos pelo código
description (query)	string	Filtro de documento pela descrição
required (query)	string	Filtro de documentos por obrigatoriedade
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

Request

Body

Não possui body!

(200) - Operação realizada com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de documentos de reembolso
items.code	string	Código do documento no sistema	BBS_COD	*required
items.description	string	Descrição do documento	BBS_DESCRI	*required
items.image_href	string	Caminho no servidor da imagem vinculada ao documento.	BBS_IMG
items.required	string	Indica se o documento é obrigatório na solicitação de reembolso, sendo: 0 - Não 1 - Sim	BBS_OBRIGA	*required

Exemplo

{
    "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ção	Descrição
Não se aplica	Não se aplica

04. TELA API DOCUMENTS

Principais Campos e Parâmetros

Campo	Descrição
BBS_COD	Código do documento no sistema
BBS_OBRIGA	Indica se o documento é obrigatório na solicitação de reembolso

05. TABELAS UTILIZADAS

Documentos/Tipos de Comprovantes (BBS)

Árvore de páginas