Increase.Simulations.Exports (Increase v1.0.0)

Copy Markdown View Source

Sandbox-only simulations related to Export.

These endpoints only work against the sandbox environment and let you fast-forward events that would otherwise take hours or days in production (settlement, acknowledgement, returns, and so on). See https://increase.com/documentation/api/overview#sandbox for details.

Summary

Functions

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.

Functions

create(client, params \\ %{}, opts \\ [])

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Exports.Export.t()} | {:error, Increase.Error.t()}

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.

POST /simulations/exports