API: consultas de agenda, atendimentos, MDF-e, financeiro, estoque, fiscal e da conta
Entre 27 e 30 de outubro de 2026, a API passou a consultar muito mais partes do sistema: agenda, atendimentos, MDF-e, caixas, boletos, extratos, notas de entrada, trocas e devoluções, painel das ordens de serviço e os dados do plano e da conta. Os relatórios já somados ganharam artigo próprio.
Quase tudo o que entrou é somente consulta: a API lê a informação, mas cadastrar, editar, emitir ou excluir continua sendo pela tela do sistema. A exceção são os canais de venda, que também aceitam cadastro, edição e exclusão.
Cada consulta tem a sua seção na documentação da API, com os filtros aceitos e um exemplo de retorno.
As regras que valem para quase todas
- Período: data inicial e final no formato AAAA-MM-DD, as duas juntas. Sem datas, vem o mês atual. O período máximo é de 12 meses.
- Permissão: a API segue a mesma permissão da tela. Se o usuário da chave não pode ver aquilo no sistema, a API recusa.
- Lojas: sem informar a loja, vêm todas as lojas que o usuário da chave acessa.
- Só o que é dele: caixas, compromissos, chamados e cotações seguem a mesma regra da tela. Se o usuário da chave só vê os próprios registros no sistema, a API também traz só os dele.
- Lista: paginada, com no máximo 100 registros por página.
Agenda
- Os compromissos do período, os de um dia (a data é obrigatória) e os próximos compromissos do usuário da chave, além do detalhe de cada um, com histórico e lembretes.
- As situações da agenda.
Atendimentos
- Os chamados do período (pela data de abertura) e o detalhe de cada um. Abrir o chamado pela API não o marca como lido.
- Os assuntos, as formas, as situações e os campos extras de atendimentos.
MDF-e
- A lista e o detalhe dos manifestos, filtrando por número, série, situação, placa e condutor.
- Exige o MDF-e contratado no plano.
- A API não devolve o XML e não emite, encerra nem cancela o manifesto.
Financeiro
- Caixas: os caixas abertos e fechados, com saldo, e o detalhe de cada um, com os totais por forma de pagamento e a conferência do fechamento. Abrir, fechar, sangria e reforço continuam na tela.
- Boletos: os recebimentos emitidos como boleto, com a situação da remessa e do último envio. A linha digitável e o código de barras não vêm na consulta.
- Totais de contas a pagar e a receber: o mesmo quadro da tela (total, em aberto, vencidos, vencem hoje, a vencer e pagos ou recebidos).
- Histórico de um lançamento: a linha do tempo de um pagamento ou de um recebimento.
- Painel das contas bancárias: o saldo de cada conta numa data (sem data, hoje).
- Extratos bancários: os extratos importados e, no detalhe, cada linha com a situação da conciliação (conciliado, sugestão, divergente ou arquivado). Importar, conciliar e arquivar continuam na tela.
- Grupos do DRE, com os subgrupos.
Estoque e compras
- Movimentações de estoque de um produto: o produto é obrigatório na consulta.
- Cotações de compra, com o detalhe de cada uma.
- Campos extras de compras.
Fiscal
- Notas fiscais de entrada (as notas de compra), pelo período de emissão ou pela chave da nota. O XML e o DANFE não vêm na consulta.
- CFOP e NCM: a busca de NCM pede ao menos 2 caracteres, e o detalhe mostra as regras fiscais da empresa para aquele NCM.
- Naturezas de operação de NF-e e NFC-e e intermediadores de transação.
Vendas e ordens de serviço
- Trocas e devoluções, com o detalhe de cada uma.
- Painel das ordens de serviço (prazos, prioridades e faturamento de uma loja) e o quadro (kanban), com a quantidade e o valor das ordens em cada situação.
- Canais de venda: consultar, cadastrar, editar e excluir. O canal padrão e o canal já usado não podem ser excluídos.
Cadastros
- Histórico do preço de venda de um produto.
- Modelos de etiqueta.
- Detalhe da loja.
- Busca de CEP, que devolve o endereço a partir de um CEP de 8 dígitos.
- Grades, tabelas de preço e unidades já aceitavam cadastro, edição e exclusão; marcas, grupos de serviços e grupos de permissões são só consulta.
Plano e conta
- Renovação do plano, com os dias para vencer e os recursos extras, e o boleto da renovação. Se o plano estiver vencido e não houver cobrança recente, pedir o boleto gera a cobrança; pedir de novo devolve a mesma.
- Simulação de periodicidade (o plano atual em cada periodicidade e a economia) e preços dos recursos.
- Aplicativos do plano (contratados, em teste e disponíveis) e integrações ativas.
- Dados da empresa e configurações gerais, loja por loja. Senhas e dados de acesso não vêm na consulta.
- Certificado digital: a situação (válido, vencido, senha incorreta ou ausente), a validade, os dias para vencer, o titular e o emissor, loja por loja. O arquivo e a senha do certificado nunca saem pela API.