Diferencia entre revisiones de «API ConsultarClientes»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
 
(No se muestran 11 ediciones intermedias de 2 usuarios)
Línea 1: Línea 1:
−
<includeonly>=</includeonly>== <font color="Blue"> API ConsultarClientes</font> ==<includeonly>=</includeonly>
+
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.
−
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.
 
 
<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> 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| Tips Urls de Emisión]]'''
 
 
<br>
 
<br>
−
 
+
<br>
−
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:
+
'''Para mayor información pude consultas las URL en la siguiente sección:'''
 +
'''[[Tips_Urls_de_Emisión #ConsultarClientes|ConsultarClientes]]'''
 +
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio <u>ConsultarClientes</u> y de esta forma garantizar la implementación de este nuevo método:
  
 
; REQUEST: Parámetros a Enviar
 
; REQUEST: Parámetros a Enviar
Línea 33: Línea 31:
 
|}
 
|}
 
<br>
 
<br>
 +
; 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. <u>'''Uso interno TFHKA'''</u>.
 +
|-
 +
|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. <u>'''Uso interno TFHKA'''</u>.
 +
|-
 +
|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]]
 +
|-

Revisión actual del 19:30 10 nov 2023

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 consultas las URL en la siguiente sección: 

ConsultarClientes

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.
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.

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 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

Donde Class.DireccionCliente contiene la siguiente información:

RESPONSE
Parámetros a Recibir Array DireccionCliente
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
Obtenido de «http://felcowiki.thefactoryhka.com.co/index.php?title=API_ConsultarClientes&oldid=4796»