Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 5

changes.mady.by.user Bruno Tauscheck Zielinski

Gravado em

comparado com

Nova versão 6

changes.mady.by.user Bruno Tauscheck Zielinski

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Revertida da versão 4

CONTEÚDO
Âncora
início
início

  1. Visão Geral                                                                     clique no conteúdo para acesso rápido à informação desejada ↓
  2. API x Pontos UPC Relacionados
  3. JSON de metadata
  4. Especificidades de Customização
    1. Tela - Listagem Relacionamento x Tributo
  5. 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
titleImportante

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
GETURL_Base/metadata/?type=listgetMetaData

list

Metadados

Estrutura metadados da listagem.

GETURL_Base/metadata/?type=newgetMetaData

new

Metadados

Estrutura metadados da tela de inclusão.

GETURL_Base/metadata/<código estabelecimento>?type=editgetMetaData

edit

Metadados

Estrutura metadados da tela de edição.

GETURL_Base/metadata/<código estabelecimento>?type=copygetMetaData

copy

Metadados

Estrutura metadados da tela de detalhes.



Manipulação de Dados
Método (API)Endpoint (API)Endpoint (UPC)Evento (UPC)Entrada (UPC)Observação
GETURL_Base/<chave do registro>findById

findById

Dados do registro

Executado depois de buscar um registro específico.

GETURL_Base?pageSize=10&page=1findAll

findAll

Dados dos registros

Executado depois de buscar os registros.

POST

URL_Base

create

beforeCreate

Payload*

Executado antes de criar um registro.

POSTURL_Basecreate

afterCreate

Payload*

Executado depois da criação de um registro.

PUTURL_Baseupdate

beforeUpdate

Payload*

Executado antes da alteração de um registro.

PUTURL_Baseupdate

afterUpdate

Payload*

Executado depois da alteração de um registro.

DELETEURL_Base/<código estabelecimento>delete

beforeDelete

Vazio

Executado antes da eliminação de um registro.

DELETEURL_Base/<código estabelecimento>delete

afterDelete

Vazio

Executado depois da eliminação de um registro.

Bloco de código
titleExemplo de Payload (body da requisição)
linenumberstrue
collapsetrue
   	 {
        "dateValidInidescTpDespICMSUfDest": "2025-03-21INVESTIMENTO ETE",
        "codEstabdescTpDespFCP": "*INVESTIMENTO ETE",
        "codNaturOperacestab": "*1",
        "deferralPercentccICMSST": 0"",
        "aliquotespICMSST": 0"dp",
        "documentTypedescEspFCP": 1"duplicata",
        "cityespICMSUfDest": "Joinvilledp",
    "updateInfAdicAuto": false,
    "codCfopdescEspICMSUfDest": "*duplicata",
        "codClientGroupctFCP": 0"11361198",
        "presumCredPercentupdateApbAuto": 0true,
        "taxExemptionRatetpDespICMSST": 021,
        "ufespFCP": "Santa Catarinadp",
        "speciAliquotPerApproUniMedIsccFCP": 0"",
        "tributeTypedescEspICMSST": 2"duplicata",
        "codIssuerctICMSUfDest": 0"11361198",
        "codServiceccICMSUfDest": 0"",
        "codNcmdescTpDespICMSST": "*INVESTIMENTO ETE",
    "tpDespFCP": 21,
    "codItemintegApb": "*"true,
    "estabName": "Estabelecimento Automação - "taxableUnitMeasureIsTOTVS": 0,
    "tpDespICMSUfDest": 21,
    "reductionPercentctICMSST": 0
    "00001116"
}

03. JSON de metadata
Âncora
3
3

...