ConsultClient API

The ConsultarCliente API is a development developed by The Factory HKA team which provides the taxpayer with the possibility of consulting the clients registered in the electronic invoice portal in a demo environment and in a production environment.

@IMPORTANT: 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:

 ConsultarCliente

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

REQUEST

Parameters to Send

Type	Identifier	Description
String	Nit	Taxpayer document number to consult
String	CompanyToken	Supplied by The Factory HKA Colombia according to the environment to be consulted
	TokenPassword
String	Platform	Platform name corresponds to TFHKA

RESPONSE

Parameters to Receive when consulting the ConsultClients Method

Type	Identifier	Description
int	Code	Indicates the status of the operation returned by the service
String	Result	Method consumption result: “Successful” or “Error”
String	Message	This message is associated with the code, useful for error identification
String	Nit	Document number of the taxpayer consulted
String	Platform	Name of the platform to consult TFHKA or DIAN numbering
Array <Customers>	Clients	History of Clients configured in TFHKA in the Demo or Production portal.
Array <CustomerAddress>	CustomerAddress	Information detailing the Customer's reception address
Array <FiscalAddress>	FiscalAddress	Tax address of the client.
Array <TaxDetails>	Tax Details	Customer tax details.
Array <Responsibilities>	Responsibilities	Obligations and regime of the client
Array <EconomicActivities>	Economic Activities	Corresponds to the economic activity code.

Where Class.Customers contains the following information:

RESPONSE

Parameters to Receive Client Array

Type	Identifier	Description
String	ClientId	Configured client identifier. TFHKA internal use.
String	Active	Indicates the status of the client Active= 1 Not Active=0
String	persontype	Person type identifier. It must correspond to one of the values in Table 5
String	DescriptionTypePerson	Indicates the type of natural or legal person
String	SocialReason	Name or Company Name of the client
String	BusinessName	Customer's Business Name
String	Names	Contact Name
String	Surnames	Contact Last Names
String	IdentificationType	Customer Identification Type. It must correspond to one of the values in Table 3
String	DescriptionTypeIdentification	It must correspond to one of the values in Table 3. Examples: Citizenship Card.
String	IdentificationNumber	Customer Tax Identification Number
String	DvIdentificationNumber	NIT verification digit of the acquirer
String	Regime	Optional, if informed, indicate “Not applicable”. Possible Values: 48: “Sales tax - VAT” 49: “Not responsible for VAT”
String	Mail	Email of the client that will go to the fiscal XML/UBL
String	Telephone	Customer telephone
String	Fax	Telefax Telephone
String	Reference	Reference number assigned to the customer
String	ContactName	Contact Name
String	Note	Additional contact note
String	Notify	Activate sending email to the acquirer. 1= Yes Notify 2= No Notify

Where Class.CustomerAddress contains the following information:

RESPONSE

Parameters to Receive ArrayCustomerAddress

Type	Identifier	Description
String	ClientId	Configured client identifier. TFHKA internal use.
String	Active	Indicates the status of the client Active= 1 Not Active=0
String	persontype	Person type identifier. It must correspond to one of the values in Table 5