Create an Export

Changed on
post/exports

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/exports
  • Auth
    HTTP bearer

Request body

category'account_statement_bai2' | 'account_statement_ofx' | 'account_verification_letter' | 'balance_csv' | 'bookkeeping_account_balance_csv' | 'daily_account_balance_csv' | 'entity_csv' | 'fee_csv' | 'funding_instructions' | 'transaction_csv' | 'vendor_csv' | 'voided_check' required

The type of Export to create.

entity_csvobject

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

vendor_csvobject

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

Example request

{
  "category": "transaction_csv",
  "transaction_csv": {
    "account_id": "account_in71c4amph0vgo2qllky"
  }
}

Response

Export

category'account_statement_bai2' | 'account_statement_ofx' | 'account_verification_letter' | 'balance_csv' | 'bookkeeping_account_balance_csv' | 'daily_account_balance_csv' | 'dashboard_table_csv' | 'entity_csv' | 'fee_csv' | 'form_1099_int' | 'form_1099_misc' | 'funding_instructions' | 'transaction_csv' | 'vendor_csv' | 'voided_check' required

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_atstring date-time required

The time the Export was created.

dashboard_table_csvobject nullable required

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

entity_csvobject nullable required

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

idstring required

The Export identifier.

idempotency_keystring nullable required

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'pending' | 'complete' | 'failed' required

The status of the Export.

type'export' required

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

vendor_csvobject nullable required

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

Example response

{
  "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",
  "daily_account_balance_csv": null,
  "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
}

Changes

  • 64a92a8cc343Revision changes
    • info

      added the new optional request property

    • info

      added the new fee_csv enum value to the request property

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

  • 0482ee5f9cf2Revision changes
    • breaking

      the /// request property's maxLength was decreased to 35