Integracao Touch Comp ERP Terceiros (API/Endpoints)/API Pedido
Integracao_Touch_Comp_ERP_Terceiros_(API/Endpoints)
API Pedido
Esta wiki destina-se a explanação sobre os endpoints disponibilizados pela API da Touch Comp para acesso a informações com o intuito de criar novos pedidos por parte de um sistema frontend. Através dessa comunicação, o sistema frontend busca informações como produtos, clientes, transportadores, etc disponíveis na base de dados.
Esta wiki contem apenas as especificidades de Pedido. Questões genericas, como autenticação, pesquisas, verifique as wikis apropriadas.
Cancelamento de Pedidos
Para cancelar um Pedido, deve-se chamar o endpoint /cancelar-pedido. Será necessario enviar a situação de Pedidos de cancelamento. Verifique com o responsável pela empresa qual a situação a ser enviado conforme o fluxo de pedidos da empresa. Nesta situação, existe uma opção em especial "cancelarTitulos" que determina que os dados do pedido serão cancelados, que deve estar marcada. Se enviada uma situação sem esta marcação, o pedido não será cancelado.
Informe também o motivo do cancelamento. O Payload abaixo detalha os dados a serem enviados.
{
"input": {
"pedidoIdentificador": 224647,
"situacaoPedidoIdentificador": 4,
"motivoCancelamento":"Teste de cancelamento"
}
}
Pagamentos e Parcelas
Em situações simples, apenas enviando a condição de pagamento, o ERP já irá automaticamente gerar as previsões financeiras com base nos prazos da(s) condição(ões) informada(s). Caso deseje manipular estas datas, é possível informá-las.
Você deve compreender antes, que o pedido pode varias formas de pagamento e cada forma um ou mais titulos.
Se você deseja portanto manipular os pagamentos, sugerimos chamar os endpoints específicos para pré gerar estes dados, e posteriormente, manipulá-los se necessário:
- /novo-pagamento(PUT): cria um novo pagamento com base nos dados informados. O payload será o abaixo. Observe o caso das Parcelas. Algumas condições de pagamento, as variáveis, estas parcelas podem ser informadas como por exemplo 30;60;90;.
{
"input": {
"condicoesPagamento": 1,
"parcelas":""
}
}
Será retornado os seguintes dados:
{
"identificador": null,
"meioPagamento": "DINHEIRO",
"meioPagamentoIdentificador": 3,
"valor": 0.0,
"nrAutorizacao": null,
"titulos": [],
"tipoPagamentoNFe": "01-Dinheiro",
"tipoPagamentoNFeIdentificador": 1,
"bandeiraCartaoNFe": null,
"bandeiraCartaoNFeIdentificador": null,
"credenciadoraCreditoDebito": null,
"credenciadoraCreditoDebitoIdentificador": null,
"condicoesPagamentoIdentificador": 1,
"condicoesPagamento": "A VISTA",
"tipoIntegracao": 1,
"valorTroco": 0.0,
"valorLiquido": 0.0,
"dataFinanceiraCartao": null,
"valorAcrescimo": 0.0,
"valorDesconto": 0.0,
"nrDiasMedios": 0,
"parcelas": "",
"naoGerarComissao": 0,
"tipoPagST": 0
}
Observe que os titulos não foram retornados. Para que sejam calculados, será necessário informar o valor de cada pagamento. Para que seja calculado, será necessário enviar o pedido, com as informações de pagamento já adicionadas com os respectivos valores e parcelas, conforme endpoint abaixo.
- /criar-titulos(PUT): gera os títulos e previsões conforme os dados do pedido.
{
"input": {
"clienteIdentificador": 894,
"dataCadastro": 1728678568845,
"dataEmissao": 1728678568845,
"dataPrevisaoFat": 1728678568845,
"dataPrevisaoSaida": 1728678568845,
"destacarDesconto": 1,
"destacarDespAcessoria": 1,
"destacarFrete": 0,
"destacarSeguro": 0,
"empresaIdentificador": 17,
"indicanteIdentificador": null,
"infPagamentoPedido": [
{
"bandeiraCartaoNFe": null,
"bandeiraCartaoNFeIdentificador": null,
"condicoesPagamento": "A VISTA",
"condicoesPagamentoIdentificador": 1,
"credenciadoraCreditoDebito": null,
"credenciadoraCreditoDebitoIdentificador": null,
"dataFinanceiraCartao": null,
"identificador": null,
"meioPagamento": "DINHEIRO",
"meioPagamentoIdentificador": 3,
"naoGerarComissao": 0,
"nrAutorizacao": null,
"nrDiasMedios": 0,
"parcelas": "",
"tipoIntegracao": 1,
"tipoPagamentoNFe": "01-Dinheiro",
"tipoPagamentoNFeIdentificador": 1,
"tipoPagST": 0,
"titulos": [
],
"valor": 1459.0,
"valorAcrescimo": 0.0,
"valorDesconto": 0.0,
"valorLiquido": 1459.0,
"valorTroco": 0.0
}
],
"itemPedido": [
{
"centroEstoqueIdentificador": 8,
"descontoItem": 1,
"despAcessItem": 0,
"fatorConversao": 1,
"formTabDinCalcComissaoIdentificador": 77,
"formTabDinCalcPrecoIdentificador": 74,
"freteItem": 0,
"infoAdicionalItem": "",
"infoAdicionalItemAux": "",
"nrItemPedido": "",
"nrPedido": "59",
"nrSequencial": 0,
"percComissao": 0.5,
"percDesconto": 0,
"percDescontoItem": 0.62,
"percDescontoItemInf": 0.62,
"percDespesaAcessoria": 0,
"percFrete": 0,
"percSeguro": 0,
"produtoIdentificador": 3268,
"quantidadeTotal": 10,
"seguroItem": 0,
"tipoDesconto": 1,
"tipoDespAcessoria": 1,
"tipoFrete": 1,
"tipoSeguro": 1,
"tipoTabPreco": 1,
"unidadeMedidaIdentificador": 8,
"valorCusto": 145.9,
"valorDesconto": 0,
"valorDescontoItemInf": 9,
"valorDespesaAcessoria": 0,
"valorFrete": 0,
"valorMaximo": 156321.43,
"valorMinimo": 128.89,
"valorSeguro": 0,
"valorSugerido": 145.9,
"valorTotal": 1450,
"valorTotalBruto": 1459,
"valorUnitario": 145.9
}
],
"meioPagamentoIdentificador": 22,
"naturezaOperacaoIdentificador": 34,
"nfceConsumidor": null,
"nrPedidoCliente": "",
"nrTotalItens": 1,
"observacao": "",
"observacaoUsoInterno": "",
"percDescontoInf": 0,
"percDescontoItemInf": 0.62,
"percDespAcessoria": 0,
"percDespAcessoriaInf": 0,
"percFinanceiro": 0,
"percFrete": 0,
"percFreteInf": 0,
"percSeguro": 0,
"percSeguroInf": 0,
"pessoaAutorizada": null,
"pessoaAutorizadaIdentificador": null,
"qtdeTotalItens": 10,
"representanteIdentificador": 3,
"serialForSync": "",
"situacaoPedidoIdentificador": 10,
"tipoDesconto": 1,
"tipoDespAcessInf": 1,
"tipoFreteIdentificador": 1,
"tipoFreteInf": 1,
"tipoSeguroInf": 1,
"transportadorIdentificador": 108,
"unidadeFatClienteIdentificador": 4693,
"usuarioIdentificador": null,
"valorDescontoInf": 0,
"valorDescontoItemInf": 9,
"valorDespAcessoria": 0,
"valorDespAcessoriaInf": 0,
"valorFrete": 0,
"valorFreteInf": 0,
"valorSeguro": 0,
"valorSeguroInf": 0,
"valorTotal": 1450,
"valorTotalBruto": 1459,
"valorTotalComImpostos": 1459,
"vlrTotalCusto": 145.9
}
}
O retorno será o pedido completo, com os titulos gerados.
{
"@type": "WebDTOResult",
"status": "SUCESSO",
"messages": [],
"result": {
"identificador": null,
"nrPedidoCliente": "",
"codigoPedido": null,
"observacao": "",
"observacaoUsoInterno": "",
"percFrete": 0.0,
"valorFrete": 0.0,
"percDesconto": 0.0,
"valorDesconto": 0.0,
"valorBancoCredito": 0.0,
"valorTotalBruto": 1459.0,
"valorTotal": 1450.0,
"percSeguro": 0.0,
"valorSeguro": 0.0,
"percDespAcessoria": 0.0,
"valorDespAcessoria": 0.0,
"condPagMut": null,
"percDescFinanceiro": 0.0,
"percComissao": 0.0,
"dataPrevisaoFat": 1728678568845,
"representanteIdentificador": 3,
"representante": "CLARICE ELIDA RODRIGUES ARAUJO",
"indicanteIdentificador": null,
"indicante": null,
"condicoesPagamentoIdentificador": null,
"condicoesPagamento": null,
"tipoFreteIdentificador": 1,
"tipoFrete": "REMETENTE (CIF)",
"dataPrevisaoSaida": 1728678568845,
"naturezaOperacaoIdentificador": 34,
"naturezaOperacao": "2 - VENDA - NFE",
"unidadeFatClienteIdentificador": 4693,
"unidadeFatCliente": "FULVIO DE QUEIROZ CARDOSO NETO FAZENDA RIBEIRAO DOS SANTOS - Cep: 35637899 IE: 0014195670020",
"situacaoPedidoIdentificador": 10,
"situacaoPedido": "PEDIDO APP",
"transportadorIdentificador": 108,
"transportador": "COOPERATIVA AGROPECUARIA DE BOM DESPACHO LTDA",
"transportadorRedesIdentificador": null,
"transportadorRedes": null,
"expedicaoIdentificador": null,
"expedicao": "[]",
"dataEmissao": 1728678568845,
"dataCadastro": 1728678568845,
"dataAtualizacao": null,
"empresaIdentificador": 17,
"empresa": "INSUMOS ARAUJOS",
"itemPedido": [
{
"identificador": null,
"valorUnitario": 145.9,
"valorUnitarioDescTrib": 0.0,
"valorFrete": 0.0,
"valorDesconto": 0.0,
"valorTotalBruto": 1459.0,
"valorTotal": 1450.0,
"valorBancoCredito": 0.0,
"valorFabrica": 0.0,
"percComissao": 0.5,
"percDesconto": 0.0,
"percFrete": 0.0,
"percDespesaAcessoria": 0.0,
"percSeguro": 0.0,
"valorDespesaAcessoria": 0.0,
"valorSeguro": 0.0,
"valorSugerido": 145.9,
"valorMinimo": 128.89,
"valorMaximo": 156321.43,
"modeloFiscalIdentificador": null,
"modeloFiscal": null,
"tabDesFinancProdutoIdentificador": null,
"tabDesFinancProduto": null,
"classificacaoVendasIdentificador": null,
"classificacaoVendas": null,
"produtoIdentificador": 3268,
"produto": "3268 - FARELO SOJA 46% CARGILL 50KG PRODUCAO MINEIRA",
"produtoNome": "FARELO SOJA 46% CARGILL 50KG PRODUCAO MINEIRA",
"produtoCodigoAuxiliar": "1513",
"unidadeMedidaIdentificador": 8,
"unidadeMedida": "SC",
"quantidadeTotal": 10.0,
"gradeItemPedido": [],
"fatorConversao": 1.0,
"infoAdicionalItem": "",
"infoAdicionalItemAux": "",
"tipoCondicao": 0,
"codigoAux": null,
"descricaoAux": null,
"nrItemPedido": "",
"itemPedidoFiscal": null,
"valorDescFinanceiro": 0.0,
"nrSequencial": 0,
"quantidadePecas": 0.0,
"descontoItem": 1,
"despAcessItem": 0,
"seguroItem": 0,
"freteItem": 0,
"tipoDesconto": 1,
"tipoFrete": 1,
"tipoSeguro": 1,
"tipoDespAcessoria": 1,
"valorTotalComImpostos": 0.0,
"centroEstoqueIdentificador": 8,
"centroEstoque": "8 - INSUMOS ARAUJOS",
"prazoEntrega": 0,
"nrPedido": "59",
"itemCotacaoVendasIdentificador": null,
"itemCotacaoVendas": null,
"percComissaoMin": 0.0,
"percComissaoMax": 0.0,
"valorCusto": 145.9,
"formTabDinCalcPrecoIdentificador": 74,
"formTabDinCalcPreco": "AVALIADOR PRECOS",
"formTabDinCalcComissaoIdentificador": 77,
"formTabDinCalcComissao": "AVALIADOR COMISSAO",
"tipoTabPreco": 1,
"dataAtualizacao": null,
"grupoProdutosIdentificador": null,
"grupoProdutos": null,
"percDescTrib": 0.0,
"valorTotalBrutoDescTrib": 0.0,
"valorTotalDescTrib": 0.0,
"dataEntrega": null,
"percDescontoItemInf": 0.62,
"percFreteItemInf": 0.0,
"percDespAcessItemInf": 0.0,
"percSeguroItemInf": 0.0,
"valorDescontoItemInf": 9.0,
"valorFreteItemInf": 0.0,
"valorDespAcessItemInf": 0.0,
"valorSeguroItemInf": 0.0,
"percDescontoRateado": 0.0,
"percFreteRateado": 0.0,
"percDespAcessRateado": 0.0,
"percSeguroRateado": 0.0,
"valorDescontoRateado": 0.0,
"valorFreteRateado": 0.0,
"valorDespAcessRateado": 0.0,
"valorSeguroRateado": 0.0,
"percDescontoTrib": 0.0,
"valorDescontoTrib": 0.0,
"nrLoteFabricacao": null,
"dataFabricacao": null,
"dataValidade": null,
"errors": []
}
],
"reservarEstoque": 0,
"tipoDesconto": 1,
"pesoTotal": 0.0,
"totalComissao": 0.0,
"observacaoSistema": "",
"cotacaoVendasIdentificador": null,
"cotacaoVendas": null,
"tipoFreteInf": 1,
"tipoSeguroInf": 1,
"tipoDespAcessInf": 1,
"destacarFrete": 0,
"destacarSeguro": 0,
"destacarDesconto": 1,
"destacarDespAcessoria": 1,
"agenteLojaIdentificador": null,
"agenteLoja": null,
"informarLocalEntrega": 0,
"enderecoEntrega": null,
"nrSequencialPedido": 1,
"codigoPedInformado": null,
"centroEstoqueReservaIdentificador": null,
"centroEstoqueReserva": null,
"percFreteInf": 0.0,
"valorFreteInf": 0.0,
"percDescontoInf": 0.0,
"valorDescontoInf": 0.0,
"percSeguroInf": 0.0,
"valorSeguroInf": 0.0,
"percDespAcessoriaInf": 0.0,
"valorDespAcessoriaInf": 0.0,
"valorTotalComImpostos": 1459.0,
"pedidoPaiIdentificador": null,
"pedidoPai": null,
"tipoDataTitulo": 0,
"ufEmbarqueIdentificador": null,
"ufEmbarque": null,
"localEmbarque": null,
"usuarioIdentificador": null,
"usuario": null,
"idPedidoMobileIdentificador": null,
"idPedidoMobile": null,
"volumeTotal": 0.0,
"tipoConsumidor": 0,
"pedidoBonificacaoBrinde": null,
"moedaIdentificador": null,
"moeda": null,
"cotacaoMoedaIdentificador": null,
"cotacaoMoeda": null,
"arquivoDocIdentificador": null,
"arquivoDoc": null,
"diasMediosCondPag": 0,
"situacaoPedAntIdentificador": null,
"situacaoPedAnt": null,
"nrTotalItens": 1,
"qtdeTotalItens": 10.0,
"vlrTotalCusto": 145.9,
"meioPagamentoIdentificador": 22,
"meioPagamento": "CARTAO TEF DEBITO",
"unificacaoPedidoIdentificador": null,
"unificacaoPedido": null,
"liberacaoMTCIdentificador": null,
"liberacaoMTC": null,
"usuarioUltModIdentificador": null,
"usuarioUltMod": null,
"infPagamentoPedido": [
{
"identificador": null,
"meioPagamento": "DINHEIRO",
"meioPagamentoIdentificador": 3,
"valor": 1459.0,
"nrAutorizacao": null,
"titulos": [
{
"identificador": null,
"pessoaIdentificador": 2937,
"pessoa": "FULVIO DE QUEIROZ CARDOSO NETO",
"pagRec": 1,
"tipoDocIdentificador": 1,
"tipoDoc": "BOLETO",
"carteiraCobrancaIdentificador": 36,
"carteiraCobranca": "36 - CNAB RECEBIMENTO - BANCO ITAU",
"representantes": [
{
"identificador": null,
"tituloIdentificador": null,
"titulo": " - FULVIO DE QUEIROZ CARDOSO NETO",
"representanteIdentificador": 3,
"representante": "CLARICE ELIDA RODRIGUES ARAUJO",
"vrBCComissao": 1450.0,
"percComissao": 0.5
}
],
"provisao": 0,
"dataVencimento": 1728678568845,
"dataEmissao": 1728678568845,
"dataEntradaSaida": 1728678568845,
"numeroBanco": null,
"observacao": "Pedido: FULVIO DE QUEIROZ CARDOSO NETO(1/1)",
"naoCompoeFluxo": 0,
"valor": 1459.0,
"dataCompetencia": 1728678568845,
"vrDescontoCondicional": 0.0,
"vrJurosDia": 1.0699333333333336,
"dataCadastro": 1728678568845,
"empresaIdentificador": 17,
"empresa": "INSUMOS ARAUJOS",
"percJurosMes": 2.2,
"numParcTituloEstnota": 1,
"dataAtualizacao": null,
"planoContaIdentificador": 5600,
"planoConta": "1120100002 - ASSOCIADOS A RECEBER",
"tipoPessoa": 1,
"lancCtbGerencial": [
{
"identificador": null,
"debCred": 1,
"valor": 1459.0,
"historico": "Titulo/Parcela: 1. Pessoa: FULVIO DE QUEIROZ CARDOSO NETO",
"centroCustoIdentificador": null,
"centroCusto": null,
"planoContaGerencialIdentificador": 478,
"planoContaGerencial": "MERCADORIAS PARA REVENDA",
"planoContaGerencialCodigo": "020101010100007 ",
"dataCadastro": 1728678568845,
"dataAtualizacao": null,
"empresaIdentificador": 1,
"empresa": "SUPERMERCADO BOM DESPACHO",
"gerado": 0,
"provRealizado": 0,
"tipoLancamento": 0,
"dataPrevista": 1728678568845,
"idLancOrigem": null
}
],
"valorSaldo": 0.0,
"boletoTitulo": [],
"vrIofPago": 0.0,
"vrAbatimento": 0.0,
"descontoFinanceiro": 0.0,
"percDescontoMes": 0.0,
"faturaCte": null,
"valorJurosEmbutido": 0.0,
"valorMultaEmbutida": 0.0,
"valorDespesaBancariaEmbutida": 0.0,
"antecipado": 0,
"valorDescontosEmbutido": 0.0,
"valorDespBancPaga": 0.0,
"logTituloCnab": [],
"numeroParcelas": 1,
"arquivoDoc": null,
"dataVencimentoBase": 1728678568845,
"percMulta": 0.0,
"valorAdicional": 0.0,
"infPagamentoPedido": "",
"capturarIdFgts": 0,
"tituloPisCofins": [],
"valorTaxaCartao": 0.0,
"meioPagamentoIdentificador": 3,
"meioPagamento": "DINHEIRO",
"contabilizar": 1,
"logCobrancaTitulos": [],
"valorOutraMoeda": 0.0,
"classificacaoPessoaIdentificador": 1,
"classificacaoPessoa": "ASSOCIADOS",
"tipoValoresTitulosTitulos": [],
"cupomDesconto": []
}
],
"tipoPagamentoNFe": "01-Dinheiro",
"tipoPagamentoNFeIdentificador": 1,
"bandeiraCartaoNFe": null,
"bandeiraCartaoNFeIdentificador": null,
"credenciadoraCreditoDebito": null,
"credenciadoraCreditoDebitoIdentificador": null,
"condicoesPagamentoIdentificador": 1,
"condicoesPagamento": "A VISTA",
"tipoIntegracao": 1,
"valorTroco": 0.0,
"valorLiquido": 1459.0,
"dataFinanceiraCartao": null,
"valorAcrescimo": 0.0,
"valorDesconto": 0.0,
"nrDiasMedios": 0,
"parcelas": "",
"naoGerarComissao": 0,
"tipoPagST": 0
}
],
"notaEmpenho": null,
"nrContrato": null,
"usuarioAutorizacaoDescontoIdentificador": null,
"usuarioAutorizacaoDesconto": null,
"serialForSync": "",
"valorAcrescCondPagamento": 0.0,
"valorDescCondPagamento": 0.0,
"modoReservaEstoque": 1,
"valorTotalBrutoDescTrib": 0.0,
"valorTotalDescTrib": 0.0,
"valorDescFinanceiro": 0.0,
"indicadorPresencaConsumidor": 1,
"tipoIntermediadorComercial": -1,
"valorLimiteDispAntesVenda": 0.0,
"valorLimiteDispPosVenda": 0.0,
"limiteCredito": 0.0,
"totalCompras": 0.0,
"valorDescontoTrib": 0.0,
"percDescontoTrib": 0.0
},
"countOf": 1,
"name": null,
"message": null,
"detailMessage": null
}
Consultar dados do faturamento de um pedido
A partir da versão 202505-01, o endpoint descrito abaixo foi adicionado com o intuito de consultar sobre o faturamento de um pedido. Como parâmetro, o endpoint recebe na própria URL o identificador do pedido e, como resposta, retorna dados da expedição e das respectivas notas geradas a partir do pedido.
URL: /touch-erp/auth/vendas/pedido-otimizado/consultar-dados-pedido-faturado/{identificador_pedido}
Método: GET
Exemplo JSON de resposta:
{
"@type": "WebDTOResult",
"status": "SUCESSO",
"messages": [],
"result": {
"identificador": 1,
"nrPedido": "",
"identificadorCliente": 11,
"nomeCliente": "CLIENTE TESTE",
"expedicoes": [
{
"identificadorExpedicao": 111,
"numeroNota": 1111,
"serie": "1",
"identificadorNota": 11111
}
]
},
"countOf": 1,
"name": null,
"message": null,
"detailMessage": null
}
Problemas e soluções
E.ERP.1511.001 - Informe uma condição de pagamento. Verifique se na requisição está informado corretamente uma condição de pagamento
E.ERP.1511.002 - Informe parcelas válidas. Se a condição de pagamento é mutante e não foi informado nenhuma configuração para as parcelas, essa exceção é lançada.
E.ERP.1511.003 - O usuário logado não está cadastrado como representante. Somente um representante pode realizar pedidos e, caso o usuário logado não possua cadastrado com esse status, então o cadastro de pedidos não poderá ocorrer.
E.ERP.1511.004 - Produto não está definido na tabela de preços base. De acordo com os parâmetros do pedido, foi realizado uma busca da tabela de preços principal e vinculada mas nenhuma foi encontrada para o produto informado.
E.ERP.1511.005 - Tabela de preços vencida. A tabela de preços encontrada encontra-se vencida e não poderá ser aplicada.
E.ERP.1511.006 - Nenhuma condição encontrada para os parâmetros. Nenhuma tabela de preços (dinâmica) foi encontrada aplicando as informações do pedido. Saiba mais sobre a tabela dinâmica em Modulo Vendas Tabela Precos Dinamica
E.ERP.1511.007 - Informe um produto válido. Nenhum produto foi encontrado com o identificador informado.
E.ERP.1511.008 - Não foi possível buscar o estoque do produto. Foi realizado uma tentativa de buscar o estoque do produto no banco de dados mas o retorno não é válido. Contate nossa equipe para análise.
E.ERP.1511.009 - Informe um produto válido. O produto informado não existe no servidor.
E.ERP.1511.010 - O produto não aceita quantidade fracionada. Foi informado uma quantidade decimal para o item mas o mesmo está configurado para não aceitar números fracionados.
E.ERP.1511.011 - O valor unitário deve ser maior que zero. O valor informado pelo usuário não pode ser igual ou inferior a zero.
E.ERP.1511.012 - Informe as informações do pedido. A requisição recebida não possui as informações do pedido. Verifique se a padronização utilizada está de acordo com nossa resolução.
01-02-00735 - As parcelas informadas ultrapassam o máximo de número de dias médios definidos na condição ou condição inválida. Verifique a parametrização da condição de pagamento e das parcelas informadas.
01-02-00736 - Produto sem Tabela de Preço Código, tabela de preço expirada, ou sem tabela principal. Verifique no Mentor a tabela de preço para o produto informado e seu status.
01-02-00737 - Tipo de tabela de preço não suportado. Está configurado nas Opções de Faturamento uma tabela de preço que não identificamos.
01-02-00738 - Produto sem grades ou grades inativas.