Codat to Amazon S3

This page provides you with instructions on how to extract data from Codat and load it into Amazon S3. (If this manual process sounds onerous, check out Stitch, which can do all the heavy lifting for you in just a few clicks.)

What is Codat?

Codat provides a standardized data format across multiple accountancy software applications and financial APIs.

What is S3?

Amazon S3 (Simple Storage Service) provides cloud-based object storage through a web service interface. You can use S3 to store and retrieve any amount of data, at any time, from anywhere on the web. S3 objects, which may be structured in any way, are stored in resources called buckets.

Getting data out of Codat

Codat exposes data through a REST API, which developers can use to extract information. To access information, you can use a GET method to retrieve data via the Codat API. Codat exposes data from customers, suppliers, invoices, bills, payments, creditNotes, and bankStatements endpoints. You can use an optional query parameter in the format [propertyName][operator][value] to select only certain data. Operators include "equal to" (%3d) and, for numeric and date values, "greater than" (%3e), and "less than" (%ec). So, to retrieve invoices for a customer whose ID is "61," you would call:

GET /companies/[companyId]/data/invoices?query=customerRef.id%3d61

Sample Codat data

A GET call returns a JSON object with all the fields of the specified dataset as a reply. Invoices, for example, have 11 possible properties, though all of them may not be present for any given record, so the JSON might look like:

{
    "id": "20",
    "invoiceNumber": "1001",
    "customerRef": {
      "id": "55",
      "companyName": "Oxon - Holiday Party"
    },
    "issueDate": "2017-01-24T00:00:00",
    "dueDate": "2017-02-23T00:00:00",
    "currency": "GBP",
    "totalAmount": 10800,
    "amountDue": 0
}

Loading data into Amazon S3

To upload files you must first create an S3 bucket. Once you have a bucket you can add an object to it. An object can be any kind of file: a text file, data file, photo, or anything else. You can optionally compress or encrypt the files before you load them.

Keeping Codat up to date

At this point you've coded up a script or written a program to get the data you want and successfully moved it into your data warehouse. But how will you load new or updated data? It's not a good idea to replicate all of your data each time you have updated records. That process would be painfully slow and resource-intensive.

Instead, identify key fields that your script can use to bookmark its progression through the data and use to pick up where it left off as it looks for updated data. Auto-incrementing fields such as updated_at or created_at work best for this. When you've built in this functionality, you can set up your script as a cron job or continuous loop to get new data as it appears in Codat.

And remember, as with any code, once you write it, you have to maintain it. If Codat modifies its API, or the API sends a field with a datatype your code doesn't recognize, you may have to modify the script. If your users want slightly different information, you definitely will have to.

Other data warehouse options

S3 is great, but sometimes you want a more structured repository that can serve as a basis for BI reports and data analytics — in short, a data warehouse. Some folks choose to go with Amazon Redshift, Google BigQuery, PostgreSQL, Snowflake, Microsoft Azure SQL Data Warehouse, or Panoply, which are RDBMSes that use similar SQL syntax. If you're interested in seeing the relevant steps for loading data into one of these platforms, check out To Redshift, To BigQuery, To Postgres, To Snowflake, To Azure SQL Data Warehouse, and To Panoply.

Easier and faster alternatives

If all this sounds a bit overwhelming, don’t be alarmed. If you have all the skills necessary to go through this process, chances are building and maintaining a script like this isn’t a very high-leverage use of your time.

Thankfully, products like Stitch were built to move data from Codat to Amazon S3 automatically. With just a few clicks, Stitch starts extracting your Codat data via the API, structuring it in a way that's optimized for analysis, and inserting that data into your Amazon S3 data warehouse.