Lista de views
Alertas
Se estes campos estiverem vazios ou null estes podem causar uma falha ou integrações erradas
Clientes
A VIEW deve devolver informação dos clientes da empresa.
Nome: ViewClientes
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único do cliente |
| * codigoCliente | String | Código interno do cliente |
| * nomeCliente | String | Designação do cliente |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
| nifCliente | String | NIF do cliente |
| telefoneCliente | String | Número de telefone/telemóvel do cliente |
| emailCliente | String | Email geral do cliente |
| moradaCliente | String | Morada do cliente |
| localidadeCliente | String | Lodalidade do cliente |
| codigoPostalCliente | String | Código postal |
| paisCliente | String | País de origem do cliente |
| idiomaCliente | String | Idioma associado ao cliente |
| aux1 | String | Campo auxiliar 1 |
| aux2 | String | Campo auxiliar 2 |
-- Exemplo
SELECT id, codigoCliente, nomeCliente, isAtivo, nifCliente, telefoneCliente, emailCliente, moradaCliente, localidadeCliente, codigoPostalCliente, paisCliente, idiomaCliente, aux1, aux2
FROM ViewClientesFornecedores
A VIEW deve devolver informação dos fornecedores da empresa.
Nome: ViewFornecedores
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único do fornecedor |
| * codigoFornecedor | String | Código interno do fornecedor |
| * nomeFornecedor | String | Designação do fornecedor |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
| nifFornecedor | String | NIF do fornecedor |
| telefoneFornecedor | String | Número de telefone/telemóvel do fornecedor |
| emailFornecedor | String | Email geral do fornecedor |
| moradaFornecedor | String | Morada do fornecedor |
| localidadeFornecedor | String | Lodalidade do fornecedor |
| codigoPostalFornecedor | String | Código Postal |
| paisFornecedor | String | País de origem do fornecedor |
| idiomaFornecedor | String | Idioma associado ao fornecedor |
| aux1 | String | Campo auxiliar 1 |
| aux2 | String | Campo auxiliar 2 |
-- Exemplo
SELECT id, codigoFornecedor, nomeFornecedor, isAtivo, nifFornecedor, telefoneFornecedor, emailFornecedor, moradaFornecedor, localidadeFornecedor, codigoPostalFornecedor, paisFornecedor, idiomaFornecedor, aux1, aux2
FROM ViewFornecedoresArtigos
A VIEW deve devolver apenas informação dos artigos da empresa. Deve no entanto ser filtrado na própria
VIEW, para mostrar apenas artigos que façam sentido na produção.
Exemplo de artigos que não devem ser devolvidos: Serviços, Rendas, Contratos, etc.
Nome: ViewArtigos
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único do artigo |
| * codigoArtigo | String | Código interno do artigo |
| * nomeArtigo | String | Designação do artigo |
| * tipoArtigo | String | Exemplo: corante, matéria-prima, acessórios, embalagem, etc… |
| * usaCor | String | 1 = Sim | 0 = Não |
| * usaTamanho | String | 1 = Sim | 0 = Não |
| * unidadeCompra | String | Unidade de medida que serve de referência ao artigo no processo de receção |
| * movimentaStock | String | 1 = Sim | 0 = Não |
| * unidadeProducao | String | Unidade de medida que serve de referência à quantidade produzida e consumos |
| * fatorConversao | Decimal (16,4) | Fator que converte a compra em produção, se não existir fica “1” |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
| familiaArtigo | String | Família do artigo |
| codigoBarras | String | EAN, GTIN, etc… |
| corArtigo | String | Campo de artigo intermédio / produto acabado |
| tamanhoArtigo | String | Campo de artigo intermédio / produto acabado |
| dimensaoArtigo | String | Campo de artigo intermédio / produto acabado |
| capacidade | String | Campo de artigo intermédio / produto acabado |
| marcaArtigo | String | Marca do artigo |
| modeloArtigo | String | Modelo do artigo |
| usaLote | String | 1 = Sim | 0 = Não |
| usaSerialNumber | String | 1 = Sim | 0 = Não |
| quantidadeEncomendada | Decimal (16,4) | Quantidade encomendada |
| quantidadeStockMin | Decimal (16,4) | Quantidade stock Minimo |
| quantidadeStock | Decimal (16,4) | Quantidade stock existente em stock |
| quantidadeReservada | Decimal (16,4) | Quantidade reservada |
| custo | Decimal (16,4) | Custo médio padrão ou último preço custo ou outro a definir pelo cliente - custo utilizado para custeio na produção |
| custoRefProducao | Decimal (16,4) | Preço de custo previsto, para efeitos de analise |
| qtdMinimaEncForn | String | Quantidade unitária minima a encomendar |
| prazoMinimoEntrega | String | Prazo minimo de encomenda |
| centroAnalitico | String | |
| validade | INT | Nº de dias de validade, para calcular validade na receção |
| imagemArtigo | String | Imagem base64 |
| desvioMaximoAdmitidoRececao | Decimal (16,4) | Desvio máximo em % que o Vsoft permite receber do artigo nas encomendas. Se não existir limite colocar o campo a NULL |
| isMercadoria | String | Campo para identificar produtos que são rececionados para serem revendidos. 1 = Ativo | 0 = Inativo |
| aux1 | String | Campo auxiliar 1 |
| aux2 | String | Campo auxiliar 2 |
-- Exemplo
SELECT id, codigoArtigo, nomeArtigo, tipoArtigo, usaCor, usaTamanho, unidadeCompra, movimentaStock, unidadeProducao, fatorConversao, isAtivo, familiaArtigo, codigoBarras, corArtigo, tamanhoArtigo, dimensaoArtigo, capacidade, marcaArtigo, modeloArtigo, usaLote, usaSerialNumber, quantidadeEncomendada, quantidadeStockMin, quantidadeStock, quantidadeReservada, custo, custoRefProducao, qtdMinimaEncForn, prazoMinimoEntrega, centroAnalitico, validade, imagemArtigo, desvioMaximoAdmitidoRececao, isMercadoria, aux1, aux2
FROM ViewArtigosTamanhos
Retorna a informação dos tamanhos existentes no ERP da empresa.
Utilizado geralmente quando o artigo tem um código único mas pode ter vários tamanhos.
Nome: ViewListaTamanhos
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único do tamanho |
| * codigoArtigo | String | Código interno do artigo associado |
| * tamanho | String | Designação do tamanho |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
-- Exemplo
SELECT id, codigoArtigo, tamanho, isAtivo
FROM ViewListaTamanhosCores
Retorna a informação das cores existentes no ERP da empresa.
Utilizado quando o artigo tem várias cores, mas um único código no ERP.
Nome: ViewListaCores
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único da cor |
| * codigoArtigo | String | Código interno do artigo associado |
| * cor | String | Designação da cor |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
-- Exemplo
SELECT id, codigoArtigo, cor, isAtivo
FROM ViewListaCoresReferência externas
Retorna a informação das referência e nomes atribuidas por entidades externas a cada artigo.
O objetivo é fazer corresponder o código de artigos dos fornecedores com o código de artigo no ERP.
Nome: ViewReferenciaExternas
| Coluna | Tipo | Descrição |
|---|---|---|
| * codigoArtigo | String | Código interno de identificação do artigo em causa |
| * codigoExterno | String | Código de identificação externo |
| * nomeExterno | String | Designação de identificação externa |
| * codigoEntidade | String | Código de cliente ou fornecedor |
-- Exemplo
SELECT codigoArtigo, codigoExterno, nomeExterno, codigoEntidade
FROM ViewReferenciaExternasStock de artigos
Retorna a informação do stock disponível por artigo existente no ERP da empresa.
Nome: ViewStockArtigos
| Coluna | Tipo | Descrição |
|---|---|---|
| * codigoArtigo | String | Código interno do artigo |
| * nomeArtigo | String | Designação do artigo |
| * unidadeArtigo | String | Unidade em medida para stock |
| * quantidadeStock | Decimal (16,4) | Quantidade em stock na unidade acima identificada |
| * armazemArtigo | String | Armazém onde se encontra o artigo |
| corArtigo | String | Cor do artigo |
| tamanhoArtigo | String | Tamanho do artigo |
| dimensaoArtigo | String | Dimensão do artigo |
| dataProdArtigo | date | Data de produção do artigo |
| lote | String | Lote do artigo |
| custoUnit | Decimal (16,4) | Custo de aquisição por Lote. Se gerar lote deve trazer o custo desse lote. Quando não aplicavél deve vir a NULL |
| serialNumber | String | Número de Série do artigo |
| validadeArtigo | date | Deve respeitar o formato: AAAA-MM-DD |
| localizacao | String | Se não exisitir o campo deve vir a NULL |
| aux1 | String | Campo auxiliar 1 |
| aux2 | String | Campo auxiliar 2 |
-- Exemplo
SELECT codigoArtigo, nomeArtigo, unidadeArtigo, quantidadeStock, armazemArtigo, corArtigo, tamanhoArtigo, dimensaoArtigo, dataProdArtigo, lote, custoUnit, serialNumber, validadeArtigo, localizacao, aux1, aux2
FROM ViewStockArtigosÚltimo valor de compra
Retorna a informação do último valor de compra para todos os artigos de matéria-prima/mercadoria.
Nome: ViewUltimaCompraArtigo
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único do artigo |
| * codigoArtigo | String | Código interno do artigo |
| * codigoFornecedor | String | Código interno do fornecedor da última compra |
| * nomeFornecedor | String | Nome do fornecedor da última compra |
| * precoCustoUnit | Decimal (16,4) | Valor de custo sem iva por unidade comprada em euros |
| * unidade | String | Unidade de compra |
| dataCompra | date | Data de última compra do artigo |
| aux1 | String | Campo auxiliar 1 |
| aux2 | String | Campo auxiliar 2 |
-- Exemplo
SELECT id, codigoArtigo, codigoFornecedor, nomeFornecedor, precoCustoUnit, unidade, dataCompra, aux1, aux2
FROM ViewUltimaCompraArtigoEncomendas fornecedor
Retorna a informação base das encomendas realizadas ao fornecedor.
O objetivo é facilitar o processo de receção no picking.
Nome: ViewEncomendasFornecedor
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único da encomenda |
| * codigoFornecedor | String | Código interno do fornecedor |
| * nomeFornecedor | String | Designação do fornecedor |
| * dataHoraEncomenda | datetime | Data e hora a que foi realizada a encomenda. Deve respeitar o formato: AAAA-MM-DD hh:mm:ss.mmm |
| * idDocumentoERP | String | ID único da encomenda gerado pelo ERP |
| * numeroEncomenda | String | Considerar o número único, juntar ano/serie com numero de documento |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
| serieEncomenda | String | Indicar a serie do documento, utilizado pelo ERP |
| encomendadoPor | String | Nome de quem procedeu à encomenda |
| localDescarga | String | Designação do local de descarga |
| moradaDescarga | String | Morada de descarga |
| localidadeFornecedor | String | Localidade de descarga |
| codigoPostalDescarga | String | Código postal da descarga |
| paisDescarga | String | País a realizar a descarga |
| aux1 | String | Campo auxiliar 1 |
| aux2 | String | Campo auxiliar 2 |
-- Exemplo
SELECT id, codigoFornecedor, nomeFornecedor, dataHoraEncomenda, idDocumentoERP, numeroEncomenda, isAtivo, serieEncomenda, encomendadoPor, localDescarga, moradaDescarga, localidadeFornecedor, codigoPostalDescarga, paisDescarga, aux1, aux2
FROM ViewEncomendasFornecedorArtigos encomendas fornecedor
Retorna a informação detalhada de cada artigo por encomenda realizadas ao fornecedor.
Nome: ViewEncomendasArtigosFornecedor
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único do artigo |
| * codigoArtigo | String | Código interno do artigo |
| * nomeArtigo | String | Designação do artigo |
| * familiaArtigo | String | Família do artigo |
| * quantidadeEncomendada | Decimal (16,4) | Quantidade encomendada do artigo |
| * unidade | String | Unidade de medida da quantidade encomendada |
| * quantidadePorVolume | Decimal (16,4) | Quantidade de artigos por volume |
| * quantidadeTotal | Decimal (16,4) | Quantidade total de artigos |
| * quantidadePendente | Decimal (16,4) | Quantidade pendente para satisfazer a encomenda |
| * idDocumentoLinhaERP | String | Número da linha do documento onde está o artigo no ERP |
| * idDocumentoERP | String | ID único da encomenda gerado pelo ERP |
| * ordemERP | String | Ordenação do artigo no documento ERP |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
| armazem | String | Armazem por defeito para rececionar artigo |
| corArtigo | String | Cor do artigo |
| tamanhoArtigo | String | Tamanho do artigo |
| dimensaoArtigo | String | Dimensão do artigo |
| obraProjetoDestino | String | Obra/Projeto de destino do artigo |
| custoUnitario | Decimal (16,4) | Preço unitário de cada artigo associado à encomenda |
| custo | Decimal (16,4) | Custo total desta linha de encomenda do artigo (custo un. * quantitdade) |
| dataPrazoEntrega | date | Deve respeitar o formato: AAAA-MM-DD |
-- Exemplo
SELECT id, codigoArtigo, nomeArtigo, familiaArtigo, quantidadeEncomendada, unidade, quantidadePorVolume, quantidadeTotal, quantidadePendente, idDocumentoLinhaERP, idDocumentoERP, ordemERP, isAtivo, armazem, corArtigo, tamanhoArtigo, dimensaoArtigo, obraProjetoDestino, custoUnitario, custo, dataPrazoEntrega
FROM ViewEncomendasArtigosFornecedorEncomendas do cliente
Retorna a informação base das encomendas realizadas pelo cliente.
O objetivo é facilitar o processo de expedição no picking.
Nome: ViewEncomendasCliente
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único da encomenda |
| * codigoCliente | String | Código interno do cliente |
| * nomeCliente | String | Designação do cliente |
| * dataHoraEncomenda | datetime | Data e hora a que foi pedida a encomenda. Deve respeitar o formato: AAAA-MM-DD hh:mm:ss.mmm |
| * idDocumentoERP | String | ID único da encomenda gerado pelo ERP |
| * numeroEncomenda | String | Considerar o número único, juntar ano/serie com numero de documento |
| * paisDescarga | String | País a realizar a descarga |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
| encomendadoPor | String | Nome de quem procedeu à encomenda |
| rota | String | Designação da rota |
| localDescarga | String | Designação do local de descarga |
| moradaDescarga | String | Morada de descarga |
| localidadeFornecedor | String | Localidade de descarga |
| codigoPostalDescarga | String | Código postal da descarga |
| aux1 | String | Campo auxiliar 1 |
| aux2 | String | Campo auxiliar 2 |
-- Exemplo
SELECT id, codigoCliente, nomeCliente, dataHoraEncomenda, idDocumentoERP, numeroEncomenda, paisDescarga, isAtivo, encomendadoPor, rota, localDescarga, moradaDescarga, localidadeFornecedor, codigoPostalDescarga, aux1, aux2
FROM ViewEncomendasClienteArtigos Encomendas clientes
Retorna a informação detalhada de cada artigo por encomenda realizadas pelo cliente.
Nome: ViewEncomendasArtigosCliente
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único do artigo |
| * codigoArtigo | String | Código interno do artigo |
| * nomeArtigo | String | Designação do artigo |
| * quantidadeEncomendada | Decimal (16,4) | Quantidade encomendada do artigo |
| * unidade | String | Unidade de medida que serve de referência ao artigo |
| * quantidadePorVolume | Decimal (16,4) | Quantidade de artigos por volume |
| * quantidadeTotal | Decimal (16,4) | Quantidade total de artigos |
| * idDocumentoERP | String | ID único da encomenda gerado pelo ERP |
| * idDocumentoLinhaERP | String | Número da linha do documento onde está o artigo no ERP |
| * ordemERP | String | Ordenação do artigo no documento ERP |
| * firmada | String | Campo para indicar, se a encomenda têm ordem para expedir. 1 = Ativo | 0 = Inativo |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
| familiaArtigo | String | Família do artigo |
| corArtigo | String | Cor do artigo |
| tamanhoArtigo | String | Tamanho do artigo |
| dimensaoArtigo | String | Dimensão do artigo |
| dataPrevistaExpedicao | date | Data prevista para a expedição. Deve respeitar o formato: AAAA-MM-DD |
| custoUnitario | Decimal (16,4) | Custo unitário de cada artigo associado à encomenda |
| quantidadeEntregue | Decimal (16,4) | Quantidade já expedida |
| quantidadePendente | Decimal (16,4) | Quantidade pendente por entregar |
| custo | Decimal (16,4) | Custo total da encomenda |
| dataPrazoEntrega | date | Deve respeitar o formato: AAAA-MM-DD |
| observacao | String | Observações associadas ao artigo no documento ERP |
-- Exemplo
SELECT id, codigoArtigo, nomeArtigo, quantidadeEncomendada, unidade, quantidadePorVolume, quantidadeTotal, idDocumentoERP, idDocumentoLinhaERP, ordemERP, firmada, isAtivo, familiaArtigo, corArtigo, tamanhoArtigo, dimensaoArtigo, dataPrevistaExpedicao, custoUnitario, quantidadeEntregue, quantidadePendente, custo, dataPrazoEntrega, observacao
FROM ViewEncomendasArtigosClienteViaturas
Retorna a informação das viaturas criadas no ERP
Nome: ViewViaturas
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único da viatura |
| * matriculaViatura | String | Matricula da viatura |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
| nomeViatura | String | Designação da viatura |
-- Exemplo
SELECT id, matriculaViatura, isAtivo, nomeViatura
FROM ViewViaturasUtilizadores
Retorna a informação detalhada dos utilizadores existentes no ERP.
Nome: ViewUsers
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único do utilizador |
| * codigoUser | String | Código interno do utilizador |
| * primeiroNomeUser | String | Nome próprio do utilizador |
| * ultimoNomeUser | String | Apelido do utilizador |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
| username | String | Username atribuído ao utilizador |
| emailUser | String | Email do utilizador |
| telefoneUser | String | Número de telefone/telemóvel do utilizador |
| custoHora | String | Custo hora do utilizador, para custeio |
| aux1 | String | Campo auxiliar 1 |
| aux2 | String | Campo auxiliar 2 |
-- Exemplo
SELECT id, codigoUser, primeiroNomeUser, ultimoNomeUser, isAtivo, username, emailUser, telefoneUser, custoHora, aux1, aux2
FROM ViewUsersArmazéns
A VIEW deve devolver apenas informação dos armazéns da empresa.
Nome: ViewArmazens
| Coluna | Tipo | Descrição |
|---|---|---|
| * id | String | ID único do armazém |
| * codigoArmazem | String | Código interno do armazém |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
| nomeArmazem | String | Designação do armazém |
| descritivoArmazem | String | Descrição da utilização ou outra especificação do armazém. Apenas visível em base de dados |
| usaLocalizacoes | String | 1 = Sim | 0 = Não |
-- Exemplo
SELECT id, codigoArmazem, isAtivo, nomeArmazem, descritivoArmazem, usaLocalizacoes
FROM ViewArmazensArtigos por armazém
Deve disponibilizar informação sobre os artigos existentes em cada armazém.
Nome: ViewArtigosArmazens
| Coluna | Tipo | Descrição |
|---|---|---|
| * codigoArtigo | String | ID único do artigo |
| * nomeArtigo | String | Designação do artigo |
| * codigoArmazem | String | ID único do armazém |
-- Exemplo
SELECT codigoArtigo, nomeArtigo, codigoArmazem
FROM ViewArtigosArmazensLocalizações
A VIEW deve devolver apenas informação das Localizações da empresa.
Nome: ViewLocalizações
| Coluna | Tipo | Descrição |
|---|---|---|
| * codigoLocalizacao | String | ID único da localização |
| * nomeLocalizacao | String | Nome descritivo da localização |
| * codigoArmazem | String | ID único do armazém, ao qual pertence a localização |
| * isAtivo | String | 1 = Ativo | 0 = Inativo |
-- Exemplo
SELECT codigoLocalizacao, nomeLocalizacao, codigoArmazem, isAtivo
FROM ViewLocalizações