Árvore de páginas

Versões comparadas

Chave

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

...

Painel
titleColorOrange
borderStylesolid
titleReasonDenied - Retorna o motivo de negação da despesa 

Retorna o motivo de glosa da despesa

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

GET

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 de reembolso*required
sequential (path)stringSequencial da despesa no protocolo*required
Dica
Expandir
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
datestringData do motivoB14_DATA*required
reasonstringDescrição do motivo de glosa B14_MOTIVO*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "date": "2023-06-07",
    "reason": "Motivo de ter negado a despesa"
}
Aviso
Expandir
title(406) - Parâmetros obrigatórios
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": "As chave do path param está inválida",
    "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": "E002",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado nenhum protocolo de reembolso com o numero 41750520230607000088 (BOW_PROTOC)"
}
Aviso
Expandir
title(404) - Despesa não encontrada
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": "E003",
    "message": "Despesa não encontrada para o protocolo de reembolso 41750520230607000006",
    "detailedMessage": "Não foi encontrada a despesa de sequencial 002 (B1N_SEQUEN) para o protocolo 41750520230607000006 (BOW_PROTOC)"
}
Aviso
Expandir
title(404) - Motivo 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": "Não encontrada motivo de glosa para a despesa",
    "detailedMessage": "Não foi encontrada nenhum motivo de glosa do sequencial 001 (B1N_SEQUEN) para o protocolo 41750520230607000015 (BOW_PROTOC) na tabela B14"
}

Âncora
#attachmentsGet
#attachmentsGet


Painel
titleColorOrange
borderStylesolid
titleattachments - Retorna os anexos do protocolo de reembolso

Retorna os protocolos de reembolso do beneficiário

/totvsHealthPlans/attendance/v1/refunds/{protocol}/attachments

GET

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 de reembolso (BOW_PROTOC)*required
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
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsnumeric (integer)Quantidade de registros ainda existem para retorno
*required
itemsarrayLista de anexos do protocolo

items.codestring

Código do anexo no sistema

ACB_CODOBJ*required
items.filestringNome do arquivo com extensãoACB_OBJETO*required
items.descriptionstringNome do arquivoACB_DESCRI*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "items": [
        {
            "code": "0000000282",
            "file": "TOTVS-E1652279934109_2023_06_02_18_31_03.JPG",
            "description": "totvs-e1652279934109_2023_06_02_18_31_03"
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}
Aviso
Expandir
title(406) - Parâmetros obrigatórios
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": "A chave do path param está inválida",
    "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."
        }
    ]
}
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": "E002",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado nenhum protocolo de reembolso com o numero 41750520230602000070 (BOW_PROTOC)"
}

...