Try a call
Pick a call, fill it in, and see what comes back. Or copy the line and run it wherever you like.
From Settings, then API keys inside ObraLedger. It stays in this tab and goes nowhere else - we don't save it, and it isn't in the address bar.
A key can only do what the person who made it can do, and only for one company. Even so, a write here writes to your real books. Read calls are the safe way to look around.
Fill it in
What you're sending
Click a field to add it. These are the ones you're allowed to set - everything else is ours to fill in.
Nothing is sent until you press this.
What came back
Before you build against it
Three things catch people out, and all three are cheaper to know now than to find in production.
- Money comes back as text. Keep it that way. A JSON number is a float to most parsers, and a float loses cents.
- Lists don't carry a total. Follow the
Linkheader until it stops. - Anything that creates needs an idempotency key. Retrying without one is how you get two of something.
All three, with the reasoning, are on how the API behaves.
Building something and stuck? Tell us - we'd rather hear it than have you guess.