...
- 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 | Refunds - Retorna os protocolos de reembolso |
---|
|
Retorna os protocolos de reembolso do beneficiário /totvsHealthPlans/attendance/v1/refunds | |
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 | subscriber-id (query) | string | Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO) | *required | request-date-initial (query) | string (date) | Data inicial de solicitação do protocolo Obrigatório para quando não for informado o query param protocol |
| request-date-final (query) | string (date) | Data final de solicitação do protocolo Obrigatório para quando não for informado o query param protocol |
| 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 |
| 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 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.request-date | string (date) | Data da solicitação | BOW_DTDIGI | *required | items.presented-amount | numeric (double) | Valor apresentado | BOW_VLRAPR | *required | items.refunded-amount | numeric (double) | Valor reembolsado | BOW_VLRREE |
| items.payment-date | string (date) | Data de pagamento do reembolso | BOW_PGMTO |
| items.beneficiary-name | 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",
"request-date": "2023-06-07",
"presented-amount": 250,
"refunded-amount": 0,
"payment-date": "",
"beneficiary-name": "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",
"request-date": "2023-06-07",
"presented-amount": 250,
"refunded-amount": 0,
"payment-date": "",
"beneficiary-name": "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 request-date-initial não informado",
"detailedMessage": "Não foi informado o campo request-date-initial."
},
{
"code": "E001A-406",
"message": "Campo request-date-final não informado",
"detailedMessage": "Não foi informado o campo request-date-final."
},
{
"code": "E001A-406",
"message": "Campo subscriber-id 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)"
} |
|
|
|
...
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 | |
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 |
|
|
Dica |
---|
Expandir |
---|
| 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: | 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)"
} |
|
|
|
Âncora |
---|
| protocolBase64 |
---|
| protocolBase64 |
---|
|
Painel |
---|
titleColor | Orange |
---|
borderStyle | solid |
---|
title | Protocol/base64 - Retorna protocolo do reembolso em arquivo base64 |
---|
|
Retorna o pdf do protocolo de reembolso em arquivo base64. /totvsHealthPlans/attendance/v1/refunds/{protocol}/protocol/base64 | |
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 |
|
|
Dica |
---|
Expandir |
---|
| Body
Não possui body! |
|
Dica |
---|
Expandir |
---|
title | (200) - Operação realizada com sucesso |
---|
| fileName | string | Nome do arquivo em PDF |
| *required | file | string | String do arquivo em base 64 |
| *required |
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"fileName": "protocreembsc043500.pdf",
"file": "JVBERi0xLjMKJbe+raoKMSAwIG9i..."
} |
|
|
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": "Existem chaves obrigatórias que não foram informadas.",
"detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
"details": [
{
"code": "E001-406",
"message": "Chave protocol obrigatória",
"detailedMessage": "Não foi informado no pathParams da requisição a chave protocol."
}
]
} |
|
|
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 não encontrado",
"detailedMessage": "Não foi encontrada na tabela BOW o protocol 41750520230607000099 (BOW_PROTOC)."
} |
|
|
|
03. TELA API REFUNDS
Outras Ações / Ações relacionadas
...