API connectors
Let an external app post cashflow into Oflync — without sharing your partner login.
What it does
API connectors give you an API key that is bound to one outlet. A trusted system (for example Whatzneu sending a monthly cash summary) can call Oflync with that key and record inflow or outflow for that outlet only.
The key is not a login. It cannot open your Partner Portal, change settings, or post cashflow for any other outlet.
Who it's for
- Partners who already use Cashflow
- Businesses that keep collections in another product and want Oflync to stay up to date
- Integrators who need a dedicated, key-based cashflow capture API
How to create a key
- Log in to the Partner Portal
- Open API connectors (sidebar), or Settings → Team & access → Manage API keys, or Cashflow → API connectors
- Click Create API key
- Enter a name (for example
Whatzneu monthly cashflow) - Choose the outlet this key may post to
- Choose expiration: No expiration, 3 months, 6 months, 1 year, or a custom date
- Click Create key
- Copy the secret immediately — Oflync will not show the full key again
Share the secret only with the system that will call Oflync (for example your Whatzneu workspace). Treat it like a password.
How to give it to Whatzneu
Send your integrator:
| What they need | Where you find it |
|---|---|
| API key secret | Shown once when you create or rotate the key |
| Outlet ID | The outlet you selected when creating the key (also listed on the key) |
| Capture URL | See Cashflow connector API |
| API spec (OpenAPI) | Swagger-style reference · YAML |
Ask them to send a unique externalReference each month (for example whatzneu-2026-08-income) so a retry updates the same entry instead of duplicating it.
Managing the key lifecycle
On API connectors you can:
| Action | What it does |
|---|---|
| Create | Issues a new secret, shown once |
| Rotate | Revokes the old secret and issues a new one (update Whatzneu right away) |
| Revoke | Stops the key immediately; calls will fail |
| Last used | Shows when the key last called Oflync |
Revoked and expired keys stay in the list so you can see history. You can have up to 10 active keys.
What appears in Cashflow
Posted entries show on that outlet ’s Cashflow ledger with source EXTERNAL_API. You can review or delete them like a manual entry if a figure was wrong.
Connectors that already track every sale or bill should send period totals (inflow + outflow). Oflync computes net cashflow. See Cashflow connector API.
Cashflow must be active on your subscription or the connector call is rejected.
Tips
- One key per connector per outlet — easier to revoke if something leaks
- Rotate if a contractor leaves or a secret might have been copied
- Use a name that includes the partner and the outlet, e.g.
Whatzneu · MG Road
Common questions
Can I use the same key for all outlets?
No. Each key is bound to one outlet. Create another key for another location.
I closed the copy dialog without saving the secret.
Rotate the key to get a new secret. The old one is revoked.
Does this connect my bank?
No. It only lets an approved app post cashflow numbers into Oflync.
Is this the same as Billing Desk Access?
No. Billing Desk Access is for staff PIN login on the till. API connectors are for server-to-server calls.