Perguntas Pedido/Orçamento (EmitirCupom)
- Emerson
-
Autor do Tópico
- Desconectado
- Administrator
-
Menos
Mais
- Postagens: 12
- Obrigados Recebidos: 1
1 mês 2 horas atrás #165
por Emerson
Pedido/Orçamento (EmitirCupom) foi criado por Emerson
API WSG1/SFI — Pedidos / Orçamentos (EmitirCupom)
Documentação técnica dos endpoints Datasnap REST do ERP SFI (WSG1) usados para criar e consultar pedidos/orçamentos, com base na implementação de referência do app PowerSales (pack_eres_cupom).
1. Visão geral
Importante: o ERP SFI, nesta API, não expõe endpoints de listagem geral de pedidos, cancelamento ou alteração de status. O CRUD disponível é limitado a:
2. Criar / Emitir pedido (orçamento)
POST
O mesmo endpoint serve tanto para criar (envia pedidoID: -1) quanto para reenviar/atualizar um pedido (envia o pedidoID já existente).
2.1. Body da requisição (schema completo)
2.2. Item do pedido (itens)
Demais campos do item (contaEstoque, seguro, frete, comissao, bico, gradeId, fator, formula, md5, tributacao, etc.) são campos internos do SFI, mantidos como 0/"" quando não utilizados pelo app cliente.
2.3. Endereço (enderecoEntrega / enderecoCliente)
2.4. Pagamento (item de pgtos)
3. Exemplo de payload de request (criação)
4. Resposta (response)
A resposta vem embrulhada em uma chave de nível raiz que indica sucesso ou falha da operação.
4.1. Sucesso
Observação: alguns campos podem retornar em variantes com nomes internos do ERP (lowercase/snake_case), por exemplo pedidoid em vez de pedidoID, contaid em vez de cliente, vendedorid em vez de vendedor, valor_contabil em vez de valor, condicaoid em vez de condicaoPagamento, tabela_preco em vez de tabelaPrecoID, op_financeira em vez de opFinanceira, nomecliente em vez de nomeConsumidor. Um cliente de integração deve aceitar ambas as formas.
4.2. Falha
O ERP retorna mensagens de erro pouco padronizadas em falha.detalhe — apenas o caso "Integer overflow" é conhecido (ocorre quando a quantidade de parcelas excede o permitido); os demais devem ser tratados como texto livre vindo do ERP.
4.3. Erro genérico
5. Consultar pedido/orçamento
GET
Usado logo após o POST EmitirCupom ter sucesso, para obter o objeto completo do pedido já persistido no ERP (mesmo schema descrito na seção 2.1).
6. Reimprimir pedido
GET
Retorna os dados formatados para reimpressão do cupom/comprovante.
7. Endpoints auxiliares (necessários antes de criar um pedido)
Para montar corretamente o payload da seção 2 (tabela de preço, condição de pagamento, opção financeira etc.), o app consulta previamente estes endpoints. Sem eles, campos como tabelaPrecoID, condicaoPagamento e opFinanceira ficam zerados e o ERP tende a rejeitar o pedido.
8. O que NÃO existe nesta API
9. Erros e validações
Documento gerado a partir da implementação de referência do app PowerSales (pack_eres_cupom / pack_modelos). O client HTTP de baixo nível (pacote pack_clientweb_http) não estava disponível para inspeção direta; a autenticação Basic Auth foi inferida pela configuração padrão do adaptador (EncodedType.basic_auth).
Documentação técnica dos endpoints Datasnap REST do ERP SFI (WSG1) usados para criar e consultar pedidos/orçamentos, com base na implementação de referência do app PowerSales (pack_eres_cupom).
1. Visão geral
- Base URL:
http://{host_sfi}/Datasnap/rest/ - Autenticação: HTTP Basic Auth (usuário/senha do vendedor/terminal logado)
- Header:/
Accept: application/json
Content-Type: application/json
- Formato: JSON (request e response)
Importante: o ERP SFI, nesta API, não expõe endpoints de listagem geral de pedidos, cancelamento ou alteração de status. O CRUD disponível é limitado a:
- Criar pedido/orçamento — POST TOrdemServico/EmitirCupom/{caixa} (mesmo endpoint também é usado para "atualizar", reenviando com o pedidoID existente)
- Consultar pedido/orçamento por ID — GET TVendas/BuscarOrcamento/{pedido}
- Reimprimir pedido — GET TVendas/ImprimePedido/{id}
2. Criar / Emitir pedido (orçamento)
POST
/Datasnap/rest/TOrdemServico/EmitirCupom/{caixa}| Parâmetro | Tipo | Obrigatório | Descrição |
| caixa | integer | sim | ID do caixa/terminal vinculado à sessão do vendedor logado (segmento posicional na URL). |
O mesmo endpoint serve tanto para criar (envia pedidoID: -1) quanto para reenviar/atualizar um pedido (envia o pedidoID já existente).
2.1. Body da requisição (schema completo)
| Campo (JSON) | Tipo | Descrição |
| os | number | Número da OS de origem, se houver (0 se avulso). |
| pedidoID | number | -1 para criar; ID existente para atualizar. |
| transacaoDescicao | string | (sic — chave vem com esse nome no payload) Descrição da transação. |
| dataFinalizacaoOC | string | Data de finalização (ordem de compra), ISO 8601. |
| ehOrcamento | boolean | true = orçamento; false = pedido/cupom concluído. |
| classePedido | string | Classe do pedido (ex.: "ORCAMENTO"). |
| situacao | number | Código de situação do pedido. |
| concluido | boolean | Indica se o pedido foi concluído/finalizado. |
| tipo | string | Tipo do pedido. |
| valorItens | number | Subtotal (soma dos itens, sem desconto/acréscimo). |
| lat / lon | number | Coordenadas de geolocalização do lançamento. |
| empresa | object | Dados da empresa emissora (objeto aninhado). |
| transacaoDef | string | Código da transação financeira. |
| tipoPedidoDef | string | Tipo de pedido padrão. |
| tipoOrigReq | string | Origem da requisição. |
| orcamentoID | number | ID do orçamento de origem, se convertendo orçamento → pedido. |
| caixa | number | Caixa/terminal (mesmo valor do path). |
| serie / especie / numero | string | Identificação fiscal do documento (preenchido pelo ERP na resposta). |
| cliente | number | ID do cliente no SFI (idcli). |
| cOO | number | Contador de Ordem de Operação (cupom fiscal). |
| filial | number | Filial de origem. |
| vendedor | number | ID do vendedor (idven). |
| nomeVendedor / nomeFantasiaVendedor | string | Nome do vendedor. |
| formaPgto | string | Forma de pagamento. |
| md5 | string | Hash de integridade (uso interno do ERP). |
| numeroDAV / numeroPV | string | Número de documento auxiliar de venda / pedido de venda. |
| obs | string | Observações livres. |
| data / dataBase / dataEmissao / dataEntrega | string (ISO 8601) | Datas do pedido. |
| valor | number | Total do pedido (itens + acréscimo − desconto). |
| desconto | number | Percentual de desconto. |
| valorDesconto | number | Valor de desconto em R$. |
| acrescimo | number | Percentual de acréscimo. |
| valorAcrescimoManual | number | Acréscimo lançado manualmente, em R$. |
| trocaTabela | boolean | Indica troca manual de tabela de preço. |
| pedidoOrigem | number | ID do pedido de origem (fusão/duplicação). |
| deletaPedidoOrigem | boolean | Se true, remove o pedido de origem ao confirmar. |
| truncar | boolean | Trunca casas decimais em vez de arredondar. |
| regimeTributario | string | Regime tributário do emitente. |
| condicaoPagamento | number | ID da condição de pagamento. |
| descontoEscalonadoAgrupado | boolean | Uso de desconto escalonado agrupado. |
| tabelaPrecoID | number | ID da tabela de preço aplicada. |
| opFinanceira | string | Operação financeira. |
| contaEstoque / contaEstoqueD | number | Conta de estoque (crédito/débito). |
| agenteID | number | Agente financeiro/banco. |
| entregaid | number | ID do endereço de entrega. |
| tipoFrete | string | Tipo de frete (CIF/FOB etc). |
| indicadorConsumo / indicadorPresenca | string | Indicadores fiscais (NF-e/NFC-e). |
| toTalizarTributos | string | (sic) Flag de totalização de tributos. |
| uFCliente / uFEmpresa | string | UF do cliente / da empresa. |
| vendedorPoliticaDesconto | number | ID da política de desconto do vendedor. |
| usarVendedororigPoliticaDesconto | boolean | (sic) Usa política de desconto do vendedor de origem. |
| profissional | number | Profissional/técnico vinculado. |
| contaSubstituta | number | Conta contábil substituta. |
| cPFConsumidor / nomeConsumidor | string | CPF/nome do consumidor final (cupom sem cliente cadastrado). |
| transacaoIDNovo | string | ID da nova transação, quando aplicável. |
| numeroReserva | number | Número de reserva de estoque vinculada. |
| usuarioDesc | number | Usuário que autorizou o desconto. |
| valorTaxa | number | Valor de taxa adicional (cartão, etc). |
| supervisor | number | ID do supervisor que autorizou a operação. |
| serieSAT / chaveDfe / cNPJEmitente | string | Dados fiscais (SAT/NFC-e). |
| codigoAnterior | string | Código anterior, para migração/histórico. |
| t | string | tabelaPrecoID repetido como string. |
| placa | string | Placa do veículo vinculado ao pedido (contexto de OS). |
| cer / ere / ciu | number/string | Campos internos do ERP (não documentados pelo fornecedor). |
| veiculo | object|null | Dados do veículo, quando aplicável. |
| pagamentoID | number | ID do pagamento vinculado. |
| mensagem1..mensagem5 | string | Mensagens livres impressas no cupom. |
| fisco1..fisco5 | string | Campos fiscais adicionais. |
| operador | string | Operador de caixa. |
| enderecoEntrega / enderecoCliente | object | Ver seção 2.3 (schema de endereço). |
| itens | array | Lista de itens do pedido. Ver seção 2.2. |
| pgtos | array | Lista de formas de pagamento/parcelas. Ver seção 2.4. |
| consumidor | object | { "nome", "cpf", "codClie" } — dados do consumidor final. |
2.2. Item do pedido (itens)
| Campo | Tipo | Obrigatório | Descrição |
| itemID | number | sim (0 para novo) | ID do item (0 = novo item). |
| numOrd | number | sim | Ordem sequencial do item na lista (1, 2, 3...). |
| produto | string | sim | Código do produto no SFI (mesmo idpro usado na carga de Produtos), enviado como string. |
| descricao | string | não | Descrição do produto. |
| quantidade | number | sim | Quantidade do item. |
| preco / precoOriginal | number | sim | Preço unitário aplicado / preço de tabela original. |
| valorBruto | number | não | Preço unitário × quantidade, sem desconto. |
| valor_Contabil | number | não | (sic) Valor contábil do item (preço líquido × quantidade). |
| descontos / valorDesconto | number | não | Percentual / valor de desconto do item. |
| descontoManual | boolean | não | Desconto lançado manualmente. |
| acrescimos / valorAcrescimo | number | não | Percentual / valor de acréscimo do item. |
| acrescimoManual | boolean | não | Acréscimo lançado manualmente. |
| promocao | boolean | não | Indica se o preço veio de uma promoção. |
| tabelaPreco / tabelaPrecoID | string / number | não | Tabela de preço usada no item. |
| situacao | string | não | Situação do item (ex.: esNormal). |
| unidade | string | não | Unidade de medida. |
| agrupamento | string | não | Flag de agrupamento de itens. |
| faixaPreco | number | não | Faixa de preço aplicada. |
| vendedorId | number | não | Vendedor responsável pelo item. |
| nCM / cFOP / eAN / eX_IPI | string | não | Dados fiscais do item. |
| iCMS / cOFINS / pIS / iPI / iI | object | não | Blocos de tributação do item (estrutura interna do ERP). |
Demais campos do item (contaEstoque, seguro, frete, comissao, bico, gradeId, fator, formula, md5, tributacao, etc.) são campos internos do SFI, mantidos como 0/"" quando não utilizados pelo app cliente.
2.3. Endereço (enderecoEntrega / enderecoCliente)
{
"logradouro": "Rua X",
"numero": "10",
"complemento": "",
"bairro": "Centro",
"cidade": "São Paulo",
"uF": "SP",
"cEP": "01000000",
"idcli": 0,
"idctt": 0,
"vendedor": 0,
"email": "",
"cpf_cnpj": "",
"fone": "",
"obs": "",
"nome": "",
"usuario": "",
"novo": 0,
"env_nfe": "",
"env_spo": ""
}2.4. Pagamento (item de pgtos)
{
"opFin": "LC",
"valor": 350.90,
"valorRecebido": 350.90,
"descricao": "Lcto Contábil",
"finalizacao": 1,
"index": 1,
"parcela": 1,
"vencimento": "2026-08-20T10:00:00.000",
"modalidade": "",
"agente": "",
"banco": "",
"emissaoID": 0
}3. Exemplo de payload de request (criação)
{
"os": 0,
"pedidoID": -1,
"ehOrcamento": true,
"classePedido": "ORCAMENTO",
"concluido": true,
"valorItens": 350.90,
"valor": 333.40,
"desconto": 5,
"valorDesconto": 17.50,
"acrescimo": 0,
"caixa": 1,
"cliente": 4521,
"vendedor": 10,
"nomeVendedor": "João Silva",
"formaPgto": "DINHEIRO",
"condicaoPagamento": 1,
"tabelaPrecoID": 3,
"opFinanceira": "01",
"cPFConsumidor": "12345678900",
"nomeConsumidor": "Cliente Teste",
"data": "2026-08-20T10:00:00.000",
"dataBase": "2026-08-20T10:00:00.000",
"itens": [
{
"itemID": 0,
"numOrd": 1,
"produto": "1234",
"descricao": "Produto Teste",
"quantidade": 2,
"preco": 50.00,
"precoOriginal": 50.00,
"valorBruto": 100.00,
"valor_Contabil": 100.00,
"descontos": 0,
"valorDesconto": 0,
"descontoManual": false,
"acrescimos": 0,
"valorAcrescimo": 0,
"acrescimoManual": false,
"promocao": false,
"tabelaPrecoID": 3,
"unidade": "UN",
"agrupamento": "",
"faixaPreco": 0,
"vendedorId": 10
}
],
"pgtos": [
{
"opFin": "LC",
"valor": 333.40,
"valorRecebido": 333.40,
"descricao": "Lcto Contábil",
"finalizacao": 1,
"index": 1,
"parcela": 1,
"vencimento": "2026-08-20T10:00:00.000"
}
],
"consumidor": { "nome": "Cliente Teste", "cpf": "12345678900", "codClie": 4521 }
}4. Resposta (response)
A resposta vem embrulhada em uma chave de nível raiz que indica sucesso ou falha da operação.
4.1. Sucesso
{
"sucesso": {
"pedidoID": 123456,
"cliente": 4521,
"valor": 333.40,
"situacao": 0,
"numero": "000123",
"serie": "1"
}
}Observação: alguns campos podem retornar em variantes com nomes internos do ERP (lowercase/snake_case), por exemplo pedidoid em vez de pedidoID, contaid em vez de cliente, vendedorid em vez de vendedor, valor_contabil em vez de valor, condicaoid em vez de condicaoPagamento, tabela_preco em vez de tabelaPrecoID, op_financeira em vez de opFinanceira, nomecliente em vez de nomeConsumidor. Um cliente de integração deve aceitar ambas as formas.
4.2. Falha
{
"falha": {
"detalhe": "Integer overflow"
}
}O ERP retorna mensagens de erro pouco padronizadas em falha.detalhe — apenas o caso "Integer overflow" é conhecido (ocorre quando a quantidade de parcelas excede o permitido); os demais devem ser tratados como texto livre vindo do ERP.
4.3. Erro genérico
{
"erro": "mensagem de erro do Datasnap"
}5. Consultar pedido/orçamento
GET
/Datasnap/rest/TVendas/BuscarOrcamento/{pedido}| Parâmetro | Tipo | Obrigatório | Descrição |
| pedido | integer | sim | ID do pedido/orçamento (pedidoID) retornado na criação. |
Usado logo após o POST EmitirCupom ter sucesso, para obter o objeto completo do pedido já persistido no ERP (mesmo schema descrito na seção 2.1).
6. Reimprimir pedido
GET
/Datasnap/rest/TVendas/ImprimePedido/{id}| Parâmetro | Tipo | Obrigatório | Descrição |
| id | integer | sim | ID do pedido a ser reimpresso. |
Retorna os dados formatados para reimpressão do cupom/comprovante.
7. Endpoints auxiliares (necessários antes de criar um pedido)
Para montar corretamente o payload da seção 2 (tabela de preço, condição de pagamento, opção financeira etc.), o app consulta previamente estes endpoints. Sem eles, campos como tabelaPrecoID, condicaoPagamento e opFinanceira ficam zerados e o ERP tende a rejeitar o pedido.
| Finalidade | Método | Endpoint |
| Dados primários (tabela de preço, tipo de pedido, cliente) | GET | TCadastroGeral/BuscarTransacoesPrimarias/{codigoVendedor}/{codigoCliente} |
| Configuração de parcelamento/pagamento | GET | TVendas/configuracaoPagamento |
| Finalização — Transação financeira | GET | TVendas/BuscaFinalizacaoTF/{usaPrazoMedio}/{codCliente}/{condicaoID}/{agenteID}/{modalidadeID}/{opFinanceira}/{tipo}/{transacao} |
| Finalização — Condição de pagamento | GET | TVendas/BuscaFinalizacaoCondicao/{codCliente}/{agenteID}/{modalidadeID}/{opFinanceira}/{tf}/{tipo}/{transacao} |
| Finalização — Opção financeira | GET | TVendas/BuscaFinalizacaoOpFinanceira/{codCliente}/{condicaoID}/{agenteID}/{modalidadeID}/{tf}/{tipo}/{transacao} |
| Finalização — Agente | GET | TVendas/BuscaFinalizacaoAgente/{codCliente}/{condicaoID}/{modalidadeID}/{opFinanceira}/{tf}/{tipo}/{transacao} |
| Finalização — Modalidade | GET | TVendas/FinalizacaoModalidade/{codCliente}/{condicaoID}/{agenteID}/{opFinanceira}/{tf}/{tipo}/{transacao} |
| Política de acréscimo | GET | TVendas/PoliticaAcrescimo/{cliente}/{vendedor}/{tabela}/{condicao}/{data} |
| Política de desconto | GET | TVendas/ConfgPoliticaDesconto |
| Faixas de preço | GET | TVendas/%22BuscarFaixasdePrecos%22 |
| Descontos por faixa | GET | TVendas/%22BuscarDescontosPorFaixa%22 |
| Login de vendedor p/ desconto maior | GET | TCadastroGeral/LoginVendedores/{usuario}/{senha} |
| Parâmetros gerais do sistema | GET | TCadastroGeral/Parametros |
8. O que NÃO existe nesta API
| Operação | Situação |
| Listar todos os pedidos | Não há endpoint remoto — só consulta individual por ID (BuscarOrcamento). |
| Cancelar pedido no ERP | Não há endpoint. Cancelamento de um pedido ainda não enviado é apenas local (remoção do rascunho no app cliente). |
| Alterar status via PUT/PATCH | Não existe verbo de atualização parcial. A única forma de "atualizar" é reenviar o pedido completo via POST EmitirCupom com o pedidoID já existente. |
| Excluir (DELETE) | Não utilizado neste fluxo. |
9. Erros e validações
| Situação | Comportamento |
| Sem conexão com a internet | O pedido é salvo em uma fila local (offline) para reenvio posterior — o app não chega a chamar o SFI. |
| Resposta com chave "erro" | Tratada como erro genérico do Datasnap; a mensagem é repassada como está. |
| Resposta com chave "falha" | Erro de regra de negócio do ERP. Mensagem em falha.detalhe (texto livre, salvo o caso conhecido "Integer overflow" = limite de parcelas excedido). |
| Carrinho/itens vazio | Não há validação client-side — o payload é enviado com itens: [] e a rejeição, se houver, vem do próprio ERP. |
| Cliente novo (ainda não cadastrado no SFI) | O cliente é cadastrado primeiro em endpoint separado de cadastro, e só então o pedido é enviado com o idcli retornado. |
Documento gerado a partir da implementação de referência do app PowerSales (pack_eres_cupom / pack_modelos). O client HTTP de baixo nível (pacote pack_clientweb_http) não estava disponível para inspeção direta; a autenticação Basic Auth foi inferida pela configuração padrão do adaptador (EncodedType.basic_auth).
Por favor Acessar ou Registrar para participar da conversa.
Tempo para a criação da página:0.104 segundos