A API disponibiliza os seguintes campos :
| Atributo | Tipo | Descrição |
|---|---|---|
| codigoPedido | texto | Nome do pedido |
| idExterno | texto | Identificador único do pedido no sistema que está integrando com o Nomus ERP |
| idTipoPedido | número | (Opcional) Id do tipo de pedido no Nomus ERP |
| idEmpresa | número | Id da empresa no Nomus ERP |
| idPessoaCliente | número | Id do cliente no Nomus ERP |
| idPessoaRepresentante | número | (Opcional) Id do representante no Nomus ERP |
| idPessoaVendedor | número | (Opcional) Id do vendendor no Nomus ERP |
| idSetorSaida | número | (Opcional) Id do setor de saída no Nomus ERP |
| idTabelaPreco | número | (Opcional) Id da tabela de preço no Nomus ERP |
| dataEmissao | data (dd/mm/aaaa ou dd/mm/aaaa hh:mm) | Data de emissão do pedido |
| dataEntregaPadrao | data (dd/mm/aaaa ou dd/mm/aaaa hh:mm) | (Opcional) Data de entrega padrão do pedido |
| idContato | número | (Opcional) Id do contato no Nomus ERP |
| condicaoPagamentoTexto | texto | (Opcional) Condição de pagamento no formato texto |
| pedidoCompraCliente | texto | (Opcional) Pedido de compra do cliente no formato texto |
| observacoes | texto | (Opcional) Observação do pedido de venda |
| modalidadeTransporte | número | (Opcional) 0) Contratação do Frete por conta do Remetente (CIF) 1) Contratação do Frete por conta do Destinatário (FOB) 2) Contratação do Frete por conta de Terceiros 3) Transporte Próprio por conta do Remetente 4) Transporte Próprio por conta do Destinatário 9) Sem Ocorrência de Transporte |
| IdPessoaTransportadora | número | (Opcional) Id da transportadora no Nomus ERP |
| valorTotalFrete | número | (Opcional) Valor total do frete no formato |
| valorTotalSeguro | número | (Opcional) Valor total do seguro do pedido |
| valorTotalOutrasDespesasAcesso | número | (Opcional) Valor total de outras despesas acessórias |
| idCondicaoPagamento | número | (Opcional) Id da condição de pagamento no Nomus ERP |
| idFormaPagamento | número | (Opcional) Id da forma de pagamento no Nomus ERP |
| infAdFisco | texto | (Opcional) Informações adicionais de interesse do fisco |
| infCpl | texto | Informações adicionais de interesse do contribuinte |
| itensPedido | array | Ver abaixo |
| parcelas | array | Ver abaixo |
| nfes | array | Ver abaixo |
Itens de pedido
| Atributo | Tipo | Descrição |
|---|---|---|
| item | texto | Nome do item de pedido |
| idExterno | texto | Identificador único do item no sistema que está integrando com o Nomus ERP |
| idProduto | número | Id do produto no Nomus ERP |
| quantidade | número | Quantidade do item |
| valorUnitario | número | Valor de cada unidade do item |
| idUnidadeMedida | número | (Opcional) Id da unidade de medida no Nomus ERP |
| idSetorSaida | número | (Opcional) Id do setor de saída no Nomus ERP |
| idTabelaPreco | número | (Opcional) Id da tabela de preço no Nomus ERP |
| idTipoMovimentacao | número | (Opcional) Id do tipo de movimentação no Nomus ERP |
| percentualAcrescimo | número | (Opcional) Percentual de acréscimo (este atributo não deve ser utilizado junto com o valorAcrescimo) |
| valorAcrescimo | número | (Opcional) Valor do acréscimo (este atributo não deve ser utilizado junto com o percentualAcrescimo) |
| percentualDesconto | número | (Opcional) Percentual de desconto (este atributo não deve ser utilizado junto com o valorDesconto) |
| valorDesconto | número | (Opcional) Valor do desconto (este atributo não deve ser utilizado junto com o percentualDesconto) |
| dataEntrega | data (dd/mm/aaaa ou dd/mm/aaaa hh:mm) | Data de entrega do item |
| observacoes | texto | (Opcional) Observações do item |
| status | número | (Opcional) 1 - Aguardando liberação 2 - Liberado 3 - Atendido parcialmente 4 - Atendido totalmente 5 - Atendido com corte 6 - Cancelado 7 - Devolvido parcialmente 8 - Devolvido totalmente |
Parcelas
| Atributo | Tipo | Descrição |
|---|---|---|
| dataVencimento | data (dd/mm/aaaa) | Data de vencimento da parcela |
| valorParcela | número | Valor da parcela |
| idFormaPagamento | número | (Opcional) Id da forma de pagamento no Nomus ERP |
| idContaBancaria | número | (Opcional) Id da conta bancária no Nomus ERP |
| geraAdiantamento | boolean | (Opcional) True se gera adiantamento ou false caso contrário |
NFes
| Atributo | Tipo | Descrição |
|---|---|---|
| ambiente | número | 1 - Produção 2 - Homologação |
| chave | número | Chave de acesso de 44 dígitos. Utilizada para acessar a nota na SEFAZ |
| cnpjEmitente | número | CNPJ do emissor da NFe |
| dataProcessamento | data (dd/mm/aaaa) | Data de processamento da NFe |
| finalidade | número | 1 - Normal 2 - Complementar 3 - Ajuste 4 - Devolução de mercadoria |
| horaProcessamento | hora (hh:mm:ss) | Hora de processamento da NFe |
| id | número | Id da NFe |
| isFornecedor | número | 1 - a nota é proveninente de algum fornecedor e foi importada para o ERP 0 - a nota foi emitida pela empresa no ERP |
| numero | número | Número da NFe |
| protocolo | número | Protocolo da NFe |
| recibo | número | Recibo da NFe |
| serie | número | Número de serie da NFe |
| status | número | 1 - Dados inconsistentes 3 - Aguardando autorização 4 - Autorizada 5 - Denegada 6 - Rejeitada 7 - Cancelada 8 - Inutilizada |
| tipoEmissao | número | 1 - Normal 2 - FS-IA 3 - SCAN 4 - DPEC 5 - EPEC 6 - SVC-AN 7 - SVC-RS 9 - Offline da NFC-e |
| tipoOperacao | número | 0 - Entrada 1 - Saída |
| usuario | texto | Usuário do ERP que emitiu a NFe |
Serviços disponíveis
Inserir um pedido de venda
Insere um pedido de venda no Nomus ERP, usando os campos descritos acima. Existe uma configuração geral "Força a codifição de pedidos integrados com as regras do Nomus ERP" caso o cliente queira sobrescrever o nome dado ao pedido com as regras de nomeclatura do Nomus ERP. Neste caso o campo codigoPedido passar a ser opcional.
POST - /rest/pedidos
Retorno:
{id: id_criado_do_pedido, codigoPedido: nome_dado_ao_pedido}Exemplo:
Uma requisição POST com o corpo:
{
"codigoPedido": "teste",
"idExterno":1,
"idEmpresa":2,
"idPessoaCliente":39,
"dataEmissao":"01/01/2019",
itensPedido: [
{"item":"item1",
"idExterno":"123",
"idProduto":77,
"quantidade":1,
"valorUnitario":"1,65",
"dataEntrega":"10/01/2019"
},
{"item":"item2",
"idExterno":"124",
"idProduto":79,
"quantidade":4,
"valorUnitario":"2,99",
"dataEntrega":"12/01/2019"
}
]
}Retornaria:
{"id": 55, "codigoPedido": "teste"}Consultar um pedido de venda
Retorna as informações de um pedido de venda cm o id passado por parâmetro
GET - /rest/pedidos/{id_do_pedido_de_venda}Retorno:
{
"codigoPedido": "PD 000309",
"condicaoPagamentoTexto": "",
"dataEmissao": "01/07/2021",
"dataEntregaPadrao": "12/11/2020",
"idCondicaoPagamento": 1,
"idEmpresa": 1,
"idPessoaCliente": 104,
"idPessoaRepresentante": 7,
"idPessoaTransportadora": 3,
"idPessoaVendedor": 22,
"idTabelaPreco": 24,
"idTipoMovimentacao": 11,
"idTipoPedido": 1,
"infAdFisco": "Teste",
"infCpl": "Teste",
"itensPedido": [
{
"idProduto": 12,
"idSetorSaida": 4,
"idTipoMovimentacao": 11,
"idUnidadeMedida": 4,
"item": "3",
"observacoes": "",
"percentualAcrescimo": "0",
"percentualDesconto": "0",
"quantidade": "100",
"status": 4,
"valorAcrescimo": "0",
"valorUnitario": "1"
}
],
"modalidadeTransporte": 0,
"nfes": [
{
"ambiente": 2,
"chave": "33210706167864000189550100000100161000009863",
"cnpjEmitente": "06167864000189",
"dataProcessamento": "01/07/2021",
"finalidade": 1,
"horaProcessamento": "12:04:14",
"id": 263,
"isFornecedor": 0,
"numero": "10016",
"protocolo": "333210000253974",
"recibo": "333002195986926",
"serie": "10",
"status": 7,
"tipoEmissao": 1,
"tipoOperacao": 1,
"usuario": "Jhonatan Cunha"
}
],
"observacoes": "Teste",
"parcelas": [
{
"dataVencimento": "18/03/2022",
"geraAdiantamento": false,
"valorParcela": "81"
}
],
"valorTotalFrete": "10.00",
"valorTotalOutrasDespesasAcessorias": "10.00",
"valorTotalSeguro": "10.00"
}Consultar todos os pedidos
Este serviço lista todos os pedidos de venda. O resultado é listado de forma paginada, retornando no máximo 50 registros. Se nenhuma página for passada será retornado os 50 registros mais recentes. Para listar todos os resultados é necessário passar o número da página. Exemplo:
