Exibir origem

CONTEÚDO

Visão Geral
Exemplo de utilização
1. Refunds - Inclusão de um protocolo de reembolso
2. Refunds - Retorna os protocolos de reembolso
3. Refunds - Deleta um protocolo de reembolso
4. Send - Envia protocolo de reembolso não finalizado
5. Expenses - Retorna as despesas do protocolo de reembolso
6. Expenses - Deleta uma despesa do protocolo de reembolso
7. Expenses - Inclusão de um nova despesa ao protocolo de reembolso
8. Expenses - Altera despesa do protocolo de reembolso
9. ReasonDenied - Retorna o motivo negado da despesa
10. attachments - Retorna os anexos do protocolo de reembolso
11. attachments - Inclusão de novos anexos ao protocolo de reembolso
12. attachments - Deleta um anexo do protocolo de reembolso
Tela api refunds
1. Outras Ações / Ações relacionadas
Tela api refunds
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

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.

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

Realiza a inclusão de um novo protocolo de reembolso para o beneficiário

/totvsHealthPlans/attendance/v1/refunds

POST

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

status	string	Define o status final do protocolo, sendo: 1 - Protocolado 0 - Solicitação não concluída		*required
healthInsurerCode	string	Código da operadora de saúde no sistema	BOW_OPEMOV	*required
subscriberId	string	Matricula do beneficiário solicitante do protocolo	BOW_USUARI	*required
refundReceipts	array	Comprovantes de reembolso		*required
refundReceipts.unreferencedNetworkIdentifier	string	CPF/CNPJ do prestador de serviço	B1N_PRCNPJ	*required
refundReceipts.unreferencedNetworkName	string	Nome do prestador de serviço	B1N_PRNOME	*required
refundReceipts.stateAbbreviation	string	Estado do prestador	B1N_EST	*required
refundReceipts.cityCode	string	Código do Município do prestador (obtido através da api /totvsHealthPlans/locality/v1/cities)	B1N_CODMUN	*required
refundReceipts.documentCode	string	Código do tipo de comprovante (obtido através da api /totvsHealthPlans/refundSetup/v1/documents)	B1N_TIPDOC (BBS_COD)	*required
refundReceipts.documentNumber	string	Numero do documento	B1N_NUMDOC
refundReceipts.documentDate	string (date)	Data de emissão do documento	B1N_DATDOC	*required
refundReceipts.expenses	array	Despesas do comprovante de reembolso		*required
refundReceipts.expenses.subscriberId	string	Matricula do beneficiário da despesa
refundReceipts.expenses.procedureClass	string	Código do tipo de despesa utilizado (obtido através da api totvsHealthPlans/procedure/v1/classes)
refundReceipts.expenses.tableCode	string
refundReceipts.expenses.procedureCode	string
refundReceipts.expenses.continuousUse	string
refundReceipts.expenses.expenseAmount	number (double)
refundReceipts.expenses.quantity	number (integer)
refundReceipts.expenses.executionDate	string (date)

{
    "status" : "0",
	"healthInsurerCode" : "0001",
	"subscriberId" : "00011008000027010",
    "refundReceipts" : [
        {
            "unreferencedNetworkIdentifier" : "77077733000159",
            "unreferencedNetworkName" : "JOSE",
            "stateAbbreviation" : "SP",
            "cityCode" : "3500105",
            "documentCode" : "03",
            "documentNumber" : "00007674",
            "documentDate" : "2023-06-02",
            "expenses" : [
                {
                    "subscriberId" : "00011008000027010",
                    "procedureClass" : "000001",
                    "tableCode" : "01",
                    "procedureCode": "10101012",
                    "continuousUse" : "0",
                    "expenseAmount": 250,
                    "quantity" : 1,
                    "executionDate" : "2023-06-02"		
                }
            ],
            "attachments" : [
                {
                    "href" : "https://www.totvs.com/wp-content/uploads/2021/04/totvs-shared.png?teste"
                }
            ]
        }
    ]
}

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	integer	Quantidade de registros ainda existem para retorno		*required
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: 1 = Pessoa Física 2 = Pessoa Juridica	BG9_TIPO	*required
items.use	string	Uso: 1 = Normal 2 = Usuários Admissionais/Contratos não cadastrados	BG9_USO	*required
items.links	array	links relacionados ao recurso companies (Padrão HATEOAS): rel: contracts (somente para pessoa jurídica).

{
    "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.	*required

{
    "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 XXXXX

Outras Ações / Ações relacionadas

Ação	Descrição
Inclua a ação	Inclua a descrição relacionada
Inclua a ação	Inclua a descrição relacionada
Inclua a ação	Inclua a descrição relacionada

04. TELA XXXXX

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

Coloque o link das tabelas relacionadas