Guides
Concepts explain how one part of FinBaze works. Guides put the parts together for a kind of product. Every guide ends with how to try it in the sandbox: a seeded demo company, a test clock and a webhook receiver you can run locally.
By partner type#
| You are | Start here | You will use |
|---|---|---|
| A bank or neobank | Banks | Bank feed push, booking-chip, receipts from the camera, VAT paid from the account, tax reservation |
| A point-of-sale vendor | Point of sale | Z-report as a custom record, a flow template, tips and cash differences, VAT return |
| A logistics or TMS vendor | Logistics | Shipment record, invoice from a flow template, carrier invoices, ICP and OSS, reverse charge |
| An e-commerce platform | E-commerce | Orders to invoices, OSS, refunds as credit notes |
| A scheduling or workforce product | Scheduling and hours | Worked hours feed, employees and employments |
By part of FinBaze#
| Part | Guide |
|---|---|
| Bank data, statements, feed health | Data sources |
| What FinBaze says to your users | Messages and routing |
| Invoices and payslips in your branding | Documents |
| Hiding parts of FinBaze for some companies | Features and limits |
| Accounting firms on your companies | Firms |
| Closing, moving and exporting a company | Lifecycle and migration |
| iOS, Android and React Native | Mobile |
Runnable examples#
Sample apps lists the six sample repositories, each with a deploy button, a README and an end-to-end script that runs against the sandbox every night.
How these guides were checked#
Every GraphQL block in these pages is validated against the current schema in CI, and every operation name they mention must exist in it. Flow templates in the guides are the same files that live in the sample apps, and those are parsed by the API's own template parser in the API test suite. Where a guide depends on something that is not released yet, it says so in a note.