Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  1. Visão Geral
  2. API x Pontos UPC Relacionados
  3. JSON de metadata
  4. Especificidades de customização
    1. Tela - Formulário de Apurações

    2. Tela - Formulário de Valores

    3. Tela - Formulário de Informações Adicionais

    4. Tela - Formulário de Documentos

    5. Tela - Formulário de Recolhimento

    6. Tela - Formulário de Pagamentos

    7. Tela - Formulário de Valores Declaratórios

      Listagem Parâmetros Estabelecimento x GNRE Tela - Novo/Editar Parâmetros Estabelecimento x GNRE 

  5. Observações Gerais

01. Visão Geral 
Âncora
1
1

Este documento tem como objetivo descrever o que poderá ser customizado detalhar as possibilidades de personalização na tela HTML do programa Apuração de Impostos (html.taxAssessment)
Aqui será descrito quais . Serão descritos os componentes e elementos podem ser customizadospassíveis de customização.


Aviso
titleImportante

As customizações nativas dos componentes dinâmicos do PO-UI estão detalhadas na documentação Manual de personalização e customização PO-UI e não serão abordadas neste documento.

...

Segue abaixo a lista de APIs e Pontos de UPC responsáveis pelo processamento da interface dinâmica e dos dados do programa. Para mais detalhes sobre como cadastrar uma UPC para essa API, consulte o tópico 5 da documentação documentação Customização PO-UI.

          API REST - ftp/api/v1/taxAssessment.p

...

Manipulação de Dados - Valores Declaratórios
EndpointEventoEntradaObservação
GetDeclaratoryValuesbeforePayload, PathParams, QueryParamsExecutado antes de buscar um valor declaratório específico.
GetDeclaratoryValuesafterPayload, PathParams, QueryParamsExecutado depois de buscar um valor declaratório específico.
CreateDeclaratoryValuesbeforePayload, PathParams, QueryParamsExecutado antes da criação de valores declaratórios.
CreateDeclaratoryValuesafterPayload, PathParams, QueryParamsExecutado depois da criação de um valores declaratórios.
UpdateDeclaratoryValuesbeforePayload, PathParams, QueryParamsExecutado antes da alteração de valores declaratórios.
UpdateDeclaratoryValuesafterPayload, PathParams, QueryParamsExecutado depois da alteração de valores declaratórios.
DeleteDeclaratoryValuesbeforePayload, PathParams, QueryParamsExecutado depois da eliminação de valores declaratórios.
DeleteDeclaratoryValuesafterPayload, PathParams, QueryParamsExecutado depois da eliminação de valores declaratórios.
QueryDeclaratoryValuesbeforePayload, PathParams, QueryParamsExecutado antes de buscar valores declaratórios.
QueryDeclaratoryValuesafterPayload, PathParams, QueryParamsExecutado depois de buscar valores declaratórios.


03. JSON de metadata
Âncora
3
3

É possível retornar os metadados das telas para analisar a estrutura do JSON, executando as requests abaixo (após realizar o login no produto Datasul):

Tipo

Endpoint

Observações

Inclusão de Apuração 

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/taxAssessmentMetadata/?type=new

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Edição de Apuração

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/taxAssessmentMetadata/?type=edit

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Visualização de Apuração

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/taxAssessmentMetadata/?type=view

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Inclusão de Valores Declaratórios

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/<capa da apuração>/taxAssessmentMetadataDeclaratoryValues/?type=new

Capa da apuração enviada como path param.

Edição de Valores Declaratórios

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/<capa da apuração>/taxAssessmentMetadataDeclaratoryValues/?type=edit

Capa da apuração enviada como path param.

Visualização de Valores Declaratórios

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/<capa da apuração>/taxAssessmentMetadataDeclaratoryValues/?type=view

Capa da apuração enviada como path param.

Inclusão de Recolhimentos

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/<capa da apuração>/taxAssessmentMetadataCollection/?type=new

Capa da apuração enviada como path param.

Edição de Recolhimentos

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/<capa da apuração>/taxAssessmentMetadataCollection/?type=edit

Capa da apuração enviada como path param.

Visualização de Recolhimentos

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/<capa da apuração>/taxAssessmentMetadataCollection/?type=view

Capa da apuração enviada como path param.

Inclusão de Valores

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/taxAssessmentMetadataValues/?type=new

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Edição de Valores

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/taxAssessmentMetadataValues/?type=edit

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Visualização de Valores

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/taxAssessmentMetadataValues/?type=view

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Inclusão de Informações Adicionais

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/taxAssessmentMetadataAdditionalInfos/?type=new

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Edição de Informações Adicionais

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/taxAssessmentMetadataAdditionalInfos/?type=edit

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Visualização de Informações Adicionais

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/taxAssessmentMetadataAdditionalInfos/?type=view

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Inclusão de Pagamentos

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/<capa da apuração>/taxAssessmentMetadataPayments/?type=new

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Edição de Pagamentos

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/<capa da apuração>/taxAssessmentMetadataPayments/?type=edit

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Visualização de Pagamentos

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/<capa da apuração>/taxAssessmentMetadataPayments/?type=view

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Inclusão de Documentos

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/taxAssessmentMetadataDocuments/?type=new

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Edição de Documentos

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/taxAssessmentMetadataDocuments/?type=edit

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

Visualização de Documentos

https://<servidor>:<porta>/api/ofp/v1/taxAssessment/taxAssessmentMetadataDocuments/?type=view

Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo.

04. Especificidades de Customização
Âncora
4
4

a) Tela - Formulário de Apurações
Âncora
4a
4a

A tela de formulário de apurações de impostos não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-edit, mas sim o po-page com componentes como po-input, po-decimal, entre outros. Por isso, alguns elementos da tela não podem ser customizados. Por exemplo, os campos serão fixados em locais específicos da tela (abaixo do campo Observação), na aba Geral do formulário de apurações de impostos.

PropriedadeDescrição
fields

Formulário dinâmico da aba de listagem das apurações de impostos, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código
titleExemplo
collapsetrue
"fields": [
    {
      "visible": true,
      "gridColumns": 12,
      "divider": "Itens da UPC",
      "property": "codUsuario",
      "label": "Especifico Apuracao",
      "type": "string",
      "required": true
    }
]

validateFields

Um array com os nomes de propriedade dos campos que possuem validação 

Bloco de código
titleExemplo
collapsetrue
"validateFields": ["codUsuario"]

b) Tela - Formulário de

...

Valores 
Âncora
4b
4b

A tela de formulário de valores da apuração de impostos não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-edit, mas sim o po-page com componentes como po-input, po-decimal, entre outros. Por essa razão, alguns elementos da tela não podem ser customizados. Por exemplo, os campos serão fixados em locais específicos da tela (abaixo do campo Valor), no formulário principal de valores da apuração de impostos.

fields

Formulário dinâmico da aba de valores, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código
titleExemplo
collapsetrue
"fields": [
    {
      "visible": true,
      "gridColumns": 12,
      "divider": "Itens da UPC",
      "property": "codUsuario",
      "label": "Especifico Apuracao",
      "type": "string",
      "required": true
    }
]

validateFields

Um array com os nomes de propriedade dos campos que possuem validação 

Bloco de código
titleExemplo
collapsetrue
"validateFields": ["codUsuario"]

c) Tela - Formulário de Informações

...

Adicionais 
Âncora
4c
4c

A tela de formulário das informações adicionais da apuração de impostos não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-edit, mas sim o po-page com componentes como po-input, po-decimal, entre outros. Por essa razão, alguns elementos da tela não podem ser customizados. Por exemplo, os campos serão fixados em locais específicos da tela (abaixo do campo Observação), no formulário principal de informações adicionais da apuração de impostos.

fields

Formulário dinâmico da aba de informações adicionais, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código
titleExemplo
collapsetrue
"fields": [
    {
      "visible": true,
      "gridColumns": 12,
      "divider": "Itens da UPC",
      "property": "codUsuario",
      "label": "Especifico Apuracao",
      "type": "string",
      "required": true
    }
]

validateFields

Um array com os nomes de propriedade dos campos que possuem validação 

Bloco de código
titleExemplo
collapsetrue
"validateFields": ["codUsuario"]

d) Tela - Formulário de

...

Documentos 
Âncora
4d
4d

A tela de formulário de documentos da apuração de impostos não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-edit, mas sim o po-page com componentes como po-input, po-decimal, entre outros. Por essa razão, alguns elementos da tela não podem ser customizados. Por exemplo, os campos serão fixados em locais específicos da tela (abaixo do campo Observação), no formulário principal de documentos da apuração de impostos.

fields

Formulário dinâmico da aba de documentos, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código
titleExemplo
collapsetrue
"fields": [
    {
      "visible": true,
      "gridColumns": 12,
      "divider": "Itens da UPC",
      "property": "codUsuario",
      "label": "Especifico Apuracao",
      "type": "string",
      "required": true
    }
]

validateFields

Um array com os nomes de propriedade dos campos que possuem validação 

Bloco de código
titleExemplo
collapsetrue
"validateFields": ["codUsuario"]

e) Tela - Formulário de

...

Recolhimento 
Âncora
4e
4e

A tela de formulário de recolhimento da apuração de impostos não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-edit, mas sim o po-page com componentes como po-input, po-decimal, entre outros. Por essa razão, alguns elementos da tela não podem ser customizados. Por exemplo, os campos serão fixados em locais específicos da tela (abaixo do campo Observação), no formulário principal de recolhimento da apuração de impostos.

fields

Formulário dinâmico da aba de recolhimento, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código
titleExemplo
collapsetrue
"fields": [
    {
      "visible": true,
      "gridColumns": 12,
      "divider": "Itens da UPC",
      "property": "codUsuario",
      "label": "Especifico Apuracao",
      "type": "string",
      "required": true
    }
]

validateFields

Um array com os nomes de propriedade dos campos que possuem validação 

Bloco de código
titleExemplo
collapsetrue
"validateFields": ["codUsuario"]

f) Tela - Formulário de

...

Pagamentos 
Âncora
4f
4f

A tela de formulário de pagamentos da apuração de impostos não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-edit, mas sim o po-page com componentes como po-input, po-decimal, entre outros. Por essa razão, alguns elementos da tela não podem ser customizados. Por exemplo, os campos serão fixados em locais específicos da tela (abaixo dos campos Data de Vencimento, Operação e Valor do Imposto), no formulário principal de pagamentos da apuração de impostos.

fields

Formulário dinâmico da aba de pagamentos, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código
titleExemplo
collapsetrue
"fields": [
    {
      "visible": true,
      "gridColumns": 12,
      "divider": "Itens da UPC",
      "property": "codUsuario",
      "label": "Especifico Apuracao",
      "type": "string",
      "required": true
    }
]

validateFields

Um array com os nomes de propriedade dos campos que possuem validação 

Bloco de código
titleExemplo
collapsetrue
"validateFields": ["codUsuario"]

g) Tela - Formulário de Valores

...

Declaratórios 
Âncora
4g
4g

A tela de formulário de valores declaratórios da apuração de impostos não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-edit, mas sim o po-page com componentes como po-input, po-decimal, entre outros. Por essa razão, alguns elementos da tela não podem ser customizados. Por exemplo, os campos serão fixados em locais específicos da tela (abaixo dos campos Descrição Complementar), no formulário principal de valores declaratórios da apuração de impostos.

fields

Formulário dinâmico da aba de valores declaratórios, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código
titleExemplo
collapsetrue
"fields": [
    {
      "visible": true,
      "gridColumns": 12,
      "divider": "Itens da UPC",
      "property": "codUsuario",
      "label": "Especifico Apuracao",
      "type": "string",
      "required": true
    }
]

validateFields

Um array com os nomes de propriedade dos campos que possuem validação 

Bloco de código
titleExemplo
collapsetrue
"validateFields": ["codUsuario"]

05. Observações Gerais 
Âncora
5
5

  • Todos os objetos que não foram mencionados, a principio, não podem ser customizados.
  • Caso deseje customizar algum componente além dos descritos neste documento e na documentação padrão de customização do PO-UI, por favor, abra um ticket solicitando a customização e justificando a necessidade.
  • Clique aqui para baixar um exemplo de código fonte de UPC para este programa.