Codat to BigQuery

This page provides you with instructions on how to extract data from Codat and load it into Google BigQuery. (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.

What is Google BigQuery?

Google BigQuery is a data warehouse that delivers super-fast results from SQL queries, which it accomplishes using a powerful engine dubbed Dremel. With BigQuery, there's no spinning up (and down) clusters of machines as you work with your data. With all of that said, it's clear why some claim that BigQuery prioritizes querying over administration. It's super fast, and that's the reason why most folks use it.

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
}

Loading data into Google BigQuery

Google Cloud Platform offers a helpful guide for loading data into BigQuery. You can use the bq command-line tool to upload the files to your awaiting datasets, adding the correct schema and data type information along the way. The bq load command is your friend here. You can find the syntax in the bq command-line tool quickstart guide. Iterate through this process as many times as it takes to load all of your tables into BigQuery.

Other data warehouse options

BigQuery is really great, but sometimes you need to optimize for different things when you're choosing a data warehouse. Some folks choose to go with Postgres or Redshift, which are two RDBMSes that use similar SQL syntax. If you're interested in seeing the relevant steps for loading this data into Postgres or Redshift, check out To Redshift and To Postgres.

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 Google BigQuery data warehouse.