Declarações
Para disponibilizar extratos de coparticipação, implemente os objetos descritos nesta documentação.
Caso seu SGDB esteja configurado para ser CASE SENSITIVE, crie todos os objetos de bancos de dados em MINÚSCULAS.
Importante: todos os objetos desta documentação são obrigatórios. Não criar um ou mais objetos impossibilitará que a integração via banco de dados OMNILINK seja corretamente realizada.
IMPORTANTE
O Omnilink da total autonomia para as Operadoras, a listagem que será exibida no app/web está diretamente ligada a ordenação da view, caso deseje ordenar por regras de negócio da operadora, faça isso ordenando a view.
Tipo do objeto: View
Nome do objeto: omni_lista_declaracao
Objeto obrigatório: SIM
Informação adicional: implemente esta view para exibir a lista de declarações que deseja exibir.
Estrutura de campos:
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_omni_lista_declaracao | Número | Sim | Atributo do tipo primary key. Este atributo deve ser um número único por registro. |
id_operadora | Número | Sim | Atributo fixo o valor = 1, quanto view for implementado pela operadora. |
id_config_cliente_app | Número | Sim | Atributo fixo no valor = 1, quanto view ou tabela for implementado pela operadora. |
instancia_aplicacao | Texto | Sim | Atributo fixo no valor = '1', quanto view ou tabela for implementado pela operadora. |
id_tipo_declaracao | Texto | Sim | (1=IRPF; 2=Quitacao; 3=Permanencia) |
nome_tipo_declaracao | Texto | Sim | Imposto de renda / Declaração de quitação / Permanência |
chave_unica | Texto | Sim | Chave de identificação única por beneficiário. Não deve se repetir em nenhuma hipótese. |
numero_contrato | Texto | Sim | Número do contrato. Deve ser relacionado ao atributo de numero_contrato da view de beneficiários |
descricao_contrato | Texto | Sim | Nome do contrato que aparecerá no extrato. |
id_declaracao | Texto | Sim | Utilize uma STRING que seja suficiente Exemplo: 2020:IRPF |
titulo_declaracao | Texto | Sim | Exemplo: 2020 |
subtitulo_declaracao | Texto | Sim | Declaração IR - 2020 |
sequencia | Número | Sim | coluna para usar na ordenação |
Tipo do objeto: View
Nome do objeto: omni_detalhe_declaracao
Informação adicional: implemente esta view para exibir os detalhes de declarações de IRPF
IMPORTANTE
As declarações são agrupadas pela chave_unica ou seja, para que dados do grupo familiar de um TITULAR venham a ser incluídos nas declarações, se faz necessário lançar na chave_unica do TITULAR os lançamentos referentes aos seus DEPENDENTES.
Ex:
Beneficiario Titular: chave_unica = 11111111111; numero_contrato = 000001; etc..
Beneficiário Dependente_1 : chave_unica = 11111111111 (deve ser informado a chave_unica do titular para que seja agrupado na declaracao do titular); numero_contrato = 0000001; etc…
Beneficiário Dependente_2 : chave_unica = 11111111111 (deve ser informado a chave_unica do titular para que seja agrupado na declaracao do titular); numero_contrato = 0000001; etc…
Estrutura de campos:
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_omni_detalhe_declaracao | Número | Sim | Atributo do tipo primary key. Este atributo deve ser um número único por registro. |
id_config_cliente_app | Número | Sim | Atributo fixo no valor = 1, quanto view ou tabela for implementado pela operadora. |
id_operadora | Número | Sim | Atributo fixo o valor = 1, quanto view for implementado pela operadora. |
instancia_aplicacao | Texto | Sim | Atributo fixo no valor = '1', quanto view ou tabela for implementado pela operadora. |
id_declaracao | Texto | Sim | Utilize uma STRING que seja suficiente Exemplo: 2020:IRPF (deve ter relação com o mesmo campo da view omni_lista_declaracao) |
chave_unica | Texto | Sim | Chave de identificação única por beneficiário. Não deve se repetir em nenhuma hipótese. |
numero_contrato | Texto | Sim | Número do contrato. Deve ser relacionado ao atributo de numero_contrato da view de beneficiários |
descricao_contrato | Texto | Sim | Nome do contrato que aparecerá no extrato. |
cpf_pagador | Texto | Sim | cpf do pagador |
matricula_pagador | Texto | Sim | matricula do pagador |
nome_pagador | Texto | Sim | nome do pagador |
id_evento_agrupador | Texto | Sim | 1=Mensalidade; 2=Coparticipação; 3=Reembolso |
descricao_evento_agrupador | Texto | Sim | Indique um texto para exibir o agrupamento (Mensalidade, Coparticipação, Reembolso) |
observacao_evento_agrupador | Texto | Não | Texto livre |
matricula_beneficiario | Texto | Não | Exemplo: 00010001000001000 Critério de uso: se informado, será concatenado em cada linha com o conteúdo do campo descricao_evento |
nome_beneficiario | Texto | Não | Nome do beneficiário. Critério de uso: se informado, será concatenado em cada linha com o conteúdo do campo descricao_evento |
detalhe_beneficiario | Texto | Não | texto livre para complementar a informação do beneficiário. Será concatenado ao nome do beneficiario. Exemplo: - Titular. Critério de uso: se informado, será concatenado em cada linha com o conteúdo do campo descricao_evento |
descricao_evento | Texto | Sim | Preencha com o texto que será exibido em cada linha do extrato. Ele será agrupado em cada evento agrupador. Este texto também será utilizado como conteúdo inicial, para depois ser concatenado com os campos matricula_beneficiario, nome_beneficiario e detalhe_beneficiario. Exemplo: assuma que uma linha da view tenha os seguintes conteúdos: descricao_evento = “Mensalidade 02/2023” matricula_beneficiario = “1010” nome_beneficiario = “João da Silva” detalhe_beneficiario = “Titular” Será impressa na linha da seguinte forma “Mensalidade 02/2023 - 1010 - João da Silva - Titular” |
valor_1 | Numérico | Sim | Coluna 1 de valores. Informe os valores a serem informados nessa coluna, com pontos decimais. |
titulo_valor_1 | Texto | Sim | Descrição da coluna 1. Exemplo: Mensalidade |
totaliza_valor_1 | Texto | Sim | Deve-se inserir um totalizador nessa coluna? 0 = Não; 1 = Sim |
valor_2 | Numérico | Não | Coluna 2 de valores. Informe os valores a serem informados nessa coluna, com pontos decimais. |
titulo_valor_2 | Texto | Não | Descrição da coluna 2. Exemplo: Valores reembolsados |
totaliza_valor_2 | Texto | Não | Deve-se inserir um totalizador nessa coluna? 0 = Não; 1 = Sim |
valor_3 | Numérico | Não | Coluna 3 de valores. Informe os valores a serem informados nessa coluna, com pontos decimais. |
titulo_valor_3 | Texto | Não | Descrição da coluna 3. Exemplo: Valores a declarar |
totaliza_valor_3 | Texto | Não | Deve-se inserir um totalizador nessa coluna? 0 = Não; 1 = Sim |
valor_4 | Numérico | Não | Coluna 4 de valores. Informe os valores a serem informados nessa coluna, com pontos decimais. |
titulo_valor_4 | Texto | Sim | Descrição da coluna 4. Exemplo: Valores a declarar |
totaliza_valor_4 | Texto | Sim | Deve-se inserir um totalizador nessa coluna? 0 = Não; 1 = Sim |
IMPORTANTE
O Omnilink da total autonomia para as Operadoras, a listagem que será exibida no app/web está diretamente ligada a ordenação da view, caso deseje ordenar por regras de negócio da operadora, faça isso ordenando a view.
Tipo do objeto: View
Nome do objeto: omni_dados_cedente
Informação adicional: view obrigatória, que tem correlação com a view de omni_debito. Nesta view, informe os dados do cedente para obtenção de dados relacionados ao responsável financeiro.
Estrutura de campos:
Essa view está descrita em outra documentação. Para acesso à sua estrutura, siga esse link:
Tipo do objeto: View
Nome do objeto: omni_declaracao_textos
Informação adicional: implemente esta view para exibir os textos das declarações de IRPF
Estrutura de campos:
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_omni_detalhe_declaracao | Número | Sim | Atributo do tipo primary key. Este atributo deve ser um número único por registro. |
id_config_cliente_app | Número | Sim | Atributo fixo no valor = 1, quanto view ou tabela for implementado pela operadora. |
id_operadora | Número | Sim | Atributo fixo o valor = 1, quanto view for implementado pela operadora. |
instancia_aplicacao | Texto | Sim | Atributo fixo no valor = '1', quanto view ou tabela for implementado pela operadora. |
id_declaracao | Texto | Sim | Utilize uma STRING que seja suficiente Exemplo: 2020:IRPF (deve ter relação com o mesmo campo da view omni_lista_declaracao) |
chave_unica | Texto | Sim | Chave de identificação única por beneficiário. Não deve se repetir em nenhuma hipótese. |
numero_contrato | Texto | Sim | Número do contrato. Deve ser relacionado ao atributo de numero_contrato da view de beneficiários |
descricao_contrato | Texto | Sim | Nome do contrato que aparecerá no extrato. |
texto_titulo | Texto | Sim | Informe um texto para o título da declaração |
texto_cabecalho | Texto | Sim | Informe um cabeçalho para o título da declaração |
texto_rodape | Texto | Sim | Informe um cabeçalho para a declaração |
Related content
Mobile Saúde - Mosia Omnichannel