Histórico da Página

CONTEÚDO
Âncora

...

title	Exemplo de Payload (body da requisição)
linenumbers	true
collapse	true

...

   	 {
        "dateValidIni": "2025-03-21",
        "codEstab": "*",
        "codNaturOperac": "*",
        "deferralPercent": 0,
        "aliquot": 0,
        "documentType": 1,
        "city": "Joinville",
        "codCfop": "*",
        "codClientGroup": 0,
        "presumCredPercent": 0,
        "taxExemptionRate": 0,
        "uf": "Santa Catarina",
        "speciAliquotPerApproUniMedIs": 0,
        "tributeType": 2,
        "codIssuer": 0,
        "codService": 0,
        "codNcm": "*",
        "codItem": "*",
        "taxableUnitMeasureIs": 0,
        "reductionPercent": 0
    }

...

É possível retornar o metadata das telas para fazer a análise da estrutura do JSON, executando as requests abaixo (depois de logado no produto Datasul):

...

Tipo

...

Método (API)

...

Endpoint (API)

...

Observações

...

GET

...

URL_Base/metadata/?type=list

...

GET

...

URL_Base/metadata/?type=new

...

GET

...

URL_Base/metadata/<código estabelecimento>?type=edit

...

Utiliza o código do estabelecimento como path param.

...

GET

...

URL_Base/metadata/<código estabelecimento>?type=copy

...

Utiliza o código do estabelecimento como path param.

início
início

Visão Geral clique no conteúdo para acesso rápido à informação desejada ↓
API x Pontos UPC Relacionados
JSON de metadata
Especificidades de Customização
1. Tela - Listagem Relacionamento x Tributo
2. Tela - Edição/Novo Relacionamento x Tributo
Observações Gerais

01. Visão Geral
Âncora
1
1

Este documento tem como objetivo descrever o que poderá ser customizado na tela HTML do programa Relacionamento x Tributo item de menu Relacionamento x Tributo (html-mft.relationshipTribute), aqui será descrito quais componentes e elementos podem ser customizados.

Aviso

title	Importante

Esse documento somente cita itens de customização que diferem da customização padrão de uma tela HTML utilizando PO-UI, ou seja, somente as especificidades de customização do programa HTML em questão. As customizações nativas dos componentes dinâmicos do PO-UI podem ser verificadas aqui e não serão abordadas nesse documento.

02. API x Pontos UPC Relacionados
Âncora
2
2

Segue a lista de APIs e Pontos de UPC responsáveis pelo processamento da interface dinâmica e dos dados do programa.
Para maiores detalhes de como cadastrar uma UPC para essa API podem ser visualizados aqui.

API REST: ftp/api/v1/refRelationshipTribute.p.
URL base para requisições: https://<servidor>:<porta>/api/ftp/v1/refRelationshipTribute.p.

Manipulação de Objetos da Interface (Metadata)
Método (API)	Endpoint (API)	Endpoint (UPC)	Evento (UPC)	Entrada (UPC)	Observação
GET	*URL_Base*/metadata/?type=list	getMetaData	list	Metadados	Estrutura metadados da listagem.
GET	*URL_Base*/metadata/?type=new	getMetaData	new	Metadados	Estrutura metadados da tela de inclusão.
GET	*URL_Base*/metadata/<ROWID do registro>?type=edit	getMetaData	edit	Metadados	Estrutura metadados da tela de edição.

Manipulação de Dados
Método (API)	Endpoint (API)	Endpoint (UPC)	Evento (UPC)	Entrada (UPC)	Observação
GET	*URL_Base*/<ROWID do registro>	findById	findById	Dados do registro	Executado depois de buscar um registro específico.
GET	*URL_Base*?pageSize=10&page=1	findAll	findAll	Dados dos registros	Executado depois de buscar os registros.
POST	*URL_Base*	create	beforeCreate	Payload*	Executado antes de criar um registro.
POST	*URL_Base*	create	afterCreate	Payload*	Executado depois da criação de um registro.
POST	*URL_base*/VALIDATE	validateForm	validateForm	Payload* e Campo alterado	Executado ao chamar a rota de Validate.
PUT	*URL_Base*	update	beforeUpdate	Payload*	Executado antes da alteração de um registro.
PUT	*URL_Base*	update	afterUpdate	Payload*	Executado depois da alteração de um registro.
DELETE	*URL_Base*/<ROWID do registro>	delete	beforeDelete	Vazio	Executado antes da eliminação de um registro.
DELETE	*URL_Base*/<ROWID do registro>	delete	afterDelete	Vazio	Executado depois da eliminação de um registro.

Bloco de código

title	Exemplo de Payload (body da requisição)
linenumbers	true
collapse	true

{
    "dateValidIni": "2025-03-21",
    "codEstab": "*",
    "codNaturOperac": "*",
    "deferralPercent": 0,
    "aliquot": 0,
    "documentType": 1,
    "city": "Joinville",
    "codCfop": "*",
    "codClientGroup": 0,
    "presumCredPercent": 0,
    "taxExemptionRate": 0,
    "uf": "Santa Catarina",
    "speciAliquotPerApproUniMedIs": 0,
    "tributeType": 2,
    "codIssuer": 0,
    "codService": 0,
    "codNcm": "*",
    "codItem": "*",
    "taxableUnitMeasureIs": 0,
    "reductionPercent": 0
}

03. JSON de metadata
Âncora
3
3

É possível retornar o metadata das telas para fazer a análise da estrutura do JSON, executando as requests abaixo (depois de logado no produto Datasul):

Tipo	Método (API)	Endpoint (API)	Observações
Listagem	GET	*URL_Base*/metadata/?type=list
Inclusão	GET	*URL_Base*/metadata/?type=new
Edição	GET	*URL_Base*/metadata/<chave do registro>?type=edit	Utiliza a chave do registro como path param.
Copia	GET	*URL_Base*/metadata/<chave do registro>?type=copy	Utiliza a chave do registro como path param.

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

a) Tela - Listagem Relacionamento x Tributo

Âncora

	4a
	4a

A tela de listar não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-table por exemplo, e sim usando po-page com uma po-table, por conta disso alguns elementos da tela não podem ser customizados e algumas propriedades do metadata são utilizados de forma um pouco diferente, a seguir a descrição de cada customização possível.

Propriedade

Descrição

title

Título da página.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"title":"Relacionamento x Tributo"

Image Added

keepfilters

Indica se deseja salvar no cache do navegador as informações do filtro de busca avançada e as preferencias das colunas (colunas visíveis e posição), recebe true ou false.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"keepfilters": true

hideColumnsManager

Indica se deseja exibir o gerenciador de coluna da tabela, recebe true ou false.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"hideColumnsManager": false

Image Added

pageCustomActions

Utilizado para remover o botão de novo parâmetros ou para inserir novos botões, o botão inserido aqui deve conter label e url.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"pageCustomActions": [
        {
            "label": "Novo Parâmetro",
            "url": "/relationshipTribute/new"
        }
]

Image Added

tableCustomActions

Utilizado para remover os botões de editar, copiar e deletar das ações da tabela ou para inserir novos. Para que uma ação padrão não seja criada basta que o metadata não contenha os labels de edit, duplicate e Delete, caso necessário criar ou ação diferente ela deve possuir tanto label quanto url.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"tableCustomActions": [
        {
            "label": "edit"
        },
        {
            "label": "duplicate"
        },
        {
            "label": "delete"
        }
]

Image Added

columnsList

Lista das colunas da tabela, contém um array de objetos que implementam a interface PoTableColumn. Para mais informações do que é possível acessar a documentação do Portinari: po-table

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"columnsList": [
        {
            "visible": true,
            "allowColumnsManager": true,
            "property": "tributeType",
            "options": [
                {
                    "label": "Aberto",
                    "value": 1
                },
                {
                    "label": "Alocado",
                    "value": 2
                },
                {
                    "label": "Calculado",
                    "value": 3
                },
                {
                    "label": "Confirmado",
                    "value": 4
                }
            ],
            "label": "Tributo",
            "type": "label",
            "labels": [
                {
                    "color": "color-10",
                    "tooltip": "Contribuição sobre bens e serviço",
                    "label": "CBS",
                    "value": 1
                },
                {
                    "color": "color-01",
                    "tooltip": "Imposto sobre Bens e serviço (Município)",
                    "label": "IBS MUN",
                    "value": 2
                },
                {
                    "color": "color-05",
                    "tooltip": "Imposto sobre Bens e serviço (Estadual)",
                    "label": "IBS UF",
                    "value": 3
                },
                {
                    "color": "color-08",
                    "tooltip": "Imposto Seletivo",
                    "label": "IS",
                    "value": 4
                }
            ]
        },
        {
            "visible": true,
            "allowColumnsManager": true,
            "property": "aliquot",
            "format": "0.3-4",
            "label": "Alíquota",
            "type": "number"
        },
        {
            "visible": true,
            "allowColumnsManager": true,
            "property": "dateValidIni",
            "label": "Dt Inicio validade",
            "type": "date"
        },
        {
            "visible": true,
            "allowColumnsManager": true,
            "property": "codEstab",
            "label": "Estabelecimento",
            "type": "string"
        },
        {
            "visible": true,
            "allowColumnsManager": true,
            "property": "codNaturOperac",
            "label": "Natureza de Operação",
            "type": "string"
        },
        {
            "visible": true,
            "allowColumnsManager": true,
            "property": "codNcm",
            "label": "Classificação Fiscal",
            "type": "string"
        },
        {
            "visible": true,
            "allowColumnsManager": true,
            "property": "codClientGroup",
            "label": "Grupo Cliente/Fornecedor",
            "type": "number"
        },
        {
            "visible": true,
            "allowColumnsManager": true,
            "property": "codIssuer",
            "label": "Emitente",
            "type": "number"
        },
        {
            "visible": true,
            "allowColumnsManager": true,
            "property": "codItem",
            "label": "Item",
            "type": "string"
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "documentType",
            "label": "Tipo Documento",
            "type": "string"
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "codService",
            "label": "Serviço",
            "type": "number"
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "codCfop",
            "label": "CFOP",
            "type": "string"
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "uf",
            "label": "UF",
            "type": "string"
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "city",
            "label": "Cidade",
            "type": "string"
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "deferralPercent",
            "label": "Perc Diferido",
            "type": "number"
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "reductionPercent",
            "label": "Perc Redução",
            "type": "number"
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "presumCredPercent",
            "label": "Perc Créd Presumido",
            "type": "number"
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "taxExemptionRate",
            "label": "Aliq Desoneração",
            "type": "number"
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "taxableUnitMeasureIs",
            "label": "Unid Med Tributável IS",
            "type": "string"
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "taxExemptionRate",
            "label": "Aliq Espec Unid Med Aprop IS ",
            "type": "number"
        }
]

Image Added

detailedInfoDynamicViewFields

Expansão da linha da tabela, dados completos da tabela. Neste componente é utilizado o po-dynamic-view e todas as propriedades do PoDynamicViewField podem ser utilizadas.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"detailedInfoDynamicViewFields": [
        {
            "gridColumns": 4,
            "property": "tributeType",
            "options": [
                {
                    "label": "CBS",
                    "value": 1
                },
                {
                    "label": "IBS Mun",
                    "value": 2
                },
                {
                    "label": "IBS UF",
                    "value": 3
                },
                {
                    "label": "IS",
                    "value": 4
                }
            ],
            "label": "Tributo",
            "placeholder": "Situação",
            "type": "label",
            "labels": [
                {
                    "color": "color-10",
                    "tooltip": "Contribuição sobre bens e serviço",
                    "label": "CBS",
                    "value": 1
                },
                {
                    "color": "color-01",
                    "tooltip": "Imposto sobre Bens e serviço (Município)",
                    "label": "IBS MUN",
                    "value": 2
                },
                {
                    "color": "color-05",
                    "tooltip": "Imposto sobre Bens e serviço (Estadual)",
                    "label": "IBS UF",
                    "value": 3
                },
                {
                    "color": "color-08",
                    "tooltip": "Imposto Seletivo",
                    "label": "IS",
                    "value": 4
                }
            ]
        },
        {
            "gridColumns": 4,
            "property": "aliquot",
            "format": "0.3-4",
            "label": "Alíquota",
            "type": "number"
        },
        {
            "gridColumns": 4,
            "property": "dateValidIni",
            "label": "Dt Inicio validade",
            "type": "date"
        },
        {
            "gridColumns": 4,
            "property": "codEstab",
            "label": "Estabelecimento",
            "type": "string"
        },
        {
            "gridColumns": 4,
            "property": "codNaturOperac",
            "label": "Natureza de Operação",
            "type": "string"
        },
        {
            "gridColumns": 4,
            "property": "codNcm",
            "label": "Classificação Fiscal",
            "type": "string"
        },
        {
            "gridColumns": 4,
            "property": "codClientGroup",
            "label": "Grupo",
            "type": "number"
        },
        {
            "gridColumns": 4,
            "property": "codIssuer",
            "label": "Emitente",
            "type": "number"
        },
        {
            "gridColumns": 4,
            "property": "codItem",
            "label": "Item",
            "type": "string"
        },
        {
            "gridColumns": 4,
            "property": "documentType",
            "label": "Tipo Documento",
            "type": "number"
        },
        {
            "gridColumns": 4,
            "property": "codService",
            "label": "Serviço",
            "type": "number"
        },
        {
            "gridColumns": 4,
            "property": "codCfop",
            "label": "CFOP",
            "type": "string"
        },
        {
            "gridColumns": 4,
            "property": "uf",
            "label": "UF",
            "type": "string"
        },
        {
            "gridColumns": 4,
            "property": "city",
            "label": "Cidade",
            "type": "string"
        },
        {
            "gridColumns": 4,
            "divider": "Alíquotas e percentuais",
            "property": "deferralPercent",
            "label": "Perc Diferido",
            "type": "number"
        },
        {
            "gridColumns": 4,
            "property": "reductionPercent",
            "label": "Perc Redução",
            "type": "number"
        },
        {
            "gridColumns": 4,
            "property": "presumCredPercent",
            "label": "Perc Créd Presumido",
            "type": "number"
        },
        {
            "gridColumns": 4,
            "property": "taxExemptionRate",
            "label": "Aliq Desoneração",
            "type": "number"
        },
        {
            "gridColumns": 4,
            "property": "taxableUnitMeasureIs",
            "label": "Unid Med Tributável IS",
            "type": "string"
        },
        {
            "gridColumns": 4,
            "property": "taxExemptionRate",
            "label": "Aliq Espec Unid Med Aprop IS ",
            "type": "number"
        }
]

advancedFilters

Busca avançada da tela, permite o filtro pelos valores preenchidos. Neste componente é utilizado o po-dynamic-form e todas as propriedades do PoDynamicFormField podem ser utilizadas.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"advancedFilters": [
        {
            "gridColumns": 12,
            "optionsMulti": true,
            "property": "tributeType",
            "options": [
                {
                    "label": "CBS",
                    "value": 1
                },
                {
                    "label": "IBS Mun",
                    "value": 2
                },
                {
                    "label": "IBS UF",
                    "value": 3
                },
                {
                    "label": "IS",
                    "value": 4
                }
            ],
            "label": "Tributo",
            "placeholder": "Tributo",
            "type": "label",
            "labels": [
                {
                    "color": "color-10",
                    "tooltip": "Contribuição sobre bens e serviço",
                    "label": "CBS",
                    "value": 1
                },
                {
                    "color": "color-01",
                    "tooltip": "Imposto sobre Bens e serviço (Município)",
                    "label": "IBS MUN",
                    "value": 2
                },
                {
                    "color": "color-05",
                    "tooltip": "Imposto sobre Bens e serviço (Estadual)",
                    "label": "IBS UF",
                    "value": 3
                },
                {
                    "color": "color-08",
                    "tooltip": "Imposto Seletivo",
                    "label": "IS",
                    "value": 4
                }
            ]
        },
        {
            "gridColumns": 6,
            "property": "dateValidIni",
            "label": "Data Validade inicial",
            "placeholder": "Data Inicial",
            "type": "date",
            "fieldValue": "1990-01-01"
        },
        {
            "gridColumns": 6,
            "property": "dateValidFim",
            "label": "Data Validade final",
            "placeholder": "Data Final",
            "type": "date",
            "fieldValue": "9999-12-31"
        },
        {
            "gridColumns": 6,
            "property": "codEstabIni",
            "label": "Estabelecimento inicial",
            "placeholder": "Estabelecimento Inicial",
            "type": "string",
            "fieldValue": "",
            "maxLength": 5
        },
        {
            "gridColumns": 6,
            "property": "codEstabFim",
            "label": "Estabelecimento final",
            "placeholder": "Estabelecimento Final",
            "type": "string",
            "fieldValue": "ZZZZZ",
            "maxLength": 5
        },
        {
            "gridColumns": 6,
            "property": "codNaturOperacIni",
            "label": "Natureza de Operação inicial",
            "placeholder": "Natureza de Operação inicial",
            "type": "string",
            "fieldValue": "",
            "maxLength": 6
        },
        {
            "gridColumns": 6,
            "property": "codNaturOperacFim",
            "label": "Natureza de Operação final",
            "placeholder": "Natureza de Operação final",
            "type": "string",
            "fieldValue": "ZZZZZZ",
            "maxLength": 6
        },
        {
            "gridColumns": 6,
            "property": "codCfopIni",
            "label": "CFOP inicial",
            "placeholder": "CFOP inicial",
            "type": "string",
            "fieldValue": "",
            "maxLength": 10
        },
        {
            "gridColumns": 6,
            "property": "codCfopFim",
            "label": "CFOP final",
            "placeholder": "CFOP final",
            "type": "string",
            "fieldValue": "ZZZZZZZZZZ",
            "maxLength": 10
        },
        {
            "gridColumns": 6,
            "property": "codServiceIni",
            "label": "Código Serviço inicial",
            "placeholder": "Código Serviço inicial",

...

A tela de listar não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-table por exemplo, e sim usando po-page com uma po-table, por conta disso alguns elementos da tela não podem ser customizados e algumas propriedades do metadata são utilizados de forma um pouco diferente, a seguir a descrição de cada customização possível.

Propriedade

Description

title

Título da página.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"title":"Relacionamento x Tributo"

Image Removed

pageCustomActions

Utilizado para remover o botão de novo parâmetros ou para inserir novos botões, o botão inserido aqui deve conter label e url.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"pageCustomActions": [
        {
            "labeltype": "Novo Parâmetronumber",
            "urlfieldValue": "/relationshipTribute/new",
            }
]

Image Removed

tableCustomActions

Utilizado para remover os botões de editar, copiar e deletar das ações da tabela ou para inserir novos. Para que uma ação padrão não seja criada basta que o metadata não contenha os labels de edit, duplicate e Delete, caso necessário criar ou ação diferente ela deve possuir tanto label quanto url.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"tableCustomActions": ["mask": "99.999"
        },
        {
            "labelgridColumns": "edit"6,
        }    "property": "codServiceFim",
        {    "label": "Código Serviço final",
            "labelplaceholder": "duplicateCódigo Serviço final",
             }"type": "number",
           { "fieldValue": "99999",
            "labelmask": "delete99.999"
        }
]

Image Removed

columnsList

Lista das colunas da tabela, contém um array de objetos que implementam a interface PoTableColumn. Para mais informações do que é possível acessar a documentação do Portinari: po-table

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"columnsList": [
,
        {
            "gridColumns": 6,
          {  "property": "codClientGroupIni",
            "visiblelabel": true"Código Grupo Cliente inicial",
            "allowColumnsManagerplaceholder": true"Código Grupo Cliente inicial",
            "propertytype": "tributeTypestring",
            "optionsfieldValue": ["",
            "maxLength": 5
    {    },
        {
            "labelgridColumns": "Aberto"6,
            "property": "codClientGroupFim",
            "valuelabel": 1 "Código Grupo Cliente final",
            "placeholder": "Código Grupo Cliente }final",
                {"type": "string",
                    "label"fieldValue": "AlocadoZZZZZ",
                    "value"maxLength": 25
        },
        },{
            "gridColumns": 6,
   {
         "property": "codIssuerIni",
            "label": "CalculadoEmitente inicial",
            "placeholder": "Emitente inicial",
      "value      "type": 3"number",
                }"fieldValue": "",
            "mask": "999999999"
   {
     },
        {
       "label": "Confirmado",
      "gridColumns": 6,
              "valueproperty": 4"codIssuerFim",
            "label": "Emitente final",
  }
          "placeholder": "Emitente ]final",
            "labeltype": "Tributonumber",
            "typefieldValue": "label999999999",
            "labelsmask": ["999999999"
        },
        {
            "gridColumns": 6,
            "colorproperty": "color-10codItemIni",
            "label": "Item inicial",
            "tooltipplaceholder": "Contribuição sobre bens e serviçoItem inicial",
                    "labeltype": "CBSstring",
                "fieldValue": "",
    "value": 1
       "maxLength": 16
        },
           {
     {
       "gridColumns": 6,
            "colorproperty": "color-01codItemFim",
                    "tooltip"label": "Imposto sobre Bens e serviço (Município)",
Item final",
            "placeholder": "Item final",
            "labeltype": "IBS MUNstring",
               "fieldValue": "ZZZZZZZZZZZZZZZZ",
     "value": 2
      "maxLength": 16
         },
        {
        {
       "gridColumns": 6,
             "colorproperty": "color-05codNcmIni",
            "label": "Classificação Fiscal inicial",
     "tooltip": "Imposto sobre Bens e serviço (Estadual)",
              "placeholder": "Classificação Fiscal inicial",
             "labeltype": "IBS UFstring",
            "fieldValue": "",
       "value": 3
       "maxLength": 8
         },
        {
        {
        "gridColumns": 6,
            "colorproperty": "color-08codNcmFim",
            "label": "Classificação Fiscal final",
     "tooltip": "Imposto Seletivo",
     "placeholder": "Classificação Fiscal final",
            "labeltype": "ISstring",
                    "value"fieldValue": 4"ZZZZZZZZ",
            "maxLength": 8
    }
    },
        ]{
        },
        {"gridColumns": 6,
            "visibleproperty": true"ufIni",
            "allowColumnsManagerlabel": true"UF inicial",
            "propertyplaceholder": "aliquotUnidade Federativa inicial",
            "formattype": "0.3-4string",
            "labelfieldValue": "Alíquota",
            "typemaxLength": "number"2
        },
        {
            "visiblegridColumns": true6,
            "allowColumnsManagerproperty": true"ufFim",
            "propertylabel": "dateValidIniUF final",
            "labelplaceholder": "DtUnidade InicioFederativa validadefinal",
            "type": "datestring",
        },
        {"fieldValue": "ZZ",
            "visiblemaxLength": true,2
            "allowColumnsManager": true},
            "property": "codEstab",{
            "labelgridColumns": "Estabelecimento"6,
            "typeproperty": "string"
        }cityIni",
        {
            "visible"label": true"Cidade inicial",
            "allowColumnsManagerplaceholder": "Cidade trueinicial",
            "propertytype": "codNaturOperacstring",
            "labelfieldValue": "Natureza de Operação",
            "typemaxLength": "string"50
        },
        {
            "visiblegridColumns": true6,
            "allowColumnsManagerproperty": true"cityFim",
            "propertylabel": "codNcmCidade final",
            "labelplaceholder": "ClassificaçãoCidade Fiscalfinal",
            "type": "string",
        },
        {"fieldValue": "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ",
            "visiblemaxLength": true,50
        },
       "allowColumnsManager": true, {
            "propertygridColumns": "codClientGroup"6,
            "labelproperty": "Grupo Cliente/FornecedorpageSize",
            "typelabel": "numberNúmero de registros",
        },
    "placeholder": "Numero de  {registros",
            "visibletype": true"string",
            "allowColumnsManagerfieldValue": true"20",
            "propertymaxLength": "codIssuer",2
        }
]

Image Added

b) Tela - Edição/Novo Relacionamento x Tributo

Âncora

	4b
	4b

Propriedade

Descrição

title

Título da página.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"title":"Novo

"label": "Emitente",

Relacionamento Tributo"

Image Added

breadcrumb

O caminho de migalhas da página, recebe a página o link para a página de listagem com label assim como também o link e label da página atual, o link de listagem deve ser "/relationshipTribute" para que ao ser clicado a pagina seja redirecionada para a tela de listagem.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"breadcrumb": {

type

items":

"number"

},

{

visible

link":

true,

"allowColumnsManager": true,

"/relationshipTribute",

"property": "codItem",

            "label": "

Item

Lista Relacionamento Tributo"

,

"type": "string"

},

},

{

visible

link":

false, "allowColumnsManager": true,

"/relationshipTribute",

"property":

"documentType",

"label": "

Tipo

Novo

Documento

Relacionamento"

,

"type": "string"

}
        ]
}

, { "visible": false, "allowColumnsManager": true, "property": "codService",

Image Added

getDefault

Indica se ao abrir a página de criação de um novo registro deve busca os valores padrões ou não, recebe true ou false.

OBS: Valores padrões (pode ser customizado): IBS UF, nota de entrada, "* - todos *" para as informações principais e 0 para as alíquotas e percentuas.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"getDefault": true

pageCustomActions

Indica quais ações a tela terá, por padrão irá criar "Salvar, Salvar e Continuar e Voltar", para remover a ação basta remover o label da ação que deseja que não apareça, pode ser retornar "URL" junto com o label para indicar para onde deve ser redirecionado ao clicar, a url da tela de listagem é "/relationshipTribute".

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"pageCustomActions": [

"label": "Serviço",

{
            "

type

label": "

number

Salvar"
        },

{

"visible": false,

 {
            "

allowColumnsManager

label":

true,

"Salvar e Continuar"
        },

"property": "codCfop",

    {
            "label": "

CFOP

Voltar",
            "

type

url": "

string

/relationshipTribute"
        }

, { "visible": false,

Image Added

validateFields

Indica quais campos do po-dynamic-form ira executar a validação ao sair do campo, a validação em sí é feita na API de dados "/dts/datasul-rest/resources/prg/ftp/v1/refRelationshipTribute/validate", enviando para a API qual campo foi modificado e o registro completo. Para saber mais sobre o que pode ser feito com este campo, consulte a documentação do PO-UI: PoDynamicFormValidation

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"validateFields": [

allowColumnsManager": true, "property": "uf", "label": "UF", "type": "string" }, { "visible": false, "allowColumnsManager": true, "property": "city", "label": "Cidade", "type": "string" }, { "visible": false,

codRowid"
]

createDynamicFormFields

formulário dinâmico do cadastro de Relacionamento x Tributo, deve vir um array de objetos que implementam a interface PoDynamicFormField. Para mais informações do que é possível inserir acessar a documentação do Portinari: po-dynamic-form

Informações

Caso a propriedade tenha "searchService" é possível enviar na URL o queryParam "acceptAsterisk" como true pare que seja possivel no lookup informar "*" e seja automaticamente retornado "* - Todos" sem fazer o envio da requisição para a API, exemplo:

"searchService": "/dts/datasul-rest/resources/prg/cdp/v1/establishmentsPublic?acceptAsterisk=true"

OBS: Para as APIs padrões da tela o tratamento já foi feito, caso queira alterar ou incluir outras, a API precisa retornar "code" e "description" para funcionar, sendo o "code" o "*" e a "description o "Todos", e no metadata o format precisa ser "format": [ "code", "description"], assim como também "fieldValue": "code" e "fieldLabel": "description"

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"createDynamicFormFields": [

"allowColumnsManager": true,

{
            "

property

gridColumns":

"deferralPercent"

6,
            "

label

property": "

Perc Diferido

tributeType",
            "

type

options":

"number"

},

"visible":

false,

allowColumnsManager

label":

true,

property

CBS"

: "reductionPercent"

"label":

"Perc Redução",

type

value":

"number"

},

{ "visible": false

},

"allowColumnsManager":

true,

"property":

"presumCredPercent",

"label": "

Perc

IBS

Créd Presumido

Mun",

"type

       "value":

"number"

},

{

},

"visible":

false,

"allowColumnsManager":

true,

property

label": "

taxExemptionRate

IBS UF",

"label":

"Aliq

Desoneração",

type

value":

"number"

},

{

},

"visible":

false,

"allowColumnsManager":

true,

property

label": "

taxableUnitMeasureIs

IS",

"label": "Unid Med Tributável IS",

type

value":

"string"

},

{

"visible": false

],
            "

allowColumnsManager

disabled":

true

false,
            "

property

label": "

taxExemptionRate

Tributo",
            "

label

type":

"Aliq Espec Unid Med Aprop IS "

"label",
            "key": true,
            "

type

required":

"number"

true,

} ]

Image Removed

detailedInfoDynamicViewFields

Expansão da linha da tabela, dados completos da tabela. Neste componente é utilizado o po-dynamic-view e todas as propriedades do PoDynamicViewField podem ser utilizadas.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"detailedInfoDynamicViewFields

   "labels": [

{

"gridColumns": 4,

property

color": "

tributeType

color-10",

"options":

[

       "tooltip": "Contribuição sobre bens

{

e serviço",
                    "label": "CBS",
                    "value": 1
                },
                {
                    "

label

color": "

IBS Mun

color-01",
                    "

value

tooltip":

2

"Imposto sobre Bens e

}, {

serviço (Município)",
                    "label": "IBS

UF

MUN",
                    "value":

3

label

color": "

IS

color-05",
                    "

value

tooltip":

4

"Imposto sobre Bens e

}

serviço (Estadual)",

],

        "label": "

Tributo

IBS UF",

"placeholder": "Situação",

type

value":

"label",

"labels": [

    },
                {
                    "color": "color-

10

08",
                    "tooltip": "

Contribuição sobre bens e serviço

Imposto Seletivo",
                    "label": "

CBS

IS",
                    "value":

1

4
                }

,

{

    },
        {
            "

color

gridColumns":

"color-01"

6,

"tooltip

"divider": "

Imposto sobre Bens e serviço (Município)

Informações principais",

"label

"property": "

IBS MUN

dateValidIni",

"value

"disabled":

2

false,
            "label": "Data inicio

}

Validade",
            "placeholder": "Data

{

de Validade",

color

type": "

color-05

date",
            "required": true

"tooltip": "Imposto sobre Bens e serviço (Estadual)"

 },
        {
            "

label

gridColumns":

"IBS UF"

6,

value

property":

3

"documentType",

},

"options": [
                {
                    "

color

label": "

color-08

Entrada",
                    "

tooltip

value":

"Imposto Seletivo",

1
                },

"label": "IS",

    {
                    "

value

label":

4

"Saida",

}

   "value": 2

]

,

{

  ],
            "

gridColumns

disabled":

4

false,
            "

property

label": "

aliquot

Tipo Documento",
            "

format

type": "

0.3-4

label",
            "

label

required":

"Alíquota"

true,
            "

type

labels":

"number"

},

        {
                    "

gridColumns

color":

4

"color-10",
                    "

property

tooltip": "

dateValidIni

Documento de entrada",
                    "label": "

Dt Inicio validade

Entrada",
                    "

type

value":

"date"

},

{

},

"gridColumns":

4,

"property":

"codEstab",

label

color": "

Estabelecimento

color-01",

"type": "string"

       "tooltip": "Documento de

}

saida",

{

gridColumns

label":

4

"Saida",

"property

        "value":

"codNaturOperac",

"label": "Natureza de Operação",

"type": "string"

]
        },
        {
            "gridColumns":

4

6,
            "

property

searchService": "

codNcm

/dts/datasul-rest/resources/prg/cdp/v1/establishmentsPublic?acceptAsterisk=true",
            "

label

columns": [

"Classificação

Fiscal",

"type": "string"

},

{

    "property": "code",

"gridColumns":

4,

property

label": "

codClientGroup

Código",
                    "

label

type": "

Grupo

string"

,

"type":

"number"

},

{

"gridColumns":

4,

            "property": "

codIssuer

name",
                    "label": "

Emitente

Nome",
                    "type": "

number

string"
                }

,

{

 ],
            "

gridColumns

fieldLabel":

4

"name",
            "property": "

codItem

codEstab",
            "

label

format": [

"Item

      "code",

"type":

string

name"

}

],

{

   "disabled": false,
            "

gridColumns

label":

4

"Estabelecimento",
            "

property

placeholder": "

documentType

Estabelecimento: * para todos",
            "

label

fieldValue": "

Tipo Documento

code",
            "

type

required":

"number"

true
        },
        {
            "gridColumns":

4

6,
            "

property

searchService": "

codService

/dts/datasul-rest/resources/prg/cdp/v1/cfgTransactionType?acceptAsterisk=true",
            "

label

columns":

"Serviço",

"type":

"number"

},

{

gridColumns

property":

4

"natOperation",

"property":

"codCfop",

            "label": "

CFOP

Código",
                    "type": "string"
                },

{

"gridColumns":

4,

            "property": "

uf

descriptionType",
                    "label": "

UF

Tipo",
                    "type": "string"
                },

{

"gridColumns": 4,

              "property": "

city

description",
                    "label": "

Cidade

Descrição",
                    "type": "string"

},

{

"gridColumns": 4

],
            "

divider

fieldLabel": "

Alíquotas e percentuais

description",
            "property": "

deferralPercent

codNaturOperac",
            "

label

format": [

"Perc Diferido

     "natOperation",

"type":

number

description"

}

],

{

   "disabled": false,
            "

gridColumns

label":

4

"Natureza de Operação",
            "

property

placeholder": "

reductionPercent

Natureza - * para todos",
            "

label

fieldValue": "

Perc Redução

natOperation",
            "

type

required":

"number"

true
        },
        {
            "gridColumns":

4

6,
            "

property

searchService": "

presumCredPercent

/dts/datasul-rest/resources/prg/cdp/v1/operationTypesPublic?acceptAsterisk=true",
            "

label

columns": [

"Perc

Créd

Presumido",

"type": "number"

},

{

    "property": "code",

"gridColumns":

4,

property

label": "

taxExemptionRate

Código",

"label":

"Aliq

Desoneração",

"type": "

number

string"
                },

{

"gridColumns": 4,

              "property": "

taxableUnitMeasureIs

description",
                    "label": "

Unid Med Tributável IS",

Descrição",
                    "type": "string"
                },

{

"gridColumns": 4,

               "property": "

taxExemptionRate

addIinformation",
                    "label": "

Aliq Espec Unid Med Aprop IS ",

Informações Adicionais",
                    "type": "

number

string"
                }

]advancedFilters

Busca avançada da tela, permite o filtro pelos valores preenchidos. Neste componente é utilizado o po-dynamic-form e todas as propriedades do PoDynamicFormField podem ser utilizadas.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"advancedFilters": [

],

{

"fieldLabel": "addIinformation",
            "

gridColumns

property":

12

"codCfop",
            "

optionsMulti

format":

true,

"property":

tributeType

code",
                "

options

description"

: [

],

{

        "disabled": false,
            "label": "

CBS

CFOP",
            "placeholder": "CFOP: * para todos",
            "

value

fieldValue":

1

"code",
            "required": true
        },
        {

{

"gridColumns": 6,
            "

label

searchService": "

IBS Mun

/dts/datasul-rest/resources/prg/cdp/v1/serviceCode?acceptAsterisk=true",

"value

"columns":

2

},

{

     "property": "code",
                    "label": "

IBS UF

Código",
                    "

value

type":

3

label

property": "

IS

description",
                    "

value

label":

4

"Descrição",

}

    "type": "string"

],

"label": "Tributo",

"placeholder": "Tributo"

],
            "

type

fieldLabel": "

label

description",
            "

labels

property":

[

"codService",

{ "color

"format":

"color-10",

"tooltip": "Contribuição sobre bens e serviço

"code",
                "description"

"label":

"CBS",

        ],
            "

value

disabled":

1

false,
            "label": "Código de Serviço do

}

Item",
            "placeholder": "Código de Serviço

{

do Item: * para padrão",

color

fieldValue": "

color-01

code",
            "required": true

"tooltip": "Imposto sobre Bens e serviço (Município)"

 },
        {
            "

label

gridColumns":

"IBS MUN"

6,

value

searchService":

2

"/dts/datasul-rest/resources/prg/cdp/v1/customerGroupsPublic?acceptAsterisk=true",

},

"columns": [
                {
                    "

color

property": "

color-05

code",
                    "

tooltip

label": "

Imposto sobre Bens e serviço (Estadual)

Código",
                    "

label

type": "

IBS UF

string"

,

},

"value":

3

},

{

"property": "description",
                    "

color

label": "

color-08

Descrição",
                    "

tooltip

type": "

Imposto Seletivo

string"

,

"label": "IS"

 ],
            "fieldLabel": "description",
            "

value

property":

4

"codClientGroup",
            "format": [

}

]

"code",

},

{

"description"

"gridColumns": 6

],
            "

property

disabled":

"dateValidIni"

false,
            "label": "

Data

Grupo

Validade

de

inicial

cliente/fornecedor",
            "placeholder": "

Data Inicial

Grupo de cliente: * para todos",
            "

type

fieldValue": "

date

code",
            "

fieldValue

required":

"1990-01-01"

true
        },
        {
            "gridColumns": 6,
            "

property

searchService": "

dateValidFim

/dts/datasul-rest/resources/prg/cdp/v1/customerPublic?acceptAsterisk=true",
            "

label

columns":

"Data Validade final",

 [
                {

"placeholder

        "property": "

Data Final

customerCode",

"type

       "label": "

date

Código",
                    "

fieldValue

type": "

9999-12-31

string"
                },

{

"gridColumns": 6,

                "property": "

codEstabIni

customerName",

"label":

"Estabelecimento

inicial",

"placeholder

"label": "

Estabelecimento Inicial

Nome",

"type": "string",

fieldValue

type": "string"

,

"maxLength":

5

},

{

],
            "

gridColumns

fieldLabel":

6

"customerName",
            "property": "

codEstabFim

codIssuer",
            "

label

format":

"Estabelecimento final",

"placeholder":

Estabelecimento Final

customerCode",

"type":

string

customerName"

,

"fieldValue": "ZZZZZ"

],
            "

maxLength

disabled":

5

false,

}

    "label": "Cliente/Fornecedor",

{

    "placeholder": "Cliente/Fornecedor: * para

"gridColumns": 6

todos",
            "

property

fieldValue": "

codNaturOperacIni

customerCode",
            "

label

required":

"Natureza de Operação inicial",

true
        },

"placeholder":

"Natureza

de

Operação

inicial",

{
            "

type

gridColumns":

"string"

6,
            "

fieldValue

searchService": "/dts/datasul-rest/resources/prg/cdp/v1/product?acceptAsterisk=true",
            "

maxLength

columns":

6

},

"gridColumns":

6,

       "property": "

codNaturOperacFim

product",
                    "label": "

Natureza de Operação final

Código",

"placeholder": "Natureza de Operação final",

            "type": "string"

,

"fieldValue":

"ZZZZZZ",

},

"maxLength":

6

},

{

gridColumns

property":

6

"productDescription",

"property

        "label": "

codCfopIni

Nome",
                    "

label

type": "

CFOP inicial

string"

,

"placeholder": "CFOP inicial"

},

"type": "string",

"fieldValue

      "property": "unitMeasure",

"maxLength

        "label":

10

"Unidade Medida",

},

{

"type": "string"

"gridColumns": 6,

"property": "codCfopFim"

],
            "

label

fieldLabel": "

CFOP final

unitMeasure",
            "

placeholder

property": "

CFOP final

codItem",
            "

type

format":

"string",

"fieldValue":

ZZZZZZZZZZ

product",

"maxLength":

10

   "productDescription"

},

{

],
            "

gridColumns

disabled":

6

false,
            "

property

label": "

codServiceIni

Item",
            "

label

placeholder": "

Código Serviço inicial

Item: * para todos",
            "

placeholder

fieldValue": "

Código Serviço inicial

product",
            "

type

required":

"number",

true
        },
        {
            "

fieldValue

gridColumns":

""

6,
            "

mask

searchService": "

99.999"

/dts/datasul-rest/resources/prg/cdp/v1/fiscalClassification?acceptAsterisk=true",

},

    "columns": [

{

"gridColumns": 6,

"property":

"codServiceFim",

label

property": "

Código Serviço final

fiscalClassification",

"placeholder": "Código

Serviço

final",

type

label": "

number

Código",

"fieldValue":

"99999",

mask

type": "

99.999

string"

},

{

},

"gridColumns":

6,

"property":

"codClientGroupIni",

label

property": "

Código Grupo Cliente inicial

description",

"placeholder": "Código Grupo Cliente inicial",

type

label": "

string

Descrição",
                    "

fieldValue

type": "string"

,

"maxLength":

5

},

{

],
            "

gridColumns

fieldLabel":

6

"description",
            "property": "

codClientGroupFim

codNcm",
            "

label

format": [

"Código

Grupo

Cliente

final",

placeholder

fiscalClassification"

:

"Código

Grupo

Cliente

final",

type": "string",

description"

"fieldValue": "ZZZZZ"

],
            "

maxLength

disabled":

5

false,

},

    "label":

{

"Classificação Fiscal",
            "placeholder"

gridColumns

: "Classificação Fiscal:

6

 * para todos",
            "

property

fieldValue": "

codIssuerIni

fiscalClassification",
            "

label

required":

"Emitente inicial",

true
        },

"placeholder":

"Emitente

inicial",

{
            "

type

gridColumns":

"number"

6,
            "

fieldValue

searchService": "/dts/datasul-rest/resources/prg/cdp/v2/federatedState?acceptAsterisk=true",
            "

mask

columns":

"999999999"

},

        {
                    "

gridColumns

property":

6

"code",

"property

      "label": "

codIssuerFim

Sigla",
                    "

label

type": "

Emitente final

string"

,

"placeholder": "Emitente final"

},

"type": "number",

"fieldValue

        "property": "

999999999

name",

"mask":

"999999999"

}

"label": "Cidade",

{

gridColumns

type":

6,

"string"

"property":

"codItemIni",

},

"label":

"Item

inicial",

"placeholder":

"Item

inicial",

type

property": "

string

country",
                    "

fieldValue

label": "Pais",

"maxLength":

16

},

"type": "string"

{

"gridColumns": 6,

"property": "codItemFim"

],
            "

label

fieldLabel": "

Item final

country",
            "

placeholder

property": "

Item final

uf",
            "

type

format":

"string",

"fieldValue":

ZZZZZZZZZZZZZZZZ

code",

"maxLength":

16

"name"

},

{

],
            "

gridColumns

disabled":

6

false,
            "

property

label": "

codNcmIni

Estado",
            "

label

placeholder": "

Classificação Fiscal inicial

Estado: * para todos",
            "

placeholder

params":

"Classificação Fiscal inicial",

{
                "

type

onlyBrasil":

"string"

true
            },
            "fieldValue": "code",
            "

maxLength

required":

8

true
        },
        {
            "gridColumns": 6,
            "property": "city",

"codNcmFim"

      "disabled": false,
            "label": "

Classificação Fiscal final

Cidade",
            "placeholder": "

Classificação Fiscal final

Cidade: * para todos",
            "type": "string",
            "maxLength": 50,
            "required": true
        },

"fieldValue": "ZZZZZZZZ",

 {
            "

maxLength

thousandMaxlength":

8

3,

},

{

"gridColumns": 6,
            "

gridColumns

divider":

6

 "Alíquotas e Percentuais",
            "property": "

ufIni

aliquot",
            "

label

optional":

"UF inicial"

true,
            "

placeholder

label": "

Unidade Federativa inicial

Alíquota",
            "type": "

string

currency",
            "

fieldValue

required":

""

false,
            "

maxLength

decimalsLength":

2

4
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 6,
            "property": "

ufFim

reductionPercent",
            "

label

optional":

"UF final"

true,
            "

placeholder

label": "

Unidade

Perc

Federativa final

Redução",
            "type": "

string

currency",
            "

fieldValue

required":

"ZZ"

false,
            "

maxLength

decimalsLength":

2

4
        },
        {

{

     "thousandMaxlength": 3,
            "gridColumns": 6,
            "property": "

cityIni

deferralPercent",
            "

label

optional":

"Cidade inicial"

true,
            "

placeholder

label": "

Cidade

Perc

inicial

Diferido",
            "type": "

string

currency",
            "

fieldValue

required":

""

false,
            "

maxLength

decimalsLength":

50

4
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 6,
            "property": "

cityFim

presumCredPercent",
            "

label

optional":

"Cidade final"

true,
            "

placeholder

label": "

Cidade

Perc Créd

final

Presumido",
            "type": "

string

currency",
            "

fieldValue

required":

"ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"

false,
            "

maxLength

decimalsLength":

50

4
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 6,
            "property": "

pageSize

taxExemptionRate",
            "

label

optional":

"Número de registros"

true,
            "

placeholder

label": "

Numero

Aliq

de registros

Desoneração",
            "type": "

string

currency",
            "

fieldValue

required":

"20"

false,
            "

maxLength

decimalsLength":

2

4
        }
]

Image Removed

...

Image Added

05. Observações Gerais
Âncora
5
5

...

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

CONTEÚDO
Âncora

início
início

01. Visão Geral
Âncora
1
1

02. API x Pontos UPC Relacionados
Âncora
2
2

API REST: ftp/api/v1/refRelationshipTribute.p.

URL base para requisições: https://<servidor>:<porta>/api/ftp/v1/refRelationshipTribute.p.

03. JSON de metadata
Âncora
3
3

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

05. Observações Gerais
Âncora
5
5

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

CONTEÚDO Âncora

inícioinício

01. Visão Geral Âncora11

02. API x Pontos UPC Relacionados Âncora22

API REST: ftp/api/v1/refRelationshipTribute.p.

URL base para requisições: https://<servidor>:<porta>/api/ftp/v1/refRelationshipTribute.p.

03. JSON de metadata Âncora33

04. Especificidades de Customização Âncora44

05. Observações Gerais Âncora55

CONTEÚDO
Âncora

início
início

01. Visão Geral
Âncora
1
1

02. API x Pontos UPC Relacionados
Âncora
2
2

03. JSON de metadata
Âncora
3
3

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

05. Observações Gerais
Âncora
5
5