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	Expenses - Deleta uma despesa do protocolo de reembolso

Deleta uma despesa do protocolo de reembolso com o status de solicitação não concluida.

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

DELETE

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 (BOW_PROTOC)	*required
sequencial (path)	string	Sequencial da despesa no protocolo (B1N_SEQUEN) (obtido através da api /totvsHealthPlans/attendance/v1/refunds/{protocol}/expenses)	*required

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

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

Body

Não possui body!

Aviso

Expandir

title	(406) - Parâmetro Inválido

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 path param estão inválidas",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001B-406",
            "message": "Campo protocol obrigatório",
            "detailedMessage": "Não foi informado valor do campo protocol."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ter o tamanho 20."
        },
        {
            "code": "E001B-406",
            "message": "Campo sequential obrigatório",
            "detailedMessage": "Não foi informado valor do campo sequential."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo sequential",
            "detailedMessage": "O valor do campo sequential deve ter o tamanho 3."
        }
    ]
}

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": "E004",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado o protocolo de reembolso 41750520230605000100 (BOW_PROTOC) na base de dados (BOW)"
}

Aviso

Expandir

title	(400) - Status do protocolo não permitido

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": "E005",
    "message": "Não permitido incluir, alterar ou excluir despesa pois a solicitação já esta protocolada, entre em contato com a operadora",
    "detailedMessage": "Permitido somente incluir, alterar, excluir despesas para protocolos com o status (BOW_STATUS) igual a A (Solicitação não concluida)"
}

Aviso

Expandir

title	(404) - Despesa não encontrada

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": "E006",
    "message": "Despesa não encontrada para o protocolo de reembolso 41750520230607000014",
    "detailedMessage": "Não foi encontrada a despesa de sequencial 002 (B1N_SEQUEN) para o protocolo 41750520230607000014 (BOW_PROTOC)"
}

Âncora

	expensesPost
	expensesPost

Painel

titleColor	Orange
borderStyle	solid
title	Expenses - Inclusão de um nova despesa ao protocolo de reembolso

Realiza a inclusão de uma nova despesa ao protocolo de reembolso

/totvsHealthPlans/attendance/v1/refunds/expenses

POST

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

Dica

Expandir

title	Request

protocol	string	Numero do protocolo de reembolso	BOW_PROTOC	*required
subscriberId	string	Matricula do beneficiário da despesa	B1N_MATRIC	*required
unreferencedNetworkIdentifier	string	CPF/CNPJ do prestador de serviço	B1N_PRCNPJ	*required
unreferencedNetworkName	string	Nome do prestador de serviço	B1N_PRNOME	*required
stateAbbreviation	string	Estado do prestador	B1N_EST	*required
cityCode	string	Código do Município do prestador (obtido através da api /totvsHealthPlans/locality/v1/cities)	B1N_CODMUN	*required
documentCode	string	Código do tipo de comprovante (obtido através da api /totvsHealthPlans/refundSetup/v1/documents)	B1N_TIPDOC (BBS_COD)	*required
documentNumber	string	Numero do documento	B1N_NUMDOC
documentDate	string (date)	Data de emissão do documento	B1N_DATDOC	*required
procedureClass	string	Código do tipo de despesa utilizado (obtido através da api totvsHealthPlans/procedure/v1/classes)	B1N_TIPSER	*required
tableCode	string	Código da tabela da despesa	B1N_CODPAD	*required
procedureCode	string	Código da despesa	B1N_CODPRO	*required
continuousUse	string	Quando a despesa for medicamento, informa se é de uso contínuo, sendo: 0 - Não 1 - Sim	B1N_USOCON	*required
prescriptionCode	string	Código da receita do medicamento de uso continuo (obtivo através da api /totvsHealthPlans/refundSetup/v1/continuousMedications) Obrigatório quando continuousUse for igual a 1	B1N_CODREC
expenseAmount	numeric (double)	Valor total da despesa	B1N_VLRTOT	*required
quantity	numeric (integer)	Quantidade de despesa	B1N_QTDPRO	*required
executionDate	string (date)	Data de execução da despesa	B1N_DATPRO	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "protocol" : "41750520230607000015",
    "subscriberId": "00011008000027010",
    "unreferencedNetworkIdentifier": "77077733000159",
    "unreferencedNetworkName": "JOSE",
    "stateAbbreviation": "SP",
    "cityCode": "3500105",
    "documentCode": "03",
    "documentNumber": "0000012349",
    "documentDate": "2023-04-23",
    "procedureClass": "000001",
    "tableCode": "01",
    "procedureCode": "10101012",
    "continuousUse": "0",
    "prescriptionCode" : "",
    "expenseAmount": 500,
    "quantity": 1,
    "executionDate": "2023-04-23"
}

Dica

Expandir

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

status	string	Status da despesa, sendo: 0 - Negado 1 - Autorizado	B1N_IMGSTA	*required
subscriberId	string	Matricula do beneficiário da despesa	B1N_MATRIC	*required
beneficiaryName	string	Nome do beneficiário	BA1_NOMUSR	*required
protocol	string	Numero do protocolo	B1N_PROTOC	*required
sequential	string	Sequencial da despesa no protocolo	B1N_SEQUEN	*required
procedureClass	string	Código do tipo de despesa utilizado (obtido através da api totvsHealthPlans/procedure/v1/classes)	B1N_TIPSER	*required
tableCode	string	Código da tabela da despesa	B1N_CODPAD	*required
procedureCode	string	Código da despesa	B1N_CODPRO	*required
procedureDescription	string	Descrição da despesa	BR8_DESCRI	*required
continuousUse	string	Medicamento de uso continuo: 0 - Não 1 - Sim	B1N_USOCON	*required
quantity	numeric (integer)	Quantidade de despesa	B1N_QTDPRO	*required
expenseAmount	numeric (double)	Valor apresentado da despesa	B1N_VLRAPR	*required
totalExpenseAmount	numeric (double)	Valor total da despesa	B1N_VLRTOT	*required
refundedAmount	numeric (double)	Valor reembolsado	B1N_VLRREE	*required
unreferencedNetworkIdentifier	string	CPF/CNPJ do prestador de serviço	B1N_PRCNPJ	*required
unreferencedNetworkName	string	Nome do prestador de serviço	B1N_PRNOME	*required
stateAbbreviation	string	Estado do prestador	B1N_EST	*required
cityCode	string	Código do Município do prestador (obtido através da api /totvsHealthPlans/locality/v1/cities)	B1N_CODMUN	*required
documentCode	string	Código do tipo de comprovante (obtido através da api /totvsHealthPlans/refundSetup/v1/documents)	B1N_TIPDOC (BBS_COD)	*required
documentDescription	string	Descrição do tipo de comprovante (obtido através da api /totvsHealthPlans/refundSetup/v1/documents)	B1N_TIPDOC	*required
documentNumber	string	Numero do documento	B1N_NUMDOC
documentDate	string (date)	Data de emissão do documento	B1N_DATDOC	*required
executionDate	string (date)	Data de execução da despesa	B1N_DATPRO	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "status": "1",
    "subscriberId": "00011008000027010",
    "beneficiaryName": "HERNANDES ALVES DA SILVA",
    "protocol": "41750520230607000015",
    "sequential": "002",
    "procedureClass": "000001",
    "tableCode": "01",
    "procedureCode": "10101012",
    "procedureDescription": "CONSULTA EM CONSULTORIO",
    "continuousUse": "0",
    "quantity": 1,
    "expenseAmount": 500,
    "totalExpenseAmount": 500,
    "refundedAmount": 0,
    "unreferencedNetworkIdentifier": "77077733000159",
    "unreferencedNetworkName": "JOSE",
    "stateAbbreviation": "SP",
    "cityCode": "3500105",
    "documentCode": "03",
    "documentDescription": "RECIBO",
    "documentNumber": "0000012349",
    "documentDate": "2023-04-23",
    "executionDate": "2023-04-23"
}

Aviso

Expandir

title	(406) - Json do body invalido

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": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>\"subscriberId\": \"00011008000027010\",\r\n    \"unreferencedNetworkIdentifier\": \"77077733000159\",\r\n    \"unreferencedNetworkName\": \"JOSE\",\r\n    \"stateAbbreviation\": \"SP\",\r\n    \"cityCode\": \"3500105\",\r\n    \"documentCode\": \"03\",\r\n    \"documentNumber\": \"0000012350\",\r\n    \"documentDate\": \"2023-04-23\",\r\n    \"procedureClass\": \"000001\",\r\n    \"tableCode\": \"01\",\r\n    \"procedureCode\": \"10101012\",\r\n    \"continuousUse\": \"0\",\r\n    \"prescriptionCode\" : \"\",\r\n    \"expenseAmount\": 500,\r\n    \"quantity\": 1,\r\n    \"executionDate\": \"2023-04-23\"\r\n}<<"
}

Aviso

Expandir

title	(406) - Campos do body inválidos

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": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002E-406",
            "message": "Tamanho inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ter o tamanho 20."
        },
        {
            "code": "E002B-406",
            "message": "Campo subscriberId obrigatório",
            "detailedMessage": "Não foi informado valor do campo subscriberId."
        },
        {
            "code": "E002E-406",
            "message": "Tamanho inválido para o campo subscriberId",
            "detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
        },
        {
            "code": "E002A-406",
            "message": "Campo stateAbbreviation não informado",
            "detailedMessage": "Não foi informado o campo stateAbbreviation."
        },
        {
            "code": "E002F-406",
            "message": "Valor inválido para o campo continuousUse",
            "detailedMessage": "O valor do campo continuousUse deve ser: 0;1"
        }
    ]
}

Aviso

Expandir

title	(400) - Dados do reembolso inválidos

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": "E003",
    "message": "Dados inválidos para realizar a inclusão da despesa",
    "detailedMessage": "Verifique os detalhes dos erros no campo details",
    "details": [
        {
            "code": "E005C-404",
            "message": "Código do documento não encontrado",
            "detailedMessage": "Não foi encontrado nenhum documento com o código 99 no cadastro (BBS)"
        },
        {
            "code": "E005D-404",
            "message": "Estado e Cidade não encontrado",
            "detailedMessage": "Não foi encontrado nenhum estado SP e cidade 3500106 no cadastro (BID)"
        }
    ]
}

03. TELA API REFUNDS

Outras Ações / Ações relacionadas

...

Árvore de páginas

Versões comparadas

Versão antiga 44

Nova versão 45

Chave

03. TELA API REFUNDS