Histórico da Página

...

Painel

titleColor	Orange
borderStyle	solid
title	Send - Envia protocolo de reembolso não finalizado

Confirma o envio do protocolo de reembolso com o status de solicitação não concluída.

/totvsHealthPlans/attendance/v1/refunds/send

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "protocol" : "41750520230607000013"
}

Dica

Expandir

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

protocol	string	Numero do protocolo do reembolso	BOW_PROTOC	*required
status	string	Status do protocolo: 0 - Solicitação não concluída 1 - Protocolado	BOW_STATUS	*required
requestDate	string (date)	Data de solicitação	BOW_DTDIGI	*required
presentedAmount	numeric (double)	Valor apresentado	BOW_VLRAPR	*required
refundedAmount	numeric (double)	Valor reembolsado	BOW_VLRREE
paymentDate	string (date)	Data de pagamento do reembolso	BOW_PGMTO
beneficiaryName	string	Nome do beneficiário solicitante	BOW_NOMUSR	*required
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

{
    "protocol": "41750520230607000003",
    "status": "1",
    "requestDate": "2023-06-07",
    "presentedAmount": 250,
    "refundedAmount": 0,
    "paymentDate": "",
    "beneficiaryName": "HERNANDES ALVES DA SILVA",
    "links": [
        {
            "rel": "expenses",
            "href": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/expenses"
        },
        {
            "rel": "attachments",
            "href": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/attachments"
        }
    ]
}

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: >>}<<"
}

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": "E002D-406",
            "message": "Tipo inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ser do tipo (C)."
        }
    ]
}

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E003",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado o protocolo de reembolso 41750520230607000019 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.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E004",
    "message": "Permite finalizar protocolo de reembolso somente com o status de solicitação não concluida",
    "detailedMessage": "Permitido somente finalizar protocolos com o status (BOW_STATUS) igual a 0 (Solicitação não concluida)"
}

...

Árvore de páginas

Versões comparadas

Versão antiga 38

Nova versão 39

Chave