Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Painel
titleColorOrange
borderStylesolid
titleExpenses - 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
titleParameters
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)stringNumero 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
titleRequest

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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E001",
    "message": "AAs chavechaves do path param estaestão inválidainvá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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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(404400) - Protocolo Status do protocolo não encontradopermitido
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E002E005",
    "message": "Protocolo de reembolso não encontradoNã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 "detailedMessage": "Não foi encontradodespesas para protocolos com o protocolo de reembolso 41750520230607000019 na base de dados (BOWstatus (BOW_STATUS) igual a A (Solicitação não concluida)"
}
Aviso
Expandir
title(400404) - Status do protocolo Despesa não permitidoencontrada
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E003E006",
    "message": "NãoDespesa foinão possívelencontrada excluirpara estao solicitaçãoprotocolo poisde já esta protocolada, entre em contato com a operadorareembolso 41750520230607000014",
    "detailedMessage": "PermitidoNão foi somenteencontrada excluira protocolosdespesa comde osequencial status002 (BOWB1N_STATUSSEQUEN) igualpara o aprotocolo A41750520230607000014 (Solicitação não concluidaBOW_PROTOC)"
}





03. TELA API REFUNDS

Outras Ações / Ações relacionadas

...