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
- Observações gerais
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.
Importante
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.
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
Atenção
Os metadados desse dashboard são fixos e não permitem customização, caso tenham essa necessidade favor abrir uma sugestão de melhoria via central colaborativa justificando a necessidade.
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 servidor de execução (RPW).
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 | Especificidades | Observação |
getMetaData | list | Metadados | Estrutura metadados da listagem. | |
getMetaData | edit | Metadados | 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": Folder "Narrativa": | Estrutura metadados da tela de edição. |
getMetaData | detail | Metadados | 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 | listComparativo | Metadados | Estrutura metadados da tela de listagem do comparativo. | |
getMetaData | agreg | Metadados | 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 | 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 | Especificidades | Observação |
getMetaData | list | Metadados | Estrutura metadados da listagem. | |
getMetaData | edit | Metadados | 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": Folder "Compras": Folder "Impostos": Folder "Estoque": Folder "Narrativa": | Estrutura metadados da tela de edição. |
getMetaData | detail | Metadados | 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 | updatesNature | Metadados | 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 | editLote | Metadados | Retorna os arrays: fieldTypeLote - Campo utilitário que indica se foi escolhido o formato "Único" para informar a parte de estoque ou o "Rateio". | Estrutura metadados apra edição do lote |
getMetaData | editOrders | Metadados | Retorna os arrays: fieldsOrdersOriginal - Dados originais exibidos a esquerda, são campos apenas para visualização. | Estrutura metadados apra edição das ordens |
getMetaData | editTributes | Metadados | Retorna o array padrão , com os campos referente aos impostos do documento XML. | Estrutura metadados do folder impostos do item. |
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" |
simularRecalculoImpostos | simularRecalculoImpostos | Payload | Executado após a simulação do recálculo de impostos. |
simularAtualizacaoDadosConsiderados | simularAtualizacaoDadosConsiderados | Payload | 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.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. |
findSaldosDevol | findSaldosDevol | Dados dos registros | Executado depois de buscar os registros de saldos a devolver. |
findSaldosTerc | findSaldosTerc | Dados dos registros | Executado depois de buscar os registros de saldos de terceiros. |
findSugestaoRateioLoteTerceiros | findSugestaoRateioLoteTerceiros | Dados dos registros | 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 | beforeCreate | Payload | Executado antes da criação de um registro. |
create | afterCreate | Payload | Executado depois da criação de um registro. |
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. |
Lotes do item:
Pontos UPC API REST - rep/api/v1/loteItemDocumentoXmlNfe.p
Manipulação de Objetos da Interface (Metadata) | ||||
---|---|---|---|---|
Endpoint | Evento | Entrada | Especificidades | Observação |
getMetaData | list | Metadados | Estrutura metadados da listagem. | |
getMetaData | edit | Metadados | 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 | findById | Dados do registro | Executado depois de buscar um registro específico. |
findAll | findAll | Dados dos registros | Executado depois de buscar os registros. |
validateForm | validateForm | Payload | Executado após sair do campo que tenha a validação do formulário. |
validateRecord | beforeValidateRecord | Payload | Executado antes de validar os dados de lote do item. |
validateRecord | afterValidateRecord | Payload | Executado após validar os dados de lote do item. |
validateRecordRateioLoteTerceiros | beforeValidateRecordRateioLoteTerceiros | Payload | 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 | Payload | 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 | Payload | 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 | Payload | 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.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. |
validateForm | validateForm | Payload | Executado após sair do campo que tenha a validação do formulário. |
validateRecord | beforeValidateRecord | Payload | Executado antes de validar os dados de FIFO de ordem de compra do item. |
validateRecord | afterValidateRecord | Payload | 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.p
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. |
create | beforeCreate | Payload | Executado antes da criação de um registro. |
create | afterCreate | Payload | Executado depois da criaçã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. |
Histórico do configurador de tributos do item:
Pontos UPC API REST - rep/api/v1/historicoConfigTribXmlNfe.p
Manipulação de Objetos da Interface (Metadata) | ||||
---|---|---|---|---|
Endpoint | Evento | Entrada | Especificidades | Observação |
getMetaData | list | Metadados | 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 | findById | Dados do registro | Executado depois de buscar um registro específico. |
findAll | findAll | Dados dos registros | Executado depois de buscar os registros. |
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 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. |
Documentos XML CT-e
Cabeçalho do documento:
Pontos UPC API REST - rep/api/v1/documentoXmlCte.p
Manipulação de Objetos da Interface (Metadata) | ||||
---|---|---|---|---|
Endpoint | Evento | Entrada | Especificidades | Observação |
getMetaData | list | Metadados | Estrutura metadados da listagem. | |
getMetaData | edit | Metadados | 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 | detail | Metadados | 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 | 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. |
engineRegras | beforeEngineRegras | Payload | Executado antes de executar a aplicação das regras. |
engineRegras | afterEngineRegras | Payload | Executado após executar a aplicação das regras. |
cancelarCte | beforeCancelarCte | Payload | Executado antes de executar o cancelamento do CT-e. |
cancelarCte | afterCancelarCte | Payload | Executado após executar o cancelamento do CT-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. |
ratearDocumentos | beforeRatearDocumentos | Payload | Executado antes de salvar o rateio de documentos. |
ratearDocumentos | afterRatearDocumentos | Payload | Executado após salvar o rateio de documentos. |
gerarNovoRateio | beforeGerarNovoRateioDespesas | Payload | Executado antes de gerar o novo rateio de despesas. |
gerarNovoRateio | afterGerarNovoRateioDespesas | Payload | Executado após gerar o novo rateio de despesas. |
Item do documento:
Pontos UPC API REST - rep/api/v1/itemDocumentoXmlCte.p
Manipulação de Objetos da Interface (Metadata) | ||||
---|---|---|---|---|
Endpoint | Evento | Entrada | Observação | |
getMetaData | list | Metadados | Estrutura metadados da listagem. | |
getMetaData | edit | Metadados | 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 | detail | Metadados | 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 | 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. |
validateForm | validateForm | Payload | 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.p
Manipulação de Objetos da Interface (Metadata) | ||||
---|---|---|---|---|
Endpoint | Evento | Entrada | Especificidades | Observação |
getMetaData | list | Metadados | Estrutura metadados da listagem. | |
getMetaData | edit | Metadados | 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 | findById | Dados do registro | Executado depois de buscar um registro específico. |
findAll | findAll | Dados dos registros | Executado depois de buscar os registros. |
create | beforeCreate | Payload | Executado antes da criação de um registro. |
create | afterCreate | Payload | Executado depois da criaçã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. |
Rateio de despesas (documentos de saída, normalmente frete de produtos vendidos):
Pontos UPC API REST - rep/api/v1/rateioDespesasCte.p
Manipulação de Objetos da Interface (Metadata) | ||||
---|---|---|---|---|
Endpoint | Evento | Entrada | Especificidades | Observação |
getMetaData | list | Metadados | Estrutura metadados da listagem. | |
getMetaData | new | Metadados | 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 | edit | Metadados | Mesmo formato de metadados do evento "new". | Estrutura metadados da tela de edição. |
getMetaData | detail | Metadados | 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 | findById | Dados do registro | Executado depois de buscar um registro específico. |
findAll | findAll | Dados dos registros | Executado depois de buscar os registros. |
create | beforeCreate | Payload | Executado antes da criação de um registro. |
create | afterCreate | Payload | Executado depois da criação de um registro. |
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. |
validateRecord | beforeValidateRecord | Payload | Executado após validar os dados de rateio. |
validateRecord | afterValidateRecord | Payload | Executado após validar os dados de rateio. |
Documentos XML NFS-e
Cabeçalho do documento:
Pontos UPC API REST - rep/api/v1/documentoXmlNfse.p
Manipulação de Objetos da Interface (Metadata) | ||||
---|---|---|---|---|
Endpoint | Evento | Entrada | Especificidades | Observação |
getMetaData | list | Metadados | Estrutura metadados da listagem. | |
getMetaData | edit | Metadados | 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": Folder "Item/Compra": | Estrutura metadados da tela de edição. |
getMetaData | detail | Metadados | 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 | editItemCompra | Metadados | 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 | 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. |
engineRegras | beforeEngineRegras | Payload | Executado antes de executar a aplicação das regras. |
engineRegras | afterEngineRegras | Payload | Executado após executar a aplicação das regras. |
cancelarNfse | beforeCancelarNfse | Payload | Executado antes de executar o cancelamento da NFS-e. |
cancelarNfse | afterCancelarNfse | Payload | 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.p
Manipulação de Objetos da Interface (Metadata) | ||||
---|---|---|---|---|
Endpoint | Evento | Entrada | Especificidades | Observação |
getMetaData | list | Metadados | Estrutura metadados da listagem. | |
getMetaData | edit | Metadados | 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 | detail | Metadados | 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 | 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. |
validateForm | validateForm | Payload | Executado após sair do campo que tenha a validação do formulário. |
Cancelamentos recebidos
Pontos UPC API REST - rep/api/v1/eventoCancelamento.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. |
update | beforeUpdate | Payload | Executado antes da alteração de um registro. |
update | afterUpdate | Payload | Executado depois da alteração de um registro. |
03. 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. 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. 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 | validateForm | Payload | Executado após sair do campo que tenha a validação do formulário. 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. |
04. Observações Gerais
- Todas as APIs REST citadas neste documento seguem o padrão de API TOTVS.