...
CRITÉRIOS DE PREENCHIMENTO
Atributo | Nome | Descrição |
---|---|---|
M | Mandatório | O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado. |
C | Condicional | O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado. |
OP | Opcional | Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array |
Lista de métodos que serão descritos:
...
O webservice deverá receber os dados de identificação do beneficiário e retornar os seus protocolos de reembolso e, conforme tipo de usuário, retornar também os protocolos do seu grupo familiar.
Se o beneficiário solicitado for o titular, retornar os seus protocolos e de todo o grupo familiar
Se o beneficiário solicitado for um dependente, retornar apenas os seus próprios protocolos de reembolsos
Opcionalmente, o webservice poderá receber uma data inicial e final e retornar todos os protocolos de reembolso existentes no período.
Se os parâmetros Data Inicial e Final não forem informados, retorne uma lista com a quantidade de protocolos que desejar, como por exemplo, os protocolos dos últimos 12 meses.
Parâmetros de entrada
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
chaveBeneficiario | M | String | Chave única do beneficiário no seu sistema de gestão. | Formato de texto livre. |
dataInicial | OP | Date | Data inicial do extrato de reembolso | Formato:” YYYY-MM-DD” |
dataFinal | OP | Date | Data final do extrato de reembolso | Formato:” YYYY-MM-DD” |
Estrutura de retorno
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
status | M | Boolean | True = indica que a requisição foi bem sucedida False = Indica que a requisição foi mal sucedida | true |
motivoCritica | C | String | Quando o status for igual a False, envie nesta propriedade o motivo pelo qual não foi possível realizar a requisição. | Este campo é obrigatório quando o status igual a False Formato: texto livre. |
extrato | M | Array de objetos “extrato” | Retornar uma lista de objetos “extrato“ (definição abaixo) |
Definição da estrutura “extrato”
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
chaveReembolso | M | String | Chave única de identificação do reembolso. Essa chave será utilizada nos demais métodos para identificar o registro. | Formato de texto livre |
beneficiarioMatricula | M | String | Código da matricula do beneficiário | Formato de texto livre |
beneficiarioNome | M | String | Nome completo do beneficiário | Formato de texto livre |
statusId | M | Integer | Código do status do protocolo, conforme tabela de domínio descrita no método status_reembolso | Numérico |
cidade | OP | String | Nome da cidade onde o evento foi executado | Formato de texto livre |
estado | OP | String | Nome do estado onde o evento foi executado | Formato de texto livre |
dataInclusao | M | Date | Data de inclusão do reembolso | Formato aceito: YYYY-MM-DD |
previsaoPagamento | C | Date | Data de previsão de pagamento do reeembolso, quando aprovado | Formato aceito: YYYY-MM-DD |
prestadorCodigo | OP | String | Data de inclusão do reembolso | Formato de texto livre |
prestadorNome | M | String | Nome do prestador | Formato de texto livre |
prestadorCpfCnpj | M | String | CPF ou CNPJ do prestador | |
tipoServicoId | OP | String | Código que identifica o tipo de guia de reembolso no seu sistema de gestão, por exemplo. | |
tipoServicoDescricao | OP | String | Descrição do tipo de serviço | Formato de texto livre |
valorApresentado | M | Double | Valor total apresentado do protocolo / guia de reembolso | Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99) |
valorReembolsado | C | Double | Valor total que será reembolso neste protocolo / guia de reembolso. Esse campo deverá ser enviado quando o reembolso estiver aprovado e o valor tiver sido apurado pelo sistema de gestão | Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99) |
observacao | OP | Text | Texto livre para envio de informações. Envie por exemplo o motivo pelo qual o reembolso foi negado. |
Método “detalheReembolso“
...
O webservice deverá receber a chave do reembolso e retornar os dados complementares do protocolo / guia.
Parâmetros de entrada
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
chaveReembolso | OP | String | Chave do reembolso no seu sistema de gestão. |
Estrutura de retorno
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
status | M | Boolean | True = indica que a requisição foi bem sucedida False = Indica que a requisição foi mal sucedida | true |
motivoCritica | C | String | Quando o status for igual a False, envie nesta propriedade o motivo pelo qual não foi possível realizar a requisição. Este campo é obrigatório quando o status igual a False | Formato de texto livre |
itens | M | Array de objetos “item” | Retornar uma lista de objetos “item“ (definição abaixo) | |
documentos | OP | Array de objetos “documento” | Retornar uma lista de objetos “documento“ (definição abaixo) contendo informações sobre os anexos contidos no protocolo/guia de reembolso e que devem ser disponibilizados ao usuário. Você pode utilizar esse recurso para demonstrar comprovantes e documentos digitalizados |
Definição da estrutura “item”.
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
itemId | M | String | Chave única do item do protocolo/guia de reembolso | Formato de texto livre |
procedimento | M | String | Código do procedimento | Formato de texto livre |
procedimentoDescricao | M | String | Descrição do procedimento | Formato de texto livre |
statusId | M | Integer | Código do status do item, conforme tabela de domínio descrita no método status_reembolso | Numérico |
cidade | OP | String | Nome da cidade onde o evento foi executado | Formato de texto livre |
estado | OP | String | Nome do estado onde o evento foi executado | Formato de texto livre |
dataExecucao | M | Date | Data da execução do procedimento | Formato aceito: YYYY-MM-DD |
documentoTipo | OP | String | Descrição do tipo de documento apresentado pelo beneficiário para justificar a execução do procedimento, por exemplo: Nota Fiscal; Recibo simples... | Formato de texto livre |
documentoNumero | OP | String | Número do documento apresentado | Formato de texto livre |
quantidadeExecutada | M | Float | Quantidade executada | Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99) |
valorApresentado | M | Double | Valor apresentado do item | Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99) |
valorReembolsado | C | Double | Valor que será reembolso para este item. Esse campo deverá ser enviado quando o reembolso estiver aprovado e o valor tiver sido apurado pelo sistema de gestão | Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99) |
observacao | OP | String | Texto livre para envio de informações. Envie por exemplo o motivo pelo qual o item teve o reembolso negado. | Formato de texto livre. |
Definição da estrutura “documento”
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
nomeApresentacao | OP | String | Nome de apresentação ao usuário | Formato de texto livre. |
nomeArquivo | M | String | Nome do arquivo com a extensão, exemplo: imagem01.jpg | |
caminhoArquivo | M | String | Url do caminho do arquivo, exemplo: http://www.seudominio.com.br/documentos/reembolso/ |
Método “historicoReembolso”
...
O webservice deverá receber a chave única do reembolso e retornar o histórico de evolução e alteração de status do protocolo/guia de reembolso
Parâmetros de entrada
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
chaveReembolso | M | String | Chave do reembolso no seu sistema de gestão. | Formato de texto livre |
Estrutura de retorno
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
status | M | Boolean | True = indica que a requisição foi bem sucedida False = Indica que a requisição foi mal sucedida | true. |
motivoCritica | C | String | Quando o status for igual a False, envie nesta propriedade o motivo pelo qual não foi possível realizar a requisição. Este campo é obrigatório quando o status igual a False | Formato de texto livre |
historico | M | Array | Array de objetos “historico” |
Definição da propriedade “historico“
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
dataHora | M | Date Time | Data e hora da movimentação | formato aceito: “YYYY-MM-DD |
HH:mm: |
ss“ | ||||
statusId | M | String | Status da movimentação. O código de status deve existir na tabela de domínio retornada pelo método status_reembolso | formato de texto livre |
Método “statusReembolso“
Descrição do método
...
Não é necessário enviar parâmetros para este método
Estrutura de retorno
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
status | M | Boolean | True = indica que a requisição foi bem sucedida False = Indica que a requisição foi mal sucedida | true |
motivoCritica | C | String | Quando o status for igual a False, envie nesta propriedade o motivo pelo qual não foi possível realizar a requisição. Este campo é obrigatório quando o status igual a False | Formato de texto livre |
reembolsoStatus | M | Array de objetos “status“ | Retornar uma lista de objetos “status “ (definição abaixo) |
Definição da estrutura “status”
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
chaveStatus | M | String | Chave única de identificação do status de reembolso | formato de texto livre |
descricao | M | String | Descrição do status | formato de texto livre |