Diferencia entre revisiones de «API ConsultarClientes»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
Línea 87: Línea 87:
 
|String
 
|String
 
|tipoPersona
 
|tipoPersona
−
|Identificador de tipo de persona  
+
|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]]
−
: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
 
|String
Línea 112: Línea 111:
 
|String
 
|String
 
|TipoIdentificacion
 
|TipoIdentificacion
−
|Tipo de Identificación del cliente.
+
|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]]
−
: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
 
|String
Línea 129: Línea 127:
 
|String
 
|String
 
|Regimen
 
|Regimen
−
|Apellidos de Contacto
+
|
 +
: 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
 +
|Teléfono del Telefax
 
|-
 
|-
 
|}  
 
|}  
 
{{clear}}
 
{{clear}}

Revisión del 22:36 2 may 2023

API ConsultarClientes

La API ConsultarClientes 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 visitar la siguiente sección:
 Tips Urls de Emisión


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

REQUEST
Parámetros a Enviar
Tipo Identificador Descripción
String Nit Número de documento del contribuyente a consultar
String TokenEmpresa 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
Tipo Identificador Descripción
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.

Donde Class.Clientes contiene la siguiente información:

RESPONSE
Parámetros a Recibir Array Clientes
Tipo Identificador Descripción
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 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 Tabla 3
String DescripcionTipoIdentificacion Debe corresponder a uno de los valores de la 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 Teléfono del Telefax
Obtenido de «http://felcowiki.thefactoryhka.com.co/index.php?title=API_ConsultarClientes&oldid=3982»