Codat to Snowflake

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

About Codat

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

About Snowflake

Snowflake is a data warehouse solution that is entirely cloud based. It's a managed service. If you don't want to deal with hardware, software, or upkeep for a data warehouse you're going to love Snowflake. It runs on the wicked fast Amazon Web Services architecture using EC2 and S3 instances. Snowflake is designed to be flexible and easy to work with where other relational databases are not. One example of this is the query execution. Snowflake creates virtual warehouses where query processing takes place. These virtual warehouses run on separate compute clusters, so querying one of these virtual warehouses doesn't slow down the others. If you have ever had to wait for a query to complete, you know the value of speed and efficiency for query processing.

Getting data out of Codat

Codat exposes data through a REST API, which developers can use to extract information. To access information, you must know your organization’s API authentication key. Once you have that in hand, 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

The 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
}

Preparing data for Snowflake

Depending on the structure that you data is in, you may need to prepare it for loading. Take a look at the supported data types for Snowflake and make sure that the data you've got will map neatly to them. If you have a lot of data, you should compress it. Gzip, bzip2, Brotli, Zstandard v0.8 and deflate/raw deflate compression types are all supported.

One important thing to note here is that you don't need to define a schema in advance when loading JSON data into Snowflake. Onward to loading!

Loading data into Snowflake

There is a good reference for this step in the Data Loading Overview section of the Snowflake documentation. If there isn’t much data that you’re trying to load, then you might be able to use the data loading wizard in the Snowflake web UI. Chances are, the limitations on that tool will make it a non-starter as a reliable ETL solution. There two main steps to getting data into Snowflake:

  • Use the PUT command to stage files
  • Use the COPY INTO table command to load prepared data into the awaiting table from the prior step.

For the COPY step, you’ll have the option of copying from your local drive, or from Amazon S3. One of Snowflakes’ slick features lets you to make a virtual warehouse that will power the insertion process.

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 solve this problem automatically. With just a few clicks, Stitch starts extracting your Codat data via the API, structuring it in a way that is optimized for analysis, and inserting that data into your Snowflake data warehouse.