Este documento tem como objetivo descrever o que poderá ser customizado na tela HTML do programa Apuração de Impostos (html.taxAssessment)
Aqui será descrito quais componentes e elementos podem ser customizados.
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 Customização PO-UI.
| Manipulação de Objetos da Interface (Metadata) | |||
|---|---|---|---|
| Endpoint | Evento | Entrada | Observação |
| getMetaData | new | Metadados | Estrutura metadados da tela de inclusão da apuração. |
| getMetaData | edit | Metadados | Estrutura metadados da tela de edição da apuração. |
| getMetaData | view | Metadados | Estrutura metadados da tela de visualização da apuração. |
| getMetaData | newValues | Metadados | Estrutura metadados da tela de inclusão de ajustes da apuração. |
| getMetaData | editValues | Metadados | Estrutura metadados da tela de edição de ajustes da apuração. |
| getMetaData | viewValues | Metadados | Estrutura metadados da tela de visualização de ajustes da apuração. |
| getMetaData | newDocument | Metadados | Estrutura metadados da tela de inclusão de documentos da apuração. |
| getMetaData | editDocument | Metadados | Estrutura metadados da tela de edição de documentos da apuração. |
| getMetaData | viewDocument | Metadados | Estrutura metadados da tela de visualização de documentos da apuração. |
| getMetaData | newAdditionalInfo | Metadados | Estrutura metadados da tela de inclusão das informações adicionais do ajuste da apuração. |
| getMetaData | editAdditionalInfo | Metadados | Estrutura metadados da tela de edição das informações adicionais do ajuste da apuração. |
| getMetaData | viewAdditionalInfo | Metadados | Estrutura metadados da tela de visualização das informações adicionais do ajuste da apuração. |
| getMetaData | newCollection | Metadados | Estrutura metadados da tela de inclusão de recolhimento da apuração. |
| getMetaData | editCollection | Metadados | Estrutura metadados da tela de edição de recolhimento da apuração. |
| getMetaData | viewCollection | Metadados | Estrutura metadados da tela de visualização de recolhimento da apuração. |
| getMetaData | newPayments | Metadados | Estrutura metadados da tela de inclusão de pagamentos da apuração. |
| getMetaData | editPayments | Metadados | Estrutura metadados da tela de edição de pagamentos da apuração. |
| getMetaData | viewPayments | Metadados | Estrutura metadados da tela de visualização de pagamentos da apuração. |
| getMetaData | newDeclaratoryValues | Metadados | Estrutura metadados da tela de inclusão de valores declaratórios da apuração. |
| getMetaData | editDeclaratoryValues | Metadados | Estrutura metadados da tela de edição de valores declaratórios da apuração. |
| getMetaData | viewDeclaratoryValues | Metadados | Estrutura metadados da tela de visualização de valores declaratórios da apuração. |
| validateForm | validateForm | Metadados | Recebe o payload com a propriedade e valor do campo a ser validado. |
| Manipulação de Dados - Capa | |||
|---|---|---|---|
| Endpoint | Evento | Entrada | Observação |
| Get | beforeGet | Payload, PathParams, QueryParams | Executado antes de buscar uma apuração específica. |
| Get | afterGet | Payload, PathParams, QueryParams | Executado depois de buscar uma apuração específica. |
| Create | beforeCreate | Payload, PathParams, QueryParams | Executado antes de criar uma apuração. |
| Create | afterCreate | Payload, PathParams, QueryParams | Executado depois de criar uma apuração. |
| Update | beforeUpdate | Payload, PathParams, QueryParams | Executado antes da alteração de uma apuração. |
| Update | afterUpdate | Payload, PathParams, QueryParams | Executado depois da alteração de uma apuração. |
| Delete | beforeDelete | Payload, PathParams, QueryParams | Executado antes da eliminação de uma apuração. |
| Delete | afterDelete | Payload, PathParams, QueryParams | Executado depois da eliminação de uma apuração. |
| Query | beforeQuery | Payload, PathParams, QueryParams | Executado antes de buscar as apurações. |
| Query | afterQuery | Payload, PathParams, QueryParams | Executado depois de buscar as apurações. |
| Manipulação de Dados - Valores | |||
|---|---|---|---|
| Endpoint | Evento | Entrada | Observação |
| GetValues | before | Payload, PathParams, QueryParams | Executado antes de buscar um valor específico. |
| GetValues | after | Payload, PathParams, QueryParams | Executado depois de buscar um valor específico. |
CreateValues | before | Payload, PathParams, QueryParams | Executado antes de criar um valor específico. |
| CreateValues | after | Payload, PathParams, QueryParams | Executado depois de criar um valor específico. |
| UpdateValues | before | Payload, PathParams, QueryParams | Executado antes da alteração de um valor específico. |
| UpdateValues | after | Payload, PathParams, QueryParams | Executado depois da alteração de um valor específico. |
| DeleteValues | before | Payload, PathParams, QueryParams | Executado antes de deletar um valor específico. |
| DeleteValues | after | Payload, PathParams, QueryParams | Executado depois de deletar um valor específico. |
| QueryValues | before | Payload, PathParams, QueryParams | Executado antes de buscar os valores. |
| QueryValues | after | Payload, PathParams, QueryParams | Executado depois de buscar os valores. |
| Manipulação de Dados - Informações Adicionais | |||
|---|---|---|---|
| Endpoint | Evento | Entrada | Observação |
| GetAdditionalInfo | before | Payload, PathParams, QueryParams | Executado antes de buscar valores específicos das informações adicionais. |
| GetAdditionalInfo | after | Payload, PathParams, QueryParams | Executado depois de buscar valores específicos das informações adicionais. |
| CreateAdditionalInfo | before | Payload, PathParams, QueryParams | Executado antes da criação das informações adicionais. |
| CreateAdditionalInfo | after | Payload, PathParams, QueryParams | Executado depois da criação das informações adicionais. |
| UpdateAdditionalInfo | before | Payload, PathParams, QueryParams | Executado antes da alteração das informações adicionais. |
| UpdateAdditionalInfo | after | Payload, PathParams, QueryParams | Executado depois da alteração das informações adicionais. |
| DeleteAdditionalInfo | before | Payload, PathParams, QueryParams | Executado antes de deletar as informações adicionais. |
| DeleteAdditionalInfo | after | Payload, PathParams, QueryParams | Executado depois de deletar as informações adicionais. |
| QueryAdditionalInfo | before | Payload, PathParams, QueryParams | Executado antes de buscar informações adicionais. |
| QueryAdditionalInfo | after | Payload, PathParams, QueryParams | Executado depois de buscar informações adicionais. |
| Manipulação de Dados - Documentos | |||
|---|---|---|---|
| Endpoint | Evento | Entrada | Observação |
| GetDocument | before | Payload, PathParams, QueryParams | Executado antes de buscar documentos específicos. |
| GetDocument | after | Payload, PathParams, QueryParams | Executado depois de buscar documentos específicos. |
| CreateDocument | before | Payload, PathParams, QueryParams | Executado antes da criação dos documentos. |
| CreateDocument | after | Payload, PathParams, QueryParams | Executado depois da criação dos documentos. |
| UpdateDocument | before | Payload, PathParams, QueryParams | Executado antes da alteração dos documentos. |
| UpdateDocument | after | Payload, PathParams, QueryParams | Executado depois da alteração dos documentos. |
| DeleteDocument | before | Payload, PathParams, QueryParams | Executado antes da eliminação dos documentos. |
| DeleteDocument | after | Payload, PathParams, QueryParams | Executado depois da eliminação dos documentos |
| QueryDocument | before | Payload, PathParams, QueryParams | Executado antes de buscar os documentos. |
| QueryDocument | after | Payload, PathParams, QueryParams | Executado depois de buscar os documentos. |
| Manipulação de Dados - Recolhimento | |||
|---|---|---|---|
| Endpoint | Evento | Entrada | Observação |
| GetCollection | before | Payload, PathParams, QueryParams | Executado antes de buscar um recolhimento específico. |
| GetCollection | after | Payload, PathParams, QueryParams | Executado depois de buscar um recolhimento específico. |
| CreateCollection | before | Payload, PathParams, QueryParams | Executado antes da criação de um recolhimento. |
| CreateCollection | after | Payload, PathParams, QueryParams | Executado depois da criação de um recolhimento. |
| UpdateCollection | before | Payload, PathParams, QueryParams | Executado antes da alteração de um recolhimento. |
| UpdateCollection | after | Payload, PathParams, QueryParams | Executado depois da alteração de um recolhimento. |
| DeleteCollection | before | Payload, PathParams, QueryParams | Executado antes da eliminação de um recolhimento. |
| DeleteCollection | after | Payload, PathParams, QueryParams | Executado depois da eliminação de um recolhimento. |
| QueryCollection | before | Payload, PathParams, QueryParams | Executado antes da busca de um recolhimento. |
| QueryCollection | after | Payload, PathParams, QueryParams | Executado depois da busca de um recolhimento. |
| Manipulação de Dados - Pagamentos | |||
|---|---|---|---|
| Endpoint | Evento | Entrada | Observação |
| GetPayments | before | Payload, PathParams, QueryParams | Executado antes de buscar um pagamento específico. |
| GetPayments | after | Payload, PathParams, QueryParams | Executado depois de buscar um pagamento específico. |
| CreatePayments | before | Payload, PathParams, QueryParams | Executado antes da criação de um pagamento. |
| CreatePayments | after | Payload, PathParams, QueryParams | Executado depois da criação de um pagamento. |
| UpdatePayments | before | Payload, PathParams, QueryParams | Executado antes da alteração de um pagamento. |
| UpdatePayments | after | Payload, PathParams, QueryParams | Executado depois da alteração de um pagamento. |
| DeletePayments | before | Payload, PathParams, QueryParams | Executado antes da remoção de um pagamento. |
| DeletePayments | after | Payload, PathParams, QueryParams | Executado depois da remoção de um pagamento. |
| QueryPayments | before | Payload, PathParams, QueryParams | Executado antes da busca de um pagamento. |
| QueryPayments | after | Payload, PathParams, QueryParams | Executado depois da busca de um pagamento. |
| Manipulação de Dados - Valores Declaratórios | |||
|---|---|---|---|
| Endpoint | Evento | Entrada | Observação |
| GetDeclaratoryValues | before | Payload, PathParams, QueryParams | Executado antes de buscar um valor declaratório específico. |
| GetDeclaratoryValues | after | Payload, PathParams, QueryParams | Executado depois de buscar um valor declaratório específico. |
| CreateDeclaratoryValues | before | Payload, PathParams, QueryParams | Executado antes da criação de valores declaratórios. |
| CreateDeclaratoryValues | after | Payload, PathParams, QueryParams | Executado depois da criação de um valores declaratórios. |
| UpdateDeclaratoryValues | before | Payload, PathParams, QueryParams | Executado antes da alteração de valores declaratórios. |
| UpdateDeclaratoryValues | after | Payload, PathParams, QueryParams | Executado depois da alteração de valores declaratórios. |
| DeleteDeclaratoryValues | before | Payload, PathParams, QueryParams | Executado depois da eliminação de valores declaratórios. |
| DeleteDeclaratoryValues | after | Payload, PathParams, QueryParams | Executado depois da eliminação de valores declaratórios. |
| QueryDeclaratoryValues | before | Payload, PathParams, QueryParams | Executado antes de buscar valores declaratórios. |
| QueryDeclaratoryValues | after | Payload, PathParams, QueryParams | Executado depois de buscar valores declaratórios. |
É 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. |
https://<servidor>:<porta>/api/ofp/v1/taxAssessment//?type=new | Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo. | |
https://<servidor>:<porta>/api/ofp/v1/taxAssessment//?type=edit | Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo. | |
https://<servidor>:<porta>/api/ofp/v1/taxAssessment//?type=view | Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo. | |
https://<servidor>:<porta>/api/ofp/v1/taxAssessment//?type=new | Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo. | |
https://<servidor>:<porta>/api/ofp/v1/taxAssessment//?type=edit | Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo. | |
https://<servidor>:<porta>/api/ofp/v1/taxAssessment//?type=view | Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo. | |
https://<servidor>:<porta>/api/ofp/v1/taxAssessment//?type=new | Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo. | |
https://<servidor>:<porta>/api/ofp/v1/taxAssessment//?type=edit | Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo. | |
https://<servidor>:<porta>/api/ofp/v1/taxAssessment//?type=view | Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo. | |
https://<servidor>:<porta>/api/ofp/v1/taxAssessment//?type=new | Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo. | |
https://<servidor>:<porta>/api/ofp/v1/taxAssessment//?type=edit | Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo. | |
https://<servidor>:<porta>/api/ofp/v1/taxAssessment//?type=view | Por não ser um programa totalmente dinâmico, a estrutura dos metadados retornados estará vazia e sem nenhum campo. |