API Reference — Increase

Exports are batch summaries of your Increase data. You can make them from the API or dashboard. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our Exports documentation.

The Export object

{
  "category": "transaction_csv",
  "created_at": "2020-01-31T23:59:59Z",
  "file_download_url": "https://example.com/file",
  "file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "export_8s4m48qz3bclzje0zwh9",
  "idempotency_key": null,
  "status": "complete",
  "type": "export"
}

Attributes

category

enum

The category of the Export. We may add additional possible values for this enum over time; your application should be able to handle that gracefully.

created_at

string

The time the Export was created.

file_download_url

string

Nullable

A URL at which the Export's file can be downloaded. This will be present when the Export's status transitions to complete.

file_id

string

Nullable

The File containing the contents of the Export. This will be present when the Export's status transitions to complete.

string

The Export identifier.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

status

enum

The status of the Export.

type

string

A constant representing the object's type. For this resource it will always be export.

List Exports

curl \
  --url "${INCREASE_URL}/exports" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

cursor

string

Return the page of entries after this one.

limit

integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

created_at.after

string

Return results after this ISO 8601 timestamp.

created_at.before

string

Return results before this ISO 8601 timestamp.

created_at.on_or_after

string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before

string

Return results on or before this ISO 8601 timestamp.

category.in

array of strings

Filter Exports for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

status.in

array of strings

Filter Exports for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum

Create an Export

curl -X "POST" \
  --url "${INCREASE_URL}/exports" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "category": "transaction_csv",
    "transaction_csv": {
      "account_id": "account_in71c4amph0vgo2qllky"
    }
  }'

Parameters

account_statement_ofx

dictionary

Options for the created export. Required if category is equal to account_statement_ofx.

balance_csv

dictionary

Options for the created export. Required if category is equal to balance_csv.

bookkeeping_account_balance_csv

dictionary

Options for the created export. Required if category is equal to bookkeeping_account_balance_csv.