Área do desenvolvedorComunidadeMarketplaceUniversidade
Documentação API

Incluir Pedido de Venda

post
https://api.sankhya.com.br/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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Inclui Pedido de Venda no SankhyaOm

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".

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

string
required

Data da emissão do documento

string
required

Data da emissão do documento

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

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
object

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.

string
number
number
number
number
number
number

Valor referente a ICMS Fundo de Combate a Pobreza

number

Valor referente a juros acrescidos no documento

number
required

Valor total final do documento

itens
array of objects
required
itens*
financeiros
array of objects
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.

financeiros*
Responses

Updated 4 days ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago