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 da tela desse dashboard são fixos e não permitem customização, caso tenham essa necessidade favor abrir um ticket solicitando e uma sugestão de melhoria via central colaborativa justificando a necessidade de customização. |
|
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 | Especificidades | 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. | Normalmente as telas padrões retornam um array chamado "fields" com os campos a serem editados, porém, devido a complexidade da tela de edição do cabeçalho, foi necessário o envio de algumas "quebras" de fields para permitir a customização em qualquer um dos folders, segue abaixo cada array e onde ele é utilizado: fieldsTop - Informações que são exibidas no topo da página, são campos apenas para visualização. Folder "Documento": fieldsOriginalDocument - Dados originais exibidos a esquerda, são campos apenas para visualização. fieldsDocument - Dados traduzidos exibidos a direita, alguns campos podem ser alterados conforme regras de negócio do sistema. Folder "Narrativa": fieldsNarrativa - Campos que são exibidos nesse folder. | Estrutura metadados da tela de edição. | getMetaData | | | No caso da tela de detalhes é enviado o mesmo formato de metadados da edição "edit", com a única diferença que todos os campos ficam desabilitados. | Estrutura metadados da tela de detalhes. | getMetaData | | | | Estrutura metadados da tela de listagem do comparativo. | getMetaData | | | São retornados os array fieldPK e fieldsTop - Informações que são exibidas no topo da página, são campos apenas para visualização. Também retorna o array fieldsDoctoRelac, referente as colunas da listagem referente aos documentos que será relacionados. | Estrutura metadados da tela de relacionamento de nota agregada |
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 | Especificidades | Observação |
---|
getMetaData | | | | Estrutura metadados da listagem. | getMetaData | | | Normalmente as telas padrões retornam um array chamado "fields" com os campos a serem editados, porém, devido a complexidade da tela de edição de sequência de item, foi necessário o envio de diversas "quebras" de fields para permitir a customização em qualquer um dos folders, segue abaixo cada array e onde ele é utilizado: fieldsTop - Informações que são exibidas no topo da página, são campos apenas para visualização. Folder "Detalhes": fieldsOriginalItem - Dados originais exibidos a esquerda, são campos apenas para visualização. fieldsItem - Dados traduzidos exibidos a direita, alguns campos podem ser alterados conforme regras de negócio do sistema. Folder "Compras": fieldsOrdersOriginal - Dados originais exibidos a esquerda, são campos apenas para visualização. fieldTypeOrders - Campo utilitário que indica se foi escolhido o formato "Simplificado" para informar a parte de compras ou o "FIFO". fieldsOrders - Dados traduzidos referente a opção "Simplificado", exibidos a direita, alguns campos podem ser alterados conforme regras de negócio do sistema. Folder "Impostos": fieldsImpostosList - Colunas que são exibidas na tabela de impostos do monitor NF-e. Folder "Estoque": fieldTypeLote - Campo utilitário que indica se foi escolhido o formato "Único" para informar a parte de estoque ou o "Rateio". fieldsLote - Dados traduzidos referente a opção "Único", exibidos a direita, alguns campos podem ser alterados conforme regras de negócio do sistema. Folder "Narrativa": fieldsNarrativa - Campos que são exibidos nesse folder. | Estrutura metadados da tela de edição. | getMetaData | | | No caso da tela de detalhes é enviado o mesmo formato de metadados da edição "edit", com a única diferença que todos os campos ficam desabilitados. | Estrutura metadados da tela de detalhes. | getMetaData | | | Retorna o array fieldsUpdateNature, com os campos para atribuir a natureza de operação ao documento | Estrutura metadados da tela de atribuição de natureza de operação | getMetaData | | | Retorna os arrays: fieldTypeLote - Campo utilitário que indica se foi escolhido o formato "Único" para informar a parte de estoque ou o "Rateio". fieldsLote - Dados traduzidos referente a opção "Único", exibidos a direita, alguns campos podem ser alterados conforme regras de negócio do sistema. | Estrutura metadados apra edição do lote | getMetaData | | | Retorna os arrays: fieldsOrdersOriginal - Dados originais exibidos a esquerda, são campos apenas para visualização. fieldTypeOrders - Campo utilitário que indica se foi escolhido o formato "Simplificado" para informar a parte de compras ou o "FIFO". fieldsOrders - Dados traduzidos referente a opção "Simplificado", exibidos a direita, alguns campos podem ser alterados conforme regras de negócio do sistema. | Estrutura metadados apra edição das ordens | getMetaData | | | Retorna o array padrão , com os campos referente aos impostos do documento XML. | Estrutura metadados do folder impostos do item |
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 | beforeValidateRecord | | Executado depois de buscar os registros. | update | | | | de validar os dados de lote do item.validateRecord | afterValidateRecordda alteração de um registro. | update | | | Executado depois da alteração de um registro. | validateForm | | | | validar os dados de lote do item.validateRecordRateioLoteTerceiros | beforeValidateRecordRateioLoteTerceirossair do campo que tenha a validação do formulário. | deparaItens | | | | validar os dados de lote do item. Específico para rateio de lotes da nota de faturamento de consignação.validateRecordRateioLoteTerceiros | afterValidateRecordRateioLoteTerceirosexecutar o de-para de itens. | deparaItens | | | | validar os dados de lote do item. Específico para rateio de lotes da nota de faturamento de consignação.saveListaRateioLoteTerceiros | beforeSaveListaRateioLoteTerceirosexecutar o de-para de itens. | atualizaNatureza | | | | 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 itematualizar 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/ordemItemDocumentoXmlNfeitemReferDocumentoXmlNfe.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. | validateFormvalidateForm | 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. | | 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 | Especificidades | Observação |
---|
getMetaData | | | | Estrutura metadados da listagem. | getMetaData | | | Além do array de fields que é retornado com os campos a serem editados, também está sendo retornado o array fieldsOriginal com as colunas dos dados originais. | 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. |
Relacionamento material agregado:Pontos UPC API REST - rep/api/v1/movtoPendDocumentoXmlNfe.pManipulação de Dados |
---|
Endpoint | Evento | Entrada | Observação |
---|
findById | | | Executado depois de buscar um registro específico. | findAll | | | Executado depois de buscar os registros. | create | | | Executado antes da criação de um registro. | create | | | Executado depois da criação de um registro. | delete | | | Executado antes da eliminação de um registro. | delete | | | Executado depois da eliminação de um registro. |
Histórico do configurador de tributos do item:Pontos UPC API REST - rep/api/v1/historicoConfigTribXmlNfe.pManipulação de Objetos da Interface (Metadata) |
---|
Endpoint | Evento | Entrada | Especificidades | Observação |
---|
getMetaData | | | Além do array de fields que é retornado com as colunas da tabela que está sendo exibida, também está sendo retornado o array fieldsTop com os campos exibidos no topo da modal. | 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. |
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-eCabeçalho do documento:Pontos UPC API REST - rep/api/v1/documentoXmlCte.pManipulação de Objetos da Interface (Metadata) |
---|
Endpoint | Evento | Entrada | Especificidades | Observação |
---|
getMetaData | | | | Estrutura metadados da listagem. | getMetaData | | | Normalmente as telas padrões retornam um array chamado "fields" com os campos a serem editados, porém, devido a necessidade de "quebra" entre dados originais e dados traduzidos, foi necessário criar os seguintes arrays: fieldsTop - Informações que são exibidas no topo da página, são campos apenas para visualização. fieldsOriginalDocument - Dados originais exibidos a esquerda, são campos apenas para visualização. fieldsDocument - Dados traduzidos exibidos a direita, alguns campos podem ser alterados conforme regras de negócio do sistema. | Estrutura metadados da tela de edição. | getMetaData | | | No caso da tela de detalhes é enviado o mesmo formato de metadados da edição "edit", com a única diferença que todos os campos ficam desabilitados. | 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. | engineRegras | | | Executado antes de executar a aplicação das regras. | engineRegras | | | Executado após executar a aplicação das regras. | cancelarCte | | | Executado antes de executar o cancelamento do CT-e. | cancelarCte | | | Executado após executar o cancelamento do CT-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. | ratearDocumentos | | | Executado antes de salvar o rateio de documentos. | ratearDocumentos | | | Executado após salvar o rateio de documentos. | gerarNovoRateio | beforeGerarNovoRateioDespesas | | Executado antes de gerar o novo rateio de despesas. | gerarNovoRateio | afterGerarNovoRateioDespesas | | Executado após gerar o novo rateio de despesas. |
Item do documento:Pontos UPC API REST - rep/api/v1/itemDocumentoXmlCte.pManipulação de Objetos da Interface (Metadata) |
|
---|
Endpoint | Evento | Entrada | Observação |
|
---|
getMetaData | | | Estrutura metadados da listagem. |
| getMetaData | | | Retorna o array fieldsItem com a estrutura de campos referente informações do item do CT-e | Estrutura metadados da tela de edição. | getMetaData | | | No caso da tela de detalhes é enviado o mesmo formato de metadados da edição "edit", com a única diferença que todos os campos ficam desabilitados. | 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. | validateForm | | | Executado após sair do campo que tenha a validação do formulário. |
Rateio de documentos de entrada (normalmente frete de produtos comprados):Pontos UPC API REST - rep/api/v1/rateioDocumentoXmlCte.pManipulação de Objetos da Interface (Metadata) |
---|
Endpoint | Evento | Entrada | Especificidades | Observação |
---|
getMetaData | | | | Estrutura metadados da listagem. | getMetaData | | | Além do array de fieldsDocument que é retornado com as colunas da tabela que está sendo exibida, também está sendo retornado o array fieldsTop com os campos exibidos no topo da tela. | 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. | create | | | Executado antes da criação de um registro. | create | | | Executado depois da criação de um registro. | delete | | | Executado antes da eliminação de um registro. | delete | | | Executado depois da eliminação de um registro. |
Rateio de despesas (documentos de saída, normalmente frete de produtos vendidos):Pontos UPC API REST - rep/api/v1/rateioDespesasCte.pManipulação de Objetos da Interface (Metadata) |
---|
Endpoint | Evento | Entrada | Especificidades | Observação |
---|
getMetaData | | | | Estrutura metadados da listagem. | getMetaData | | | Além do array de fields que é retornado com as colunas da tabela que está sendo exibida, também está sendo retornado o array fieldsTop com os campos exibidos no topo da tela. O fieldsDocument contém os campos relativos ao cabeçalho do documento, já o fieldsItem contém o campo de item. Quando o usuário clica no botão novo e abre a modal de edição, são exibidos os campos do array fieldsModal. | Estrutura metadados da tela de criação. | getMetaData | | | Mesmo formato de metadados do evento "new". | Estrutura metadados da tela de edição. | getMetaData | | | No caso da tela de detalhes é enviado o mesmo formato de metadados da edição "edit", com a única diferença que todos os campos ficam desabilitados. | 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. | 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. | validateForm | | | Executado após sair do campo que tenha a validação do formulário. | validateRecord | | | Executado após validar os dados de rateio. | validateRecord | | | Executado após validar os dados de rateio. |
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | pNFS-e |
---|
| Documentos XML NFS-eCabeçalho do documento:Pontos UPC API REST - rep/api/v1/documentoXmlNfse.pManipulação de Objetos da Interface (Metadata) |
---|
Endpoint | Evento | Entrada | Especificidades | Observação |
---|
getMetaData | | | | Estrutura metadados da listagem. | getMetaData | | | Normalmente as telas padrões retornam um array chamado "fields" com os campos a serem editados, porém, devido a complexidade da tela de edição do cabeçalho, foi necessário o envio de algumas "quebras" de fields para permitir a customização em qualquer um dos folders, segue abaixo cada array e onde ele é utilizado: fieldsTop - Informações que são exibidas no topo da página, são campos apenas para visualização. Folder "Documento": fieldsOriginalDocument - Dados originais exibidos a esquerda, são campos apenas para visualização. fieldsDocument - Dados traduzidos exibidos a direita, alguns campos podem ser alterados conforme regras de negócio do sistema. Folder "Item/Compra": fieldsOriginalService - Dados originais exibidos a esquerda, são campos apenas para visualização. fieldsService - Dados traduzidos exibidos a direita, alguns campos podem ser alterados conforme regras de negócio do sistema. | Estrutura metadados da tela de edição. | getMetaData | | | No caso da tela de detalhes é enviado o mesmo formato de metadados da edição "edit", com a única diferença que todos os campos ficam desabilitados. | Estrutura metadados da tela de detalhes. | getMetada | | | Executado ao alterar o item do documento de serviço, arrays retornados conforme o evento de edit/metadados | 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. | 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. | engineRegras | | | Executado antes de executar a aplicação das regras. | engineRegras | | | Executado após executar a aplicação das regras. | cancelarNfse | | | Executado antes de executar o cancelamento da NFS-e. | cancelarNfse | | | Executado após executar o cancelamento da NFS-e. |
Itens do documento (discriminação do serviço):Pontos UPC API REST - rep/api/v1/itemDocumentoXmlNfse.pManipulação de Objetos da Interface (Metadata) |
---|
Endpoint | Evento | Entrada | Especificidades | Observação |
---|
getMetaData | | | | Estrutura metadados da listagem. | getMetaData | | | Normalmente as telas padrões retornam um array chamado "fields" com os campos a serem editados, porém, devido a necessidade de "quebra" entre dados originais e dados traduzidos, foi necessário criar os seguintes arrays: fieldsTop - Informações que são exibidas no topo da página, são campos apenas para visualização. fieldsOriginalItem - Dados originais exibidos a esquerda, são campos apenas para visualização. fieldsItem - Dados traduzidos exibidos a direita, alguns campos podem ser alterados conforme regras de negócio do sistema. | Estrutura metadados da tela de edição. | getMetaData | | | No caso da tela de detalhes é enviado o mesmo formato de metadados da edição "edit", com a única diferença que todos os campos ficam desabilitados. | Estrutura metadados da tela de detalhes. |
| 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 |
---|
findAllfindAll dos registrosExecutado 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. | 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. | validateForm | | | Executado após sair do campo que tenha a validação do formulário. |
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | pCancelados |
---|
| Cancelamentos recebidosPontos UPC API REST - rep/api/v1/detalheComparativoXmleventoCancelamento.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 04 |
---|
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. | update | | | Executado antes da alteração de um registro. | update | | | Executado depois da alteração de um registro. |
| 44Para 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:
04. Observações Gerais |