Histórico da Página

...

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 Parâmetros Estabelecimento Relacionamento x GNRETributo
2. Tela - Novo/Editar Parâmetros Estabelecimento x GNRE
  1. Aba Geral
  2. Aba Fornecedor x UF
  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 Guias GNRE Relacionamento x Tributo item de menu Parâmetros Estabelecimento Relacionamento x GNRETributo (html-mft.guiasGnrerelationshipTribute), aqui será descrito quais componentes e elementos podem ser customizados.

...

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/
gnreParameters
refRelationshipTribute.p.
URL base para requisições: https://<servidor>:<porta>/api/ftp/v1/
gnreParameters
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/<código estabelecimento><ROWID do registro>?type=edit	getMetaData	edit	Metadados	Estrutura metadados da tela de edição. GET	*URL_Base*/metadata/<código estabelecimento>?type=copy	getMetaData	detail	Metadados	Estrutura metadados da tela de detalhes.

Manipulação de Dados
Método (API)	Endpoint (API)	Endpoint (UPC)	Evento (UPC)	Entrada (UPC)	Observação
GET	*URL_Base*/<codigo estabelecimento><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*/<código estabelecimento><ROWID do registro>	delete	beforeDelete	Vazio	Executado antes da eliminação de um registro.
DELETE	*URL_Base*/<código estabelecimento><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

{
    "descTpDespICMSUfDestdateValidIni": "INVESTIMENTO ETE2025-03-21",
    "descTpDespFCPcodEstab": "INVESTIMENTO ETE*",
    "estabcodNaturOperac": "1*",
    "ccICMSSTdeferralPercent": ""0,
    "espICMSSTaliquot": "dp"0,
    "descEspFCPdocumentType": "duplicata"1,
    "espICMSUfDestcity": "dpJoinville",
    "updateInfAdicAuto": false,
    "descEspICMSUfDestcodCfop": "duplicata*",
    "ctFCPcodClientGroup": "11361198"0,
    "updateApbAutopresumCredPercent": true0,
    "tpDespICMSSTtaxExemptionRate": 210,
    "espFCPuf": "dpSanta Catarina",
    "ccFCPspeciAliquotPerApproUniMedIs": ""0,
    "descEspICMSSTtributeType": "duplicata"2,
    "ctICMSUfDestcodIssuer": "11361198"0,
    "ccICMSUfDestcodService": ""0,
    "descTpDespICMSSTcodNcm": "INVESTIMENTO ETE*",
    "tpDespFCPcodItem": 21"*",
    "integApbtaxableUnitMeasureIs": true0,
    "estabNamereductionPercent": "Estabelecimento Automação - TOTVS",
    "tpDespICMSUfDest": 21,
    "ctICMSST": "00001116"
}0
}

03. JSON de metadata
Âncora
3
3

...

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/<código estabelecimento><chave do registro>?type=edit	Utiliza o código a chave do estabelecimento registro como path param.
Copia	GET	*URL_Base*/metadata/<código estabelecimento><chave do registro>?type=copy	Utiliza o código a chave do estabelecimento registro como path param.

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

a) Tela - Listagem Parâmetros Estabelecimento Relacionamento x GNRE 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.

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 urlpageCustomActions[{ "label":"Novo Parâmetro", "url":"\/gnre\/gnreParameters\/new" }]

Image Removed

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, Copy e Delete, caso necessário criar ou ação diferente ela deve possuir tanto label quanto urltableCustomActions[{ "label":"Edit" },{ Copy }{ "label":"Delete" }]

Image Removed

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-tablecolumnsList "allowColumnsManager":true, "property":"estab", Estabelecimento, "type":"string", "key":true, "order":1 },{ "allowColumnsManager":true, "booleanTrue":"Sim", "property":"integApb", "booleanFalse":"Não", Integra APB, "type":"boolean", "order":2 },{ "allowColumnsManager":true, "booleanTrue":"Sim", "property":"updateApbAuto", "booleanFalse":"Não", "label":"Atualiza APB Automático", "type":"boolean", "order":3 }]

Image Removed

Propriedade

DescriptionDescrição

title

Título da página.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"title":"Parâmetros EstabelecimentoRelacionamento x GNRETributo"

Image RemovedImage Added

pageCustomActions

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

tableCustomActions

.

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"

columnsList


            "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"

icmsStView

Elemento que se encontra dentro da expansão da linha da tabela, dados sobre o ICMS ST. Neste componente é utilizado o po-dynamic-view e todas as propriedades do PoDynamicViewField podem ser utilizadas.

Informações
Caso o icmsStView, icmsUfDestView e o fcpView não sejam enviados a expansão da linha não será exibida, caso apenas um ou dois desses elementos não sejam enviados a expansão ainda é criada, exibindo os elementos enviados.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"icmsSTView":[{
    "gridColumns":6,
    "property":"espICMSST",
    "label":"Espécie",
    "type":"string", 
    "order":1
},{
    "gridColumns":6,
    "property":"tpDespICMSST",
    "label":"Tipo Despesa",
    "type":"string",
    "order":2
},{
    "gridColumns":6,
    "property":"ctICMSST",
    "label":"Conta Contábil",
    "type":"string",
    "order":3
},{
    "gridColumns":6,
    "property":"ccICMSST",
    "label":"Centro Custo",
    "type":"string",
    "order":4
}],

Image Removed

icmsUfDestView

Elemento que se encontra dentro da expansão da linha da tabela, dados sobre o ICMS Uf Dest. Neste componente é utilizado o po-dynamic-view e todas as propriedades do PoDynamicViewField podem ser utilizadas.

Informações
Caso o icmsStView, icmsUfDestView e o fcpView não sejam enviados a expansão da linha não será exibida, caso apenas um ou dois desses elementos não sejam enviados a expansão ainda é criada, exibindo os elementos enviados.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"icmsUfDestView":[{
    "gridColumns":6,
    "property":"espICMSUfDest"",
    "label":"Espécie",
    "type":"string", 
    "order":1
},{
    "gridColumns":6,
    "property":"tpDespICMSUfDest"",
    "label":"Tipo Despesa",
    "type":"string",
    "order":2
},{
    "gridColumns":6,
    "property":"ctICMSUfDest"",
    "label":"Conta Contábil",
    "type":"string",
    "order":3
},{
    "gridColumns":6,
    "property":"ccICMSUfDest""",
    "label":"Centro Custo",
    "type":"string",
    "order":4
}],

Image Removed

fcpView

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

Informações
Caso o icmsStView, icmsUfDestView e o fcpView não sejam enviados a expansão da linha não será exibida, caso apenas um ou dois desses elementos não sejam enviados a expansão ainda é criada, exibindo os elementos enviados.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"icmsUfDestView":[{
    "gridColumns":6,
    "property":"espICMSUfDest"",
    "label":"Espécie",
    "type":"string", 
    "order":1
},{
    "gridColumns":6,
    "property":"tpDespICMSUfDest"",
    "label":"Tipo Despesa",
    "type":"string",
    "order":2
},{
    "gridColumns":6,
    "property":"ctICMSUfDest"",
    "label":"Conta Contábil",
    "type":"string",
    "order":3
},{
    "gridColumns":6,
    "property":"ccICMSUfDest""",
    "label":"Centro Custo",
    "type":"string",
    "order":4
}],

...

A tela de novo/editar não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-table por exemplo, e sim utilizando o po-page-default, po-lookup, po-dynamic-form, po-tabs e 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.

...

Título da página, essa informação pode ser:

novo;
editando;
copiando.

dependendo do type enviado na requisição que busca o metadata.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"title":"Novo Parâmetro Estabelecimento X GNRE"

...

O caminho de migalhas da página, mostrando a página atual e a pagina anterior com o link para voltar

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"items":[{
        "link":"\/gnre\/gnreParameters",
        "label":"Lista Parâmetros Estabelecimento x GNRE"
    },
    {
       "link":"\/gnre\/gnreParameters",
       "label":"Novo Parâmetro"
    }
]

Image Removed

...

URL utilizada para buscar os dados da aba "Geral"

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"urlGnre":"\/dts\/datasul-rest\/resources\/prg\/ftp\/v1\/gnreParameters"

...

formulário dinâmico da aba geral, 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

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

Obs: O exemplo aqui contem apenas 1 dos switches e 1 dos lookups como exemplo, pois o json completo para essa aba é longo.

"generalTab":[{
    "gridColumns":6,
    "booleanTrue":"Sim",
    "property":"integApb",
    "booleanFalse":"Não",
    "optional":true,
    "label":"Integrar com o Contas a pagar",
    "type":"boolean",
    "order":2
},{
    "gridColumns":6,
    "columns":[{
        "visible":true,
        "property":"code",
        "width":"25%",
        "label":"Código",
        "type":"string"
    },
    {
        "visible":true,
        "property":"description",
        "width":"50%",
        "label":"Descrição",
        "type":"string"
    },
    {
        "property":"documentTypeDescription",
        "width":"25%",
        "label":"Tipo",
        "type":"string"
    }],
    "format":[
        "code",
        "description"
    ],
    "optional":true,
    "label":"Espécie Padrão",
    "params":{
        "module":"apb",
        "order":"module"
    },
    "fieldValue":"code",
    "required":false,
    "divider":"ICMS ST",
    "searchService":"\/dts\/datasul-rest\/resources\/prg\/fin\/v1\/documentType",
    "fieldLabel":"description",
    "property":"espICMSST",
    "disabled":true,
    "order":5
}]

Image Removed

...

Campos do formulário que terão validações quando forem preenchidos, corresponde a propriedade p-validate-fields do componente dinâmico po-dynamic-form.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"validateFields":[
      "estab",
      "integApb",
      "ctICMSST",
      "ctICMSUfDest",
      "ctFCP"
]

...

}
]

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",
            "type": "number",
            "fieldValue": "",
            "mask": "99.999"
        },
        {
            "gridColumns": 6,
            "property": "codServiceFim",
            "label": "Código Serviço final",
            "placeholder": "Código Serviço final",
            "type": "number",
            "fieldValue": "99999",
            "mask": "99.999"
        },
        {
            "gridColumns": 6,
            "property": "codClientGroupIni",
            "label": "Código Grupo Cliente inicial",
            "placeholder": "Código Grupo Cliente inicial",
            "type": "string",
            "fieldValue": "",
            "maxLength": 5
        },
        {
            "gridColumns": 6,
            "property": "codClientGroupFim",
            "label": "Código Grupo Cliente final",
            "placeholder": "Código Grupo Cliente final",
            "type": "string",
            "fieldValue": "ZZZZZ",
            "maxLength": 5
        },
        {
            "gridColumns": 6,
            "property": "codIssuerIni",
            "label": "Emitente inicial",
            "placeholder": "Emitente inicial",
            "type": "number",
            "fieldValue": "",
            "mask": "999999999"
        },
        {
            "gridColumns": 6,
            "property": "codIssuerFim",
            "label": "Emitente final",
            "placeholder": "Emitente final",
            "type": "number",
            "fieldValue": "999999999",
            "mask": "999999999"
        },
        {
            "gridColumns": 6,
            "property": "codItemIni",
            "label": "Item inicial",
            "placeholder": "Item inicial",
            "type": "string",
            "fieldValue": "",
            "maxLength": 16
        },
        {
            "gridColumns": 6,
            "property": "codItemFim",
            "label": "Item final",
            "placeholder": "Item final",
            "type": "string",
            "fieldValue": "ZZZZZZZZZZZZZZZZ",
            "maxLength": 16
        },
        {
            "gridColumns": 6,
            "property": "codNcmIni",
            "label": "Classificação Fiscal inicial",
            "placeholder": "Classificação Fiscal inicial",
            "type": "string",
            "fieldValue": "",
            "maxLength": 8
        },
        {
            "gridColumns": 6,
            "property": "codNcmFim",
            "label": "Classificação Fiscal final",
            "placeholder": "Classificação Fiscal final",
            "type": "string",
            "fieldValue": "ZZZZZZZZ",
            "maxLength": 8
        },
        {
            "gridColumns": 6,
            "property": "ufIni",
            "label": "UF inicial",
            "placeholder": "Unidade Federativa inicial",
            "type": "string",
            "fieldValue": "",
            "maxLength": 2
        },
        {
            "gridColumns": 6,
            "property": "ufFim",
            "label": "UF final",
            "placeholder": "Unidade Federativa final",
            "type": "string",
            "fieldValue": "ZZ",
            "maxLength": 2
        },
        {
            "gridColumns": 6,
            "property": "cityIni",
            "label": "Cidade inicial",
            "placeholder": "Cidade inicial",
            "type": "string",
            "fieldValue": "",
            "maxLength": 50
        },
        {
            "gridColumns": 6,
            "property": "cityFim",
            "label": "Cidade final",
            "placeholder": "Cidade final",
            "type": "string",
            "fieldValue": "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ",
            "maxLength": 50
        },
        {
            "gridColumns": 6,
            "property": "pageSize",
            "label": "Número de registros",
            "placeholder": "Numero de registros",
            "type": "string",
            "fieldValue": "20",
            "maxLength": 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 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": {
        "items": [
            {
                "link": "/relationshipTribute",
                "label": "Lista Relacionamento Tributo"
            },
            {
                "link": "/relationshipTribute",
                "label": "Novo Relacionamento"
            }
        ]
}

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": "Salvar"
        },
        {
            "label": "Salvar e Continuar"
        },
        {
            "label": "Voltar",
            "url": "/relationshipTribute"
        }
]

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": [
        "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": [
        {
            "gridColumns": 6,
            "property": "tributeType",
            "options": [
                {
                    "label": "CBS",
                    "value": 1
                },
                {
                    "label": "IBS Mun",
                    "value": 2
                },
                {
                    "label": "IBS UF",
                    "value": 3
                },
                {
                    "label": "IS",
                    "value": 4
                }
            ],
            "disabled": false,
            "label": "Tributo",
            "type": "label",
            "key": true,
            "required": true,
            "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,
            "divider": "Informações principais",
            "property": "dateValidIni",
            "disabled": false,
            "label": "Data inicio Validade",
            "placeholder": "Data de Validade",
            "type": "date",
            "required": true
        },
        {
            "gridColumns": 6,
            "property": "documentType",
            "options": [
                {
                    "label": "Entrada",
                    "value": 1
                },
                {
                    "label": "Saida",
                    "value": 2
                }
            ],
            "disabled": false,
            "label": "Tipo Documento",
            "type": "label",
            "required": true,
            "labels": [
                {
                    "color": "color-10",
                    "tooltip": "Documento de entrada",
                    "label": "Entrada",
                    "value": 1
                },
                {
                    "color": "color-01",
                    "tooltip": "Documento de saida",
                    "label": "Saida",
                    "value": 2
                }
            ]
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/cdp/v1/establishmentsPublic?acceptAsterisk=true",
            "columns": [
                {
                    "property": "code",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "name",
                    "label": "Nome",
                    "type": "string"
                }
            ],
            "fieldLabel": "name",
            "property": "codEstab",
            "format": [
                "code",
                "name"
            ],
            "disabled": false,
            "label": "Estabelecimento",
            "placeholder": "Estabelecimento: * para todos",
            "fieldValue": "code",
            "required": true
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/cdp/v1/cfgTransactionType?acceptAsterisk=true",
            "columns": [
                {
                    "property": "natOperation",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "descriptionType",
                    "label": "Tipo",
                    "type": "string"
                },
                {
                    "property": "description",
                    "label": "Descrição",
                    "type": "string"
                }
            ],
            "fieldLabel": "description",
            "property": "codNaturOperac",
            "format": [
                "natOperation",
                "description"
            ],
            "disabled": false,
            "label": "Natureza de Operação",
            "placeholder": "Natureza - * para todos",
            "fieldValue": "natOperation",
            "required": true
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/cdp/v1/operationTypesPublic?acceptAsterisk=true",
            "columns": [
                {
                    "property": "code",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "description",
                    "label": "Descrição",
                    "type": "string"
                },
                {
                    "property": "addIinformation",
                    "label": "Informações Adicionais",
                    "type": "string"
                }
            ],
            "fieldLabel": "addIinformation",
            "property": "codCfop",
            "format": [
                "code",
                "description"
            ],
            "disabled": false,
            "label": "CFOP",
            "placeholder": "CFOP: * para todos",
            "fieldValue": "code",
            "required": true
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/cdp/v1/serviceCode?acceptAsterisk=true",
            "columns": [
                {
                    "property": "code",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "description",
                    "label": "Descrição",
                    "type": "string"
                }
            ],
            "fieldLabel": "description",
            "property": "codService",
            "format": [
                "code",
                "description"
            ],
            "disabled": false,
            "label": "Código de Serviço do Item",
            "placeholder": "Código de Serviço do Item: * para padrão",
            "fieldValue": "code",
            "required": true
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/cdp/v1/customerGroupsPublic?acceptAsterisk=true",
            "columns": [
                {
                    "property": "code",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "description",
                    "label": "Descrição",
                    "type": "string"
                }
            ],
            "fieldLabel": "description",
            "property": "codClientGroup",
            "format": [
                "code",
                "description"
            ],
            "disabled": false,
            "label": "Grupo de cliente/fornecedor",
            "placeholder": "Grupo de cliente: * para todos",
            "fieldValue": "code",
            "required": true
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/cdp/v1/customerPublic?acceptAsterisk=true",
            "columns": [
                {
                    "property": "customerCode",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "customerName",
                    "label": "Nome",
                    "type": "string"
                }
            ],
            "fieldLabel": "customerName",
            "property": "codIssuer",
            "format": [
                "customerCode",
                "customerName"
            ],
            "disabled": false,
            "label": "Cliente/Fornecedor",
            "placeholder": "Cliente/Fornecedor: * para todos",
            "fieldValue": "customerCode",
            "required": true
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/cdp/v1/product?acceptAsterisk=true",
            "columns": [
                {
                    "property": "product",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "productDescription",
                    "label": "Nome",
                    "type": "string"
                },
                {
                    "property": "unitMeasure",
                    "label": "Unidade Medida",
                    "type": "string"
                }
            ],
            "fieldLabel": "unitMeasure",
            "property": "codItem",
            "format": [
                "product",
                "productDescription"
            ],
            "disabled": false,
            "label": "Item",
            "placeholder": "Item: * para todos",
            "fieldValue": "product",
            "required": true
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/cdp/v1/fiscalClassification?acceptAsterisk=true",
            "columns": [
                {
                    "property": "fiscalClassification",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "description",
                    "label": "Descrição",
                    "type": "string"
                }
            ],
            "fieldLabel": "description",
            "property": "codNcm",
            "format": [
                "fiscalClassification",
                "description"
            ],
            "disabled": false,
            "label": "Classificação Fiscal",
            "placeholder": "Classificação Fiscal: * para todos",
            "fieldValue": "fiscalClassification",
            "required": true
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/cdp/v2/federatedState?acceptAsterisk=true",
            "columns": [
                {
                    "property": "code",
                    "label": "Sigla",
                    "type": "string"
                },
                {
                    "property": "name",
                    "label": "Cidade",
                    "type": "string"
                },
                {
                    "property": "country",
                    "label": "Pais",
                    "type": "string"
                }
            ],
            "fieldLabel": "country",
            "property": "uf",
            "format": [
                "code",
                "name"
            ],
            "disabled": false,
            "label": "Estado",
            "placeholder": "Estado: * para todos",
            "params": {
                "onlyBrasil": true
            },
            "fieldValue": "code",
            "required": true
        },
        {
            "gridColumns": 6,
            "property": "city",
            "disabled": false,
            "label": "Cidade",
            "placeholder": "Cidade: * para todos",
            "type": "string",
            "maxLength": 50,
            "required": true
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 6,
            "divider": "Alíquotas e Percentuais",
            "property": "aliquot",
            "optional": true,
            "label": "Alíquota",
            "type": "currency",
            "required": false,
            "decimalsLength": 4
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 6,
            "property": "reductionPercent",
            "optional": true,
            "label": "Perc Redução",
            "type": "currency",
            "required": false,
            "decimalsLength": 4
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 6,
            "property": "deferralPercent",
            "optional": true,
            "label": "Perc Diferido",
            "type": "currency",
            "required": false,
            "decimalsLength": 4
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 6,
            "property": "presumCredPercent",
            "optional": true,
            "label": "Perc Créd Presumido",
            "type": "currency",
            "required": false,
            "decimalsLength": 4
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 6,
            "property": "taxExemptionRate",
            "optional": true,
            "label": "Aliq Desoneração",
            "type": "currency",
            "required": false,
            "decimalsLength": 4
        }
]

Image Added

...

CampoDescriçãourlGnreUfURL utilizada para buscar os dados da aba "Fornecedor x UF"

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"urlGnreUf":"\/dts\/datasul-rest\/resources\/prg\/ftp\/v1\/gnreParametersProviderUf"

fornecUfTabColumns

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

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"fornecUfTabColumns":[{
     "allowColumnsManager":true,
     "property":"providerName",
     "label":"Fornecedor",
     "type":"string",
     "order":17
},
{
     "allowColumnsManager":true,
     "property":"ufName",
     "label":"Estado",
     "type":"string",
     "order":18
}]

tableCustomActions

Campo utilizado para exibir ou não a ação de delete da tebela de UF x Fornecedor, caso não venha o DELETE nesta propriedade o botão não é criado.

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"tableCustomActions":[{
     "label":"Delete"
}]

assocFornecUfModal

Campos da modal de Relalação Forncedor x UF, a modal possui um po-dynamic-form e aceita todas as propriedades da interface PoDynamicFormField. Para mais informações do que é possível inserir acessar a documentação do Portinari: po-dynamic-form

Bloco de código

title	Exemplo
linenumbers	true
collapse	true

"assocFornecUfModal":[{
    "gridColumns":12,
    "searchService":"\/dts\/datasul-rest\/resources\/prg\/cdp\/v1\/customerPublic",
    "columns":[{
        ...
    }],
    "fieldLabel":"customerName",
    "property":"provider",
    "format":[
        "customerCode",
        "customerName"
    ],
    "label":"Fornecedor",
    "params":{
        "order":"customerCode"
    },
    "fieldValue":"customerCode",
    "required":true,
    "order":19
},
{
    "gridColumns":12,
    "optionsMulti":true,
    "property":"uf",
    "options":[{
        "label":"AC - Acre",
        "value":"AC"
    },
    { ... 
    }],
    "label":"Estado",
    "type":"label",
    "required":true,
    "order":20
}]

Image Removed

05. Observações Gerais
Âncora
5
5

...

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

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 2

Nova versão Atual

Chave

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

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