Increase.Exports.Export (Increase v1.0.0)

Copy Markdown View Source

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.

Fields

  • id - The Export identifier.
  • account_statement_bai2 - Details of the account statement BAI2 export. This field will be present when the category is equal to account_statement_bai2.
  • account_statement_ofx - Details of the account statement OFX export. This field will be present when the category is equal to account_statement_ofx.
  • account_verification_letter - Details of the account verification letter export. This field will be present when the category is equal to account_verification_letter.
  • balance_csv - Details of the balance CSV export. This field will be present when the category is equal to balance_csv.
  • bookkeeping_account_balance_csv - Details of the bookkeeping account balance CSV export. This field will be present when the category is equal to bookkeeping_account_balance_csv.
  • category - 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 - The time the Export was created.
  • daily_account_balance_csv - 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_csv - Details of the dashboard table CSV export. This field will be present when the category is equal to dashboard_table_csv.
  • entity_csv - Details of the entity CSV export. This field will be present when the category is equal to entity_csv.
  • fee_csv - Details of the fee CSV export. This field will be present when the category is equal to fee_csv.
  • form_1099_int - Details of the Form 1099-INT export. This field will be present when the category is equal to form_1099_int.
  • form_1099_misc - Details of the Form 1099-MISC export. This field will be present when the category is equal to form_1099_misc.
  • funding_instructions - Details of the funding instructions export. This field will be present when the category is equal to funding_instructions.
  • idempotency_key - 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 - The result of the Export. This will be present when the Export's status transitions to complete.
  • status - The status of the Export.
  • transaction_csv - Details of the transaction CSV export. This field will be present when the category is equal to transaction_csv.
  • type - A constant representing the object's type. For this resource it will always be export.
  • vendor_csv - Details of the vendor CSV export. This field will be present when the category is equal to vendor_csv.
  • voided_check - Details of the voided check export. This field will be present when the category is equal to voided_check.

Summary

Types

t()

Types

t()

@type t() :: %Increase.Exports.Export{
  account_statement_bai2:
    Increase.Exports.Export.AccountStatementBai2.t() | nil,
  account_statement_ofx: Increase.Exports.Export.AccountStatementOfx.t() | nil,
  account_verification_letter:
    Increase.Exports.Export.AccountVerificationLetter.t() | nil,
  balance_csv: Increase.Exports.Export.BalanceCsv.t() | nil,
  bookkeeping_account_balance_csv:
    Increase.Exports.Export.BookkeepingAccountBalanceCsv.t() | nil,
  category: String.t(),
  created_at: DateTime.t(),
  daily_account_balance_csv:
    Increase.Exports.Export.DailyAccountBalanceCsv.t() | nil,
  dashboard_table_csv: Increase.Exports.Export.DashboardTableCsv.t() | nil,
  entity_csv: Increase.Exports.Export.EntityCsv.t() | nil,
  fee_csv: Increase.Exports.Export.FeeCsv.t() | nil,
  form_1099_int: Increase.Exports.Export.Form1099Int.t() | nil,
  form_1099_misc: Increase.Exports.Export.Form1099Misc.t() | nil,
  funding_instructions: Increase.Exports.Export.FundingInstructions.t() | nil,
  id: String.t(),
  idempotency_key: String.t() | nil,
  result: Increase.Exports.Export.Result.t() | nil,
  status: String.t(),
  transaction_csv: Increase.Exports.Export.TransactionCsv.t() | nil,
  type: String.t(),
  vendor_csv: Increase.Exports.Export.VendorCsv.t() | nil,
  voided_check: Increase.Exports.Export.VoidedCheck.t() | nil
}