Comparação de Páginas

http://exemplo.com/detalheDebito /detalheReembolso

POST

application/json

Endpoint para listar os registros de utilização relacionadas ao localizador (chaveUnica)

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

dataPrevisaoPagamento

MOP

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

MOP

Array

Array de objetos que indica informações complementares relativa ao pagamento do reembolso

Obrigatório o preenchimento conforme Opcional, caso seja preenchido, o mesmo deve estar em conformidade ao objeto "complemento" descrito posteriormente.

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

MOP

Float

Valor reembolsado da despesa (Numérico, 2 posições decimais)

Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)

valorGlosado

MOP

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.