Histórico da Página

...

Informações

title	Importante

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

A Portanto nos pontos onde citamos "padrão framework Datasul", 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 temos a mesma situação "de seguir 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"!

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

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. Segue o padrão framework Datasul.
gerarFiscal	beforeGerarFiscal	Payload	Executado antes de executar a geração do recebimento fiscal. Segue o padrão framework Datasul.
gerarFiscal	afterGerarFiscal	Payload	Executado após executar a geração do recebimento fiscal. Segue o padrão framework Datasul.
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.

Detalhes do documento

Edição cabeçalho do documento

Edição itens do documento

Permitir alterar as informações dos itens da nota fiscal de entrada que não pode ser gerada no recebimento devido a erros de negócio ou ainda verificar se todas as informações dos itens da nota estão corretas antes de gerar a nota no recebimento.

O programa possui as pastas: Detalhes, Compras, Estoque, Narrativa e a partir da release 12.1.2307 a pasta Impostos. Em algumas pastas as informações estão divididas em duas partes, Dados originais (no lado esquerdo), que são as informações exatamente como foram trazidas pelo arquivo XML e Dados traduzidos, que são as informações depois da realização da conversão dos campos do XML para os campos do documento. Esta conversão é realizada por cadastros do produto Datasul e também levando em consideração as regras que são configuradas via programa Engine de Regras (CD0024).

Atribuir natureza operação para o item do documento XML NF-e

Agregar Nota (Material Agregado)

Notas relacionadas (Devolução ou retorno de terceiros)

Totvs custom tabs box items

default	no
referencia	pComparativo

Documentos XML Comparativo

Listagem de documentos

Detalhamento das divergências do documento

Ação	Descrição
Atualizar	Quando acionado, serão atualizados os registros conforme o filtro selecionado. Importante salientar que como será realizada nova busca, serão exibidos os dez primeiros registros conforme o filtro!
Reprocessar	Quando acionado, realiza o reprocessamento das divergências do documento. Este reprocessamento é útil quando ocorre algum ajuste no pedido de compras para ficar de acordo com o documento, ou ajuste de parametrização do comparativo para aquele estabelecimento.
Liberar	Quando acionado, realiza a liberação daquela divergência, mudando a Situação da mesma para "Liberada". É obrigatório informar uma Justificativa para essa liberação "manual" caso esteja marcado nos Parâmetros comparativo XML, pasta "Configurações" o campo "Solicita justificativa liberação".
Enviar e-mail	Quando acionado, realiza o envio de e-mail com as divergências do documento. Regras para o envio de e-mail com as divergências no comparativo XML
Observações comparativo	Quando acionada, será aberta uma tela permitindo a inclusão de observação do comparativo no documento, quando a situação da divergência estiver igual a pendente.
Busca avançada	Quando acionado será exibida a tela com os filtros possíveis para a consulta, sendo eles: Situação - Múltipla escolha Tipo divergência - Múltipla escolha Pedido - Faixa Ordem compra - Faixa Sequência do item da NF-e - Faixa