Contents
Description
ip1Customers.get brings up a list of customers based on the input parameters; scan words, filter & sort fields. With the paging input parameters(keyFrom, keyTo and direction) you can view a subset of the retrieved list. See parameters that control the returned results.
Restrictions
Access is dependent on user access and restrictions.
Input/Output parameters
View JSON parameters| Input | Type | Description |
| noOfRecords | 5N0 | No of records to return |
| scanWord | 60a | Scan word |
| filterBy | Array of 10 max. | Filter by |
| field | 8A | DB field(DSCM00P ) except numeric fields |
| value | 20a | Field value |
| condition | 2A | Condition: EQ,NE,GT,GE,LT,LE |
| sortFields | Array of 2 max. 8A |
Sort fields. If not given, sort by CN. DB field(DSCM00P ). |
| sortOrder | 1A | Sort order:A=Ascending, D=Descending |
| keyFrom | 100a | Key-from returned |
| keyTo | 100a | Key-to returned |
| direction | 1A | P=Previous,N=Next,F=First,L=Last |
| Output | Type | Description |
| lists | List of customers | |
| customerNumber | 10A | Account number |
| regBusinessName | 60a | Registered business name |
| postalCustomerName | 60a | Postal customer name |
| postalAddressLine4 | 20a | Postal address 4 |
| postalAddressLine5 | 20a | Postal address 5 |
| companyCode | 2A | Company code |
| branchCode | 2A | Branch code |
| exchangeCode | 1A | Currency exchange code |
| currencyISO | 3A | Currency ISO |
| customerStatus | 1A | Customer status |
| noOfRecordsReturned | 5N0 | No of records returned |
| keyFrom | 100a | Key-from returned |
| keyTo | 100a | Key-to returned |
| pageInfo | 1A | A=All,T=Top,B=Bottom,M=More |
JSON example
View JSON request examplesScan word = Dymocks, filter by Company code NE 61
{
“IptorAPI”: “1.0”,
“method”: “ip1Customers.get”,
“params”: {
“scanWord”: “Dymocks”,
“noOfRecords”: 10,
“filterBy”: [
{
“field”: “CONO”,
“value”: “61”,
“condition”: “NE”
}
]
},
“id”: “1234567890”
}
Scan word = Dymocks sydney, sort by PAD6 (postal address line6), REGN (registered business name), filter by customer status NE C (Closed), direction = N (next). Note: “keyTo” is not given so it will read from the first record.
{
“IptorAPI”: “1.0”,
“method”: “ip1Customers.get”,
“params”: {
“scanWord”: “Dymocks sydney”,
“noOfRecords”: 10,
“sortBy”: [
{
“field”: “PAD6”,
“order”: “A”
},
{
“field”: “REGN”
}
],
“filterBy”: [
{
“field”: “CSTS”,
“value”: “C”,
“condition”: “NE”
}
],
“direction”: “N”
},
“id”: “1234567890”
}
Response format
For standard response format for IP1 API methods, see Response format.
Related topics
