Árvore de páginas

Versões comparadas

Chave

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

...

Manipulação de Objetos da Interface (Metadata)
EndpointEventoEntradaObservação
getMetaData

new

Metadados

Estrutura metadados da tela de inclusão de parâmetros do estabelecimentodos itens de obrigações fiscais.

getMetaData

edit

Metadados

Estrutura metadados da tela de inclusão de parâmetros do estabelecimentodos itens de obrigações fiscais.

getMetaData

view

Metadados

Estrutura metadados da tela de visualização de parâmetros do estabelecimentodos itens de obrigações fiscais.

Manipulação de Dados
EndpointEventoEntradaObservação

GetItemsParametersOF

beforeGetEstablishmentParameters

Payload, PathParams, QueryParams

Executado antes de buscar um documento específico.

GetItemsParametersOF

afterGetEstablishmentParameters

Payload, PathParams, QueryParams

Executado depois de buscar um documento específico.

QuerytemsParametersOF

beforeQueryEstablishmentParameters

Payload, PathParams, QueryParams

Executado antes de buscar os documentos.

QuerytemsParametersOF

afterQueryEstablishmentParameters

Payload, PathParams, QueryParams

Executado depois de buscar os documentos.

CreatetemsParametersOF

beforeCreateEstablishmentParameters

Payload

Executado antes de criar um documento.

CreatetemsParametersOF

afterCreateEstablishmentParameters

Payload

Executado depois da criação de um documento.

UpdatetemsParametersOF

beforeUpdateEstablishmentParameters

Payload

Executado antes da alteração de um documento.

UpdatetemsParametersOF

afterUpdateEstablishmentParameters

Payload

Executado depois da alteração de um documento.

...

PropriedadeDescrição
scancFuelDistributorForm

Formulário dinâmico da seção Processos Operacionais da aba Geralaba SCANC Distribuidora de combustível, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código
titleExemplo
collapsetrue
"scancFuelDistributorForm": [
         {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/ofp/v1/itensObligations",
            "columns": [
                {
                    "property": "productCode",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "description",
                    "label": "Descrição",
                    "type": "string"
                },
                {
                    "property": "measureUnit",
                    "label": "Unidade medida",
                    "type": "string"
                }
            ],
            "fieldLabel": "measureUnit",
            "property": "productCode",
            "format": [
                "productCode",
                "description"
            ],
            "label": "Código produto",
            "placeholder": "Selecione o código do produto",
            "type": "string",
            "fieldValue": "productCode",
            "order": 1
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/ofp/v1/productStockVariation",
            "columns": [
                {
                    "property": "code",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "description",
                    "label": "Descrição",
                    "type": "string"
                },
                {
                    "property": "unity",
                    "label": "Unidade medida",
                    "type": "string"
                }
            ],
            "fieldLabel": "unity",
            "property": "productStockVariation",
            "format": [
                "code",
                "description"
            ],
            "label": "Produto variação estoque",
            "placeholder": "Selecione o código do produto",
            "type": "string",
            "fieldValue": "code",
            "order": 2
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 3,
            "property": "stateDivisionProducing",
            "label": "% Repartição UF do produtor",
            "placeholder": "Insira a % de repartição por UF do produtor",
            "type": "currency",
            "decimalsLength": 2,
            "order": 3
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 3,
            "property": "stateDivisionDestination",
            "label": "% Repartição UF de destino",
            "placeholder": "Insira a % de repartição por UF de destino",
            "type": "currency",
            "decimalsLength": 2,
            "order": 4
        }]
scancRefineryForm

Formulário dinâmico da seção Configuração da aba Fiscal do parâmetro do estabelecimentoda aba SCANC Refinaria dos parâmetros dos itens de obrigações fiscais, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código
titleExemplo
collapsetrue
"scancRefineryForm": [
        {
            "gridColumns": 6,
            "property": "refineryProduct",
            "label": "Produto refinaria",
            "placeholder": "Insira o produto refinaria",
            "type": "string",
            "maxLength": 10,
            "order": 5
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/ofp/v1/productStockVariation",
            "columns": [
                {
                    "property": "code",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "description",
                    "label": "Descrição",
                    "type": "string"
                },
                {
                    "property": "unity",
                    "label": "Unidade medida",
                    "type": "string"
                }
            ],
            "fieldLabel": "unity",
            "property": "productRegNF",
            "format": [
                "code",
                "description"
            ],
            "label": "Produto reg NF",
            "placeholder": "Selecione o código do produto",
            "type": "string",
            "fieldValue": "code",
            "order": 6
        }
    ]
spedFormespedForm

Formulário dinâmico da seção Ressarcimento SPED Fiscal da aba Fiscal do parâmetro do estabelecimentoaba Campos SPED dos parâmetros dos itens de obrigações fiscais, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código
titleExemplo
collapsetrue
"spedForm": [
        {
            "gridColumns": 6,
            "property": "IPIFramework",
            "label": "Enquadramento IPI",
            "placeholder": "Insira o enquadramento IPI",
            "type": "string",
            "maxLength": 5,
            "order": 7
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 6,
            "property": "internalICMSRate",
            "label": "Alíquota ICMS interna",
            "placeholder": "Insira a alíquota de ICMS interna",
            "type": "currency",
            "decimalsLength": 2,
            "order": 8
        }
    ]

...