Strings disponibilizadas pela API do Venda ERP

Neste artigo será possível visualizar os modelos de Strigns disponibilizadas em nossa Documentação API para a tela de Vendas, facilitando ainda mais na modelagem do json a ser utilizado.

Acesse a Documentação API em Pedidos, Orçamentos e Ordens de Serviço

Ao expandir o Método da API desejado, clique em Model

Assim será disponibilizado as Strings opcionais que também poderá ser utilizado na criação do seu json para importação de informações que desejas. Segue as strigs Opcionais, descritas com sua funcionalidade: "ID": (string, optional) ID do Pedido , "AndroidVendaID": (string, optional) ID do Pedido no Android, "Codigo": (integer, optional) Código do Pedido "OrigemVenda": (string, optional) Origem da Venda, informação definida pelo sistema. OPÇÕES: Venda Direta ou E-commerce "DepositoID": (string, optional) ID do Depósito aonde será gerada a movimentação. "Tabela": (string, optional) Nome da tabela de preço utilizado na venda "TabelaID": (string, optional) ID da tabela de preço utilizado na venda "Deposito": (string, optional) Nome do Depósito aonde será gerada a movimentação "StatusSistema": (string, optional) Status Padrão do Sistema. OPÇÕES: Orçamento, Pedido, Pedido Não Faturado, Pedido Faturado, Pedido Cancelado "Status": (string, optional) Status definido pelo usuário. Deve estar previamente cadastrada no sistema. "Categoria": (string, optional) Categoria definida pelo usuário. Deve estar previamente cadastrada no sistema. "Validade": (string, optional) Data de Validade do Pedido/Orçamento. Categoria do pedido. Deve estar previamente cadastrada no sistema. "Empresa": (string, optional) Nome da empresa responsável pela VENDA. "EmpresaID": (string, optional) ID da empresa responsável pela VENDA. "ClienteID": (string, optional) Cliente ID responsável pela compra. "Cliente": (string, optional) Cliente responsável pela compra. "PessoaID": (string, optional) ID do cliente, para não perder o vinculo caso ele modifique o nome "ClienteCNPJ": (string, optional) Cliente responsável pela compra. (CNPJ) "ClienteEmail": (string, optional) Cliente responsável pela compra. (CNPJ) "Vendedor": (string, optional) Nome do Vendedor relacionado a venda "PlanoDeConta": (string, optional) Plano de conta, deve estar previamente cadastrada. "FormaPagamento": (string, optional) Forma de Pagamento escolhida, deve estar previamente cadastrada. "FormaPagamentoID": (string, optional) ID da forma de pagamento da VENDA. "NumeroParcelas": (integer, optional) Número de Parcelas "FreteMeioEnvio": (integer, optional) Meio de Envio (Correio ou Outros) "Transportadora": (string, optional) Nome da responsável pelo transporte da mercadoria. "FreteFormaEnvio": (string, optional) Formato de Envio do Produto "DataEnvio": (string, optional) Data de envio da mercadoria "PrevisaoEntrega": (string, optional) Previsão de Entrega "DataPostagem": (string, optional) Data de postagem "Enviado": (boolean, optional) A mercadoria foi enviada "ValorFrete": (number, optional): Valor do Frete "FreteContaEmitente": (boolean, optional): O frete deve ser pago pelo emitente "CodigoRastreio": (string, optional): Código de rastreamento da entrega "EnderecoOpcional": (boolean, optional): Caso o cliente tenha solicitado a entrega para um endereço diferente do seu cadastro "ValorSeguro": (number, optional): Valor do Seguro "Descricao": (string, optional): Descrição e observações relacionados ao pedido "OutrasDespesas": (number, optional): Outras despesas que devem ser acrescentadas ao valor final do pedido "TransacaoCartao": (string, optional): Código da Transação de Cartão "ValorFinal": (number, optional): Valor Final do Pedido - Não utilizado Método POST/PUT "Finalizado": (boolean, optional): Pedido finalizado que não pode sofrer alterações "Lancado": (boolean, optional): Pedido já lançado pelo financeiro "Municipio": (string, optional): DADOS DE ENTREGA: nome do muninípio. "CodigoMunicipio": (string, optional): DADOS DE ENTREGA: código do muninípio. "Pais": (string, optional): DADOS DE ENTREGA: Nome do pais. "CEP": (string, optional): DADOS DE ENTREGA: CEP 99999-999 "UF": (string, optional): DADOS DE ENTREGA: UF do estado "UFCodigo": (string, optional): DADOS DE ENTREGA: Código UF "Bairro": (string, optional): DADOS DE ENTREGA: Nome do Bairro "Logradouro": (string, optional): DADOS DE ENTREGA: Logradouro "LogradouroNumero": (string, optional): DADOS DE ENTREGA: Número do Logradouro "LogradouroComplemento": (string, optional): DADOS DE ENTREGA: Complemento "Itens": (Array [PedidoProduto ], optional): Items da Venda "Banco": (string, optional) conta bancária deve estar pré cadastrada no sistema "Data": (string, optional): Data "Pagamentos": (Array[PagamentoPedido ], optional) "LancarComissaoVendedor": (boolean, optional): Lancar Comissão do Vendedor ao faturar pela API LancarComissaoVendedor: (boolean, optional) Lancar Comissão do Vendedor ao faturar pela API , ValorComissaoVendedor (number, optional), NumeroNFe: (string, optional), DataFaturamento: (string, optional), ChaveAcessoNFe: (string, optional), DanfeURL: (string, optional), UrlSefaz: (string, optional), OrdemServico (OS, optional): Ordem de servico , CodigoPedidoCliente (string, optional), DataAprovacaoPedido (string, optional), GerarBoletos: (boolean, optional) Ao salvar e faturar o pedido, esse valor habilita o processo de gerar boletos para os lançamentos gerados }

PedidoProduto { Codigo (string, optional): Código do produto , Unidade (string, optional): Unidade de Medida , Descricao (string, optional): Descrição , Quantidade (number, optional): Quantidade , ValorUnitario (number, optional): Valor de Venda Unitário , ValorFrete (number, optional): Valor Frete , DescontoUnitario (number, optional): Desconto de Venda Unitário , ValorTotal (number, optional): Valor Total Item - Não utilizado Método POST/PUT , PesoKG (number, optional): Peso em KG , Comprimento (number, optional): Comprimento , Altura (number, optional): Altura , Largura (number, optional): Largura , FreteGratis (boolean, optional): É frete grátis , ValorUnitarioFrete (number, optional): Valor Unitário do Frete , PrazoEntregaFrete (integer, optional): Prazo de Entrega , ComissaoVendedor (number, optional): Percentual Comissão Vendedor , Seguro (number, optional): Valor do Seguro , Composicoes (Array[PedidoProdutoComposicao], optional): Composições do Item , Atributos (Array[PedidoProdutoAtributo], optional) }

PagamentoPedido

{ FormaPagamento: (string, optional) Forma de Pagamento. OPÇÕES: Dinheiro, Cartão, Boleto, Outros DescricaoPagamento (string, optional), ValorPagamento (number, optional), BandeiraCartao (string, optional), NumeroTerminal (string, optional), DataTransacao (string, optional), CredenciadoraCartao (string, optional), necessita estar pré cadastrada no sistema CredenciadoraCNPJ (string, optional) CNPJ da credenciadora vinculada CV_NSU (string, optional), TipoIntegracao (string, optional), CondicaoPagamento (integer, optional), Parcelas (integer, optional), numero de parcelas PeriodoParcelas (integer, optional), Adiantamento (number, optional), Quitar (boolean, optional) }

OS { OrdemServicoConcluida (boolean, optional), OrdemServicoCancelada (boolean, optional), MotivoCancelamento (string, optional), Problema (string, optional), Laudo (string, optional), DataAbertura (string, optional), Tecnico (string, optional), Contrato (string, optional), DataVisita (string, optional), DataInicioIntervencaoTecnica (string, optional), DataFinalIntervencaoTecnica (string, optional), Laudos (Array[Laudo], optional), Equipamentos (Array[InformacoesEquipamento], optional), Veiculos (Array[CadastroVeiculos], optional) }

PedidoProdutoComposicao { Produto (string, optional): Descrição , Deposito (string, optional): Descrição , Consumo (number, optional): Quantidade Consumo , ConsumoTotal (number, optional): Quantidade Consumo Total , NumerosSerie (string, optional) } PedidoProdutoAtributo { AtributoId (string, optional), Descricao (string, optional), Abreviacao (string, optional), Valor (string, optional) }

Laudo { Tecnico (string, optional), DataRegistro (string, optional), LaudoTecnicoGeral (string, optional) } InformacoesEquipamento { Codigo (string, optional), Nome (string, optional), Modelo (string, optional), Observacoes (string, optional), Fabricante (string, optional) } CadastroVeiculos { Modelo (string, optional), Placa (string, optional), NumeroSerie (string, optional), Chassi (string, optional) }

Desta forma, é mais fácil visualizar as strings opcionais que a API oferta para que possa estar utilizando conforme sua necessidade.

Agora é com você, aproveite ao máximo as oportunidades do Venda ERP! Esperamos que este artigo tenha esclarecido suas dúvidas e que te ajude a aproveitar ainda mais as funcionalidades disponíveis. Restou alguma dúvida? Entre em contato com o seu fornecedor para maiores informações!