Árvore de páginas

Versões comparadas

Chave

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

...

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

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

  • chave do registro: BASE64 de: tipo tributo;data inicio validade;tipo documento;estabelecimento;natureza de operação;cfop;código de serviço;grupo de cliente;item;ncm;estado;cidade (cada informação é separado por ponto e virgula)
    • EX: MTsyMDI1LTAzLTIxOzQ7KjsqOyo7MDswOzA7KjsqO1NhbnRhIENhdGFyaW5hO01hZnJh (valor em base64 de: 1;2025-03-21;4;*;*;*;0;0;0;*;*;Santa Catarina;Mafra)


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><chave do registro>delete

beforeDelete

Vazio

Executado antes da eliminação de um registro.

DELETEURL_Base/<código estabelecimento><chave do registro>delete

afterDelete

Vazio

Executado depois da eliminação de um registro.

...