Vendor Payment Search

Beans_Vendor_Payment_Search

Search for vendor payments.

---

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.

• include_invoices (optional) BOOLEAN - Include invoices when searching.

• keywords (optional) STRING - A generic search query string. Searches by payment date or amount. If search_flag_include_invoices is TRUE, then will search for matches to vendor contact information and purchase fields: Purchase Number, Order Number, PO Number, and Quote Number.

---

Returns

• payments ARRAY - An array of Beans_Vendor_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.