CONTEÚDO
- 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
01. VISÃO GERAL
API para a entidade refunds (Reembolsos) do produto TOTVS Saúde Planos Linha Protheus.
...
Informações |
---|
title | Nomenclatura das APIs |
---|
|
Para nome composto, as APIs utilizam o padrão camelCase e quando a houver paginação será utilizado o padrão tudo minúsculo separado por hífen para os campos dentro do array items |
02. EXEMPLO DE UTILIZAÇÃO
...
Painel |
---|
titleColor | Orange |
---|
borderStyle | solid |
---|
title | Attachments - Deleta um anexo do protocolo de reembolso |
---|
|
Deleta um anexo do protocolo de reembolso com o status de solicitação não concluída. /totvsHealthPlans/attendance/v1/refunds/{protocol}/attachments/{code} | |
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 (BOW_PROTOC) | *required | code (path) | string | Código do anexo (ACB_CODOBJ) | *required |
|
|
Dica |
---|
Expandir |
---|
| 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 |
---|
| 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 path param estão invá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 code obrigatório",
"detailedMessage": "Não foi informado valor do campo code."
},
{
"code": "E001E-406",
"message": "Tamanho inválido para o campo code",
"detailedMessage": "O valor do campo code deve ter o tamanho 10."
}
]
} |
|
|
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 o protocolo de reembolso 41750520230607000099 (BOW_PROTOC) 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. |
|
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"code": "E003",
"message": "Não foi possível excluir o anexo pois a solicitação já esta protocolada, entre em contato com a operadora",
"detailedMessage": "Permitido somente excluir anexos para protocolos com o status (BOW_STATUS) igual a A (Solicitação não concluida)"
} |
|
|
Aviso |
---|
Expandir |
---|
title | (404) - Anexo 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": "Anexo não encontrada para o protocolo de reembolso 41750520230607000012",
"detailedMessage": "Não foi encontrada o anexo de código 0000000999 (ACB_CODOBJ) para o protocolo 41750520230607000012 (BOW_PROTOC)"
} |
|
|
|
03. TELA API REFUNDS
Outras Ações / Ações relacionadas
Ação | Descrição |
---|
Não se aplica | Não se aplica |
04. TELA API REFUNDS
Principais Campos e Parâmetros
Campo | Descrição |
---|
BOW_PROTOC | Numero do protocolo do reembolso no sistema |
BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO | Matricula do beneficiário |
BOW_STATUS | Status do Protocolo |
B1N_SEQUEN | Sequencial da despesa no protocolo |
ACB_CODOBJ | Código do anexo no sistema |
05. TABELAS UTILIZADAS
- Protocolo de Reembolso (BOW)
- Itens do Protocolo de Reembolso (B1N)
- Operadoras de Saúde (BA0)
- Beneficiários (BA1)
- Famílias (BA3)
- Tipo Documento Reembolso (BBS)
- Munícipios (BID)
- Bancos de Conhecimentos (ACB)
- Relação de Objetos x Entidades (AC9)
- Processamento de Contas (BD5)
- Eventos Processamentos Contas (BD6)
- Part. Honorários Prestado Itens (BD7)
- Mot. Exc. Protoc. Reembolso (B14)
- Cab. Cad. Receitas (B4F)
- Receitas Medicamento x Usuário (B7D)
- Produtos de Saúde (BI3)
- Tabela Padrão (BR8)
- Contas a Receber (SE1)
- Contas a Pagar (SE2)
...