Histórico da Página

...

Visão Geral
Exemplo de utilização
1. Refunds - Inclusão de um protocolo de reembolso
2. Refunds - Retorna os protocolos de reembolso
3. Refunds - Deleta um protocolo de reembolso
4. Send - Envia protocolo de reembolso não finalizado
5. Protocol/base64 - Retorna protocolo do reembolso em arquivo base64
6. Expenses - Retorna as despesas do protocolo de reembolso
7. Expenses - Deleta uma despesa do protocolo de reembolso
8. Expenses - Inclusão de um nova despesa ao protocolo de reembolso
9. Expenses - Altera despesa do protocolo de reembolso
10. ReasonDenied - Retorna o motivo de negação da despesa
11. attachments - Retorna os anexos do protocolo de reembolso
12. attachments - Inclusão de novos anexos ao protocolo de reembolso
13. attachments - Deleta um anexo do protocolo de reembolso
Tela api refunds
1. Outras Ações / Ações relacionadas
Tela api refunds
1. Principais Campos e Parâmetros
Tabelas utilizadas

...

Painel

titleColor	Orange
borderStyle	solid
title	attachments - Retorna os anexos do protocolo de reembolso

Retorna os anexos no banco de conhecimento do protocolo de reembolso informado.

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

GET

Nota

Expandir

title	Parameters

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)	string	Numero 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

title	Request

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)"
}

Âncora

	attachmentsPost
	attachmentsPost

Painel

titleColor	Orange
borderStyle	solid
title	attachments - Inclusão de novos anexos ao protocolo de reembolso

Realiza a inclusão de anexos ao protocolo de reembolso com o status de solicitação não concluída.

/totvsHealthPlans/attendance/v1/refunds/attachments

POST

Nota

Expandir

title	Parameters

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

Dica

Expandir

title	Request

protocol	string	Numero do protocolo de reembolso	BOW_PROTOC	*required
attachments	array	Lista de anexos a serem adicionados ao protocolo		*required
attachments.href	string	URL do arquivo para download		*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "protocol" : "41750520230607000012",
    "attachments" : [
        {
            "href" : "https://www.totvs.com/wp-content/uploads/2021/04/totvs-shared.png"
        },
        {
            "href" : "https://www.totvs.com/wp-content/uploads/2022/03/sistema-de-gestao-erp-protheus-01-financeiro.jpg"
        }
    ]
}

Dica

Expandir

title	(201) - 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": "0000000410",
            "file": "TOTVS-SHARED_2023_06_07_15_09_46.PNG",
            "description": "totvs-shared_2023_06_07_15_09_46"
        },
        {
            "code": "0000000447",
            "file": "TOTVS-SHARED_2023_06_12_15_31_25.PNG",
            "description": "totvs-shared_2023_06_12_15_31_25"
        },
        {
            "code": "0000000448",
            "file": "SISTEMA-DE-GESTAO-ERP-PROTHEUS-01-FINANCEIRO_2023_06_12_15_31_25.JPG",
            "description": "sistema-de-gestao-erp-protheus-01-financeiro_2023_06_12_15_3"
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

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: >>{\r\n            \"href\" : \"https://www.totvs.com/wp-content/uploads/2022/03/sistema-de-gestao-erp-protheus-01-financeiro.jpg\"\r\n        }\r\n    ]\r\n}<<"
}

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": "E002E-406",
            "message": "Tamanho inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ter o tamanho 20."
        },
        {
            "code": "E002B-406",
            "message": "Campo attachments obrigatório",
            "detailedMessage": "Não foi informado valor do campo attachments."
        }
    ]
}

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": "E003",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado nenhum protocolo de reembolso com o numero 41750520230607000099 (BOW_PROTOC)"
}

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": "E007",
    "message": "Permitido anexar documentos no protocolo somente no status de solicitação não concluida e aguardando informação do beneficiário",
    "detailedMessage": "Permitido somente anexar documentos no protocolo com o status (BOW_STATUS) igual a A (Solicitação não concluida) ou B (Aguardando informação do beneficiário)"
}

Aviso

Expandir

title	(400) - Dados do protocolo 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": "E006",
    "message": "Dados inválidos para realizar a inclusão dos anexos",
    "detailedMessage": "Verifique os detalhes dos erros no campo details",
    "details": [
        {
            "code": "E005-400",
            "message": "Erro ao realizar download do arquivo.",
            "detailedMessage": "Status code: 404; Erro: Not Found\r\n; Url: https://www.totvs.com/wp-content/uploads/2021/09/totvs-shared.png"
        }
    ]
}

03. TELA API REFUNDS

Outras Ações / Ações relacionadas

...

Árvore de páginas

Versões comparadas

Versão antiga 59

Nova versão 60

Chave

03. TELA API REFUNDS