24/7 Support: 800.608.6482

Navigation


CustomerCreditHistoryList_Load_Query

This function allows you to load a list Credit History Transactions for a specific customer.

See the List Load Functions Overview guide to get started.

Request Body Parameters

count Type:
Number
Title:
Count
Count is used to tell Miva how many records you want returned. If for example you are querying thousands of records you'll want to set the count to limit how many you get back in a single request.
offset Type:
Offset
Title:
Number
Used in conjunction with the Count parameter for paginating results of large datasets. Default is 0 whcih is no offset.
sort Type:
String
Title:
Sort
Field to sort results by. Avaiilable sorting fields listed above. Use - prefix for a decending sort.
Filter Type:
Object
Title:
Filter
Array of Object containing search filters. See usage here: List Load Query Overview
Customer_ID Type:
Number
Title:
Customer ID
Id of customer to load
Customer_Login Type:
String
Title:
Customer Login
Login of customer to load
Edit_Customer Type:
String
Title:
Customer Login
Login of customer to load

Response Parameters

total_count Type:
Number
Title:
Total Product Count
total_count is the total number of records that match your search criteria. Note: this is not always the total products returned. Based on the Count and Offset parameters passed, the number of records returned could be different than the total_count.
start_offset Type:
Number
Title:
Start Offset
Number number of the starting offset number of products to return. Used in conjunction with the Count parameter for paginating results of large datasets.
id Type:
Number
Title:
Credit History Transaction ID
Credit Hitory Transaction ID
user_id Type:
Number
Title:
User Id
The Id of the Admin user who added the transcation. 0 if not placed by an Admin user
cust_id Type:
Number
Title:
Customer ID
The Id of the Customer for the transaction list
order_id Type:
Number
Title:
Order Id
The Order ID the transcation references. If no order, it is 0
txref Type:
Nunber
Title:
Transaction Reference
Optional Transaction Reference
descrip Type:
String
Title:
Description
The description for the transaction list
amount Type:
Number
Title:
Amount
The amount of customer credit for the transaction
dtstamp Type:
Date Timestamp
Title:
Date / Timestamp
The timestamp for when the transaction took place
user_name Type:
String
Title:
Admin Username
The User name of the admin user if it was added by an Admin. If no admin, the string returns empty.

Example Request

Example Response

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Copyright © 1997 – 2019 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.