6.2 - Detalhe extrato de reembolso

1 Método "detalheReembolso"
- 1.1 Endpoint
- 1.2 Parâmetros de entrada
- 1.3 Exemplo request
- 1.4 Descrição dos objetos e atributos de retorno - sucesso
- 1.5 Retorno da API - Sucesso
- 1.6 Retorno da API - Falha

Só são suportadas integrações no padrão REST.

Método "detalheReembolso"

Este método é obrigatório;
Atente-se aos critérios de preenchimento;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
http://exemplo.com/detalheDebito /detalheReembolso Atenção O endpoint obrigatoriamente deve terminar com “/detalheReembolso”.	POST	application/json	Endpoint para listar os registros de utilização relacionadas ao localizador (chaveUnica)

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Serão enviados no BODY os seguintes parâmetros:

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
idReembolso	M	Number	Id de banco de dados da título no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu do atributo idReembolso do método listaReembolsos
numeroGuiaReembolso	M	String	Número da guia de registro do serviço. O aplicativo irá enviar a mesma informação que recebeu do atributo numeroGuiaReembolso do método listaReembolsos
chaveUnica	M	String	Chave de identificação do usuário retornada no login
integracao	OP	Objeto	Nó integração retornado no login do usário

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/extratoReembolso/detalheReembolso

Body:
{
  "integracao": {
        "xpto": "voluptatibus",
        "xyz": "quibusdam",
        "abcdef": 9288701
      },
  "idReembolso": "Number",
  "numeroGuiaReembolso": "String",
  "chaveUnica": "String"
}

Descrição dos objetos e atributos de retorno - sucesso

Está indicado abaixo a estrutura de retorno do seu método listaReembolsos. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

Objeto principal

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
idTipoServico	String	String
descricaoTipoServico	M	String	Descrição do tipo de serviço realizado, exemplo: Consultas, Exames/Terapias, Internação, Odontologia, outras despesas, entre outras.	Formato: Texto livre.
idReembolso	M	Number	Id de banco de dados do título no seu sistema interno.	Se o seu sistema exigir o id do título como chave para localizar o mesmo nos demais métodos, este campo deverá ser considerado obrigatório. Somente números inteiros (Não podem existir letras, espaços em branco, ou pontos decimais).
numeroGuiaReembolso	M	String	Número da guia de registro do serviço/atendimento prestado.	Formato: Texto livre.
numeroProtocolo	M	Number	Número de protocolo gerado pelo pedido de reembolso
numeroContrato	M	String	Número que identifica a qual contrato esse reembolso está vinculado
chaveUnica	M	String	Chave de identificação do usuario.
nomeBeneficiario	M	String	Nome do beneficiário que aparecerá no extrato	Formato: Texto livre.
idTipoBeneficiario	M	String	Informe o tipo de beneficiário	Conteúdo válido: T = Titular D = Dependente A = Agregado Apenas maiúsculos.
situacao	M	Objeto	Objeto que indica a situação de pagamento atual do boleto.	Obrigatório o preenchimento conforme objeto "situacao" descrito posteriormente.
dataSolicitacao	M	String	Data de solicitação do reembolso	Formato: YYYY-MM-DD HH:MM:SS
dataPrevisaoPagamento	OP	String	Data prevista para o pagamento do reembolso	Formato: YYYY-MM-DD
valorTotalSolicitado	M	Float	Valor solicitado do reembolso (Numérico, 2 posições decimais)	Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)
valorTotalReembolsado	M	Float	Valor total reembolsado (Numérico, 2 posições decimais)	Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)
valorTotalGlosado	M	Float	Valor total glosado (Numérico, 2 posições decimais)	Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)
despesas	M	Array	Array de objetos que indica as despesas do pedido de reembolso	Obrigatório o preenchimento conforme objeto "despesa" descrito posteriormente.
complementos	OP	Array	Array de objetos que indica informações complementares relativa ao pagamento do reembolso	Opcional, caso seja preenchido, o mesmo deve estar em conformidade ao objeto "complemento" descrito posteriormente.

Objeto situacao

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

id

M

String

Código ou ID que represente o status do débito no seus sistema.

descricao

M

String

Objeto que indica a situação do pedido de reembolso.

“Aprovado”, “Solicitado”, “Recusado”

cor

M

String

cor da label a ser exibida.

Hexadecimal. com o #. da cor que deseja que seja usada para representar a situação do reembolso.

Ex.: #FF0000

Objeto despesa

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
data	M	String	Data da despesa	Formato: YYYY-MM-DD
cpfCnpjExecutante	M	String	CPF/CNPJ do prestador que executou o serviço
nomeExecutante	M	String	Nome do prestador que executou o serviço
tipoDocumento	M	String	Tipo de documento enviado como comprovante de execução do serviço: Ex: "Nota Fiscal", “Recibo"
numeroDocumento	M	String	Número do documento de comprovação de execução de serviço
valorApresentado	M	Float	Valor apresentado no documento de despesa (Numérico, 2 posições decimais)	Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)
valorReembolso	OP	Float	Valor reembolsado da despesa (Numérico, 2 posições decimais)	Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)
valorGlosado	OP	Float	Valor glosado da despesa (Numérico, 2 posições decimais)	Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)
observacao	OP	String	Mensagem de observação do analista do reembolso	Formato: Texto livre.
situacao	M	Objeto	Objeto que indica a situação do pedido de reembolso.	Obrigatório o preenchimento conforme objeto "situacao" descrito anteriormente.
anexos	OP	Objeto	Objeto de anexos enviados do pedido de reembolso	Opcional, caso seja preenchido, o mesmo deve estar em conformidade ao objeto "anexo" descrito posteriormente.

Objeto anexo

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

descricao

M

String

Descrição do anexo

Ex: Nota fiscal,

Formato: Texto livre.

url

M

String

url do anexo

Formato: Texto livre.

Objeto complementos

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
titulo	M	String	Titulo do complemento	Formato: Texto livre.
campos	M	Objeto	Objeto com titulo e valor descrito posteriormente	Obrigatório o preenchimento conforme objeto "campo" descrito posteriormente

Objeto campo

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
titulo	M	String	Titulo do campo a ser exibido como label	Formato: Texto livre.
valor	M	String	Valor do campo	Formato: Texto livre

Retorno da API - Sucesso

{
	"idTipoServico": "01918",
	"descricaoTipoServico": "Consulta",
    "numeroContrato": "81479280632",
	"idReembolso": "xptoyxz",
	"numeroGuiaReembolso" : "YPXTOYXZZZ",
	"numeroProtocolo" : "19172918jsjs817171",
	"chaveUnica": "10101012",
	"nomeBeneficiario": "Geraldo Felix",
	"idTipoBeneficiario" : "T",
	"situacao" : {
		"id" : "xyz",
		"descricao" : "Aprovado",
		"cor" : "#71J171J"		
	},
	"dataSolicitacao": "2021-03-01 12:07:46",
	"dataPrevisaoPagamento" : "2021-01-01",
	"valorTotalSolicitado" : 129.00,
	"valorTotalReembolsado" : 129.00,
	"valorTotalGlosado" : 0.00,
	"despesas" : [
		{
			"data" : "2021-01-01",
			"cpfCnpjExecutante" : "18181818181",
			"nomeExecutante" : "Nome do prestador",
			"tipoDocumento" : "Nota Fiscal",
			"numeroDocumento" : "1627",			
			"valorApresentado" : 100.00,
			"valorReembolso" : 29.00,
			"valorGlosado" : 0.00,
			"observacao" : "teste teste teste",
			"situacao" : {
				"id" : "xyz",
				"cor": "#5BCE5B",
				"descricao" : "Aprovado"
			},			
			"anexos" : [
				{
					"descricao" : "nota fiscal",
					"url" : "https://www.url.com.br/imagem.jpg"
				}
			]
		}
	],
	"complementos" : [
		{
			"titulo" : "Dados Bancarios",
			"campos" : [
				{ 
					"titulo" : "Banco",
					"valor" : "Banco do Brasil"
				},
				{
					"titulo" : "Tipo de conta",
					"valor" : "Conta corrente"	
				},
				{
					"titulo" : "Agencia",
					"valor" : "10121"						
				}
			]
		}
	]
}

6.2 - Detalhe extrato de reembolso

Método "detalheReembolso"

Endpoint

Parâmetros de entrada

Exemplo request

Descrição dos objetos e atributos de retorno - sucesso

Retorno da API - Sucesso

Retorno da API - Falha