API ConsultarCliente - Historial de revisiones

Dmrodriguez2 en 13:39 27 jun 2025

2025-06-27T13:39:00Z

← Revisión anterior		Revisión del 13:39 27 jun 2025
Línea 2:		Línea 2:
	<br>		<br>
	<br>		<br>
	<font color="red">'''@IMPORTANTE:'''</font> Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:		<font color="red">'''@IMPORTANTE:'''</font> La API ConsultarCliente está construida en método POST. Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:
	<br>		<br>
	<br>		<br>

Dmrodriguez2 en 20:05 13 jun 2025

2025-06-13T20:05:20Z

← Revisión anterior		Revisión del 20:05 13 jun 2025
Línea 8:		Línea 8:
	'''[[Tips_Urls_de_Emisión #ConsultarCliente\|ConsultarCliente]]'''		'''[[Tips_Urls_de_Emisión #ConsultarCliente\|ConsultarCliente]]'''

	A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ~~<u>~~ConsultarCliente~~</u>~~ y de esta forma garantizar la implementación de este nuevo método:		A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio '''ConsultarCliente''' y de esta forma garantizar la implementación de este nuevo método:

	; REQUEST: Parámetros a Enviar		; REQUEST: Parámetros a Enviar

Dmrodriguez2 en 13:37 11 jun 2025

2025-06-11T13:37:37Z

← Revisión anterior		Revisión del 13:37 11 jun 2025
Línea 62:		Línea 62:
	\|Nombre de la plataforma a consultar corresponde a TFHKA		\|Nombre de la plataforma a consultar corresponde a TFHKA
	\|-		\|-
	\|~~Array <Clientes>~~		\|Class Cliente
	\|~~Clientes~~		\|Cliente
	\|Histórico de los Clientes configuradas en TFHKA en el portal Demo o Producción.		\|Histórico de los Clientes configuradas en TFHKA en el portal Demo o Producción.
	\|-		\|-
	\|~~Array <~~DireccionCliente>		\|Class DireccionCliente
	\|DireccionCliente		\|DireccionCliente
	\|Información donde se detalle la dirección de recepción del Cliente		\|Información donde se detalle la dirección de recepción del Cliente
	\|-		\|-
	\|~~Array <~~DireccionFiscal>		\|Class DireccionFiscal
	\|DireccionFiscal		\|DireccionFiscal
	\|Dirección fiscal del cliente.		\|Dirección fiscal del cliente.
	\|-		\|-
	\|~~Array <~~DetallesTributarios>		\|Class DetallesTributarios
	\|DetallesTributarios		\|DetallesTributarios
	\|Detalles tributarios del cliente.		\|Detalles tributarios del cliente.
	\|-		\|-
	\|~~Array <~~Responsabilidades>		\|Class Responsabilidades
	\|Responsabilidades		\|Responsabilidades
	\|Obligaciones y régimen del cliente		\|Obligaciones y régimen del cliente
	\|-		\|-
	\|~~Array <~~ActividadesEconomicas>		\|Class ActividadesEconomicas
	\|ActividadesEconomicas		\|ActividadesEconomicas
	\|Corresponde al código de actividad económica.		\|Corresponde al código de actividad económica.
Línea 89:		Línea 89:
	{{clear}}		{{clear}}

	Donde Class.~~Clientes~~ contiene la siguiente información:		Donde Class.Cliente contiene la siguiente información:

	; RESPONSE: Parámetros a Recibir Array Clientes		; RESPONSE: Parámetros a Recibir Array Clientes

Dmrodriguez2 en 17:52 25 nov 2024

2024-11-25T17:52:19Z

← Revisión anterior		Revisión del 17:52 25 nov 2024
Línea 31:		Línea 31:
	\|Parametro no Obligatorio corresponde al nombre de la plataforma = TFHKA		\|Parametro no Obligatorio corresponde al nombre de la plataforma = TFHKA
	\|}		\|}
	~~<br>~~
	<br>		<br>

	~~<center>'''Ejemplo Request ConsultarCliente'''</center>~~
	~~[[Archivo:RequestConsultarClienteFacturacion.png\|800px\|sinmarco\|centro\|Request Consultar ClienteFacturacion]]~~
	~~<br />~~

	; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarClientes		; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarClientes

Dmrodriguez2 en 21:48 22 ago 2024

2024-08-22T21:48:56Z

← Revisión anterior		Revisión del 21:48 22 ago 2024
Línea 29:		Línea 29:
	\|String		\|String
	\|Plataforma		\|Plataforma
	\|~~Nombre~~ de la plataforma ~~corresponde a~~ TFHKA		\|Parametro no Obligatorio corresponde al nombre de la plataforma = TFHKA
	\|}		\|}
	<br>		<br>
			<br>

			<center>'''Ejemplo Request ConsultarCliente'''</center>
			[[Archivo:RequestConsultarClienteFacturacion.png\|800px\|sinmarco\|centro\|Request Consultar ClienteFacturacion]]
			<br />

	; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarClientes		; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarClientes
	{\| class="mw-collapsible wikitable"		{\| class="mw-collapsible wikitable"
Línea 39:		Línea 45:
	\|- valign="center"		\|- valign="center"
	\|-		\|-
	\|~~int~~		\|Int
	\|Código		\|Código
	\|Indica el estado de la operación retornado por el servicio		\|Indica el estado de la operación retornado por el servicio
Línea 58:		Línea 64:
	\|String		\|String
	\|Plataforma		\|Plataforma
	\|Nombre de la plataforma a consultar ~~numeración~~ TFHKA ~~o DIAN~~		\|Nombre de la plataforma a consultar corresponde a TFHKA
	\|-		\|-
	\|Array <Clientes>		\|Array <Clientes>

Dmrodriguez2 en 03:33 13 jul 2024

2024-07-13T03:33:03Z

← Revisión anterior		Revisión del 03:33 13 jul 2024
Línea 25:		Línea 25:
	\|rowspan="2"\|Suministrado por The Factory HKA Colombia según el ambiente a consultar		\|rowspan="2"\|Suministrado por The Factory HKA Colombia según el ambiente a consultar
	\|-		\|-
	\|~~TokenPassword~~		\|TokenClave
	\|-		\|-
	\|String		\|String

Dmrodriguez2: Página creada con «La API '''ConsultarCliente''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente consultar los clientes que tiene re…»

2023-11-14T21:10:21Z

Página creada con «La API '''ConsultarCliente''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente consultar los clientes que tiene re…»

Página nueva

La API '''ConsultarCliente''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente consultar los clientes que tiene registrados en el portal de factura electrónica en ambiente demo y en ambiente de producción.
 
 
'''@IMPORTANTE:''' Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:
 
 
'''Para mayor información pude consultas las URL en la siguiente sección:'''
'''[[Tips_Urls_de_Emisión #ConsultarCliente|ConsultarCliente]]'''

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarCliente y de esta forma garantizar la implementación de este nuevo método:

; REQUEST: Parámetros a Enviar
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|String
|Nit
|Número de documento del contribuyente a consultar
|-
|rowspan="2"|String
|TokenEmpresa
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|-
|TokenPassword
|-
|String
|Plataforma
|Nombre de la plataforma corresponde a TFHKA
|}
 
; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarClientes
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|int
|Código
|Indica el estado de la operación retornado por el servicio
|-
|String
|Resultado
|Resultado del consumo del método:
: “Exitoso” ó “Error”
|-
|String
|Mensaje
|Este mensaje está asociado al codigo, útil para identificación de errores
|-
|String
|Nit
|Número de documento del contribuyente consultado
|-
|String
|Plataforma
|Nombre de la plataforma a consultar numeración TFHKA o DIAN
|-
|Array <Clientes>
|Clientes
|Histórico de los Clientes configuradas en TFHKA en el portal Demo o Producción.
|-
|Array <DireccionCliente>
|DireccionCliente
|Información donde se detalle la dirección de recepción del Cliente
|-
|Array <DireccionFiscal>
|DireccionFiscal
|Dirección fiscal del cliente.
|-
|Array <DetallesTributarios>
|DetallesTributarios
|Detalles tributarios del cliente.
|-
|Array <Responsabilidades>
|Responsabilidades
|Obligaciones y régimen del cliente
|-
|Array <ActividadesEconomicas>
|ActividadesEconomicas
|Corresponde al código de actividad económica.
|-
|}
{{clear}}

Donde Class.Clientes contiene la siguiente información:

; RESPONSE: Parámetros a Recibir Array Clientes
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|String
|IdCliente
|Identificador del cliente configurado. '''Uso interno TFHKA'''.
|-
|String
|Activo
|Indica el status del cliente Activo= 1 No Activo=0
|-
|String
|tipoPersona
|Identificador de tipo de persona. Debe corresponder a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 5|Tabla 5]]
|-
|String
|DescripcionTipoPersona
|Indica el tipo de persona Natural o Jurídica
|-
|String
|RazonSocial
|Nombre o Razón Social del cliente
|-
|String
|NombreComercial
|Nombre Comercial del cliente
|-
|String
|Nombres
|Nombre de Contacto
|-
|String
|Apellidos
|Apellidos de Contacto
|-
|String
|TipoIdentificacion
|Tipo de Identificación del cliente. Debe corresponder a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 3|Tabla 3]]
|-
|String
|DescripcionTipoIdentificacion
|Debe corresponder a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 3|Tabla 3]]. Ejemplos: '''Cedula de Ciudadanía'''.
|-
|String
|NumeroIdentificacion
|Número de Identificación Fiscal del Cliente
|-
|String
|NumeroIdentificacionDv
|Digito de verificación NIT del adquiriente
|-
|String
|Regimen
|
: Opcional, si informado indicar “No aplica”. Posibles Valores:
: 48: “Impuesto sobre las ventas - IVA”
: 49: “No responsable de IVA”
|-
|String
|Correo
|Correo Electrónico del cliente que irá al XML/UBL fiscal
|-
|String
|Telefono
|Teléfono del cliente
|-
|String
|Fax
|Teléfono del Telefax
|-
|String
|Referencia
|Numero referencia asignado al cliente
|-
|String
|NombreContacto
|Nombre de Contacto
|-
|String
|Nota
|Nota adicional de contacto
|-
|String
|Notificar
|Activa el envío de email al adquirente. 1= Si Notifica 2= No Notificar
|-
|}
{{clear}}

Donde Class.DireccionCliente contiene la siguiente información:

; RESPONSE: Parámetros a Recibir Array DireccionCliente
{| class="mw-collapsible wikitable"
! style="background:#f2f2f2; text-align:center;"|Tipo
! style="background:#f2f2f2; text-align:center;"|Identificador
! style="background:#f2f2f2; text-align:center;"|Descripción
|- valign="center"
|-
|String
|IdCliente
|Identificador del cliente configurado. '''Uso interno TFHKA'''.
|-
|String
|Activo
|Indica el status del cliente Activo= 1 No Activo=0
|-
|String
|tipoPersona
|Identificador de tipo de persona. Debe corresponder a uno de los valores de la [[Tablas de códigos de propiedades para emisión de documentos - Indice Manual Integración Directa#Tabla 5|Tabla 5]]
|-