UpdateClient API

The UpdateCustomer API is a development developed by The Factory HKA team which offers the taxpayer the possibility of updating the catalog of clients registered in the HKA Invoice portal in a demo environment and in a production environment or to be carried out the consumption of the service through the UpdateCustomer API.

@IMPORTANT: The UpdateClient Api is built in the PUT method. For the consumption of this service, two specific urls have been established in the DEMO environment and the PRODUCTION environment, which can be found below:

For more information you can consult the URLs in the following section:

 UpdateCustomer

The structure that must be considered in the construction of the Request and Response of the UpdateClient service is documented below and in this way guarantee the implementation of this new method:

REQUEST

Parameters to Send

Type	Identifier	Description
String	Nit	Document number of the issuing taxpayer.
String	CompanyToken	Supplied by The Factory HKA Colombia according to the environment to be consulted
	TokenPassword
String	SecretKey	Defined by the issuing taxpayer through the HKA Electronic Invoice portal in a demo environment and in a production environment COMING SOON
Array <Client>	Client	Parameters that make up the Customer class of the Invoice Object
Address	CustomerAddress	Parameters that make up the CustomerAddress class of the Invoice Object
Address	FiscalAddress	Parameters that make up the TaxAddress class of the Invoice Object
Array <Tributes>	tax details	Parameters that make up the Tax Details class of the Invoice Object
Array <Obligations>	Responsibilities	Parameters that make up the Tax Details class of the Invoice Object
String	Economic Activities	Parameters that make up the Customer class of the Invoice Object
String	Economic Activities	Parameters that make up the Customer class of the Invoice Object

Where Class.Client contains the following information:

Type	Identifier	Description
String	ClientId	Code with which the client identifies himself.
String	Active	Indicates the current status of the client to be updated
String	PersonType	Person type identifier. The content of this attribute corresponds to one of the values of Table 5
String	DescriptionTypePerson	Indicate if it is Natural or Legal according to the catalog
String	SocialReason	Name or Company Name of the acquirer
String	BusinessName	Commercial name of the acquirer
String	Names	Contact Name
String	Contact Last Name	Contact Name
String	IdTypeIdentification	Id that identifies the type of identification of the acquirer
String	IdentificationType	Type of identification of the acquirer. The content of this attribute must correspond to one of the values of the Table 3
String	DescriptionTypeIdentification	Indicates the type of document of the acquirer
String	IdentificationNumber	Document Number or Tax Identification of the acquirer
String	DvIdentificationNumber	NIT verification digit of the acquirer. If identificationType = 31.
String	RegimeId	Code with which the registered regime is indicated.
String	Regime	Acquirer regime
String	Mail	Email of the acquirer that will go to the XML/UBL fiscalRegime of the acquirer
String	Phone	Phone of the acquirer
String	Fax	Telefax
String	Reference	Acquirer reference record
String	ContactName	Contact Name.
String	Note	Additional contact note
String	Notify	Activate sending email to the acquirer. Possible values: “YES” or “NO”.