Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status

Exports

Exports allow you to download large amounts of data from your Increase account. This is useful if you want to analyze your account data in other tools or migrate to another service.


Making an Export

You can create an Export in the API or Dashboard. Once you create an Export, it will have status: pending. When it's ready, it will transition to status: complete and the file_id and file_download_url attributes will be set on the Export API object. We'll send you a webhook for this and optionally notify you via email.

Lifecycle

Export statuses

StatusDescription
pendingThe Export file is being created and is not ready to download.
completeThe Export file has been created and is ready to download.
failedThe Export file failed to be created.

Types of Export

When you create an Export, you'll need to indicate what category of data you want to download. You can also filter the data by specifying time ranges, accounts, and programs. We're working on more export types, but please let us know if there's a field or type that would be helpful to you!

CategoryDescription
account_statement_ofxAn Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
balance_csvA CSV of account balances for the dates in a given range.
bookkeeping_account_balance_csvA CSV of bookkeeping account balances for the dates in a given range.
dashboard_table_csvCertain dashboard tables are available as CSV exports. This export cannot be created via the API.
entity_csvA CSV of entities with a given status.
transaction_csvA CSV of all transactions for a given time range.
vendor_csvA CSV of vendors added to the third-party risk management dashboard.

Backwards compatibility

Exports are currently in beta, and we'll occasionally add or remove columns to our reports depending on user feedback. This might change the absolute ordering of columns. If you're automatically ingesting these CSVs in code, we recommend you not rely on column ordering and instead use the column headers to know how to parse each column.