| Índice |
|---|
Informações
Avisos
- Só são suportadas integrações no padrão REST.
- O campo "Regra de preenchimento" esclarece quais regras / validações serão aplicadas ou quais os conteúdos serão permitidos ou rejeitados. As ações descritas aqui devem ser implementadas por seus WS, evitando que os conteúdos inválidos sejam criticados pelo nosso sistema de integrações.
...
| Abreviação | 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 |
...
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| integracao | M | Objeto | Informações necessárias para realizar a identificação do beneficiário no sistema. A estrutura aqui enviada será enviada no corpo das demais requisições de integração junto com os dados preenchidos pelo beneficiário no sistema. |
| ano | M | String | Ano do extrato (YYYY) |
| mes | M | String | Mês do extrato (MM) |
Request body
| Bloco de código |
|---|
{
"integracao": {
"<chave>": "<valor>"
},
"ano": "<ano>",
"mes": "<mes>"
} |
Request body
Objetos e atributos de retorno
...
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento | |||||
|---|---|---|---|---|---|---|---|---|---|
| nomeBeneficiario | M | String | Nome do beneficiário que aparecerá no extrato | Formato: Texto livre. | |||||
| matriculaBeneficiario | M | String | Matrícula do beneficiário em seu sistema de gestão | ASCII (nao permite especiais). | |||||
| codigoEvento | M | String | Código do evento a ser exibido no extrato | Formato: Texto livre. | |||||
| descricaoEvento | M | String | Descrição do evento a ser exibido | Formato: Texto livre. | |||||
| dataAtendimento | M | String | Data de execução do serviço / atendimento | Formato: YYYY-MM-DD | |||||
| codigoExecutante | 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. | |||||
| cpfCnpjExecutante | M | Number | Indique o CPF ou CNPJ do executante do serviço | Formato: CPF ou CNPJ. | |||||
| codigoTipoServico | 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 | String | Quantidade executada. | Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99) | |||||
| valorServico | OP | String | Indique o valor individualizado do evento, se houver ou se desejar exibi-lo individualmente. Se não for enviado, apenas será exibida a descrição do evento, sem valor individualizado (RN 389 permite esse comportamento). | Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)
| |||||
| valorCoparticipacao | OP | String | Indique o valor da coparticipação, se houver ou se desejar exibi-la. | Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)
| |||||
| codigoContrato | M | String | Código do contrato do beneficiário. Este código será utilizado para organizar as informações por contrato nas interfaces do produto | O código enviado neste campo deve ter relação com a estrutura de contratos do login do usuário. |
...