Read
To read Customer Payments, please use the below parameters.
Supported “where” Filters
Field Name | Data Type | Description |
|---|---|---|
dateCreated | Long | This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates. |
internalId | String | Internal ID of the Customer Payment. Multiple values can be passed in a comma-separated string. |
lastModifiedDate | Long | This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates. |
subsidiary | String | Internal ID of Subsidiary (Primary). Do Not Use this in additonalFilter. Multiple IDs can be passed in a comma-separated string Ex: 1,2 |
additonalFilter | String | construct the additional filter with a combination of the above fields using ‘+and+’ separator and pass it as a single string. Make sure to wrap the whole string using EncodingUtil.urlEncode |
tranDate | Long | Transaction date of the record. Use the “additionalFilter” option for a range of dates. |
customer | String | To filter the records based on the Customer. Multiple IDs can be passed in a comma-separated string Ex: 6,7 |
Supported “where” Filters
Example
Map<String, Object> filters = new Map<String, Object>();
filters.put('subsidiary', '1,2');
filters.put('additionalFilter', EncodingUtil.urlEncode('lastModifiedDate>1628091060+and+lastModifiedDate<1629127860', 'UTF-8'));
// Encode additionalFilter after constructing it with +and+ for multi-filters
// field filters and additionalFilter for where param
Map<String, Object> filterMap = new Map<String, Object>();
filterMap.put('where', new Map<String, Object>{'keyValueMap'=>filters});
Map<String, Object> requestJSONMap = new Map<String, Object>();
requestJSONMap.put('customParameters', filterMap);
String reqJSON = JSON.serialize(requestJSONMap);
Map<String, Object> reqObj = new Map<String, Object>();
reqObj.put('version', '1.0');
reqObj.put('action', 'readCustomerPayment');
reqObj.put('requestJSON', reqJSON);
// Place a request to Breadwinner Global API
Map<String, Object> resp = breadwinner_ns.BreadwinnerNetSuiteAPI.call(reqObj);
System.debug(resp);