Skip to content

Customer Payment Search

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

Beans_Customer_Payment_Search

Search for customer 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.

  • 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 Sale Number, Order Number, and PO Number.


Returns

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

Clone this wiki locally