Histórico da Página

...

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. Protocol/base64 - Retorna protocolo do reembolso em arquivo base64
6. Expenses - Retorna as despesas do protocolo de reembolso
7. Expenses - Deleta uma despesa do protocolo de reembolso
8. Expenses - Inclusão de um nova despesa ao protocolo de reembolso
9. Expenses - Altera despesa do protocolo de reembolso
10. ReasonDenied - Retorna o motivo de negação da despesa
11. attachments - Retorna os anexos do protocolo de reembolso
12. attachments - Inclusão de novos anexos ao protocolo de reembolso
13. 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

...

Painel

titleColor	Orange
borderStyle	solid
title	Protocol/base64 - Retorna protocolo do reembolso em arquivo base64

Retorna o pdf do protocolo de reembolso em arquivo base64.

/totvsHealthPlans/attendance/v1/refunds/{protocol}/protocol/base64

GET

Nota

Expandir

title	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
protocol (path)	string	Numero do protocolo de reembolso (BOW_PROTOC)	*required

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizada com sucesso

fileName	string	Nome do arquivo em PDF		*required
file	string	String do arquivo em base 64		*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "fileName": "protocreembsc043500.pdf",
    "file": "JVBERi0xLjMKJbe+raoKMSAwIG9i..."
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "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 protocol obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave protocol."
        }
    ]
}

Aviso

Expandir

title	(404) - Protocolo não encontrado

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.

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E002",
    "message": "Protocolo não encontrado",
    "detailedMessage": "Não foi encontrada na tabela BOW o protocol 41750520230607000099 (BOW_PROTOC)."
}

Âncora

	expensesGet
	expensesGet

Painel

titleColor	Orange
borderStyle	solid
title	Expenses - Retorna as despesas do protocolo de reembolso

Retorna as despesas do protocolo de reembolso

/totvsHealthPlans/attendance/v1/refunds/{protocol}/expenses

GET

Nota

Expandir

title	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
protocol (path)	string	Numero do protocolo de reembolso (BOW_PROTOC)	*required
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

title	Request

Body

Não possui body!

Dica

Expandir

title	(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 despesas do protocolo de reembolso
items.status	string	Status da despesa, sendo: 0 - Negado 1 - Autorizado	B1N_IMGSTA	*required
items.subscriber-id	string	Matricula do beneficiário da despesa	B1N_MATRIC	*required
items.beneficiary-name	string	Nome do beneficiário	BA1_NOMUSR	*required
items.protocol	string	Numero do protocolo	B1N_PROTOC	*required
items.sequential	string	Sequencial da despesa no protocolo	B1N_SEQUEN	*required
items.procedure-class	string	Código do tipo de despesa utilizado (obtido através da api totvsHealthPlans/procedure/v1/classes)	B1N_TIPSER	*required
items.table-code	string	Código da tabela da despesa	B1N_CODPAD	*required
items.procedure-code	string	Código da despesa	B1N_CODPRO	*required
items.procedure-description	string	Descrição da despesa	BR8_DESCRI	*required
items.continuous-use	string	Medicamento de uso continuo: 0 - Não 1 - Sim	B1N_USOCON	*required
items.quantity	numeric (integer)	Quantidade de despesa	B1N_QTDPRO	*required
items.expense-amount	numeric (double)	Valor apresentado da despesa	B1N_VLRAPR	*required
items.total-expense-amount	numeric (double)	Valor total da despesa	B1N_VLRTOT	*required
items.refunded-amount	numeric (double)	Valor reembolsado	B1N_VLRREE	*required
items.unreferenced-network-identifier	string	CPF/CNPJ do prestador de serviço	B1N_PRCNPJ	*required
items.unreferenced-network-name	string	Nome do prestador de serviço	B1N_PRNOME	*required
items.state-abbreviation	string	Estado do prestador	B1N_EST	*required
items.city-code	string	Código do Município do prestador (obtido através da api /totvsHealthPlans/locality/v1/cities)	B1N_CODMUN	*required
items.document-code	string	Código do tipo de comprovante (obtido através da api /totvsHealthPlans/refundSetup/v1/documents)	B1N_TIPDOC (BBS_COD)	*required
items.document-description	string	Descrição do tipo de comprovante (obtido através da api /totvsHealthPlans/refundSetup/v1/documents)	B1N_TIPDOC	*required
items.document-number	string	Numero do documento	B1N_NUMDOC
items.document-date	string (date)	Data de emissão do documento	B1N_DATDOC	*required
items.execution-date	string (date)	Data de execução da despesa	B1N_DATPRO	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "status": "1",
            "subscriber-id": "00011008000027010",
            "beneficiary-name": "HERNANDES ALVES DA SILVA",
            "protocol": "41750520230605000040",
            "sequential": "001",
            "procedure-class": "000001",
            "table-code": "01",
            "procedure-code": "10101012",
            "procedure-description": "CONSULTA EM CONSULTORIO",
            "continuous-use": "0",
            "quantity": 1,
            "expense-amount": 1000,
            "total-expense-amount": 1000,
            "refunded-amount": 0,
            "unreferenced-network-identifier": "77077733000159",
            "unreferenced-network-name": "JOSE",
            "state-abbreviation": "SP",
            "city-code": "3500105",
            "document-code": "03",
            "document-description": "RECIBO",
            "document-number": "2222223",
            "document-date": "2023-06-02",
            "execution-date": "2023-06-02"
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "as chaves do query param estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001A-406",
            "message": "Campo request-date-initial não informado",
            "detailedMessage": "Não foi informado o campo request-date-initial."
        },
        {
            "code": "E001A-406",
            "message": "Campo request-date-final não informado",
            "detailedMessage": "Não foi informado o campo request-date-final."
        },
        {
            "code": "E001A-406",
            "message": "Campo subscriber-id não informado",
            "detailedMessage": "Não foi informado o campo subscriber-id."
        }
    ]
}

Aviso

Expandir

title	(404) - Beneficiário não encontrado

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.

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E002",
    "message": "Beneficiário não encontrado",
    "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000027013 no cadastro (BA1)"
}

03. TELA API REFUNDS

Outras Ações / Ações relacionadas

...

Árvore de páginas

Versões comparadas

Versão antiga 40

Nova versão 41

Chave

03. TELA API REFUNDS