Read

5min

Read Customer Subsidiary Relationship requestJSON has the following parameters.
Field Name
Data Type
Description
customParameters
Map<String, ParamValue>
It is used to add filters to your search results
pageIndex
Integer
request any page from the search results reponse
searchId
String
request any page with the Search Id from the search results reponse
customPageSize
String
no. of records to return per search request.
Custom Parameters in the requestJSON are in the form of Param Name and Value Map which are used for filtering different search results. There is currently only one supported custom parameter.
Supported Custom Parameters
Param Name
Param Value
Description
where
keyValueMap
Pass the supported where filters in Key-Value pair
Param Value can be passed in the following two ways.
ParamValue
Field Name
Data Type
Description
value
String
single param value
keyValueMap
Map<String, String>
adding multiple key value params (where filters)
Supported “where” Filters
Field Name
Data Type
Description
entity
String
Internal ID of the Customer. Multiple values can be passed in a comma separated string.
subsidiary
String
Internal ID of Subsidiary. Multiple IDs can be passed in a comma separated string Ex: 1,2
Sample Requests and Responses
The following is an example request which can be used while using ‘readCustomerSubsidiaryRelationship’ action.
Request
Response
Map<String, Object> filterMap = new Map<String, Object>();
Map<String, Object> filters = new Map<String, Object>();
    filters.put('entity', '6');

    filterMap.put('where', new Map<String, Object>{'keyValueMap'=>filters}); // field 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', 'readCustomerSubsidiaryRelationship');
    reqObj.put('requestJSON', reqJSON);

//  Placing a request to Breadwinner Global API
Map<String, Object> resp = breadwinner_ns.BreadwinnerNetSuiteAPI.call(reqObj);
System.debug(resp);
Map<String, Object> filterMap = new Map<String, Object>();
Map<String, Object> filters = new Map<String, Object>();
    filters.put('entity', '6');

    filterMap.put('where', new Map<String, Object>{'keyValueMap'=>filters}); // field 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', 'readCustomerSubsidiaryRelationship');
    reqObj.put('requestJSON', reqJSON);

//  Placing a request to Breadwinner Global API
Map<String, Object> resp = breadwinner_ns.BreadwinnerNetSuiteAPI.call(reqObj);
System.debug(resp);
﻿
﻿
﻿
﻿

Field Name	Data Type	Description
customParameters	Map<String, ParamValue>	It is used to add filters to your search results
pageIndex	Integer	request any page from the search results reponse
searchId	String	request any page with the Search Id from the search results reponse
customPageSize	String	no. of records to return per search request.

Param Name	Param Value	Description
where	keyValueMap	Pass the supported where filters in Key-Value pair

Field Name	Data Type	Description
value	String	single param value
keyValueMap	Map<String, String>	adding multiple key value params (where filters)

Field Name	Data Type	Description
entity	String	Internal ID of the Customer. Multiple values can be passed in a comma separated string.
subsidiary	String	Internal ID of Subsidiary. Multiple IDs can be passed in a comma separated string Ex: 1,2

Updated 29 May 2024

Did this page help you?

Customer Subsidiary Rel.

Create