API Documentation

Beans_Tax_Payment_Search

Search for tax payments.


Parameters

auth_uid INTEGER The ID for your API key.
auth_key STRING The API key.
auth_expiration INTEGER Unique ID tied to your key; changes if you reset your key.
sort_by STRING The sort pattern for the returned results: 'newest', 'oldest'
page INTEGER The page to return.
page_size INTEGER The number of results on each page.
search_date STRING Search payments on a specific YYYY-MM-DD date.
search_date_before STRING Search payments before a specific YYYY-MM-DD date.
tax_id INTEGER The ID of the Beans_Tax to limit payments to.
tax_name STRING A generic query string to search tax names.
include_details BOOLEAN Whether or not to include liabilities on returned tax items.

Returns

payments ARRAY An array of Beans_Tax_Payment.
total_results INTEGER Total number of results.
sort_by STRING The sort method used in the returned results.
pages INTEGER The total number of pages of results.
page INTEGER The currently returned page index.