Overview

This method allows you to obtain the details of a specific customer. 

Request

https://api.kometsales.com/api/customer.details.get

Parameters:

  • authenticationToken (required) (string:50): Komet Sales security token.
  • customerId (required) (integer:20): Komet Sales internal ID. You can obtain this value from the customer.list API method. 

Sample 1
https://api.kometsales.com/api/customer.details.get?authenticationToken=token_info_goes_here&customerId=625

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure/error.
  • message (string:500): contains status description of request.
  • customer: set of attributes corresponding to the customer given. 
    • name (string:200): name of the customer.
    • code (string:10): code of the customer.
    • customerType (string:20) type of customer (Wholesales, Retailer, etc etc).

    • billAddress (string:200): billing address.
    • billCity (string:200): billing city name.
    • billState (string:200): billing state name.
    • billZipCode (string:10): billing Zip Code.
    • billCountry (string:200): billing country name.
    • shipAddress (string:200): ship address.
    • shipCity (string:200): ship city name.
    • shipState (string:200): ship state name.
    • shipZipCode (string:10): ship zip code.
    • shipCountry (string:200): ship country name.

    • emailForInvoices (string:200): email addresses where the customer will receive the invoices. You may get a set of email addresses separated by semicolons.

    • emailForStatements (string:200): email addresses where the customer will receive the statements. You may get a set of email addresses separated by semicolons. 

    • phone (string:20): phone number.

    • fax (string:20): fax number. 

    • defaultPrice (string:1): price A or Price B. 
    • priceBMarkup (string: 10): price B markup over price A. e.g.: 10%

    • priceSellFastMarkup (string: 10): price markup over sell fast items. e.g.: 20% 

    • creditLimit (decimal:10,2): customer credit limit. If it's 0, the customer credit limit will be 0. If it's empty, there will no be credit limit. 

    • balance (decimal: 10,2): balance of the customer in terms of open invoices and open credits. 

    • lastSaleDate (date): the date when the last sale was made. (date format YYYY-MM-DD).

    • lastPaymentDate (date): the date when the last payment was applied. (date format YYYY-MM-DD).

    • customerSince (date): the date when the customer was created in the system. (date format YYYY-MM-DD) 

    • paymentTerms (string:50): Payment Terms (Net 7, Net 15, Net 30, etc)

    • chargeFuelSurcharge (boolean): Indicates if the customer is fuel surcharge chargeable or not. 

    • chargeTax (boolean): Indicates if the customer is tax chargeable or not. 

    • creditHold (boolean): Indicates if the customer is in credit hold or not. 
    • active (boolean): Indicates if the customer is active or not. 
    • tags (string:200): Tags associated to the customer separated by a comma.
    • awardValue (string:40): The number of points that the customer currently has. (Only available if the company has the setting customerAwardKeyword enabled).
    • mainLocationId (string:10): Code of the main location that will be associated with the customer. This only applies for Multilocation companies.
    • daysOfService (array):  Array of the days of service set up for the customer and its corresponding carriers. In Multilocation companies will be the array of days of service for the customer's main location and the carrier set up for each.
      • weekday (string): array of days of the week when the customer has service available.
        • carrierId (integer:20): Komet Sales internal carrier Id.
        • carrierCode (string:10): code of the carrier.
        • carrierName (string:200): name of the carrier.
    • salespersonForFlowers: set of attributes that represents the salesperson for flowers.

      • name (string:200): Name of the salesperson for flowers. 

      • phone (string:20): phone number.

      • email: salesperson's e-mail.

    • salespersonForPlants: set of attributes that represents the salesperson for plants.

      • name (string:200): Name of the salesperson for flowers. 

      • phone (string:20): phone number.

      • email: salesperson's e-mail.

 

Response Example
{
   "message": "success",
   "status": "1",
   "customer": 
   {
     "name": "ABC Wholesale",
     "code": "ABC",
     "customerType": "Wholesaler",
     "billAddress" : "123 Test Road Suite 101",
     "billCity" : "Tampa",
     "billState" : "FL",
     "billZipCode" : "76223",
     "billCountry" : "USA",
     "shipAddress" : "123 Test Road Suite 101",
     "shipCity" : "Tampa",
     "shipState" : "FL",
     "shipZipCode" : "76223",
     "shipCountry" : "USA",
     "emailForInvoices": "invoices@abwholesale.com",
     "emailForStatements": "statements@abwholesale.com",
     "phone": "987-892-8997", 
	 "fax": "900-892-8997", 
     "defaultPrice": "A", 
     "priceBMarkup": "10%", 
     "priceSellFastMarkup": "10%", 
     "creditLimit": "10000.00", 
     "balance": "2000.00", 
     "lastSaleDate":"2016-07-08",
     "lastPaymentDate":"2016-05-30",
     "customerSince":"2013-05-01",
     "paymentTerms":"Net 30",
     "chargeFuelSurcharge": true,
     "chargeTax": false,
     "active": true,
	 "tags": "primary, rateA", 
     "salespersonForFlowers": 
      {
          "name": "Jhon Doe",
          "phone": "987-892-8997", 
          "email": "jhon.doe@demoflowers.com"
      },
     "salespersonForPlants": 
      {
          "name": "Joe Smith",
          "phone": "987-892-8997", 
          "email": "joe.smith@demoflowers.com"
      },
      "daysOfService": {
            "Monday": {
                "carrierId": 4309,
                "carrierCode": "35EN",
                "carrierName": "35EN"
            },
            "Tuesday": {
                "carrierId": 4299,
                "carrierCode": "COTK",
                "carrierName": "COTK"
            },
            "Wednesday": {
                "carrierId": 4299,
                "carrierCode": "COTK",
                "carrierName": "COTK"
            }
        }      
   }
}