Consulta via API
Manual para Consultas de dados via API
Este manual descreve como acessar as diferentes rotas da API para consultar informações do Syspro ERP
Exemplo Prático
As URLs fornecidas contêm os placeholders servidor e porta, que devem ser substituídos pelos valores reais do servidor e porta onde a API está hospedada. As URLs podem ser usadas tanto com o IIS (Internet Information Services) quanto sem ele, dependendo da configuração do seu sistema.
Vamos considerar o seguinte cenário:
- Servidor: api.minhaempresa.com
- Porta: 8080
- Data Inicial: 01/01/2024
- Data Final: 10/01/2024
Usando o IIS
Se a API estiver configurada para usar o IIS (Internet Information Services), a URL para consultar vendas de produtos ficaria assim:
Sem Usar o IIS
Se a API não estiver configurada para usar o IIS, a URL tem uma estrutura ligeiramente diferente:
Passo a Passo
Obter Credenciais
Entre em contato com o suporte para obter o usuário e a senha necessários para acessar a API. Utilize os canais de comunicação fornecidos na seção de suporte.
Configurar URL
Substitua os placeholders servidor e porta na URL com os valores reais do servidor e porta da sua empresa.
Autenticação
Utilize as credenciais fornecidas para autenticar-se na API. Isso pode ser feito utilizando ferramentas de integração como o Power BI, que suportam a autenticação básica ou token-based.
Enviar Solicitação
Acesse a URL configurada em seu navegador ou ferramenta de integração para obter os dados desejados.
Rotas
Vendas de Produtos
Campos disponíveis:
- Codigo empresa (emitente): Código da empresa emitente da venda.
- Numero da venda: Número identificador da venda.
- Nome Cliente: Nome do cliente.
- Cidade Cliente: Cidade do cliente.
- UF Cliente: Unidade federativa (estado) do cliente.
- Codigo Produto: Código do produto vendido.
- Descrição: Descrição do produto.
- Departamento: Departamento relacionado à venda.
- Unidade: Unidade de medida do produto.
- Quantidade: Quantidade do produto vendido.
- Valor unitario: Valor unitário do produto.
- Valor e ST: Valor e Substituição Tributária.
- Valor de Desconto: Valor de desconto aplicado.
- Valor de Frete: Valor do frete.
- Valor Total item: Valor total do item.
- Vendedor: Nome do vendedor responsável.
- Data da venda: Data da venda.
- Quantidades: Quantidades de produtos.
- Modelo 55, 99, 65: Modelos fiscais utilizados.
- Forma de pagamento: Forma de pagamento utilizada.
Movimentações de Estoque
Campos disponíveis:
- Codigo auxiliar: Código auxiliar do produto.
- Descrição Produto: Descrição do produto.
- Data Movimento: Data do movimento de estoque.
- Quantidade anterior: Quantidade anterior ao movimento.
- Quantidade Movimentada: Quantidade movimentada.
- Saldo: Saldo após o movimento.
- Documento: Documento relacionado ao movimento.
- Participante: Participante envolvido no movimento.
- Operação: Tipo de operação realizada.
Produção de Produtos
Campos disponíveis:
- Data: Data da produção.
- Observação: Observações sobre a produção.
- Produto: Produto produzido.
- Quantidade: Quantidade produzida.
- Produzido: Quantidade efetivamente produzida.
- Operador: Operador responsável pela produção.
Títulos a Pagar
Campos disponíveis:
- Codigo empresa: Código da empresa.
- Numero Documento: Número do documento.
- Nome Fornecedor: Nome do fornecedor.
- Data Emissão: Data de emissão do documento.
- Data Vencimento: Data de vencimento do pagamento.
- Data Pagamento: Data do pagamento.
- Valor: Valor a pagar.
- Juros/multa: Valor de juros ou multa.
- Desconto: Valor de desconto.
- Valor Total: Valor total a pagar.
- Forma de pagamento liquidação: Forma de pagamento utilizada na liquidação.
Títulos a Receber
Campos disponíveis:
- Codigo empresa: Código da empresa.
- Numero Documento: Número do documento.
- Nome Cliente: Nome do cliente.
- Tipo de Documento: Tipo de documento.
- Data Emissão: Data de emissão do documento.
- Data Vencimento: Data de vencimento do recebimento.
- Data Pagamento: Data do pagamento.
- Valor: Valor a receber.
- Juros/multa: Valor de juros ou multa.
- Desconto: Valor de desconto.
- Valor Total: Valor total a receber.
Rotas de Transporte
Campos disponíveis:
- Data: Data da rota.
- Cliente: Nome do cliente.
- Produto: Produto transportado.
- Quantidade: Quantidade transportada.
- Peso: Peso da carga.
- Veiculo: Veículo utilizado.
- Motorista: Motorista responsável.
- Rotas: Rota percorrida.
- Placa veiculo: Placa do veículo.
Precisa de ajuda e não encontrou aqui?
Entre em contato, estamos disponíveis para ajudar você com qualquer dúvida ou problema que possa ter.
- whatsapp: (34) 99771-3731
- E-mail: equipe@trilinksoftware.com.br