Customer Sale Line Search

Jump to bottom Edit New page

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

Beans_Customer_Sale_Line_Search

Search for descriptions of previously entered line items. Items are returned based on the levenshtein difference to the submitted phrase.

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.
search_description (optional) STRING - The generic query to search descriptions for.

Returns

sale_lines ARRAY - An array of objects representing a Beans_Customer_Sale_Line with the most recently used information.
- description - The description of the line item.
- amount - The most recent amount assigned to that line item.
- quantity - The most recent quantity assigned to that line item.
- total - The total based on the amount and quantity.
- account_id - The most recent account attributed to that line item.
description - The description of the line item.
amount - The most recent amount assigned to that line item.
quantity - The most recent quantity assigned to that line item.
total - The total based on the amount and quantity.
account_id - The most recent account attributed to that line item.