Overview


This method allows you to update an existing customer in Komet Sales.

 


Request

https://api.kometsales.com/api/customer.update

  • Method: POST
  • Content-Type: application/json

Input Parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • customerId (required)(integer:20): Komet Sales internal ID for the customer that you want to update. You can obtain this value from the customer.list API method.
  • name (required)(string:200): name of the customer.
  • active (optional)(boolean:1): 1 if the customer is active, 0 if the customer is not active.
  • code (optional)(string:10): code of the customer.
  • type (optional)(integer:20): Komet Sales Customer Type ID. It should be one of the customer type IDs from the company. Since this list doesn't come from an API method yet, you should get this list of IDs from the Komet Sales team.
  • locationCodes (optional) (string:50):  location codes associated to the user. It applies for Multi Location companies. The location codes must be separated by colons. All the existing values will be overriden.
  • phone (optional)(string:20): phone number.
  • askPaymentUponConfirmation(optional)(boolean:1): 1 to activate this option. Type 0 to inactivate it.
  • financeChargePercentage(optional)(decimal:10,2): The finance charge percentage. Do not include the % symbol.
  • customerGroup(optional)(string:50): Customer group name. 
  • fax (optional)(string:20): fax number.
  • website (optional)(string:50): web site address.
  • terms (optional)(string:50): Payment Terms (Net 7, Net 15, Net 30, etc).
  • emailForInvoices (optional)(string:200): email addresses where the customer will receive the invoices. You may enter a set of email addresses separated by semicolons.
  • emailForStatements (optional)(string:200): email addresses where the customer will receive the statements. You may enter a set of email addresses separated by semicolons.
  • creditHold (optional)(boolean:1): 1 if the customer is held, 0 if the customer is not held.
  • creditLimit (optional)(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.
  • paymentMethod (optional)(string:50): name of the payment method. You can obtain this value from the payment.method.list API method.
  • chargeFuelSurcharge (optional)(boolean:1): 1 if the customer needs to be fuel surcharge charged.
  • chargeTax (optional)(boolean:1): 1 if the customer needs to be tax charged.
  • taxExemptNumber(optional)(string:50):  The Tax Exempt number.
  • sendInvoiceVia (optional)(string:50): valid values: e-mail, fax, mail. You may enter a set of values separated by commas.
  • sendStatementVia (optional)(string:50): valid values: e-mail, fax, mail. You may enter a set of values separated by commas.
  • defaultPrice (optional)(string:1): Default Price for the customer. Only A or B are the accepted values.
  • markupValue (optional)(number: 5): Markup percentage or amount that will be added to the default price. This field depends on the markupType field. 
  • markupType (optional)(string: 1): Possible values are $ or %. This type will be applied to the markupValue field. 
  • defaultShippingNotes (optional)(string:200): default shipping notes or comments that you want to associate with the customer.
  • billingStreet (optional)(string:200): Billing Street address.
  • billingCity (optional)(string:50): Billing City name.
  • billingState (optional)(string:50): Billing State name.
  • billingZipcode (optional)(string:10): Billing Zip/Postal Code.
  • billingCountry (optional)(string:50): Billing Country name.
  • shippingStreet (optional)(string:200): Shipping Street address.
  • shippingCity (optional)(string:50): Shipping City name.
  • shippingState (optional)(string:50): Shipping State name.
  • shippingZipcode (optional)(string:10): Shipping Zip/Postal Code.
  • shippingCountry (optional)(string:50): Shipping Country name.
  • lastSalesDate (optional)(date)(date format YYYY-MM-DD): The last sale date.
  • showFobPrice(optional)(boolean:1): 1 to activate the FOB price, 0 to deactivate it.
  • salesPersonForFlowers(optional)(string:50):  Komet Sales Login Username of the salesperson.
  • salesPersonForPlants(optional)(string:50): Komet Sales Login Username of the salesperson.
  • salesPersonCodeForFlowers (optional)(string:20): Code of the sales person when the type of product is flowers. 
  • salesPersonCodeForPlants (optional)(string:20): Code of the sales person when the type of product is plants.
  • vatCode (optional)(string:50): The Value-added Tax code.
  • mainLocationCode (optional) (string:10): Code of the main location that will be associated to the customer. This only applies for Multi Location companies. 
  • isCustomerPORequired (optional)(boolean:1): 1 if the customer PO number is required in the sales screens. 
  • crmLink (string:500): The url of a CRM external system that represents the customer.
  • territory (optional)(string:50): The territory name of the customer.
  • accountingCode (optional)(string:50): The Accounting Code of the Customer.
  • eCommerceMarkupSign (optional)(string:1): Enter only the symbol $ or %.
  • eCommerceMarkupValue (optional)(decimal:10,2): The value of the e-commerce markup. 
  • displayVendor (optional)(integer:1): 1 to display only the code, 2 to display only the name. 0 to do not display vendor information at all.
  • checkOutNotificationTo (optional)(string:200): The emails addresses where checkout notifications should be sent.
  • showArrivalDate (optional)(boolean:1): 1 to activate this option. Type 0 to inactivate it.
  • ecommerceExperience (optional)(integer:1): 0 to activate the list experience. 1 to the visual experience.
  • ecommerceShipVia (optional)(integer:1): 0 through the warehouse. 1 direct from the vendor. 2 User's choice.



Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.
  • customerId (integer:20): customer internal ID that was just created.