CONTEÚDO
- Visão Geral
- API x Pontos UPC Relacionados
- Padrões usados em todos os endpoints de processamento e validação de formulário
01. Visão Geral
Este documento tem como objetivo descrever o que poderá ser customizado nas telas HTML da central de recepção de documentos XML.
Informações |
---|
|
As telas foram construídas em sua maior parte utilizando os templates dinâmicos do PO-UI, portanto, como os metadados são retornados pelo backend, o JSON pode ser manipulado por uma UPC Open Edge, permitindo a customizaçã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
Segue a lista de APIs responsáveis pelo processamento da interface dinâmica e dos dados do programa e os pontos UPC relacionados, cada folder contém uma das opções do menu lateral esquerdo da central.
Clique aqui para maiores detalhes de como cadastrar uma UPC para ser executada por uma API REST.
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 GeralPonto UPC API REST - rep/api/v1/visaoGeral.pManipulação de Dados |
---|
Endpoint | Evento | Entrada | Observação |
---|
dash | | | Executado depois de buscar os registros referentes as métricas do visão geral |
Exemplo de passagem de parâmetros via URL: Bloco de código |
---|
| dtEmissaoIni=2020-01-01&dtEmissaoFim=2024-06-11&codEstabelIni=1&codEstabelFim=zzzzz&consideraCancelados=false&consideraEmValidacao=false |
Informações |
---|
| Os metadados desse dashboard são fixos e não permitem customização, caso tenham essa necessidade favor abrir um ticket solicitando e justificando a necessidade. |
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | pImportaXML |
---|
| Importação XMLOs 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 servidor de execução (RPW).
|
Totvs custom tabs box items |
---|
| Documentos XML NF-eCabeçalho do documento:Pontos UPC API REST - rep/api/v1/documentoXmlNfe.pManipulação de Objetos da Interface (Metadata) |
---|
Endpoint | Evento | Entrada | Observação |
---|
getMetaData | | | Estrutura metadados da listagem. | getMetaData | | | Estrutura metadados da tela de edição. | getMetaData | | | Estrutura metadados da tela de detalhes. |
Manipulação de Dados |
---|
Endpoint | Evento | Entrada | Observação |
---|
findById | | | Executado depois de buscar um registro específico. | findAll | | | Executado depois de buscar os registros. | update | | | Executado antes da alteração de um registro. | update | | | Executado depois da alteração de um registro. | delete | | | Executado antes da eliminação de um registro. | delete | | | Executado depois da eliminação de um registro. | validateForm | | | Executado após sair do campo que tenha a validação do formulário. | gerarFiscal | | | Executado antes de executar a geração do recebimento fiscal. | gerarFiscal | | | Executado após executar a geração do recebimento fiscal. | gerarFisico | | | Executado antes de executar a geração do recebimento físico. | gerarFisico | | | Executado após executar a geração do recebimento físico. | engineRegras | | | Executado antes de executar a aplicação das regras. | engineRegras | | | Executado após executar a aplicação das regras. | cancelarNfe | | | Executado antes de executar o cancelamento da NF-e. | cancelarNfe | | | Executado após executar o cancelamento da NF-e. | consultarSefaz | | | Executado antes de executar a consulta da chave de acesso na base da SEFAZ. | consultarSefaz | | | Executado após executar a consulta da chave de acesso na base da SEFAZ. | relacionaAgregado | | | Executado antes de consultar os dados para relacionamento do material agregado. | relacionaAgregado | | | Executado após consultar os dados para relacionamento do material agregado. | conferir | | | Executado antes de marcar o documento como conferido. | conferir | | | Executado após marcar o documento como conferido. | considEndSaida | | | Executado antes de marcar o documento para considerar o endereço saída. | considEndSaida | | | Executado após marcar o documento para considerar o endereço saída. |
Itens do documento:Pontos UPC API REST - rep/api/v1/itemDocumentoXmlNfe.pManipulação de Objetos da Interface (Metadata) |
---|
Endpoint | Evento | Entrada | Observação |
---|
getMetaData | | | Estrutura metadados da listagem. | getMetaData | | | Estrutura metadados da tela de edição. | getMetaData | | | Estrutura metadados da tela de detalhes. |
Manipulação de Dados |
---|
Endpoint | Evento | Entrada | Observação |
---|
findById | | | Executado depois de buscar um registro específico. | findAll | | | Executado depois de buscar os registros. | findByCfop | | | Executado depois de buscar os registros. | update | | | Executado antes da alteração de um registro. | update | | | Executado depois da alteração de um registro. | validateForm | | | Executado após sair do campo que tenha a validação do formulário. | deparaItens | | | Executado antes de executar o de-para de itens. | deparaItens | | | Executado após executar o de-para de itens. | atualizaNatureza | | | Executado antes de atualizar as naturezas dos itens por meio do "Atribuir naturezas" | atualizaNatureza | | | Executado após atualizar as naturezas dos itens por meio do "Atribuir naturezas" | simularRecalculoImpostos | | | Executado após a simulação do recálculo de impostos. | simularAtualizacaoDadosConsiderados | simularAtualizacaoDadosConsiderados | | Executado após a simulação da atualização dos dados considerados. |
Documentos referenciados (devolução e terceiros):Pontos UPC API REST - rep/api/v1/itemReferDocumentoXmlNfe.pManipulação de Objetos da Interface (Metadata) |
---|
Endpoint | Evento | Entrada | Observação |
---|
getMetaData | | | Estrutura metadados da listagem. |
Manipulação de Dados |
---|
Endpoint | Evento | Entrada | Observação |
---|
findById | | | Executado depois de buscar um registro específico. | findAll | | | Executado depois de buscar os registros. | findSaldosDevol | | | Executado depois de buscar os registros de saldos a devolver. | findSaldosTerc | | | Executado depois de buscar os registros de saldos de terceiros. | findSugestaoRateioLoteTerceiros | findSugestaoRateioLoteTerceiros | | Executado depois da sugestão de rateios de saldos de terceiros. Disponível apenas para recepção de notas de fatura de consignação. | create | | | Executado antes da criação de um registro. | create | | | Executado depois da criação de um registro. | update | | | Executado antes da alteração de um registro. | update | | | Executado depois da alteração de um registro. | delete | | | Executado antes da eliminação de um registro. | delete | | | Executado depois da eliminação de um registro. |
Lotes do item:Pontos UPC API REST - rep/api/v1/loteItemDocumentoXmlNfe.pManipulação de Objetos da Interface (Metadata) |
---|
Endpoint | Evento | Entrada | Observação |
---|
getMetaData | | | Estrutura metadados da listagem. | getMetaData | | | Estrutura metadados da tela de edição. |
Manipulação de Dados |
---|
Endpoint | Evento | Entrada | Observação |
---|
findById | | | Executado depois de buscar um registro específico. | findAll | | | Executado depois de buscar os registros. | validateForm | | | Executado após sair do campo que tenha a validação do formulário. | validateRecord | | | Executado antes de validar os dados de lote do item. | validateRecord | | | Executado após validar os dados de lote do item. | validateRecordRateioLoteTerceiros | beforeValidateRecordRateioLoteTerceiros | | Executado antes de validar os dados de lote do item. Específico para rateio de lotes da nota de faturamento de consignação. | validateRecordRateioLoteTerceiros | afterValidateRecordRateioLoteTerceiros | | Executado após validar os dados de lote do item. Específico para rateio de lotes da nota de faturamento de consignação. | saveListaRateioLoteTerceiros | beforeSaveListaRateioLoteTerceiros | | Executado antes de salvar a lista de rateios de lote de terceiros. Específico para rateio de lotes da nota de faturamento de consignação. | saveListaRateioLoteTerceiros | afterSaveListaRateioLoteTerceiros | | Executado após salvar a lista de rateios de lote de terceiros. Específico para rateio de lotes da nota de faturamento de consignação. |
FIFO de ordem de compra do item:Pontos UPC API REST - rep/api/v1/ordemItemDocumentoXmlNfe.pManipulação de Objetos da Interface (Metadata) |
---|
Endpoint | Evento | Entrada | Observação |
---|
getMetaData | | | Estrutura metadados da listagem. |
Manipulação de Dados |
---|
Endpoint | Evento | Entrada | Observação |
---|
findById | | | Executado depois de buscar um registro específico. | findAll | | | Executado depois de buscar os registros. | validateForm | | | Executado após sair do campo que tenha a validação do formulário. | validateRecord | | | Executado antes de validar os dados de FIFO de ordem de compra do item. | validateRecord | | | Executado após validar os dados de FIFO de ordem de compra do item. |
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | pComparativo |
---|
| Documentos XML ComparativoO comparativo utiliza a mesma API REST de NF-e para a listagem dos documentos. Pontos UPC API REST - rep/api/v1/documentoXmlNfe.pManipulação de Dados |
---|
Endpoint | Evento | Entrada | Observação |
---|
findAll | | | Executado depois de buscar os registros. | reprocessarComparativo | beforeReprocessarComparativo | | Executado antes de reprocessar as divergências do comparativo XML x Pedido compras. | reprocessarComparativo | afterReprocessarComparativo | | Executado após reprocessar as divergências do comparativo XML x Pedido compras. | atualizaObservComparativo | beforeAtualizaObservComparativo | | Executado antes de atualizar o campo de observações do comparativo XML x Pedido compras. | atualizaObservComparativo | afterAtualizaObservComparativo | | Executado após atualizar o campo de observações do comparativo XML x Pedido compras. | enviarEmailComparativo | beforeEnviarEmailComparativo | | Executado antes de enviar o e-mail com as divergências do comparativo XML x Pedido compras. | enviarEmailComparativo | afterEnviarEmailComparativo | | 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.pManipulação de Objetos da Interface (Metadata) |
---|
Endpoint | Evento | Entrada | Observação |
---|
getMetaData | | | Estrutura metadados da listagem. |
Manipulação de Dados |
---|
Endpoint | Evento | Entrada | Observação |
---|
findById | | | Executado depois de buscar um registro específico. | findAll | | | Executado depois de buscar os registros. | liberarLote | | | Executado antes de realizar a liberação de um lote de divergências do comparativo XML x Pedido compras. | liberarLote | | | Executado após realizar a liberação de um lote de divergências do comparativo XML x Pedido compras. |
|
Totvs custom tabs box items |
---|
| Documentos XML CT-e
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | pNFS-e |
---|
| Documentos XML NFS-e
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | pCancelados |
---|
| Cancelamentos recebidos
|
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.pManipulação de Dados |
---|
Endpoint | Evento | Entrada | Observação |
---|
gerarFiscal | | | 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 | | | 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) também é seguido o padrão do framework Datasul: Manipulação de Dados |
---|
Endpoint | Evento | Entrada | Observação |
---|
validateForm | | | 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. |
Conteúdos Relacionados:
|