Skip to content

Vendor Expense Search

Sean Callan edited this page Jun 9, 2020 · 1 revision

Beans_Vendor_Expense_Search

Search for vendor expenses.


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) STRING - The sort pattern for the returned results: 'newest', 'oldest'

  • page (optional) INTEGER - The page to return.

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

  • search_vendor_id (optional) INTEGER - Limit the search to a specific Beans_Vendor.

  • keywords (optional) STRING - A generic query string that will be compared to both vendors ( name, company name, phone number ) and expenses ( total, Expense Number, Invoice Number, and SO Number ).


Returns

  • expenses ARRAY - An array of Beans_Vendor_Expense.

  • 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.

Clone this wiki locally