---
title: "Incluir Pedido de Venda"
method: POST
path: "/v1/vendas/pedidos"
tags: ["Vendas Pedidos"]
---

# Incluir Pedido de Venda

`POST /v1/vendas/pedidos`

Inclui um Pedido de Venda no Sankhya Om, SEMPRE A CONFIRMAR. Os financeiros que serão enviados não serão registrados como baixados, e sim pendentes. Obs.: a API não preve configurações de parceiro, alíquotas de impostos, etc, os mesmos já devem estar previamente configurados. Os totalizadores do cabeçalho do pedido não precisam ser enviados, pois o próprio SANKHYA Om, com base nos impostos informados nos itens já realiza os calculos dos totalizadores automaticamente. 
- Versão mínima requirida do Sankhya Om para utilizar essa API: 4.34

## Request body

- MovimentoPedido — Os atributos apresentados aqui estão vinculados ao cabeçalho da nota, mapeados pela entidade "CabecalhoNota". Além disso, é possível utilizar campos que, embora não estejam detalhados nesta documentação, fazem parte do dicionário de dados, como por exemplo "CODNAT" que é o "código da natureza".
  - `notaModelo` integer, required — Este atributo é utilizado para preparar a inclusão do movimento no SankhyaOm, permitindo que o serviço obtenha informações essenciais, como empresa, tipo de operação, natureza, entre outros. É importante destacar que é possível enviar parâmetros que sobrescrevem os valores definidos no modelo da nota, como, por exemplo, o campo CODEMP (código da empresa). Para saber mais como configurar um Modelo de Nota, [clique aqui](https://ajuda.sankhya.com.br/hc/pt-br/articles/360051706514-Modelo-de-Notas-e-Pedidos)
  - `ad_campo_adicional` string — Pode ser adicionado qualquer campo adicional, não precisa estar dentro de um objeto como no EndPoint de Clientes
  - `data` string, required — Data da emissão do documento
  - `hora` string, required — Data da emissão do documento
  - `codigoVendedor` integer — Para registrar com precisão as vendas, insira o código do vendedor responsável pela negociação. Esse código é facilmente acessível através da nossa API, na entidade "Vendedor" (CODVEND). Obtenha essa informação e mantenha seus registros sempre atualizados. Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
  - `codigoCliente` integer — Campo opcional que possibilita inserir o código do cliente. Quando informado o mesmo passa ser mandatório pra informar o parceiro no pedido de venda e não é necessário enviar a tag cliente na requisição. Esse código é facilmente retornado pelo serviço: GET /v1/parceiros/clientes
  - `cliente` Cliente — Esta tag é opcional e funciona da seguinte forma: - Enviar sem a tag cliente e sem o campo codigoCliente na nota. O serviço assume o CODPARC contido na nota modelo utilizada para vincular ao documento. - Enviar na tag cliente, apenas o cnpjCpf. O serviço vai tentar encontrar o cliente com base nesse número. Se o serviço não conseguir localizar o cliente, ele vai salvar o CPF ou CNPJ no cabeçalho do documento (TGFCAB) em um campo específico para essa informação. - Enviar tag cliente completa. O serviço exigirá que todos os campos sejam preenchidos para poder incluir ou atualizar as informações do parceiro. Os atributos apresentados aqui estão vinculados ao cliente, mapeados pela entidade "Parceiro". Para personalizar a integração, é possível enviar os atributos dessa entidade, como "CGCCPF" em vez de "cnpjCpf". Além disso, é possível utilizar campos que, embora não estejam detalhados nesta documentação, fazem parte do dicionário de dados.
    - `atualizar` boolean, required — Ao configurar como "true", este parâmetro atualizará os dados cadastrais do parceiro, caso ele já exista no SankhyaOm. Se configurado como "false", a API não realizará atualizações cadastrais. Independentemente da configuração, se o parceiro não for encontrado pelo CPF ou CNPJ informado, ele será automaticamente incluído no SankhyaOm com o tipo "cliente" habilitado.
    - `tipo` 'PF' | 'PJ', required — Tipo da pessoa que pode ser Física ou Jurídica
    - `cnpjCpf` string, required — Documento CNPJ ou CPF, de acordo com o tipo do cliente
    - `ieRg` string, required — Documento Inscrição Estadual ou RG, de acordo com o tipo do cliente
    - `nome` string, required — Nome da pessoa física ou nome fantasia para pessoa juridica
    - `razao` string, required — Nome social para pessoa jurídica
    - `email` string, required
    - `telefoneDdd` string, required
    - `telefoneNumero` string, required
    - `endereco` PedidoDeVendasendereco, required
      - `entrega` boolean — Para e-commerces e outros cenários onde é necessário especificar o endereço de entrega, utilize o atributo "tipo" para definir essa ação com precisão. Enviando este atributo com "true" indica que o endereço é destinado à entrega, com isso o cadastro será registrado como contato do cliente e vinculado à negociação.
      - `nomeContato` string — Quando o atributo entrega for enviado com valor "true", será obrigatório enviar o nome do contato do cliente na requisição, para que o contato seja registrado e vinculado à negociação.
      - `email` string — Quando o atributo entrega for enviado com valor "true", o email do contato do cliente poderá ser enviado de forma opcional na requisição.
      - `logradouro` string, required
      - `numero` string, int64, required
      - `complemento` string, required
      - `bairro` string, required
      - `cidade` string, required
      - `codigoIbge` integer, required
      - `uf` string, required
      - `cep` string, required
  - `observacao` string
  - `valorFrete` number
  - `valorSeguro` number
  - `valorOutros` number
  - `valorIcms` number
  - `valorCofins` number
  - `valorFcp` number — Valor referente a ICMS Fundo de Combate a Pobreza
  - `valorJuro` number — Valor referente a juros acrescidos no documento
  - `valorTotal` number, required — Valor total final do documento
  - `itens` PedidoDeVendasitem[], required
    - `sequencia` integer, required — Sequência dos itens da negociação. Deve seguir uma sequência numérica crescente, começando de 1, e prosseguir como 2, 3, e assim por diante.
    - `sequenciaItemOrigem` integer — Utilizado para "faturar" pedidos lançados no SankhyaOm. Para registrar a origem do item na venda, insira aqui a "sequencia" do item no pedido lançado no SankhyaOm quando houver. Essa informação pode ser obtida e validada através da nossa API, na entidade "ItemNota" (SEQUENCIA da NUNOTA registrada no atributo "codigoPedidoOrigem"). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
    - `codigoProduto` integer, required — Para registrar os produtos utilizados da negociação, informe neste atributo o "código do produto" disponível no SankhyaOm. Esse código é facilmente acessível através da nossa API, na entidade "Produto" (CODPROD). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
    - `cfop` string
    - `unidade` string — Para registrar os produtos utilizados da negociação, informe neste atributo a "unidade de medida" disponível no SankhyaOm. Essa informação é facilmente acessível através da nossa API, na entidade "Produto" ou "UnidadeAlternativa" (CODVOL). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
    - `quantidade` number, required
    - `controle` string, required — Para registrar os produtos utilizados na negociação, insira neste campo o "controle" correspondente. No SankhyaOm, o controle é essencial para a gestão de estoque e pode incluir características como voltagem, sabor, tamanho, cor, entre outros. Por exemplo, para um produto controlado por cor, o valor "verde" seria uma informação esperada. Certifique-se de obter esses dados previamente através das entidades "Produto" ou "Estoque". Veja como funciona controle adicional de estoque em nossa ajuda [clicando aqui](https://ajuda.sankhya.com.br/hc/pt-br/articles/360045112113-Cadastro-de-Produtos#sub-abacontroleadicional). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
    - `codigoLocalEstoque` integer, required — Código do Local de Estoque para o produto utilizado na negociação. Necessário quando existe controle de estoque envolvendo local. Essa informação deve ser obtida previamente pela entidade "Estoque" (CODLOCAL). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
    - `valorDesconto` number
    - `valorUnitario` number, required
    - `impostos` PedidoDeVendasImpostos[]
      - `tipo` 'icms' | 'icms-st' | 'ipi' | 'ibs' | 'cbs' | 'is' — Tipo do imposto.
      - `cst` string — Código de Situação Tributária.
      - `tributacaoMunicipio` string — Código de tributação do município. Utilizar como referencia a Tabela de Código de Classificação Tributária do IBS/CBS.
      - `classificacaoTributaria` integer — Código de Classificação Tributária. Utilizar como referencia a Tabela de Código de Classificação Tributária do IBS/CBS.
      - `aliquota` number, double — Aliquota do imposto
      - `aliquotaEfetivaRegular` number, double — Alíquota efetiva regular do CBS ou do IBS
      - `aliquotaUnidadeMedida` number, double — Alíquota específica por unidade de medida apropriada
      - `aliquotaEfetivaBaseCalculo` number, double — Alíquota Efetiva que será aplicada a Base de Cálculo
      - `reducaoAliquota` number, double — Percentual da redução de alíquota
      - `percentualFCP` number, double — Percentual do Fundo de Combate a Pobreza (FCP).
      - `percentualReducaoAliquotaGovernamental` number, double — Percentual da redução de alíquota Governamental
      - `percentualDiferimento` number, double — Percentual do diferimento
      - `valorBase` number, double — Valor da base de cálculo
      - `valorBaseReduzida` number, double — Valor Base Cálc.Reduzida (Já com reduções da Reforma aplicadas)
      - `valorImposto` number, double — Valor do imposto calculado
      - `valorFCP` number, double — Valor do Fundo de Combate a Pobreza (FCP).
      - `valorRegular` number, double — Valor do Regular do IBS ou do Município, de acordo com o tipo do imposto enviado.
      - `valorDiferimento` number, double — Valor do Diferimento
      - `valorTributoDevolvido` number, double — Valor do tributo devolvido
  - `financeiros` PedidoDeVendasfinanceiro[], required — Todos os dados financeiros envolvidos na transação devem ser enviados. No caso de cartão de crédito parcelado, envie as parcelas em sequência. Se houver pagamento misto, envie todas as formas de pagamento também em sequência. É importante destacar que a API está preparada para receber diferentes formas de pagamento, incluindo parcelas de cartão de crédito. Basta garantir que todos os pagamentos, inclusive as parcelas, sejam enviados sequenciadas.
    - `tipoPagamento` integer — Tipo de Título para o respectivo financeiro. Essa informação deve ser obtida previamente pela entidade "TipoTitulo" (CODTIPTIT). Para saber mais, [clique aqui](https://developer.sankhya.com.br/reference/get_loadrecords)
    - `cheque` Cheque — Esta informação deve ser enviada "apenas" quando a opção de pagamento (atributo "tipoPagamento") seja do tipo "Cheque" ("02"). Recebe dados de Cheque utilizado como meio de pagamento
      - `codigoBarras` string
      - `banco` string
      - `agencia` string
      - `conta` string
      - `numero` string
      - `nome` string
      - `cnpjCpf` string
    - `cartao` Cartao
      - `bandeira` string — Segue padrão para bandeiras de cartões de créditos disponível no layout da nota fiscal eletronica. - 01 - Visa - 02 - Mastercard - 03 - American Express - 04 - Sorocred - 05 - Diners Club - 06 - Elo - 07 - Hipercard - 08 - Aura - 09 - Cabal - 99 - Outros
      - `autorizacao` string — Código de autorização na transação fornecedido pela administradora do cartão de crédito. Informação utilizada para conciliação financeira.
    - `dataVencimento` string — Data do vencimento do financeiro.
    - `dataBaixa` string — Data da baixa do financeiro. Em casos de deixar sem baixar, basta não enviar esta informação.
    - `valorParcela` number — Valor total da parcela.
    - `idTransacao` string — ID da transação quando houver. Por exemplo o protocolo da transação PIX.

## Response `200`

Operação bem sucedida

- RetornoPedido
  - `codigo` integer
  - `tipo` string
  - `mensagem` string
  - `retorno` CodigoPedido
    - `codigoPedido` integer — Identificador único pedido.

## Other responses

- `400` — Informações Inválidas. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `401` — Não autenticado. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `403` — Autenticação inválida. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `404` — Dados não encontrados. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `500` — Erro interno no servidor. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `501` — Não implementado. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `502` — Retorno inválido do servidor. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `503` — Serviço indisponível no momento. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `504` — Tempo de execução excedido. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.

---

[API](https://skmtc.net/sankhya/apis/api-sankhya.md) · [All operations](https://skmtc.net/sankhya/apis/api-sankhya/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sankhya/api-sankhya/revisions/0a3e81ca6195/schema)