API Documentation

Beans_Vendor_Purchase_Search

Search for vendor purchases.


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_vendor_id INTEGER Limit the search to a specific Beans_Vendor.
keywords STRING A generic query string that will be compared to both vendors ( name, company name, phone number ) and purchases ( total, Purchase Number, Order Number, PO Number, and Quote Number ).
invoiced BOOLEAN Whether or not the purchase has been invoiced. Can be true or false.
sent BOOLEAN Whether or not the purchase has been sent in its current form. Can be true or false.
past_due BOOLEAN Whether or not the purchase is past due. Can be true or false.
has_balance BOOLEAN Whether or not the purchase has a balance. Can be true or false.
date_created_before STRING Search purchases created before a YYYY-MM-DD date.
date_created_after STRING Search purchases created after a YYYY-MM-DD date.
date_billed_before STRING Search purchases billed before a YYYY-MM-DD date.
date_billed_after STRING Search purchases billed after a YYYY-MM-DD date.

Returns

purchases ARRAY An array of Beans_Vendor_Purchase.
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.