Histórico da Página

...

Totvs custom tabs box

tabs	Visão geral,Importação XML,Comparativo XML,Documentos XML NF-e,Documento XML CT-e, Documentos XML NFS-e, Cancelamentos Recebidos
ids	pVisaoGeral,pImportaXML,pComparativo,pNF-e,pCT-e,pNFS-e,pCancelados

Totvs custom tabs box items

default	yes
referencia	pVisaoGeral

Visão Geral

Ponto UPC API REST - rep/api/v1/visaoGeral.p

Manipulação de Dados
Endpoint	Evento	Entrada	Observação
dash	dash	Parâmetros via URL	Executado depois de buscar os registros referentes as métricas do visão geral

Exemplo de passagem de parâmetros via URL:

dtEmissaoIni=2020-01-01&dtEmissaoFim=2024-06-11&codEstabelIni=1&codEstabelFim=zzzzz&consideraCancelados=false&consideraEmValidacao=false

Informações

title	Atenção

Os metadados da tela são fixos e não permitem customização, caso tenham essa necessidade favor abrir um ticket solicitando e justificando a necessidade de customização.

Totvs custom tabs box items

default	no
referencia	pImportaXML

Importação XML

Os pontos UPC referentes a customização desse programa devem ser cadastrados na API reapi330 ou no re0522rp, pois esse programa HTML executa o re0522rp.p via RPW.

Totvs custom tabs box items

default	no
referencia	pNF-e

Documentos XML NF-e

Cabeçalho do documento:

Pontos UPC API REST - rep/api/v1/documentoXmlNfe.p

Manipulação de Objetos da Interface (Metadata)
Endpoint	Evento	Entrada	Observação
getMetaData	list	Metadados	Estrutura metadados da listagem.
getMetaData	edit	Metadados	Estrutura metadados da tela de edição.
getMetaData	detail	Metadados	Estrutura metadados da tela de detalhes.

Manipulação de Dados
Endpoint	Evento	Entrada	Observação
findById	findById	Dados do registro	Executado depois de buscar um registro específico.
findAll	findAll	Dados dos registros	Executado depois de buscar os registros.
update	beforeUpdate	Payload	Executado antes da alteração de um registro.
update	afterUpdate	Payload	Executado depois da alteração de um registro.
delete	beforeDelete	Payload	Executado antes da eliminação de um registro.
delete	afterDelete	Payload	Executado depois da eliminação de um registro.
validateForm	validateForm	Payload	Executado após sair do campo que tenha a validação do formulário.
gerarFiscal	beforeGerarFiscal	Payload	Executado antes de executar a geração do recebimento fiscal.
gerarFiscal	afterGerarFiscal	Payload	Executado após executar a geração do recebimento fiscal.
gerarFisico	beforeGerarFisico	Payload	Executado antes de executar a geração do recebimento físico.
gerarFisico	afterGerarFisico	Payload	Executado após executar a geração do recebimento físico.
engineRegras	beforeEngineRegras	Payload	Executado antes de executar a aplicação das regras.
engineRegras	afterEngineRegras	Payload	Executado após executar a aplicação das regras.
cancelarNfe	beforeCancelarNfe	Payload	Executado antes de executar o cancelamento da NF-e.
cancelarNfe	afterCancelarNfe	Payload	Executado após executar o cancelamento da NF-e.
consultarSefaz	beforeConsultarSefaz	Payload	Executado antes de executar a consulta da chave de acesso na base da SEFAZ.
consultarSefaz	afterConsultarSefaz	Payload	Executado após executar a consulta da chave de acesso na base da SEFAZ.
relacionaAgregado	beforeRelacionaAgregado	Payload	Executado antes de consultar os dados para relacionamento do material agregado.
relacionaAgregado	afterRelacionaAgregado	Payload	Executado após consultar os dados para relacionamento do material agregado.
conferir	beforeConferir	Payload	Executado antes de marcar o documento como conferido.
conferir	afterConferir	Payload	Executado após marcar o documento como conferido.
considEndSaida	beforeConsidEndSaida	Payload	Executado antes de marcar o documento para considerar o endereço saída.
considEndSaida	afterConsidEndSaida	Payload	Executado após marcar o documento para considerar o endereço saída.

Itens do documento:

Pontos UPC API REST - rep/api/v1/itemDocumentoXmlNfe.p

Manipulação de Objetos da Interface (Metadata)
Endpoint	Evento	Entrada	Observação
getMetaData	list	Metadados	Estrutura metadados da listagem.
getMetaData	edit	Metadados	Estrutura metadados da tela de edição.
getMetaData	detail	Metadados	Estrutura metadados da tela de detalhes.

Manipulação de Dados
Endpoint	Evento	Entrada	Observação
findById	findById	Dados do registro	Executado depois de buscar um registro específico.
findAll	findAll	Dados dos registros	Executado depois de buscar os registros.
findByCfop	findByCfop	/byCfop/<códigoCFOP>	Executado depois de buscar os registros.
update	beforeUpdate	Payload	Executado antes da alteração de um registro.
update	afterUpdate	Payload	Executado depois da alteração de um registro.
validateForm	validateForm	Payload	Executado após sair do campo que tenha a validação do formulário.
deparaItens	beforeDeparaItens	Payload	Executado antes de executar o de-para de itens.
deparaItens	afterDeparaItens	Payload	Executado após executar o de-para de itens.
atualizaNatureza	beforeAtualizaNatureza	Payload	Executado antes de atualizar as naturezas dos itens por meio do "Atribuir naturezas"
atualizaNatureza	afterAtualizaNatureza	Payload	Executado após atualizar as naturezas dos itens por meio do "Atribuir naturezas"

Totvs custom tabs box items

default	no
referencia	pComparativo

Documentos XML Comparativo

O comparativo utiliza a mesma API REST de NF-e para a listagem dos documentos.

Pontos UPC API REST - rep/api/v1/documentoXmlNfe.p

Manipulação de Objetos da Interface (Metadata)
Endpoint	Evento	Entrada	Observação
getMetaData	listComparativo	Metadados	Estrutura metadados da listagem - Ainda não foi implementado

Manipulação de Dados
Endpoint	Evento	Entrada	Observação
findAll	findAll	Dados dos registros	Executado depois de buscar os registros.
reprocessarComparativo	beforeReprocessarComparativo	Payload	Executado antes de reprocessar as divergências do comparativo XML x Pedido compras.
reprocessarComparativo	afterReprocessarComparativo	Payload	Executado após reprocessar as divergências do comparativo XML x Pedido compras.
atualizaObservComparativo	beforeAtualizaObservComparativo	Payload	Executado antes de atualizar o campo de observações do comparativo XML x Pedido compras.
atualizaObservComparativo	afterAtualizaObservComparativo	Payload	Executado após atualizar o campo de observações do comparativo XML x Pedido compras.
enviarEmailComparativo	beforeEnviarEmailComparativo	Payload	Executado antes de enviar o e-mail com as divergências do comparativo XML x Pedido compras.
enviarEmailComparativo	afterEnviarEmailComparativo	Payload	Executado após enviar o e-mail com as divergências do comparativo XML x Pedido compras.

Para a tela de detalhes do comparativo (divergências) é utilizada outra API REST.

Pontos UPC API REST - rep/api/v1/detalheComparativoXml.p

Manipulação de Objetos da Interface (Metadata)
Endpoint	Evento	Entrada	Observação
getMetaData	list	Metadados	Estrutura metadados da listagem.

Manipulação de Dados
Endpoint	Evento	Entrada	Observação
findById	findById	Dados do registro	Executado depois de buscar um registro específico.
findAll	findAll	Dados dos registros	Executado depois de buscar os registros.
liberarLote	beforeLiberarLote	Payload	Executado antes de realizar a liberação de um lote de divergências do comparativo XML x Pedido compras.
liberarLote	afterLiberarLote	Payload	Executado após realizar a liberação de um lote de divergências do comparativo XML x Pedido compras.

Totvs custom tabs box items

default	no
referencia	pCT-e

Documentos XML CT-e

Totvs custom tabs box items

default	no
referencia	pNFS-e

Documentos XML NFS-e

Importante

Totvs custom tabs box items

default	no
referencia	pCancelados

Cancelamentos recebidos

Informações

title

02.Padrões usados em todos os endpoints de processamento e validação de formulário

Para todos os endpoints onde é realizado algum processamento de dados no backend (normalmente POST), a chamada de UPC da API rest é construída no padrão disponibilizado pelo framework Datasul: Como customizar - Documento de referencia

.

Nos endpoints de processamento a UPC irá receber um objeto JSON no formato dos exemplos abaixo:

Exemplo API REST - rep/api/v1/documentoXmlNfe.p

Manipulação de Dados

Endpoint

Evento

Entrada

Observação

gerarFiscal

beforeGerarFiscal

Payload

Executado antes de executar a geração do recebimento fiscal. Caso a UPC retorne "NOK" o processo é abortado com status HTTP 500.

Bloco de código

language	js
title	A UPC recebe um objeto JSON nesse formato

{	
	params: {...},  //path parameters
	payload: {...}  //payload da requisição
}

gerarFiscal

afterGerarFiscal

Payload

Executado após executar a geração do recebimento fiscal.

Bloco de código

language	js
title	A UPC recebe um objeto JSON nesse formato

{	
	params: {...},  //path parameters
	payload: {...}, //payload da requisição  
    root: {...} //objeto retornado para tela
}

A UPC deverá manipular o objeto root conforme a necessidade e no retorno o mesmo será devolvido para a tela.

Quando se trata de validação de formulário (validate)

temos a mesma situação de seguir

também é seguido o padrão do framework Datasul:

Manipulação de Dados

Endpoint

Evento

Entrada

Observação

validateForm

Payload

Executado após sair do campo que tenha a validação do formulário.

Bloco de código

language	js
title	A UPC recebe um objeto JSON nesse formato

{	
	property: "propriedade", //propriedade que está sendo alterada (campo)
	originalValues: {...}, //objeto value enviado no payload da requisição
	root: {...} //objeto retornado para tela após o validate
}

A UPC deverá manipular o objeto root conforme a necessidade e no retorno o mesmo será devolvido para a tela.

Caso algum endpoint não esteja no padrão o objeto JSON enviado para a UPC será detalhado na coluna "Observação"!

Conteúdos Relacionados:

Árvore de páginas

Versões comparadas

Versão antiga 12

Nova versão 13

Chave

Visão Geral

Ponto UPC API REST - rep/api/v1/visaoGeral.p

Importação XML

Documentos XML NF-e

Cabeçalho do documento:

Pontos UPC API REST - rep/api/v1/documentoXmlNfe.p

Itens do documento:

Pontos UPC API REST - rep/api/v1/itemDocumentoXmlNfe.p

Documentos XML Comparativo

Pontos UPC API REST - rep/api/v1/documentoXmlNfe.p

Pontos UPC API REST - rep/api/v1/detalheComparativoXml.p

Documentos XML CT-e

Documentos XML NFS-e

Cancelamentos recebidos

02.Padrões usados em todos os endpoints de processamento e validação de formulário

Exemplo API REST - rep/api/v1/documentoXmlNfe.p