How Do I Export My Data to CSV?


Posted 1 year ago in Support
by Brad Hanks

ZipBooks is working towards having a user-friendly way to export all your data. Until then you can use our API to access all the data in your account. I know that not everyone reading this for the first time will have experience working with an API so I have tried to give enough instructions that even users without much of a technical background will have success.

Accessing your account

In order to access your data via the API you are going to need a way to run the commands. I recommend using Postman. They have a intuitive interface that can run from Chrome.

Once you have Postman open, you will want to log in to get a token to access further information about your account. A token is a key used to unlock this information and will expire after a certain period of time.

The first instruction we are going to send using Postman:

https://api.zipbooks.com/v1/auth/login?email=[your email]&password=[your password]

  1. Set the HTTP request method to POST.
  2. Copy and paste the instructions into the URL bar.
  3. Replace the email and password with your email and password.
  4. Click SEND.

If you do it correctly you will get a response with a token. Select the whole string between the quotes.

I put together a demo video that walks you through the process of getting a token.

Listing all invoices

Once you have a token, you can use it to list all invoices:

https://api.zipbooks.com/v1/invoices?token={token}

In this case we need to use GET to receive the information that we want from the account. Using Postman again,

  1. Set the HTTP request method to GET.
  2. Copy and paste the instructions into the URL bar.
  3. Replace the token placeholder {token} with the token you received from the previous step.
  4. Click SEND.

After you submit to Postman, you should see a JSON response body that is formatted like this:

[
  {
    "id": 47928,
    "account_id": 254,
    "customer_id": 9103,
    "recurring_profile_id": null,
    "estimate_id": "",
    "external_id": "C7yqSGt48QLTQMblGjubEaeIf5F1A2zWU4oOwC2Q",
    "google_drive_id": "",
    "number": "Hanks-0005".....

You can copy the whole JSON response into a JSON to CSV conversion tool and now you have all the data you want in a CSV format. Easy right? Let’s go through one more example that might be useful.

Listing all customers

Using the endpoint to list all customers is very similar to the process to list all invoices:

https://api.zipbooks.com/v1/customers?token={token}

Like the process to get all invoices, you also use GET to list all customers. Using Postman again, repeat the same four steps listed above.

After you submit to Postman, you should see a JSON response body that is formatted like this:

[
  {
    "id": 18999,
    "account_id": 9575,
    "name": "Customer Example",
    "email": "example@example.com",
    "phone": "",
    "attention_to": "",
    "address_1": "1278 W 125 S",
    "address_2": "",
    "city": "Lehi",
    "state": "UT",
    "postal_code": "84043",
    "country": "United States",
    "website": "",
    "stripe_customer_id": "",
    "created_at": "2016-03-15 13:43:49",
    "updated_at": "2016-03-15 13:43:49",
    "archived_at": null,
    "deleted_at": null,
    "singular": "customer",
    "plural": "customers"
  },......

Click into the Postman response box, select all and copy and paste it into the JSON to CSV conversion tool of your choice.

A complete list of all the queries that you can do once you have a token are listed in our API documentation.


About Brad

Brad Hanks is in charge of Growth at ZipBooks.

  • Michael Beech CIMA Dip MA FMAA

    yeah you really need csv to be on par with all those other apps guys. So please build it quick !!

    • Tim Chaves

      Thanks Michael, it’s on the roadmap!

  • Kahnrad Awalt

    We would use and pay for your product in a heartbeat if we could export Accounts Payable.

    • Tim Chaves

      Thank Kahnrad — exporting reports to CSV is near-term roadmap for us, hang in there! 🙂

  • paprique

    Any news on exporting data?

  • Cary Yedinak

    We are in the process of evaluating ZipBooks for our business and being able to export time tracking to excel or CSV is a key feature that is required by our clients. An update on any progress regarding this would be appreciated.

  • Elliott Morris

    Echoing the question from others – when will exporting be available? I am unable to reconcile my bank statements against what Zipbooks is showing, and without export capability it is very difficult to debug.