Histórico da Página

...

Painel

titleColor	Orange
borderStyle	solid
title	Refunds - Retorna os protocolos de reembolso do medicamento

Retorna protocolos de reembolso vinculado ao medicamento de uso contínuo.

/totvsHealthPlans/refundSetup/v1/continuousMedications/refunds

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
prescriptionCode (query)	string	Código da receita do medicamento	*required
medicationCode (query)	string	Filtro de medicamentos pelo código
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 protocolos do medicamento
items.prescriptionCodeprescription_code	string	Código da receita do medicamento	B1N_CODREC	*required
items.medicationCodemedication_code	string	Código do medicamento	B1N_CODPRO	*required
items.medicationDescriptionmedication_description	string	Descrição do medicamento	BR8_DESCRI	*required
items.protocol	string	Numero do protocolo de reembolso	B1N_PROTOC	*required
items.status	string	Status do protocolo de reembolso, sendo: 0 = Solicitado (Portal) 1 = Protocolado 2 = Em analise 3 = Deferido 4 = Indeferido 5 = Em digitação 6 = Lib. financeiro 7 = Não lib. financeiro 8 = Glosado 9 = Auditoria A = Solicitação não concluída B = Aguardando informação do Beneficiário C = Aprovado Parcialmente D = Cancelado E = Reembolso Revertido	BOW_STATUS	*required
items.requestDaterequest_date	string (date)	Data de solicitação do reembolso	BOW_DTDIGI	*required
items.quantityRequestedquantity_requested	numeric (integer)	Quantidade no reembolso	B1N_QTDMED	*required
items.repaymentDaterepayment_date	string (date)	Data de pagamento do reembolso	BOW_DATPAG

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "prescriptionCodeprescription_code": "41750520230419000001",
            "medicationCodemedication_code": "0490173961",
            "medicationDescriptionmedication_description": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "protocol": "41750520230525000002",
            "status": "A",
            "requestDaterequest_date": "2023-05-25",
            "quantityRequestedquantity_requested": 1,
            "repaymentDaterepayment_date": "2023-05-24"
        },
        {
            "prescriptionCodeprescription_code": "41750520230419000001",
            "medicationCodemedication_code": "0490173961",
            "medicationDescriptionmedication_description": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "protocol": "41750520230529000001",
            "status": "A",
            "requestDaterequest_date": "2023-05-29",
            "quantityRequestedquantity_requested": 1,
            "repaymentDaterepayment_date": "2023-04-24"
        }
    ],
    "hasNext": true,
    "remainingRecords": 30
}

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

Aviso

Expandir

title	(404) - Receita 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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "Receita Não Encontrada",
    "detailedMessage": "Não foi possível retornar os dados da receita através do código da receita informada."
}

...

Árvore de páginas

Versões comparadas

Versão antiga 12

Nova versão 13

Chave