...
- Visão Geral
- Exemplo de utilização
- Refunds - Inclusão de um protocolo de reembolso
- Refunds - Retorna os protocolos de reembolso
- Refunds - Deleta um protocolo de reembolso
- Send - Envia protocolo de reembolso não finalizado
- Protocol/base64 - Retorna protocolo do reembolso em arquivo base64
- Expenses - Retorna as despesas do protocolo de reembolso
- Expenses - Deleta uma despesa do protocolo de reembolso
- Expenses - Inclusão de um nova despesa ao protocolo de reembolso
- Expenses - Altera despesa do protocolo de reembolso
- ReasonDenied - Retorna o motivo de negação da despesa
- attachments - Retorna os anexos do protocolo de reembolso
- attachments - Inclusão de novos anexos ao protocolo de reembolso
- attachments - Deleta um anexo do protocolo de reembolso
- Tela api refunds
- Outras Ações / Ações relacionadas
- Tela api refunds
- Principais Campos e Parâmetros
- Tabelas utilizadas
...
Painel |
---|
titleColor | Orange |
---|
borderStyle | solid |
---|
title | ReasonDenied - Retorna o motivo de negação da despesa |
---|
|
Retorna o motivo de glosa da despesa /totvsHealthPlans/attendance/v1/refunds/{protocol}/expenses/{sequential}/reasonDenied | |
Nota |
---|
Expandir |
---|
| Authorization (header) | | Cabeçalho usado para autorização das requisições (Bearer token) | *required | Content-Type (header) | | 'application/json' é o formato do conteúdo | *required | protocol (path) | string | Numero do protocolo de reembolso | *required | sequential (path) | string | Sequencial da despesa no protocolo | *required |
|
|
Dica |
---|
Expandir |
---|
| Body
Não possui body! |
|
Dica |
---|
Expandir |
---|
title | (200) - Operação realizada com sucesso |
---|
| date | string | Data do motivo | B14_DATA | *required | reason | string | Descrição do motivo de glosa | B14_MOTIVO | *required |
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"date": "2023-06-07",
"reason": "Motivo de ter negado a despesa"
} |
|
|
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 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 |
---|
| 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": "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 |
---|
| 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": "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 |
---|
| 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": "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"
} |
|
|
|
Painel |
---|
titleColor | Orange |
---|
borderStyle | solid |
---|
title | attachments - Retorna os anexos do protocolo de reembolso |
---|
|
Retorna os protocolos de reembolso do beneficiário /totvsHealthPlans/attendance/v1/refunds/{protocol}/attachments | |
Nota |
---|
Expandir |
---|
| Authorization (header) | | Cabeçalho usado para autorização das requisições (Bearer token) | *required | Content-Type (header) | | 'application/json' é o formato do conteúdo | *required | protocol (path) | string | Numero do protocolo de reembolso (BOW_PROTOC) | *required | page (query) | | Valor numérico (maior que zero) representando a página solicitada |
| pageSize (query) | | Valor numérico (maior que zero) representando o total de registros retornados na consulta |
| order (query) | | Lista de campos para ordenação, separada por virgula (,). |
| fields (query) | | Lista com o nome das propriedades JSON que serão retornadas. |
| filter (query) | | Filtros seguindo o padrão ODATA |
|
|
|
Dica |
---|
Expandir |
---|
| 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 anexos do protocolo |
|
| items.code | string | Código do anexo no sistema | ACB_CODOBJ | *required | items.file | string | Nome do arquivo com extensão | ACB_OBJETO | *required | items.description | string | Nome do arquivo | ACB_DESCRI | *required |
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"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 |
---|
| 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": "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 |
---|
| 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": "Protocolo de reembolso não encontrado",
"detailedMessage": "Não foi encontrado nenhum protocolo de reembolso com o numero 41750520230602000070 (BOW_PROTOC)"
} |
|
|
|
03. TELA API REFUNDS
Outras Ações / Ações relacionadas
...