Get a Customer list
- Andres Toledo
Use this method to get a list of Customers.
Valid Tokens: Company and Vendor.
You can send parameters such as the id, code and name in order to filter the results.
Take the following statements into account when applying filters:
Filtering by
idandcodeuses an exact match.Filtering by
nameuses a "LIKE" expression.Filters are not case sensitive.
Related Articles
-
Delete a Prebook 1.0 (API)
-
-
-
Add Inventory (API)
-
Request
URL: https://api.kometsales.com/api/customer.list
Method: GET
Content-Type: URL Parameters
Input parameters
authenticationToken (required)(string:50)
Komet Sales security token.
id (optional)(integer:20)
Komet Sales internal Customer ID.
name (optional)(string:200)
Customer’s name.
code (optional)(string:10)
Customer’s code.
salesPersonId (optional)(integer:20)
Komet Sales internal Salesperson ID.
includeInactive (optional)(boolean)
Include inactive Customers.
Valid values: 1 = Yes | 0 = No
locationId (optional)(integer:20)
Komet Sales internal Location ID. Only applies to Multi-Location companies.
You can get this value from the location.list API method.
updateAsOf (optional) (date)
Include only Customers that were updated on or after a specific date.
Date format: YYYY-MM-DD
https://api.kometsales.com/api/customer.list?
authenticationToken=token_info_goes_here
Response
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Transaction status description.
customers (array)
An array containing Customers.
id (integer:20)
Komet Sales internal Customer ID.
accountingCode (string:20)
Customer’s accounting code.
name (string:200)
Customer’s name.
code (string:10)
Customer code.
active (boolean:1)
If the Customer is active.
Valid values: 1 = Active | 0 = Inactive
salesPerson (string:200)
Salesperson name.
salesPersonId (integer:20)
Salesperson ID.
customerType (string:200)
Customer type.
Example: Retailer, Wholesaler, etc.
updatedOn (datetime)
Date when the Customer was last updated.
Date format: YYYY-MM-DD'T'hh:mm:ss
{
"status": "1",
"message": "OK",
"customers":
[
{
"id": "25475",
"accountingCode": "ACC10",
"customerType": "PART-TIME FLORIST",
"salesPerson": "Julian Mejía",
"name": "2-14 BRIDAL CAKES",
"salesPersonId": 1819,
"active": "1",
"code": "T3526",
"updatedOn": "2017-08-02T12:15:17"
}
,
{
"id": "29775",
"customerType": "",
"name": "Flores SAS",
"active": "1",
"code": "ASS",
"salesPersonId": 23423,
"customerType": "Retailer",
"updatedOn": "2017-09-15T17:02:50"
}
]
}