v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB

Vendas Pedidos

Incluir Pedido de Venda

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

post/v1/vendas/pedidos

Request body

notaModelointeger 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

ad_campo_adicionalstring

Pode ser adicionado qualquer campo adicional, não precisa estar dentro de um objeto como no EndPoint de Clientes

datastring required

Data da emissão do documento

horastring required

Data da emissão do documento

codigoVendedorinteger

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

codigoClienteinteger

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

observacaostring

valorFretenumber

valorSeguronumber

valorOutrosnumber

valorIcmsnumber

valorCofinsnumber

valorFcpnumber

Valor referente a ICMS Fundo de Combate a Pobreza

valorJuronumber

Valor referente a juros acrescidos no documento

valorTotalnumber required

Valor total final do documento

Example request

{
  "notaModelo": 45941,
  "ad_campo_adicional": "valor do campo",
  "data": "30/05/2024",
  "hora": "07:34",
  "codigoVendedor": 11,
  "codigoCliente": 8115,
  "cliente": {
    "tipo": "PF",
    "cnpjCpf": "12315914799",
    "ieRg": "12315914799",
    "nome": "José da Silva",
    "razao": "José da Silva ME",
    "email": "contato@provedor.com.br",
    "telefoneDdd": "34",
    "telefoneNumero": "912349966",
    "endereco": {
      "entrega": true,
      "nomeContato": "Maria Roberta",
      "email": "maria.roberta@provedor.com.br",
      "logradouro": "Rua Maria Roberta",
      "numero": "10",
      "complemento": "Apto 104",
      "bairro": "Centro",
      "cidade": "Uberlândia",
      "codigoIbge": 11155566,
      "uf": "MG",
      "cep": "38400000"
    }
  },
  "observacao": "Observações específicas da venda aqui",
  "valorFrete": 50,
  "valorSeguro": 10,
  "valorTotal": 1060,
  "itens": [
    {
      "sequencia": 1,
      "sequenciaItemOrigem": 2,
      "codigoProduto": 9145,
      "cfop": "5405",
      "unidade": "UN",
      "quantidade": 10,
      "controle": "Verde",
      "valorUnitario": 100,
      "impostos": [
        {
          "tipo": "ibs",
          "cst": "00",
          "tributacaoMunicipio": "140801",
          "classificacaoTributaria": 200,
          "aliquota": 26.5,
          "aliquotaEfetivaRegular": 26.5,
          "aliquotaEfetivaBaseCalculo": 26.5,
          "percentualReducaoAliquotaGovernamental": 60,
          "percentualDiferimento": 10,
          "valorBase": 1000,
          "valorBaseReduzida": 400,
          "valorImposto": 106,
          "valorRegular": 106,
          "valorDiferimento": 10.6
        }
      ]
    }
  ],
  "financeiros": [
    {
      "tipoPagamento": 19,
      "cheque": {
        "codigoBarras": "\"341067330330018805201725766099\"",
        "banco": "341",
        "agencia": "0673",
        "conta": "576609",
        "nome": "José da Silva Souza",
        "cnpjCpf": "14532515955"
      },
      "cartao": {
        "bandeira": "02"
      },
      "dataVencimento": "30/05/2024",
      "dataBaixa": "30/05/2024",
      "valorParcela": 1060,
      "idTransacao": "dadotiuiwnlkeuhcnhlahdiwlaoaokd48ge55x"
    }
  ]
}

Response

Operação bem sucedida

codigointeger

tipostring

mensagemstring

Example response

{
  "mensagem": "Pedido Incluído/Atualizado/Cancelado com sucesso.",
  "retorno": {
    "codigoPedido": 98115
  }
}