Saltar para o conteúdo

Webservice

Entrada matéria-prima


 

Deve processar informação relativa aos movimentos de entrada de stock de matéria-prima e mercadoria no ERP da empresa. Esta entrada poderá estar associada a uma encomenda de fornecedor ou não.

Nome: ws_EntradaStockMateriaPrima

Cabeçalho
Campo de EntradaTipoDescrição
numeroRececaoStringCódigo interno do movimento de receção
codigoFornecedorStringCódigo interno do fornecedor
docFornecedorStringDocumento de referência do fornecedor
docAduaneiroStringDocumento para regimes aduaneiros, por exemplo provas de origem no âmbito do desalfandegamento
utilizadorStringUtilizador responsável pelo movimento
matriculaStringMatrícula do veículo de carga
dataHoraEntregaStringDeve respeitar o formato: AAAA-MM-DD hh:mm
rececionadoPorStringOperador que procedeu à receção da matéria prima
CMRStringGuia de transporte
aux1StringCampo auxiliar 1
aux2StringCampo auxiliar 2
Linhas
Campo de EntradaTipoDescrição
codigoArtigoStringCódigo interno do artigo
corArtigoStringCor do artigo
tamanhoArtigoStringTamanho do artigo
dimensaoArtigoStringDimensão do artigo
loteStringLote do artigo
serialNumberStringNumero de série do artigo
custoUnitarioStringCusto por unidade do artigo
validadedateDeve respeitar o formato: AAAA-MM-DD
numeroEncomendaStringNúmero de encomenda do cliente
quantidadeDecimal (16,4)Quantidade movimentada do artigo
unidadeStringUnidade de medida que serve de referência ao artigo
armazemDestinoStringArmazém de destino do artigo
localizacaoDestinoStringLocalização de destino do artigo
idDocumentoLinhaERPStringServe para associar a entrada de matérias-primas à encomenda de fornecedor. Descontando assim a quantidade pendente a ser entregue.
aux1StringCampo auxiliar 1
aux2StringCampo auxiliar 2
// Exemplo
{
    "numeroRececao": "2600775",
    "codigoFornecedor": "901",
    "docFornecedor": "22158",
    "docAduaneiro": "",
    "utilizador": "Vera Soares",
    "matricula": "",
    "dataHoraEntrega": "2026-08-31 09:51",
    "rececionadoPor": "Vera Soares",
    "CMR": "22158",
    "aux1": "",
    "aux2": "",
    "linhas": [
        {
            "codigoArtigo": "DOBCOU001",
            "corArtigo": "",
            "tamanhoArtigo": "",
            "dimensaoArtigo": "",
            "lote": "260831004",
            "serialNumber": "47298",
            "custoUnitario": "3.9500",
            "validade": "2028-02-04",
            "numeroEncomenda": "2026/773/Entrega-31/08/2026",
            "quantidade": 72,
            "unidade": "UN",
            "armazemDestino": "LSKJ4829",
            "localizacaoDestino": "A1",
            "idDocumentoLinhaERP": "F3723E60-4E62-4D3F-A00F-8",
            "aux1": "",
            "aux2": ""
        },
    ]
}

Consumo matéria-prima


Deve processar informação relativa aos movimentos de saída de stock de matéria-prima no ERP da empresa associado ao fabrico de produto intermédio ou acabado.

Nome: ws_SaidaStockMateriaPrima

Cabeçalho

Campo de EntradaTipoDescrição
ordemProducaoStringOrdem de produção associada ao artigo
armazemStringArmazém onde se encontra o artigo
utilizadorStringUtilizador responsável pelo movimento
dataHoraStringData e hora do registo. Deve respeitar o formato: AAAA-MM-DD hh:mm
Linhas
Campo de EntradaTipoDescrição
codigoArtigoStringCódigo interno do artigo
corArtigoStringCor do artigo
tamanhoArtigoStringTamanho do artigo
dimensaoArtigoStringDimensão do artigo
loteStringLote do artigo
serialNumberStringNumero de série do artigo
quantidadeDecimal (16,4)Quantidade movimentada do artigo
unidadeStringUnidade de medida que serve de referência ao artigo
// Exemplo
{
    "ordemProducao": "314234",
    "armazem": "LSKJ4829",
    "utilizador": "Vera Soares",
    "dataHora": "2026-04-18 08:43",
    "linhas": [
        {
            "codigoArtigo": "DOBCOU001",
            "corArtigo": "",
            "tamanhoArtigo": "",
            "dimensaoArtigo": "",
            "lote": "260831004",
            "serialNumber": "",
            "quantidade": 72,
            "unidade": "UN",
        },
    ]
}

Re-integração de stock

Deve processar informação relativa a uma re-integração de stock consumido numa ordem de produção.

Nome: ws_ReIntegracaoStock

Cabeçalho

Campo de EntradaTipoDescrição
ordemProducaoStringOrdem de produção associada ao artigo
dataHoraStringData e hora do registo. Deve respeitar o formato: AAAA-MM-DD hh:mm
utilizadorStringUtilizador responsável pelo movimento
Linhas
Campo de EntradaTipoDescrição
codigoArtigoStringCódigo interno do artigo
corArtigoStringCor do artigo
tamanhoArtigoStringTamanho do artigo
dimensaoArtigoStringDimensão do artigo
loteStringLote do artigo
serialNumberStringNumero de série do artigo
quantidadeDecimal (16,4)Quantidade movimentada do artigo
unidadeStringUnidade de medida que serve de referência ao artigo
// Exemplo
{
    "ordemProducao": "314234",
    "dataHora": "2026-04-18 08:43",
    "utilizador": "Vera Soares",
    "linhas": [
        {
            "codigoArtigo": "DOBCOU001",
            "corArtigo": "",
            "tamanhoArtigo": "",
            "dimensaoArtigo": "",
            "lote": "260831004",
            "serialNumber": "",
            "quantidade": 72,
            "unidade": "UN",
        },
    ]
}

Entradas produto acabado/intermédio


O Procedimento deve processar informação relativa aos movimentos de entrada de produto acabado no ERP da empresa.

Nome: ws_EntradaStockProdutoAcabado

Cabeçalho

Campo de EntradaTipoDescrição
ordemProducaoStringOrdem de produção associada ao artigo
encomendaClienteStringNúmero de encomenda do cliente
utilizadorStringUtilizador responsável pelo movimento
fimProducaoBoolPor defeito a 0, se colocado a 1, poderá servir para fechar o documento e recalcular quantidades e custos. Esta funcionalidade poderá não ser disponível para todas as empresas, por existir casos que não é possível determinar qual a última palete de produção
Linhas
Campo de EntradaTipoDescrição
codigoArtigoStringCódigo interno do artigo
corArtigoStringCor do artigo
tamanhoArtigoStringTamanho do artigo
dimensaoArtigoStringDimensão do artigo
loteStringLote do artigo
SSCCStringO Serial Shipping Container Code número de 18 dígitos usado para identificar unidades logísticas.
serialNumberStringNumero de série do artigo
quantidadeDecimal (16,4)Quantidade movimentada do artigo
unidadeStringUnidade de medida que serve de referência ao artigo
custoRealUnitDecimal (16,4)Custo real unitário de cada artigo
armazemStringArmazém onde se encontra o artigo
localizacaoStringLocalização onde se encontra o artigo
// Exemplo
{
    "ordemProducao": "314234",
    "encomendaCliente": "948870",
    "utilizador": "Vera Soares",
    "fimProducao": "0",
    "linhas": [
        {
            "codigoArtigo": "DOBCOU001",
            "corArtigo": "",
            "tamanhoArtigo": "",
            "dimensaoArtigo": "",
            "lote": "260831004",
            "SSCC": "273827582719372819",
            "serialNumber": "47268376",
            "quantidade": 72.4,
            "unidade": "UN",
            "custoRealUnit": 11.8,
            "armazem": "LSKJ4829",
            "localizacao": "A1"
        },
    ]
}

Movimentos de armazém


 

O Procedimento deve processar informação relativa a movimentação de matéria-prima entre armazéns.

Nome: ws_MovimentoArmazem

Cabeçalho

Campo de EntradaTipoDescrição
armazemOrigemStringArmazém de origem do artigo
localizacaoOrigemStringLocalização de origem do artigo
armazemDestinoStringArmazém de destino do artigo
localizacaoDestinoStringLocalização de destino do artigo
dataHoraStringData e hora do registo. Deve respeitar o formato: AAAA-MM-DD hh:mm
utilizadorStringUtilizador responsável pelo movimento
Linhas
Campo de EntradaTipoDescrição
codigoArtigoStringCódigo interno do artigo
corArtigoStringCor do artigo
tamanhoArtigoStringTamanho do artigo
dimensaoArtigoStringDimensão do artigo
loteStringLote do artigo
serialNumberStringNumero de série do artigo
quantidadeDecimal (16,4)Quantidade movimentada do artigo
unidadeStringUnidade de medida que serve de referência ao artigo
aux1StringCampo auxiliar 1
aux2StringCampo auxiliar 2
// Exemplo
{
    "armazemOrigem": "LSKJ4829",
    "localizacaoOrigem": "V2",
    "armazemDestino": "LSKJ4829",
    "localizacaoDestino": "A1",
    "dataHora": "2026-04-18 08:43",
    "utilizador": "Vera Soares",
    "linhas": [
        {
            "codigoArtigo": "DOBCOU001",
            "corArtigo": "",
            "tamanhoArtigo": "",
            "dimensaoArtigo": "",
            "lote": "260831004",
            "serialNumber": "47268376",
            "quantidade": 72.4,
            "unidade": "UN",
            "aux1": "",
            "aux2": ""
        },
    ]
}

Acertos de stock


 

O Procedimento deve processar informação relativa a acertos de stock de artigos finais.

Nome: ws_AcertoStock

Campo de EntradaTipoDescrição
codigoArtigoStringCódigo interno do artigo
corArtigoStringCor do artigo
tamanhoArtigoStringTamanho do artigo
dimensaoArtigoStringDimensão do artigo
loteStringLote do artigo
serialNumberStringNumero de série do artigo
armazemStringArmazém onde se encontra o artigo
localizacaoStringLocalização onde se encontra o artigo
quantidadeDecimal (16,4)Quantidade final do artigo
unidadeStringUnidade de medida que serve de referência ao artigo
dataHoraStringData e hora do registo. Deve respeitar o formato: AAAA-MM-DD hh:mm:ss.mmm
utilizadorStringUtilizador responsável pelo movimento
aux1StringCampo auxiliar 1
aux2StringCampo auxiliar 2
// Exemplo
{
    "codigoArtigo": "DOBCOU001",
    "corArtigo": "",
    "tamanhoArtigo": "",
    "dimensaoArtigo": "",
    "lote": "260831004",
    "serialNumber": "47268376",
    "armazem": "BJFI9418",
    "localizacao": "A1",
    "quantidade": 72.4,
    "unidade": "UN",
    "dataHora": "2026-04-18 08:43",
    "utilizador": "Vera Soares",
    "aux1": "",
    "aux2": "",
}

Produtos não conforme


O Procedimento deve processar informação relativa a movimentos de produto não conforme registados no sistema, e reclassificar o mesmo como não conforme no ERP.

Nome: ws_ProdutoNaoConforme

Campo de EntradaTipoDescrição
codigoArtigoStringCódigo interno do artigo
corArtigoStringCor do artigo
tamanhoArtigoStringTamanho do artigo
dimensaoArtigoStringDimensão do artigo
loteStringLote do artigo
serialNumberStringNumero de série do artigo
quantidadeDecimal (16,4)Quantidade final do artigo
unidadeStringUnidade de medida que serve de referência ao artigo
dataHoraStringData e hora do registo. Deve respeitar o formato: AAAA-MM-DD hh:mm:ss.mmm
utilizadorStringUtilizador responsável pelo movimento
aux1StringCampo auxiliar 1
aux2StringCampo auxiliar 2
// Exemplo
{
    "codigoArtigo": "DOBCOU001",
    "corArtigo": "",
    "tamanhoArtigo": "",
    "dimensaoArtigo": "",
    "lote": "260831004",
    "serialNumber": "47268376",
    "quantidade": 72.4,
    "unidade": "UN",
    "dataHora": "2026-04-18 08:43",
    "utilizador": "Vera Soares",
    "aux1": "",
    "aux2": "",
}

Documento de expedição


O Procedimento trata a informação relativa à expedição.

Nome: ws_DocExpedicao

Cabeçalho

Campo de EntradaTipoDescrição
numeroExpediçãoStringNúmero de expedição no VSOFT
numeroEncomendaStringNúmero de encomenda do cliente
codigoClienteStringCódigo interno do cliente
dataHoraSaidaStringData hora a que o veiculo finalizou a carga. Deve respeitar o formato: AAAA-MM-DD hh:mm:ss.mmm
carregadoPorStringOperador que procedeu à carga do veiculo
matriculaStringMatricula do veiculo de carga
localDescargaStringDesignação do local de descarga
moradaDescargaStringMorada de descarga
codigoPostalDescargaStringCódigo Postal de descarga
localidadeDescargaStringLocalidade de descarga
paisDescargaStringPaís de descarga
idEncomendaERPStringID único da encomenda gerado pelo ERP
idEncomendaLinhaERPStringNúmero da linha do documento onde está o artigo no ERP
utilizadorStringUtilizador responsável pelo movimento
aux1StringCampo auxiliar 1
aux2StringCampo auxiliar 2
Linhas
Campo de EntradaTipoDescrição
codigoArtigoStringCódigo interno do artigo
corArtigoStringCor do artigo
tamanhoArtigoStringTamanho do artigo
dimensaoArtigoStringDimensão do artigo
loteStringLote do artigo
serialNumberStringNumero de série do artigo
quantidadeDecimal (16,4)Quantidade movimentada do artigo
unidadeStringUnidade de medida que serve de referência ao artigo
validadedateDeve respeitar o formato: AAAA-MM-DD
armazemOrigemStringArmazém de origem do artigo
localizacaoOrigemStringLocalização de origem do artigo
aux1StringCampo auxiliar 1
aux2StringCampo auxiliar 2
// Exemplo
{
    "numeroExpedição": "1243",
    "numeroEncomenda": "457892",
    "codigoCliente": "JD9DG8N345",
    "dataHoraSaida": "2026-05-24 16:32:10",
    "carregadoPor": "Ricardo Soares",
    "matricula": "AO-91-EI",
    "localDescarga": "Sede",
    "moradaDescarga": "Rua x, n34",
    "codigoPostalDescarga": "0000-001",
    "localidadeDescarga": "Leiria",
    "paisDescarga": "Portugal",
    "idEncomendaERP": "JD9FJG91I",
    "idEncomendaLinhaERP": "GJI43H-6J6O-3I5J-OI99-3",
    "utilizador": "Vera Soares",
    "aux1": "",
    "aux2": "",
    "linhas": [
        {
            "codigoArtigo": "DOBCOU001",
            "corArtigo": "",
            "tamanhoArtigo": "",
            "dimensaoArtigo": "",
            "lote": "260831004",
            "serialNumber": "47268376",
            "quantidade": 72.4,
            "unidade": "UN",
            "validade": "2029-03-20",
            "armazemOrigem": "LKAJEI943",
            "localizacaoOrigem": "A1",
            "aux1": "",
            "aux2": "",
        },
    ]
}

Final de produção


O Procedimento deve indicar o final da produção.

Nome: ws_FinalProducao

Campo de EntradaTipoDescrição
codigoArtigoStringCódigo interno do artigo
loteStringLote do artigo
custoUnitDecimal (16,4)Custo por unidade do artigo
// Exemplo
{
    "codigoArtigo": "DOBCOU001",
    "lote": "260831004",
    "custoUnit": 22.1,
}

Quebra de artigo


O Procedimento serve para integrar no ERP quebras do artigo.

Nome: ws_QuebraArtigo

Campo de EntradaTipoDescrição
codigoArtigoStringCódigo interno do artigo
corArtigoStringCor do artigo
tamanhoArtigoStringTamanho do artigo
dimensaoArtigoStringDimensão do artigo
loteStringLote do artigo
serialNumberStringNumero de série do artigo
quantidadeDecimal (16,4)Quantidade a dar quebra do artigo
unidadeStringUnidade da quantidade a dar quebra
armazemOrigemStringArmazém de origem do artigo a dar quebra
localizacaoStringLocalização do artigo a dar quebra
operadorStringOperador que deu ordem de quebra
motivoStringMotivo de quebra
// Exemplo
{
    "codigoArtigo": "DOBCOU001",
    "corArtigo": "",
    "tamanhoArtigo": "",
    "dimensaoArtigo": "",
    "lote": "260831004",
    "serialNumber": "47268376",
    "quantidade": 72.4,
    "unidade": "UN",
    "armazemOrigem": "LKAJEI943",
    "localizacao": "A1",
    "operador": "Vera Soares",
    "motivo": "",
}

Criar necessidade de compra


O Procedimento serve para gerar no ERP a criação da necessidade de compra.

Nome: ws_CriarNecessidadeCompra

Campo de EntradaTipoDescrição
numeroNecessidadeCompraStringNúmero necessidade no VSOFT
codigoFornecedorStringIdentificador do Fornecedor no ERP
localEntregaStringLocal de entrega da Necessidade
localidadeEntregaStringLocalidade de entrega
codigoPostalEntregaStringCódigo postal de entrega
paisEntregaStringPaís de entrega
observacoesParaFornecedorStringObservações que foram passadas ao fornecedor
observacoesPagamentoStringObservações relativas ao pagamento
numeroOrcamentoStringNúmero de orçamento fornecido pelo fornecedor
// Exemplo
{
    "numeroNecessidadeCompra": "5287289",
    "codigoFornecedor": "AOCIG3481",
    "localEntrega": "Sede",
    "localidadeEntrega": "Leiria",
    "codigoPostalEntrega": "0000-001",
    "paisEntrega": "Portugal",
    "observacoesParaFornecedor": "",
    "observacoesPagamento": "",
    "numeroOrcamento": "98399",
}

Artigos necessidade de compra


O Procedimento serve para gerar no ERP os artigos relativos à necessidade de compra.

Nome: ws_CriarNecessidadeCompraLinhas

Campo de EntradaTipoDescrição
numeroNecessidadeCompraStringNúmero necessidade no VSOFT
codigoArtigoStringCódigo interno do artigo
quantidadeStringQuantidade encomendada do artigo
prazoEntregaStringPrazo previsto para entrega do artigo
// Exemplo
{
    "numeroNecessidadeCompra": "5287289",
    "codigoArtigo": "AOCIG3481",
    "quantidade": "64",
    "prazoEntrega": "2027-01-15",
}