REST APIs

What this connects

Your own software to business records over an authenticated HTTP API.

Supported workflows

• Building an internal tool on top of business data
• Feeding a data warehouse
• Automating bulk operations
• Powering a customer or supplier portal

Data exchanged

• Whatever the authorised scopes permit — typically masters, transactions and reports

Setup requirements

• API credentials issued for your account
• Scope selection limiting what the credential can reach
• A development environment for testing

Permissions required

• Scoped access per credential, following least privilege

Security and privacy

• Data is transmitted over encrypted connections (TLS).
• Credentials are scoped and can be revoked individually without affecting others.
• API access is logged for audit.

Known limitations

Stated plainly, because finding these out during implementation is worse than knowing them now.

• Rate limits apply and are documented at issue time.