increase-test
POST/simulations/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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields
categorystringrequired
The type of Export to create.
Allowed:form_1099_int
form_1099_intobjectoptional
Options for the created export. Required if `category` is equal to `form_1099_int`.

3 status codes
200Export
account_statement_bai2objectrequired
Details of the account statement BAI2 export. This field will be present when the `category` is equal to `account_statement_bai2`.
account_statement_ofxobjectrequired
Details of the account statement OFX export. This field will be present when the `category` is equal to `account_statement_ofx`.
account_verification_letterobjectrequired
Details of the account verification letter export. This field will be present when the `category` is equal to `account_verification_letter`.
balance_csvobjectrequired
Details of the balance CSV export. This field will be present when the `category` is equal to `balance_csv`.
bookkeeping_account_balance_csvobjectrequired
Details of the bookkeeping account balance CSV export. This field will be present when the `category` is equal to `bookkeeping_account_balance_csv`.
categorystringrequired
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.
Allowed:account_statement_ofxaccount_statement_bai2transaction_csvbalance_csvbookkeeping_account_balance_csventity_csvvendor_csvdashboard_table_csvaccount_verification_letterfunding_instructionsform_1099_intform_1099_misc
created_atstringrequired
The time the Export was created.
daily_account_balance_csvobjectrequired
Details of the daily account balance CSV export. This field will be present when the `category` is equal to `daily_account_balance_csv`.
dashboard_table_csvobjectrequired
Details of the dashboard table CSV export. This field will be present when the `category` is equal to `dashboard_table_csv`.
entity_csvobjectrequired
Details of the entity CSV export. This field will be present when the `category` is equal to `entity_csv`.
fee_csvobjectrequired
Details of the fee CSV export. This field will be present when the `category` is equal to `fee_csv`.
form_1099_intobjectrequired
Details of the Form 1099-INT export. This field will be present when the `category` is equal to `form_1099_int`.
form_1099_miscobjectrequired
Details of the Form 1099-MISC export. This field will be present when the `category` is equal to `form_1099_misc`.
funding_instructionsobjectrequired
Details of the funding instructions export. This field will be present when the `category` is equal to `funding_instructions`.
idstringrequired
The Export identifier.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
resultobjectrequired
The result of the Export. This will be present when the Export's status transitions to `complete`.
statusstringrequired
The status of the Export.
Allowed:pendingcompletefailed
transaction_csvobjectrequired
Details of the transaction CSV export. This field will be present when the `category` is equal to `transaction_csv`.
typestringrequired
A constant representing the object's type. For this resource it will always be `export`.
Allowed:export
vendor_csvobjectrequired
Details of the vendor CSV export. This field will be present when the `category` is equal to `vendor_csv`.
voided_checkobjectrequired
Details of the voided check export. This field will be present when the `category` is equal to `voided_check`.
4XXError
5XXError