Pedidos

Este artigo documenta o processo de pedidos de venda.

Listar pedidos

Lista de forma paginada os pedidos de venda

Requisição
Método GET
URL /api/v1/pedidos_venda
Formato do conteúdo application/json
Parâmetros de consulta
key Valor Obrigatório Descrição
query filial.id==1 Sim Filtro de pesquisa
page 0 Não Número da página que será retornada
size 10  Não Quantidade de registros retornados por página
sort data  Não Ordenação dos registros retornados
Exemplo de uso
/api/v1/pedidos_venda?query=filial.id==1
/api/v1/pedidos_venda?page=0&size=10&query=filial.id==1
/api/v1/pedidos_venda?page=0&size=10&sort=data&query=filial.id==1
/api/v1/pedidos_venda?page=0&size=10&query=representante.id==199;filial.id==1
Estrutura de dados da resposta
       
Propriedade Tipo Tamanho Obrigatório Descrição
id Integer - Sim Código identificador
numeroInterno Integer   Não Número interno
data Date   Sim Data do pedido no formato AAAA-MM-DD
prazoEntrega Date - Não Prazo de entrega no formato AAAA-MM-DD
dataExpedicao Date - Não Data da expedição no formato AAAA-MM-DD
numeroRepresentante Integer - Não Número do representante
representante Object - Sim Representante
representante.id Integer   Sim Código identificador
representante.nome String 40 Sim Nome do representante
representante.email String 120 Não E-mail do representante
numeroNotaFiscal Integer - Não Número da nota fiscal
cliente Object - Sim Cliente
cliente.id Integer - Sim Código identificador
cliente.razaoSocial String 60 Sim Razão social do cliente
condicaoPagamento Object   Sim Condição de pagamento 
condicaoPagamento.id Integer - Sim Código identificador
condicaoPagamento.nome String 30 Sim Descrição
situacao String 20 Sim

Situação do pedido

LIBERADO

BLOQUEADO

BLOQUEADO_COMERCIAL

DIGITACAO

BLOQUEADO_FINANCEIRO

BLOQUEADO_INTERNET

MARGEM_CONTRIBUICAO

BLOQUEADO_SALDO

CANCELADO

FATURADO

RASCUNHO

valorLiquido Double - Sim Valor do pedido

Exemplo de resposta

{
    "content": [
        {
            "id": 5804,
            "data": "2023-12-14",
            "prazoEntrega": "2023-12-14",
            "representante": {
                "id": 1,
                "nome": "RENOVADORA DE PNEUS LTDA",
                "email": "rpmpneus@smo.com.br",
                "condicoesAutorizadas": ""
            },
            "cliente": {
                "id": 31511,
                "razaoSocial": "JUNIOR ALVES DE FARIAS"
            },
            "condicaoPagamento": {
                "id": 1,
                "nome": "A Vista"
            },
            "situacao": "RASCUNHO",
            "valorLiquido": 0.0
        }
    ],
    "page": {
        "size": 10,
        "number": 0,
        "totalElements": 1,
        "totalPages": 1
    }
}

Consultar pedido

Consulta um pedido pelo id do pedido

Requisição
Método GET
URL /api/v1/pedidos_venda/{id}
Formato do conteúdo application/json
Exemplo de uso
/api/v1/pedidos_venda/123
Estrutura de dados da resposta
       
Propriedade Tipo Tamanho Obrigatório Descrição
id Integer - Sim Código identificador
numeroInterno Integer - Não Numero interno
data Date - Não Data do pedido no formato AAAA-MM-DD
prazoEntrega Date - Não Prazo de entrega no formato AAAA-MM-DD
dataExpedicao Date - Não Data da expedição no formato AAAA-MM-DD
representante Object - Sim Representante
representante.id Integer   Sim Código identificador
representante.nome String 40 Sim Nome do representante
representante.email String 120 Não E-mail do representante
tabelaPrecos Object   Não Tabela de preços
tabelaPrecos.id Integer - Sim Código identificador
tabelaPrecos.nome String 40 Sim Nome da tabela de preços
condicaoPagamento Object   Sim Condição de pagamento 
condicaoPagamento.id Integer   Sim Código identificador
condicaoPagamento.nome String 30 Sim Descrição
condicaoPagamento.parcelas Integer _ Não

Quantidade de parcelas

condicaoPagamento.descontoMaximo Double 10 Não Desconto máximo aplicável
cliente Object - Sim Cliente
cliente.id Integer - Sim Código identificador
cliente.razaoSocial String 60 Sim Razão social
cliente.cnpj String 18 Sim CNPJ para pessoa jurídica ou CPF para pessoa física
cliente.email String 120 Não Endereço de e-mail
cliente.telefone String 20 Não Telefone de contato
cliente.municipio String 40 Sim Nome do município
cliente.estado String 2 Sim UF do município
cliente.razaoSocial String 60 Sim Razão social do cliente
cliente.impostoIsento String 15 Sim Cliente é isento de impostos
IPI
ICMS
PIS_COFINS
PIS_COFINS_IPI
PIS_COFINS_ICMS
IPI_ICMS
NENHUM
transportadora
Object   Sim Transportadora 
transportadora.id
Integer - Sim Código identificador
transportadora.nome
String 60 Não Razão social da transportadora
transportadoraRedespacho
Object   Sim Transportadora redespacho (Somente Industrial)
transportadoraRedespacho.id
Integer - Sim Código identificador
transportadoraRedespacho.nome
String 60 Não Razão social da transportadora
situacao String 20 Sim

Situação do pedido

LIBERADO

BLOQUEADO

BLOQUEADO_COMERCIAL

DIGITACAO

BLOQUEADO_FINANCEIRO

BLOQUEADO_INTERNET

MARGEM_CONTRIBUICAO

BLOQUEADO_SALDO

CANCELADO

FATURADO

RASCUNHO

tipoVenda Object - Não Tipo de venda
tipoVenda.id Integer - Sim Código identificador
tipoVenda.nome String 30 Sim Nome do tipo de venda
pedidoMotivoNaoConformidade Object - Não Motivo não conformidade
pedidoMotivoNaoConformidade.id Integer - Sim Código identificador
pedidoMotivoNaoConformidade.descricao String 60 Sim Descrição do motivo
filial Object - Não Filial
filial.id Integer - Sim Código identificador
filial.nome String 50 Sim Nome da filial
freteTipo String 20 Sim

Tipo do frete

EMITENTE

DESTINATARIO

SEM_FRETE

TERCEIROS

TRASPORTE_PROPRIO

observacao String 1000 Não Observação do pedido
observacaoCondicaoPagamento String 1000 Não Observação sobre o pagamento
valorProdutos Double - Não Valor dos produtos
valorLiquido Double - Não Valor liquido dos pedidos
comissao Double - Não Comissão
comissaoValor Double - Não Valor da comissão
desconto1 Double - Não Desconto 1
desconto2 Double - Não Desconto 2
desconto3 Double - Não Desconto 3
desconto4 Double - Não Desconto 4
tipoConsumidor String 10 Sim

Tipo consumidor

CONSUMO

REVENDA

ipiBase Double - Não IPI base
ipiValor Double - Não IPI valor
stBase Double - Não Base de cálculo ST
stIcms Double - Não ICMS
adicionalVenda Double - Não Adicional na venda
percentualFreteCliente Double - Não Percentual de frete do cliente
valorFreteCliente Double - Não Valor do frete do cliente
descontoEspecial Object - Não Desconto especial
descontoEspecial.id Integer - Sim Código identificador
descontoEspecial.desconto Double - Sim Desconto
parcelas Integer - Não Número de parcelas
dataBaseParcelas Date - Não Data base das parcelas no formato AAAA-MM-DD
valorEntrada Double - Não Valor da entrada
dataEntrada Date - Não Data da entrada no formato AAAA-MM-DD
formaPagamento String 20 Sim

Forma de pagamento

DEPOSITO

BOLETO

CHEQUE

FINANCIAMENTO

CARTEIRA

ANTECIPADO

VALE

ASSISTENCIA

CONSIGNACAO

A_VISTA

CARTAO_CREDITO

FATURA

SEM_PAGAMENTO

GARANTIA

CARTAO_DEBITO

DINHEIRO

MENSAL

CARTAO_BNDS

PIX

observacaoNotaFiscal1 String 60 Não Observação nota fiscal 1
observacaoNotaFiscal2 String 60 Não Observação nota fiscal 2
observacaoNotaFiscal3 String 60 Não Observação nota fiscal 3
observacaoNotaFiscal4 String 60 Não Observação nota fiscal 4
observacaoNotaFiscal5 String 60 Não Observação nota fiscal 5
numeroRepresentante Integer - Não Número do representante
aceitaEnvioParcial String 3 Não

Aceita envio parcial

SIM

NAO

respeitaPrazoEntrega String 3 Não

Respeita prazo entrega

SIM

NAO

bndsNumero String 20 Não Número BNDS
bndsSeguranca String 3 Não Número segurança BNDS
instalacao String 3 Não

Instalação

SIM

NAO

bndsValidade Date - Não Data de validade BNDS no formato AAAA-MM-DD
bndsParcelas Integer - Não Quantidade parcelas
entradaSaida String 10 Não

Tipo de venda

ENTRADA

SAIDA

pedidoOrcamento String 10 Não

Pedido ou orçamento

PEDIDO

ORCAMENTO

pedidoEspecial String 3 Não

Pedido especial

SIM

NAO

metodoPesquisa Object   Não Método de pesquisa
metodoPesquisa.id Integer - Sim Código identificador
metodoPesquisa.descricao String 50 Sim Descrição do método
financiamentoBanco String 100 Não Financiamento banco
financiamentoGerente String 100 Não Financiamento gerente
financiamentoModalidade String 100 Não Modalidade financiamento
parcelasRepresentante Integer - Não Quantidade de parcelas
numeroNotaFiscal Integer - Não Número da nota fiscal
entregaTecnica String 3 Não

Entrega técnica

SIM

NAO

percentualAcrescimo Double - Não  
itens Array - Não Itens do pedido de venda
itens.item Integer - Sim Código identificador
itens.produto Object      
itens.produto.id Integer - Sim Código identificador
itens.produto.referencia String 20 Sim Referência do produto
itens.produto.descricao String 100 Sim Nome do produto
itens.quantidade Double - Sim Quantidade do item
itens.desconto Double - Não Valor de desconto
itens.comissao Double - Não Valor da comissão
itens.tabela Double - Não Preço de tabela
itens.unitario Double - Não Valor unitário
itens.total Double - Não Valor total
itens.ipiAliquota Double - Não Valor da alíquota
itens.ipiBase Double - Não Valor IPI base
itens.ipiValor Double - Não Valor do IPI
itens.ipiOutras Double - Não Valor de outros encargos do IPI
itens.ipiCst String 2 Não Código da situação tributártia
itens.stIndicacao String 3 Não

Indicação da ST

SIM

NAO

itens.stBase Double - Não ST Base
itens.stIcms Double - Não ST Icms
itens.stMva Double - Não ST MVA
itens.stIcmsUf Double - Não Valor ICMS do estado
itens.stRbc Double - Não Redução base cálculo ST
itens.cfop String 10 Não CFOP
itens.descritivo String 10000 Não Descritivo do item
itens.valorJuros Double - Não Valor do juros
itens.identificadorSuperior Integer - Não Indicador superior
itens.identificadorPai Integer - Não Indicador pai
itens.acessorioSuperior Integer - Não Acessório superior 
itens.classificacaoItemPrincipal Integer - Não Item principal
itens.produtoSubstituto Integer - Não Produto substituto
itens.multiplosProdutos String 3 Não

Múltiplos produtos

SIM

NAO 

itens.valorFrete Double - Não Valor do frete
itens.percentualFrete Double - Não Percentual do frete
itens.dimensoes Array - Não Dimensão do item
itens.dimensoes.altura Double - Sim Altura
itens.dimensoes.comprimento Double - Sim Comprimento
itens.dimensoes.largura Double - Sim Largura
itens.dimensoes.quantidade Double - Sim Quantidade
itens.dimensoes.tipoCorte String 20 Não Tipo de corte:

 BLOCO

 BLOCO_AO_MEIO 

 LAMINA

 PECA

itens.dimensoes.observacao String 200 Não Observação
itens.dimensoes.percentualPerda Double     Percentual perda
itens.acessorios Array - Não Lista de acessórios de um item Herda da lista de itens
itens.acessorios.subAcessorios Array - Não

Lista de sub-acessórios de um acessório.

Herda da lista de itens

itens.produtosSubstitutos Array - Não Lista de produtos substitutos de um item da ficha
itens.produtosSubstitutos.id Integer - Sim Identificador
itens.produtosSubstitutos.produtoFicha Object - Não Produto da ficha

itens.produtosSubstitutos.

produtoFicha.codigo

Integer - Sim Identificador do produto

itens.produtosSubstitutos.

produtoFicha.descricao

String 300 Sim Descricão do produto

itens.produtosSubstitutos.

produtoSubstituto

Object - Não Produto substituto

itens.produtosSubstitutos.

produtoSubstituto.codigo

Integer - Sim Identificador do produto

itens.produtosSubstitutos.

produtoSubstituto.descricao

String 300 Sim Descricão do produto

Exemplo de resposta

{
    "id": 1,
    "numeroInterno": 12,
    "data": "2022-12-01",
    "prazoEntrega": "2022-12-01",
    "dataExpedicao": "2022-12-01",
    "representante": {
        "id": 23,
        "nome": "Venda direta",
        "email": "representante@teste.com.br"
    },
    "tabelaPrecos": {
        "id": 23,
        "nome": "Tabela sul"
    },
    "condicaoPagamento": {
        "id": 23,
        "nome": "A vista",
        "parcelas": 0,
        "descontoMaximo": 5
    },
    "cliente": {
        "id": 23091,
        "razaoSocial": "TESTE FORM 1",
        "cnpj": "77.777.777/7777-77",
        "email": "teste@teste.com",
        "telefone": "+55 (49) 36640-000",
        "municipio": "CUNHA PORA",
        "estado": "SC",
        "impostoIsento": "IPI"
    },
      "transportadora": {
        "id": 1366,
        "nome": "GAT TRANSPORTES EIRELI - ME"
    },
    "transportadoraRedespacho": {
        "id": 1366,
        "nome": "GAT TRANSPORTES EIRELI - ME"
    },
    "situacao": "LIBERADO",
    "tipoVenda": {
        "id": 23,
        "nome": "a vista"
    },
    "pedidoMotivoNaoConformidade": {
        "id": 23,
        "nome": "Quebrado"
    },
    "filial": {
        "id": 1,
        "nome": "Filial 1"
    },
    "freteTipo": "DESTINATARIO",
    "observacao": "teste",
    "observacaoCondicaoPagamento": "nada",
    "valorProdutos": 45.56,
    "valorLiquido": 45.86,
    "comissao": 12.56,
    "comissaoValor": 55.99,
    "desconto1": 56.99,
    "desconto2": 89.66,
    "desconto3": 45.88,
    "desconto4": 99.55,
    "tipoConsumidor": "CONSUMO",
    "ipiBase": 45.89,
    "ipiValor": 89.99,
    "stBase": 12,
    "stIcms": 32.99,
    "adicionalVenda": 59.88,
    "percentualFreteCliente": 12,
    "valorFreteCliente": 2,
    "descontoEspecial": {
        "id": 23,
        "desconto": 98.98
    },
    "parcelas": 8,
    "dataBaseParcelas": "2022-12-01",
    "valorEntrada": 1000.66,
    "dataEntrada": "2022-12-01",
    "formaPagamento": "DEPOSITO",
    "observacaoNotaFiscal1": "",
    "observacaoNotaFiscal2": "",
    "observacaoNotaFiscal3": "",
    "observacaoNotaFiscal4": "",
    "observacaoNotaFiscal5": "",
    "numeroRepresentante": 23,
    "aceitaEnvioParcial": "NAO",
    "respeitaPrazoEntrega": "NAO",
    "bndsNumero": "",
    "bndsSeguranca": "",
    "instalacao": "SIM",
    "bndsValidade": "2022-12-01",
    "bndsParcelas": 0,
    "entradaSaida": "ENTRADA",
    "pedidoOrcamento": "PEDIDO",
    "pedidoEspecial": "SIM",
    "metodoPesquisa": {
        "id": 23,
        "descricao": "feira"
    },
    "financiamentoBanco": "",
    "financiamentoGerente": "",
    "financiamentoModalidade": "",
    "parcelasRepresentante": 0,
    "numeroNotaFiscal": 456987,
    "entregaTecnica": "NAO",
    "percentualAcrescimo": 10,
    "itens": [
        {
            "item": 23,
            "produto": {
                "id": 78,
                "referencia": "78",
                "descricao": "banana"
            },
            "quantidade": 56,
            "desconto": 56.99,
            "comissao": 89.88,
            "tabela": 89.99,
            "unitario": 88.88,
            "total": 69.99,
            "ipiAliquota": 56.77,
            "ipiBase": 56.77,
            "ipiValor": 78.44,
            "ipiOutras": 89,
            "ipiCst": "50",
            "stIndicacao": "SIM",
            "stBase": 78.32,
            "stIcms": 89.78,
            "stMva": 10,
            "stIcmsUf": 32.99,
            "stRbc": 10,
            "cfop": "jhdsgbhsdb",
            "descritivo": "",
            "valorJuros": 89.98,
            "identificadorSuperior": 2,
            "identificadorPai": 1,
            "acessorioSuperior": 3,
            "classificacaoItemPrincipal": 1,
            "produtoSubstituto": 23,
            "multiplosProdutos": "NAO",
            "valorFrete": 23.65,
            "percentualFrete": 78.22,
            "dimensoes": [
                {
                    "altura": 0.0,
                    "comprimento": 0.0,
                    "largura": 0.0,
                    "quantidade": 0.0,
                    "tipoCorte": "BLOCO",
                    "observacao": "observacao de teste teste",
                    "percentualPerda": 5.5
                }
            ]
            "acessorios": [
                {
                    "subAcessorios": []
                }
            ],
            "produtosSubstitutos": [
                {
                    "id": 47,
                    "produtoFicha": {
                        "codigo": 3,
                        "descricao": "PRODUTO DA FICHA 1"
                    },
                    "produtoSubstituto": {
                        "codigo": 4693,
                        "descricao": "PRODUTO EXEMPLO SUBSTITUTO 1"
                    }
                }
            ]
        }
    ]
}

Inserir pedido

Insere um pedido novo na base de dados.

Requisição  
Método POST
URL /api/v1/pedidos_venda

Formato do conteúdo

application/json
Estrutura de dados da requisição
       
Propriedade Tipo Tamanho Obrigatório Descrição
prazoEntrega Date - Não Prazo de entrega no formato AAAA-MM-DD
representante Object - Sim Representante
representante.id Integer   Sim Código identificador
tabelaPrecos Object   Sim Tabela de preços
tabelaPrecos.id Integer - Sim Código identificador
condicaoPagamento Object   Sim Condição de pagamento 
condicaoPagamento.id Integer   Sim Código identificador
cliente Object - Sim Cliente
cliente.id Integer - Sim Código identificador
transportadora Object   Sim Transportadora
transportadora.id Integer - Sim Código identificador
transportadoraRedespacho Object   Sim

Transportadora redespacho

(Somente Industrial)

transportadoraRedespacho.id Integer - Sim Código identificador
tipoVenda Object - Sim Tipo de venda
tipoVenda.id Integer - Sim Código identificador
filial Object - Sim Filial
filial.id Integer - Sim Código identificador
freteTipo String 20 Sim

Tipo do frete

EMITENTE

DESTINATARIO

SEM_FRETE

TERCEIROS

TRASPORTE_PROPRIO

observacao String 1000 Não Observação do pedido
percentualFreteCliente Double - Não Percentual de frete do cliente
valorFreteCliente Double - Não Valor do frete do cliente
valorJuros Double - Não Valor do juros no pedido
formaPagamento String 20 Sim

Forma de pagamento

DEPOSITO

BOLETO

CHEQUE

FINANCIAMENTO

CARTEIRA

ANTECIPADO

VALE

ASSISTENCIA

CONSIGNACAO

A_VISTA

CARTAO_CREDITO

FATURA

SEM_PAGAMENTO

GARANTIA

CARTAO_DEBITO

DINHEIRO

MENSAL

CARTAO_BNDS

PIX

observacaoNotaFiscal1 String 60 Não Observação nota fiscal 1
observacaoNotaFiscal2 String 60 Não Observação nota fiscal 2
observacaoNotaFiscal3 String 60 Não Observação nota fiscal 3
observacaoNotaFiscal4 String 60 Não Observação nota fiscal 4
observacaoNotaFiscal5 String 60 Não Observação nota fiscal 5
numeroRepresentante Integer - Não Número do representante
pedidoOrcamento String 10 Sim

Pedido ou orçamento

PEDIDO

ORCAMENTO

tipoConsumidor String 7 Sim

Tipo consumidor

CONSUMO

REVENDA

metodoPesquisa Object   Não Método de pesquisa
metodoPesquisa.id Integer - Sim Código identificador
usuarioId Integer - Não Id do usuário
itens Array - Não Itens do pedido de venda
itens.item Integer - Sim Número do item
itens.produto Object - Sim Produto
itens.produto.id Integer - Sim Identificador do produto
itens.quantidade Double - Sim Quantidade do item
itens.desconto Double - Não Valor de desconto
itens.comissao Double - Não Valor da comissão
itens.tabela Double - Não Tabela
itens.unitario Double - Não Valor unitário
itens.total Double - Não Valor total
itens.ipiAliquota Double - Não Valor da alíquota
itens.ipiBase Double - Não Valor IPI base
itens.ipiValor Double - Não Valor do IPI
itens.valorFrete Double - Não Valor do frete
itens.stIcms Double - Não Icms ST
itens.percentualFrete Double - Não Percentual do frete
itens.cfop String 10 Não CFOP

itens.descritivo

 

String 10000 Não

Descritivo do item

 

itens.ipiCst String 2 Não Código da situação tributártia
itens.stIndicacao String 3 Não

Indicação da ST

SIM

NAO

itens.stIcmsUf Double - Não Valor ICMS do estado
itens.stMva Double - Não ST MVA
itens.stRbc Double - Não Redução base cálculo ST
itens.dimensoes Array - Não Dimensão do item
itens.dimensoes.altura Double - Sim Altura
itens.dimensoes.comprimento Double - Sim Comprimento
itens.dimensoes.largura Double - Sim Largura
itens.dimensoes.quantidade Double - Sim Quantidade
itens.dimensoes.tipoCorte String 20 Não

Tipo de corte:

 BLOCO

 BLOCO_AO_MEIO  

 LAMINA

 PECA

itens.dimensoes.observacao String 200 Não Observação
itens.dimensoes.percentualPerda Double - Não Percentual perda
itens.acessorios Array - Não Lista de acessórios de um item Herda da lista de itens
itens.acessorios.subAcessorios Array - Não

Lista de sub-acessórios de um acessório.

Herda da lista de itens

itens.produtosSubstitutos Array - Não Lista de produtos substitutos de um item da ficha
itens.produtosSubstitutos.produtoFicha Object - Não Produto da ficha

itens.produtosSubstitutos.

produtoFicha.codigo

Integer - Sim Identificador do produto

itens.produtosSubstitutos.

produtoSubstituto

Object - Não Produto substituto

itens.produtosSubstitutos.

produtoSubstituto.codigo

Integer - Sim Identificador do produto

itens.produtosSubstitutos.usuarioId

Integer - Sim Id do usuário logado

Exemplo de conteúdo da requisição

{
    "prazoEntrega": "2022-12-01",
    "representante": {
        "id": 23
    },
    "tabelaPrecos": {
        "id": 23
    },
    "condicaoPagamento": {
        "id": 23
    },
    "cliente": {
        "id": 23
    },
    "transportadora": { 
        "id": 5499
    }, 
    "transportadoraRedespacho": { 
        "id": 2513
    }
    "tipoVenda": {
        "id": 23
    },
    "filial": {
        "id": 1
    },
    "freteTipo": "DESTINATARIO",
    "observacao": "teste",
    "percentualFreteCliente": 12,
    "valorFreteCliente": 2,
    "valorJuros": 43.55,
    "formaPagamento": "DEPOSITO",
    "observacaoNotaFiscal1": "",
    "observacaoNotaFiscal2": "",
    "observacaoNotaFiscal3": "",
    "observacaoNotaFiscal4": "",
    "observacaoNotaFiscal5": "",
    "numeroRepresentante": 23,
    "pedidoOrcamento": "PEDIDO",
    "tipoConsumidor": "CONSUMO",
    "metodoPesquisa": {
        "id": 23
    },
    "usuarioId": 1,
    "itens": [
        {
            "item": 1,
            "produto": {
                "id": 78
            },
            "quantidade": 56,
            "desconto": 56.99,
            "comissao": 89.88,
            "tabela": 89.99,
            "unitario": 88.88,
            "total": 69.99,
            "ipiAliquota": 56.77,
            "ipiBase": 56.77,
            "ipiValor": 78.44,
            "valorFrete": 23.65,
            "stIcms": 89.78,
            "percentualFrete": 78.22,
            "cfop": "5.101.01",
            "descritivo": "Um texto qualquer..."
            "ipiCst": "50",
            "stIndicacao": "SIM",
            "stIcmsUf": 0,
            "stMva": 0,
            "stRbc": 0,
            "dimensoes": [
              {
                "altura": 0.0,
                "comprimento": 0.0,
                "largura": 0.0,
                "quantidade": 0.0,
                "tipoCorte": "BLOCO",
                "observacao":"observacao de teste teste",
                "percentualPerda": 5.5
              }
            ]
            "acessorios": [
                {
                    "subAcessorios": []
                }
            ],
            "produtosSubstitutos": [
                {
                    "produtoFicha": {
                        "codigo": 3
                    },
                    "produtoSubstituto": {
                        "codigo": 4693
                    },
                    "usuarioId": 2
                }
            ]
        }
    ]
}

Resposta

A API retornará o código do novo pedido cadastrado.

Estrutura de dados do resposta
       
Propriedade Tipo Tamanho Obrigatório Descrição
id Integer - Sim Código identificador do pedido

Exemplo de resposta

{
  "id": 123456
}

Editar pedido

Atualiza um pedido na base de dados.

Requisição  
Método PUT
URL /api/v1/pedidos_venda/{id}
Formato do conteúdo application/json
Parâmetro de URL  
id Código identificador do pedido
Exemplo de uso
/api/v1/pedidos_venda/123456
Estrutura de dados da requisição
       
Propriedade Tipo Tamanho Obrigatório Descrição
prazoEntrega Date - Não Prazo de entrega no formato AAAA-MM-DD
representante Object - Sim Representante
representante.id Integer   Sim Código identificador
tabelaPrecos Object   Sim Tabela de preços
tabelaPrecos.id Integer - Sim Código identificador
condicaoPagamento Object   Sim Condição de pagamento 
condicaoPagamento.id Integer   Sim Código identificador
cliente Object - Sim Cliente
cliente.id Integer - Sim Código identificador
transportadora Object   Sim Transportadora
transportadora.id Integer - Sim Código identificador
transportadoraRedespacho Object   Sim

Transportadora redespacho

(Somente Industrial)

transportadoraRedespacho.id Integer - Sim Código identificador
tipoVenda Object - Não Tipo de venda
tipoVenda.id Integer - Sim Código identificador
filial Object - Não Filial
filial.id Integer - Sim Código identificador
freteTipo String 20 Sim

Tipo do frete

EMITENTE

DESTINATARIO

SEM_FRETE

TERCEIROS

TRASPORTE_PROPRIO

observacao String 1000 Não Observação do pedido
percentualFreteCliente Double - Não Percentual de frete do cliente
valorFreteCliente Double - Não Valor do frete do cliente
valorJuros Double - Não Valor do juros no pedido
formaPagamento String 20 Sim

Forma de pagamento

DEPOSITO

BOLETO

CHEQUE

FINANCIAMENTO

CARTEIRA

ANTECIPADO

VALE

ASSISTENCIA

CONSIGNACAO

A_VISTA

CARTAO_CREDITO

FATURA

SEM_PAGAMENTO

GARANTIA

CARTAO_DEBITO

DINHEIRO

MENSAL

CARTAO_BNDS

PIX

observacaoNotaFiscal1 String 60 Não Observação nota fiscal 1
observacaoNotaFiscal2 String 60 Não Observação nota fiscal 2
observacaoNotaFiscal3 String 60 Não Observação nota fiscal 3
observacaoNotaFiscal4 String 60 Não Observação nota fiscal 4
observacaoNotaFiscal5 String 60 Não Observação nota fiscal 5
numeroRepresentante Integer - Não Número do representante
pedidoOrcamento String 10 Sim

Pedido ou orçamento

PEDIDO

ORCAMENTO

tipoConsumidor String 7 Sim

Tipo consumidor

CONSUMO

REVENDA

metodoPesquisa Object   Não Método de pesquisa
metodoPesquisa.id Integer - Sim Código identificador
situacao String 20 Sim

Situação do pedido

LIBERADO

BLOQUEADO

BLOQUEADO_COMERCIAL

DIGITACAO

BLOQUEADO_FINANCEIRO

BLOQUEADO_INTERNET

MARGEM_CONTRIBUICAO

BLOQUEADO_SALDO

CANCELADO

FATURADO

RASCUNHO

usuarioId Integer - Não Id do usuário
itens Array - Não Itens do pedido de venda
itens.item Integer - Sim Número do item
itens.produto Object - Sim Produto
itens.produto.id Integer - Sim Identificador do produto
itens.quantidade Double - Sim Quantidade do item
itens.desconto Double - Não Valor de desconto
itens.comissao Double - Não Valor da comissão
itens.tabela Double - Não Tabela
itens.unitario Double - Não Valor unitário
itens.total Double - Não Valor total
itens.ipiAliquota Double - Não Valor da alíquota
itens.ipiBase Double - Não Valor IPI base
itens.ipiValor Double - Não Valor do IPI
itens.valorFrete Double - Não Valor do frete
itens.stIcms Double - Não Icms ST
itens.percentualFrete Double - Não Percentual do frete
itens.cfop String 10 Não CFOP
itens.descritivo String 10000 Não Descritivo do item
itens.ipiCst String 2 Não Código da situação tributártia
itens.stIndicacao String 3 Não

Indicação da ST

SIM

NAO

itens.stIcmsUf Double - Não Valor ICMS do estado
itens.stMva Double - Não ST MVA
itens.stRbc Double - Não Redução base cálculo ST
itens.dimensoes Array - Não Dimensão do item
itens.dimensoes.altura Double - Sim Altura
itens.dimensoes.comprimento Double - Sim Comprimento
itens.dimensoes.largura Double - Sim Largura
itens.dimensoes.quantidade Double - Sim Quantidade
itens.dimensoes.tipoCorte String 20 Não

Tipo de corte:

 BLOCO

 BLOCO_AO_MEIO

 LAMINA

 PECA

itens.dimensoes.observacao String 200 Não Observação
itens.dimensoes.percentualPerda

Double

- Não Percentual Perda
itens.acessorios Array - Não Lista de acessórios de um item Herda da lista de itens
itens.acessorios.subAcessorios Array - Não

Lista de sub-acessórios de um acessório.

Herda da lista de itens

itens.produtosSubstitutos Array - Não Lista de produtos substitutos de um item da ficha
itens.produtosSubstitutos.produtoFicha Object - Não Produto da ficha

itens.produtosSubstitutos.

produtoFicha.codigo

Integer - Sim Identificador do produto

itens.produtosSubstitutos.

produtoSubstituto

Object - Não Produto substituto

itens.produtosSubstitutos.

produtoSubstituto.codigo

Integer - Sim Identificador do produto

itens.produtosSubstitutos.usuarioId

Integer - Sim Id do usuário logado

Exemplo de conteúdo da requisição

{
    "prazoEntrega": "2022-12-01",
    "representante": {
        "id": 23
    },
    "tabelaPrecos": {
        "id": 23
    },
    "condicaoPagamento": {
        "id": 23
    },
    "cliente": {
        "id": 23
    },
    "transportadora": { 
        "id": 5499 
    }, 
    "transportadoraRedespacho": { 
        "id": 2513 
    }
    "tipoVenda": {
        "id": 23
    },
    "filial": {
        "id": 1
    },
    "freteTipo": "DESTINATARIO",
    "observacao": "teste",
    "percentualFreteCliente": 12,
    "valorFreteCliente": 2,
    "valorJuros": 43.55,
    "formaPagamento": "DEPOSITO",
    "observacaoNotaFiscal1": "",
    "observacaoNotaFiscal2": "",
    "observacaoNotaFiscal3": "",
    "observacaoNotaFiscal4": "",
    "observacaoNotaFiscal5": "",
    "numeroRepresentante": 23,
    "pedidoOrcamento": "PEDIDO",
    "tipoConsumidor": "CONSUMO",
    "metodoPesquisa": {
        "id": 23
    },
    "situacao": "LIBERADO",
    "usuarioId": 1,
    "itens": [
        {
            "item": 1,
            "produto": {
                "id": 78
            },
            "quantidade": 56,
            "desconto": 56.99,
            "comissao": 89.88,
            "tabela": 89.99,
            "unitario": 88.88,
            "total": 69.99,
            "ipiAliquota": 56.77,
            "ipiBase": 56.77,
            "ipiValor": 78.44,
            "valorFrete": 23.65,
            "stIcms": 89.78,
            "percentualFrete": 78.22,
            "cfop": "5.101.01",
            "descritivo": "Um texto qualquer....",
            "ipiCst": "50",
            "stIndicacao": "SIM",
            "stIcmsUf": 0,
            "stMva": 0,
            "stRbc": 0,
            "dimensoes": [
                {
                    "altura": 2.0,
                    "comprimento": 2.0,
                    "largura": 1.0,
                    "quantidade": 5.0,
                    "tipoCorte": "BLOCO",
                    "observacao": "ALTERADPOOO",
                    "percentualPerda": 2.5
                }
            ]
            "acessorios": [
                {
                    "subAcessorios": []
                }
            ],
            "produtosSubstitutos": [
                {
                    "produtoFicha": {
                        "codigo": 3
                    },
                    "produtoSubstituto": {
                        "codigo": 4693
                    },
                    "usuarioId": 2
                }
            ]
        }
    ]
}

Deletar pedido

Excluir um pedido de venda

Requisição  
Método DELETE
URL /api/v1/pedidos_venda/{id}
Parâmetro de URL  
id Código identificador do pedido
Exemplo de uso
/api/v1/pedidos_venda/123456

Consultar tabela de preço

Consulta a tabela de preço filtrando por representante e município ou representante e estado

Requisição  
Método GET
URL /api/v1/pedidos_venda/{representante}/{municipio}/{estado}/tabela_preco
Parâmetro de URL Tipo Tamanho  Descrição Exemplo
representante Integer - Código do representante 199
municipio Integer - Código do município 420470
estado String 2 Sigla do estado SC
Exemplo de uso  
/api/v1/pedidos_venda/199/420470/SC/tabela_preco  
Estrutura de dados da resposta
       
Propriedade Tipo Tamanho Obrigatório Descrição
id Integer - Não Código da tabela de preço

Exemplo de resposta

{
  "id": 94
}

Consultar impresso do pedido

Consultar impresso do pedido pelo id do pedido

Requisição
Método GET
URL /api/v1/pedidos_venda/{id}/imprimir
Formato do conteúdo application/json
Exemplo de uso
/api/v1/pedidos_venda/2666/imprimir
Estrutura de dados da resposta
       
Propriedade Tipo Tamanho Obrigatório Descrição
impresso_pedido_venda.pdf
PDF - Não O Jasper irá transmitir o PDF diretamente para o navegador ou celular

Consultar último preço praticado do cliente e produto

Consulta o último preço praticado filtrando por cliente e produto

Requisição  
Método GET
URL /api/v1/pedidos_venda/clientes/{clienteId}/produtos/{produtoId}/ultimo_preco
Exemplo de uso  
/api/v1/pedidos_venda/clientes/123/produtos/100/ultimo_preco  
Estrutura de dados da resposta
       
Propriedade Tipo Tamanho Obrigatório Descrição
id Integer - Sim Identificador do pedido
numeroInterno Integer - Sim Número interno
data Data - Sim

Data do pedido no formato

AAAA-MM-DD

dataExpedicao Data - Sim

Data de expedição no formato

AAAA-MM-DD

unitario Double - Sim Valor do último preço praticado

Exemplo de resposta

{
    "id": 5916,
    "numeroInterno": 40720,
    "data": "2022-03-11",
    "dataExpedicao": "2022-04-05",
    "unitario": 287.831525
}

Enviar Mensagem

Enviar uma mensagem via e-mail e/ou WhatsApp do pedido

Requisição  
Método POST
URL /api/v1/pedidos_venda/{id}/enviar
Formato do conteúdo application/json
Parâmetro de URL  
id Código identificador do pedido
Exemplo de uso
/api/v1/pedidos_venda/123456/enviar
Estrutura de dados da requisição
       
Propriedade Tipo Tamanho Obrigatório Descrição
recipient String 50 Não Destinatário
title String 50 Não Título da mensagem
whatsApp String 13 Não Número do WhatsApp
body String 200 Não Texto da mensagem
Exemplo de conteúdo da requisição
{
    "recipient": "destinatario@microsys.inf.br",
    "title": "Pedido de venda",
    "whatsApp": "5549988382422",
    "body": "Pedido de venda. Pedido número 999 de Microsys Sistemas"
}
Back to top