Aqui você encontra um resumo completo das APIs públicas que você pode usar com Factorial para criar integrações de despesas, automações, exportações e fluxos em tempo real. Ele indica as páginas de documentação corretas e recomenda quais endpoints e recursos usar para os cenários mais comuns.
Consulte os guias do desenvolvedor Factorial Factorial para uma orientação rápida: Introdução, Autenticação (chaves de API e OAuth), Webhooks, Paginação e construção de integrações. Esses guias mostram os fluxos recomendados, métodos de autenticação e notas de implementação.
Recursos principais da API que você usará para despesas
A referência da API expõe os recursos mais úteis para automação e reconciliação de despesas. Os principais recursos incluem:
- Despesas e Contas a Pagar (ler e inspecionar registros de despesas)
- Pontos finais de milhagem e PerDiem para dados programáticos de per diem e milhagem
- Documentos para anexos e URLs de download
- Terminais bancários como CardPayment e Transaction para reconciliar a atividade do cartão
- Pontos de extremidade financeiros , como JournalEntry , FinancialDocument , AccountingSetting , CostCenter para lançamento e mapeamento
Você encontrará a lista completa de recursos na referência da API. Factorial
Casos de uso prático e endpoints recomendados
- Exportação de despesas programaticamente
- Use os endpoints Despesas/Consumíveis para extrair dados em nível de transação. Inclua campos como valor do documento, valor reembolsável, moeda, taxa de câmbio, status de aprovação, link de recibo/documento, códigos contábeis e projeto/centro de custo. Verifique se o recurso suporta apenas GET ou crie/atualize com base na referência.
- Manipulando anexos e recibos
- Use o recurso Documentos para recuperar URLs de download ou vincular documentos a despesas. Se precisar de anexos incorporados para um ERP, considere solicitar um extrato SQL/pacote personalizado via Factorial em vez de baixar repetidamente anexos binários via API.
- Reconciliação de transações de cartão
- Use endpoints bancários (CardPayment, Transaction) para comparar feeds de emissores/cartões com registros de despesas. Inclua card_last4 e identificadores de transações em suas exportações para uma correspondência confiável.
- Diárias e automação de quilometragem
- Extraia os pontos finais de PerDiem e Milhagem para reconciliar as reivindicações de per diem com os recibos enviados e para calcular ajustes de folha de pagamento quando necessário.
- Notificações em tempo real e sincronizações bidirecionais
- Assine os webhooks para receber notificações sobre expense.created, expense.updated, card.payment ou eventos semelhantes (consulte o guia de Webhooks). Use webhooks para acionar fluxos de trabalho posteriores, como alertas do Slack, criação de faturas ou tarefas do agendador.
Notas importantes de implementação e melhores práticas
- Autenticação - Use chaves de API ou OAuth, conforme documentado nos guias de Introdução. Alterne as chaves e siga as práticas recomendadas de armazenamento seguro. Factorial
- Verifique as capacidades dos recursos - Alguns endpoints são somente leitura, enquanto outros aceitam POST/PUT. Confirme na referência antes de codificar. Factorial
- Paginação - Sempre implemente a paginação para os pontos finais da lista para evitar timeouts ou dados parciais. Consulte o guia de paginação para obter detalhes. Factorial
- Webhooks - Use assinaturas de webhooks para fluxos em tempo real e implemente manipuladores idempotentes. Veja políticas e exemplos de webhooks na documentação. Factorial
- Controle de versão e registro de alterações - Vincule solicitações a uma versão específica da API e monitore o registro de alterações para detectar alterações significativas. Verifique o registro de alterações com frequência durante o desenvolvimento e antes das implantações em produção. Factorial
- Exportar campos para solicitação - inclua document_amount, reimbursable_amount, currency, exchange_rate, base_amount, receipt_url, approval_status, accounting_account_code, project_code, cost_center, card_last4 para reconciliação downstream limpa. (Esses são campos recomendados, não requisitos rigorosos da API.)
Dicas operacionais e de tratamento de erros
- Detecte e reconcilie diferenças de câmbio incluindo
document_amount
ebase_amount
comexchange_rate
. - Para grandes extrações históricas, prefira relatórios agendados do SQL Analytics ou a equipe de dados em vez de grandes extrações repetidas de API.
- Limites de taxa, cotas ou acesso especial podem ser aplicados. Consulte os guias de Introdução e a referência da API para obter notas de uso. Factorial
Onde encontrar detalhes e acompanhar alterações
- Guias para desenvolvedores e inícios rápidos: páginas de introdução. Factorial
- Referência completa de endpoint e lista de recursos: Referência de API. Factorial
- Histórico de versões e registro de alterações significativas: Changelog. Factorial
Precisa de ajuda ou quer um extrato personalizado?
Se precisar de um CSV/XLSX agendado, anexos incorporados ou uma junção complexa entre despesas e transações de cartão, solicite um relatório personalizado do SQL Analytics por meio do Suporte. Para dúvidas técnicas sobre APIs, use o formulário de Contato/Suporte Técnico na documentação. Factorial