Guides
Task-oriented resources for building real integrations. Unlike the API reference, which documents what endpoints exist, guides walk you through common patterns and integration scenarios.
Recipes
Section titled “Recipes”Recipes are focused patterns for specific integration tasks — one job, the key API surface, and the implementation notes that matter when wiring a real system. Each recipe is deliberately small and practical.
Use recipes when you understand the platform basics and want a working pattern for creating records, subscribing to events, or querying reporting data.
- Setting up HttpClient — Configure a reusable .NET HttpClient for authenticated Efimis REST API calls.
Clients & matters
Section titled “Clients & matters”- Creating a client — Create an entity first, then assign the client role to that entity.
- Creating a matter — Open a matter from an existing client and leave firm-specific setup to authorised users.
Time & billing
Section titled “Time & billing”- Posting a work item — Create time entries and disbursements against a matter.
- Post a journal entry — Record general ledger postings from an external finance workflow.
- Reissue an invoice — Void and reissue an existing invoice without losing the audit trail.
- Apply credit notes — Create and apply a credit note against an outstanding invoice.
Ledger & trust
Section titled “Ledger & trust”- Reconcile a trust account — Query trust ledger activity and verify balances against a statement.
- Bulk-import opening balances — Import opening balances in bulk via the ETL pipeline.
Events & webhooks
Section titled “Events & webhooks”- Subscribing to general ledger postings — Push ledger posting events to an external accounting or reporting system.
- Subscribing to invoice issued events — Receive a webhook when an invoice is issued in Efimis.
Querying & reporting
Section titled “Querying & reporting”- Query for invoice list — Find invoices and inspect their line items through the API.
- Query profit and loss data — Use GraphQL to retrieve profit and loss reporting data.
- Generate a WIP report — Pull work-in-progress data for a billing period using GraphQL.
Scenarios
Section titled “Scenarios”Scenarios map common integration types to the API endpoints and events you will need. Use them when scoping a new integration to see how the pieces fit together.
Covered scenarios include time tracking, HR payroll, expense capture, CRM, general ledger, reporting, debt collection, client portals, onboarding, and case management.