We've got your whole API integration accountedfor

If you've landed here, you're in the right place to automate your financial accounts. We're delighted to introduce the next generation of API-driven accounting & payments. Welcome aboard!

A note on documentation updates

⚠️ These docs are in alpha at the moment, if you find any issues bugs or discrepancies, please report them to david@accountedfor.com.au for expeditious support and remediation. Thank you!

First Steps

accountedfor introduces a few new concepts for software developers that cross over into accounting, audit and legal principles but that should have a small learning curve for anyone that has integrated payments or interacted with a public-facing application store on the internet.

A Legal Entity on accountedfor is the base building block of business throughout the world. In fact, the business you work for may be its own legal entity. Also, in most jurisdictions, a person themselves is a legal entity - and may be entitled to trade as a Sole Trader or Sole Proprietor themselves.

Most APIs have a Test Mode, but accountedfor has a Sandbox Company:

    Sandy Shores (Proposed Name)

This company is a not-yet-formed Australian Private Company, which means it has a Director, Shareholders and Software Developers (Employees).

Anyone in the world can be an employee of Sandy Shores, and any employee can create a Customer and Invoice for Sandy Shores as these financial records will never be production records (i.e. always execute transactions in Sandbox).

People Records

In order to obtain an API Key to process transactions on behalf of the company, you must first create a person account in Production on accountedfor.

Passkeys

All people that operate on behalf of another legal entity (such as a Company, whether in Sandbox or Production) must hold a valid Passkey. More information on Passkeys can be obtained here: The beginning of the end of the password

To get started, create your accountedfor Passkey here:

https://platform.accountedfor.com.au/register

Machine Records

To enable a machine to create a financial record, you need to obtain an API Key. An API Key is a JSON Web Token (JWT) issued and signed by accountefor in the name of a legal entity and tagged as a machine credential.

Please note! As this is a living document, the format, validity and acceptance of accountedfor JWT machine credentials are subject to change. accountedfor is presently working with its Software Developer partners to ensure reliability, availability and resilience of its financial, accounting and recordkeeping systems as they grow and will guarantee API version stability for a minimum of 12 months before introducing any breaking changes.

Please get in touch with accountedfor early if your integration requires longer than 12 months of version stability at this time.

Next Steps

Once you have created a personal, Production passkey under your own email address and verified your email address, you may gain access to Sandy Shores (Proposed Name) by accessing Settings > Advanced > Generate API Key.

GenerateAPIKey

Your first Authority will be Sandy Shores (Proposed Name), and you will be able to do almost all things on behalf of a company that an employee can do.

If you need to do something new, please get in touch with accountedfor. For now, the only things you can do are to create a Customer of Sandy Shores and then create an Invoice from Sandy Shores to the Customer you have created, however short of Registering Sandy Shores to recieve an Australian Company Number (ACN) we envisage simulation of almost everything else - such as lodging a Sandbox Tax Return, authorising another employee, adding or changing Sandbox Shareholdings etc.

We cannot wait to see what our Software Developer community requests next.

Visit the next section: Authentication