Versions Compared

Old Version 1

changes.mady.by.user Andres Toledo

Saved on

compared with

New Version Current

changes.mady.by.user Andres Toledo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This method returns a list of customers. 
Excerpt

Use this method to get a list of Customers.

Tip

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 id and code uses an exact match.

  • Filtering by name uses a "LIKE" expression.

  • Filters are not case sensitive.

Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel in ( "company-token" , "vendor-token" , "customer-list" )

Request

URL: https://api.kometsales.com/api/customer.list

Method: GET

Content-Type: URL

Params.

Parameters

Input parameters

authenticationToken (required)(string:50)

:

Komet Sales security token.

id (optional)(integer:20)

:

Komet Sales internal

customer

Customer ID.

name (optional)(string:200)

:

Customer’s name

of the customer

.

code (optional)(string:10)

:

Customer’s code

of the customer

.

salesPersonId (optional)(integer:20)

:

Komet Sales internal

salesperson

Salesperson ID.

includeInactive (optional)(boolean)

: true or false. If it's true it will also return customers that have been deactivated. 

Include inactive Customers.

Valid values: 1 = Yes | 0 = No 

locationId (optional)(integer:20)

: location

Komet Sales internal Location ID. Only applies to Multi-Location companies.

You can

obtain

get this value from the location.list API method

. This only applies to companies in Multi-Location mode

.

 

updateAsOf (optional) (date)

(date format

Include only Customers that were updated on or after a specific date.

Date format: YYYY-MM-DD

): the system will only search for customers updated as of this date.info

You can use other parameters such as the ID,
Code Block
, and name in order to filter the results.

curl

Code Block

  • Filtering by ID and code uses an exact match.

  • Filtering by name uses a "LIKE" expression. Filters are not case-sensitive.

languagejs
https://api.kometsales.com/api/customer.list?
authenticationToken=token_info_goes_here

Response

Output

status (integer:1)

: transaction

Transaction status.

1 for success or 0 for failure.

Valid values: 1 = Success | 0 = Failure

message (string:500)

: description of the status of the transaction

Transaction status description.

customers

: array of customers

(array)

An array containing Customers.

id (integer:20)

:

Komet Sales internal

customer

Customer ID.

accountingCode (string:20)

: customer

Customer’s accounting code.

name (string:200)

:

Customer’s name

of the customer

.

code (string:10)

:

Customer code

of the customer

.

active (boolean:1)

: 1 if the customer is active, 0 if the customer is not active.

If the Customer is active.

Valid values: 1 = Active | 0 = Inactive

salesPerson (string:200)

: salesperson

Salesperson name.

salesPersonId (integer:20)

: salesperson

Salesperson ID.

customerType (string:200)

: customer

Customer type.

e.g.

Example: Retailer, Wholesaler, etc.

updatedOn (datetime)

(date format

Date when the Customer was last updated.

Date format: YYYY-MM-DD'T'hh:mm:ss

).: last updating date of the customer.

Sample Response

Code Block
{
    "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"
        }
    ]
}
Info

This method can be executed with Company and Vendor Tokens. 

Panel
titleRelated Articles
Filter by label (Content by label)showLabelsfalsemax10showSpacefalsesorttitlecqllabel in ( "customer-contacts" , "customer-setup" )labelscustomer-contacts customer-setup

We've encountered an issue exporting this macro. Please try exporting this page again later.