Caso sua empresa deseje exibir informações de coparticipação do beneficiário e de seu grupo familiar, esta API deverá ser implementada.
...
Endpoint | Método | Header Content-Type | Descrição | ||
---|---|---|---|---|---|
/extratoCoparticipacao/extrato
| POST | application/json | Endpoint para listar os registros de coparticipação relacionadas ao localizador (chaveUnica) |
...
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
observacao | OP | String | Informativo a ser exibido para o cliente sobre os dados apresentados a baixo. | Texto livre. |
dataInicioPeriodoApuracao | M | String | Data de inicio da apuração aplicada pelo webservice do cliente. | Formato: YYYY-MM-DD |
dataFimPeriodoApuracao | M | String | Data de fim da apuração aplicada pelo webservice do cliente. | Formato: YYYY-MM-DD |
extrato | M | Array de objetos do tipo “detalheExtrado" | Retornar um array de objetos “detalheExtrato“. |
|
Objeto detalhe extrato
...
Nota |
---|
|
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
idContrato | M | String | Numero do contrato na qual o cliente esta vinculado. |
|
descricaoContrato | M | String | Nome do contrato que aparecerá no extrato. |
|
dataInicioVigenciaContrato | M | String | Data de inicio da vigencia do contrato que aparecerá no extrato. |
|
chaveUnica | M | String | Chave de identificação do usuario. |
|
nomeBeneficiario | M | String | Nome do beneficiário que aparecerá no extrato | Formato: Texto livre. |
idTipoUsuario | M | String | Informe o tipo de usuário | Conteúdo válido: |
codigoProcedimento | M | String | Código do procedimento a ser exibido no extrato | Formato: Texto livre. |
descricaoProcedimento | M | String | Descrição do procedimento a ser exibido | Formato: Texto livre. |
numeroGuia | M | String | numero da guia de registro do serviço/atendimento prestado. | Formato: Texto livre |
dataAtendimento | M | String | Data de execução do serviço / atendimento | Formato: YYYY-MM-DD |
idExecutante | M | String | Código de identificação do prestador executante no seu sistema. | Formato: ASCII (nao permite especiais). |
nomeExecutante | M | String | Nome do prestador executante. | Formato: Texto livre. |
idTipoServico | M | String | Código do tipo de serviço realizado. O código de serviços será utilizado para agrupar os procedimentos e apresentar os subtotais exigidos pela RN 389 | Formato: ASCII (nao permite especiais). Recomenda-se observância à RN 329 |
descricaoTipoServico | M | String | Descrição do tipo de serviço realizado, exemplo: Consultas, Exames/Terapias, Internação, Odontologia, outras despesas, entre outras. Assim como o atributo codigoTipoServico, servirá como agrupador para apresentação de subtotais exigidos pela RN 389. | Formato: Texto livre. Recomenda-se observância à RN 329 |
quantidade | M | Numerico | Quantidade executada. | Numérico |
valorServico | M | Numerico | Indique o valor individualizado do serviço. Poderá definir através da configuração da funcionalidade se deseja exibir o valor por grupo/ individualmente ou apenas o total. (RN 389 permite esse comportamento). | Formato: Numérico. Caso não tenha valor a ser exibido deve informar o valor zerado. Caso não queria exibir deve ajustar a configuração da funcionalidade para este comportamento. |
valorCoparticipacao | M | Numerico | Indique o valor da coparticipação individualizado do serviço. Poderá definir através da configuração da funcionalidade se deseja exibir o valor por grupo/ individualmente ou apenas o total. (RN 389 permite esse comportamento). | Formato: Numérico. Caso não tenha valor a ser exibido deve informar o valor zerado. Caso não queria exibir deve ajustar a configuração da funcionalidade para este comportamento. |
localAtendimento | M | String | Indique o local no qual foi realizado o atendimento | Formato: Texto livre |
...
Aviso |
---|
|
Método "extratoPdf"
Informaçõesnote |
---|
|
...
Endpoint | Método | Header Content-Type | Descrição | ||
---|---|---|---|---|---|
http://exemplo.com/ extratPdf
| POST | application/json |
|
Parâmetros de entrada
...