Codat to Google Data Studio

This page provides you with instructions on how to extract data from Codat and analyze it in Google Data Studio. (If the mechanics of extracting data from Codat seem too complex or difficult to maintain, 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 Google Data Studio?

Google Data Studio is a simple dashboard and reporting tool. It's free and easy to use, but it lacks the sophisticated features of higher-end reporting software. Many of the connectors it supports are for Google products, but third parties have written partner connectors to a wide variety of data sources. Its drag-and-drop report editor lets users create about 15 types of charts.

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 Google Data Studio

Google Data Studio uses what it calls "connectors" to gain access to data. Data Studio comes bundled with 17 connectors, mostly to pull in data from other Google products. It also supports connectors to MySQL and PostgreSQL databases, and offers 200 connectors to other data sources built and supported by partners.

Using data in Google Data Studio

Google Data Studio provides a graphical canvas onto which users drag and drop datasets. Users can set dimensions and metrics, specify sorting and filtering, and tailor the way reports and charts are displayed.

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.

From Codat to your data warehouse: An easier solution

As mentioned earlier, the best practice for analyzing Codat data in Google Data Studio is to store that data inside a data warehousing platform alongside data from your other databases and third-party sources. You can find instructions for doing these extractions for leading warehouses on our sister sites Codat to Redshift, Codat to BigQuery, Codat to Azure SQL Data Warehouse, Codat to PostgreSQL, Codat to Panoply, and Codat to Snowflake.

Easier yet, however, is using a solution that does all that work for you. Products like Stitch were built to move data automatically, making it easy to integrate Codat with Google Data Studio. With just a few clicks, Stitch starts extracting your Codat data, structuring it in a way that's optimized for analysis, and inserting that data into a data warehouse that can be easily accessed and analyzed by Google Data Studio.