Skip to content

Account Transaction Search

Sean Callan edited this page Jun 9, 2020 · 2 revisions

Beans_Account_Transaction_Search

Search for transactions.


Parameters

  • auth_uid (required) INTEGER - The ID for your API key.

  • auth_key (required) STRING - The API key.

  • auth_expiration (required) INTEGER - Unique ID tied to your key; changes if you reset your key.

  • sort_by (optional) - The sort pattern for the returned results: 'newest', 'oldest'

  • page (optional) - The page to return.

  • page_size (optional) - The number of results on each page.

  • account_id (optional) - The ID of the Beans_Account to restrict the search to.

  • not_reconciled (optional) BOOLEAN - to set restricting the search to unreconciled transactions.

  • date (optional) - Limit the search to a specific YYYY-MM-DD date.

  • date_after (optional) - Limit the search to transactions strictly after ( > ) a specific date.

  • date_before (optional) - Limit the search to transactions strictly before ( < ) a specific date.

  • after_transaction_id (optional) - Limit the search to transactions strictly after the one provided.

  • before_transaction_id (optional) - Limit the search to transactions strictly before the one provided.


Returns

  • transactions - An array of Beans_Transaction.

  • total_results - Total number of results.

  • sort_by - The sort method used in the returned results.

  • pages - The total number of pages of results.

  • page - The currently returned page index.

Clone this wiki locally