Histórico da Página

...

Painel

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

Retorna os protocolos de reembolso do beneficiário

/totvsHealthPlans/attendance/v1/refunds

GET

Nota

Expandir

title	Parameters

protocol

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
subscriberId (query)	string	Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO) (obtido através da API Beneficiaries - v1.000 (Family Contract))	*required
requestDateInitial (query)	string (date)	Data inicial de solicitação do protocolo Obrigatório para quando não for informado o query param	protocol ou previousMonths
requestDateFinal (query)	string (date)	Data final de solicitação do protocolo Obrigatório para quando não for informado o query param protocol ou previousMonths
protocol (query)	string	Numero do protocolo (BOW_PROTOC)
status (query)	string	Status do protocolo de reembolso, sendo: 0 - Solicitação não concluída 1 - Protocolado 2 - Em analise 3 - Reembolso aprovado 4 - Reembolso rejeitado 5 - Aguardando informação do Beneficiário 6 - Aprovado Parcialmente 7 - Cancelado 8 - Reembolso revertido pode ser enviado mais de um status. Exemplo: 0,1,2,3
previousMonths (query)	string	Quantidade de meses anteriores dos protocolos, exemplo: caso seja informado "2", o sistema irá trazer os protocolos dos últimos 2 meses.
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 de reembolso retornados
items.status	string	Status do protocolo: 0 - Solicitação não concluída 1 - Protocolado 2 - Em analise 3 - Reembolso aprovado 4 - Reembolso rejeitado 5 - Aguardando informação do Beneficiário 6 - Aprovado Parcialmente 7 - Cancelado 8 - Reembolso revertido	BOW_STATUS	*required
items.protocol	string	Numero do protocolo de reembolso	BOW_PROTOC	*required
items.requestDate	string (date)	Data da solicitação	BOW_DTDIGI	*required
items.presentedAmount	numeric (double)	Valor apresentado	BOW_VLRAPR	*required
items.refundedAmount	numeric (double)	Valor reembolsado	BOW_VLRREE
items.paymentDate	string (date)	Data de pagamento do reembolso	BOW_PGMTO
items.beneficiaryName	string	Nome do beneficiário solicitante	BOW_NOMUSR	*required
items.observation	string	Observação do Protocolo
items.links	array	links relacionados ao recurso refunds (Padrão HATEOAS): rel: expenses (Despesas do protocolo) rel: attachments (Anexos do protocolo)		*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "status": "2",
            "protocol": "41750520230607000001",
            "requestDate": "2023-06-07",
            "presentedAmount": 250,
            "refundedAmount": 0,
            "paymentDate": "",
            "beneficiaryName": "HERNANDES ALVES DA SILVA",
            "observation": "",
            "links": [
                {
                    "rel": "expenses",
                    "href": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000001/expenses"
                },
                {
                    "rel": "attachments",
                    "href": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000001/attachments"
                }
            ]
        },
        {
            "status": "1",
            "protocol": "41750520230607000003",
            "requestDate": "2023-06-07",
            "presentedAmount": 250,
            "refundedAmount": 0,
            "paymentDate": "",
            "beneficiaryName": "HERNANDES ALVES DA SILVA",
            "observation": "",
            "links": [
                {
                    "rel": "expenses",
                    "href": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/expenses"
                },
                {
                    "rel": "attachments",
                    "href": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/attachments"
                }
            ]
        }
    ],
    "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 requestDateInitial não informado",
            "detailedMessage": "Não foi informado o campo request-date-initial."
        },
        {
            "code": "E001A-406",
            "message": "Campo requestDateFinal não informado",
            "detailedMessage": "Não foi informado o campo request-date-final."
        },
        {
            "code": "E001A-406",
            "message": "Campo subscriberId 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)"
}

...

Árvore de páginas

Versões comparadas

Versão antiga 77

Nova versão 78

Chave