API Reference — Increase

Exports are generated files. Some exports can contain a lot of data, like a CSV of your transactions. Others can be a single document, like a tax form. 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.

Events

Your application can listen to webhooks about this resource. The events about Exports will have the categories "export.created" or "export.updated".

The Export object

{
  "account_statement_bai2": null,
  "account_statement_ofx": null,
  "account_verification_letter": null,
  "balance_csv": null,
  "bookkeeping_account_balance_csv": null,
  "category": "transaction_csv",
  "created_at": "2020-01-31T23:59:59Z",
  "dashboard_table_csv": null,
  "entity_csv": null,
  "fee_csv": null,
  "form_1099_int": null,
  "form_1099_misc": null,
  "funding_instructions": null,
  "id": "export_8s4m48qz3bclzje0zwh9",
  "idempotency_key": null,
  "result": {
    "file_id": "file_makxrc67oh9l6sg7w9yc"
  },
  "status": "complete",
  "transaction_csv": {
    "account_id": "account_in71c4amph0vgo2qllky",
    "created_at": null
  },
  "type": "export",
  "vendor_csv": null,
  "voided_check": null
}

Attributes

account_statement_bai2

dictionary

Nullable

Details of the account statement BAI2 export. This field will be present when the category is equal to account_statement_bai2.

account_statement_ofx

dictionary

Nullable

Details of the account statement OFX export. This field will be present when the category is equal to account_statement_ofx.

account_verification_letter

dictionary

Nullable

Details of the account verification letter export. This field will be present when the category is equal to account_verification_letter.

balance_csv

dictionary

Nullable

Details of the balance CSV export. This field will be present when the category is equal to balance_csv.

bookkeeping_account_balance_csv

dictionary

Nullable

Details of the bookkeeping account balance CSV export. This field will be present when the category is equal to bookkeeping_account_balance_csv.

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.

dashboard_table_csv

dictionary

Nullable

Details of the dashboard table CSV export. This field will be present when the category is equal to dashboard_table_csv.

entity_csv

dictionary

Nullable

Details of the entity CSV export. This field will be present when the category is equal to entity_csv.

fee_csv

dictionary

Nullable

Details of the fee CSV export. This field will be present when the category is equal to fee_csv.

form_1099_int

dictionary

Nullable

Details of the Form 1099-INT export. This field will be present when the category is equal to form_1099_int.

form_1099_misc

dictionary

Nullable

Details of the Form 1099-MISC export. This field will be present when the category is equal to form_1099_misc.

funding_instructions

dictionary

Nullable

Details of the funding instructions export. This field will be present when the category is equal to funding_instructions.

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.

result

dictionary

Nullable

The result of the Export. This will be present when the Export’s status transitions to complete.

status

enum

The status of the Export.

transaction_csv

dictionary

Nullable

Details of the transaction CSV export. This field will be present when the category is equal to transaction_csv.

type

string

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

vendor_csv

dictionary

Nullable

Details of the vendor CSV export. This field will be present when the category is equal to vendor_csv.

voided_check

dictionary

Nullable

Details of the voided check export. This field will be present when the category is equal to voided_check.

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

enum

Filter Exports for those with the specified category.

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.

form_1099_int.account_id

string

Filter Form 1099-INT Exports to those for the specified Account.

More about Accounts.

form_1099_misc.account_id

string

Filter Form 1099-MISC Exports to those for the specified Account.

More about Accounts.

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_bai2

dictionary

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

account_statement_ofx

dictionary

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

account_verification_letter

dictionary

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

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.

category

enum

Required

The type of Export to create.

entity_csv

dictionary

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

funding_instructions

dictionary

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

transaction_csv

dictionary

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

vendor_csv

dictionary

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

voided_check

dictionary

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

Retrieve an Export

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

Parameters

export_id

string

Required

The identifier of the Export to retrieve.

More about Exports.

Sandbox: Generate a Tax Form Export

Many exports are created by you via POST /exports or in the Dashboard. Some exports are created automatically by Increase. For example, tax documents are published once a year. In sandbox, you can trigger the arrival of an export that would normally only be created automatically via this simulation.

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

Parameters

category

enum

Required

The type of Export to create.

form_1099_int

dictionary

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