Guides¶
Task-oriented walkthroughs. Each guide takes you end-to-end through a single piece of work — the steps, the API calls, and the decisions you'll have to make on the way.
If the API reference is "what exists", this section is "how to actually do something". Reach for guides when you have a goal; reach for the reference when you have a question about a specific endpoint.
Pre-1.0 — design preview, not a contract
These guides describe the intended end-to-end experience. Some of the endpoints and flows referenced are still being implemented; others may change shape before 1.0 ships. Read them as a tour of where SAE Books is heading, not as a how-to you can rely on for a production integration today. If you spot a guide step that doesn't match what the live API does, the API is currently authoritative — but neither is yet a frozen contract.
Guide index¶
| Guide | What you'll do |
|---|---|
| First chart of accounts | Set up the chart, post an opening balances journal, see it in the trial balance |
| Connect a bank feed | Create a connection via the relay, complete CDR consent, sync first transactions |
| File your first BAS | Tag transactions, prepare BAS labels, create the settlement entry or lodge via SBR |
| Migrate from Xero / MYOB | Export from incumbent, transform to SAE Books schema, import |
| Build an integration | OAuth-handoff dance, JWT lifecycle, webhooks, idempotency |
| Self-host in production | Compose hardening, Postgres tuning, backup, TLS, observability |
Conventions used in guides¶
- Code samples show
curl, with$SAEBOOKS_API_BASEand$JWTas bash variables. Substitute your own. - JSON payloads use the canonical key ordering from the OpenAPI spec; key order is not significant on the server.
- Endpoints link to the relevant section of the generated reference so you can see the full schema if you need it.
- Provisional sections are flagged with a callout. If the underlying feature ships before the guide is updated, the spec is authoritative — file an issue and we'll catch the prose up.