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.
See https://increase.com/documentation/api/exports for the full API reference for this resource.
Summary
Functions
@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) :: {:ok, Increase.Exports.Export.t()} | {:error, Increase.Error.t()}
Create an Export
POST /exports
@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) :: {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}
List Exports
Returns a %Increase.Page{} whose data is a list of %__MODULE__. Export{} structs. Page through results with
Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.
GET /exports
@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) :: {:ok, Increase.Exports.Export.t()} | {:error, Increase.Error.t()}
Retrieve an Export
GET /exports/{export_id}