Diferencia entre revisiones de «API ConsultarClientes»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
Línea 33: Línea 33:
 
|}
 
|}
 
<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.
 +
|-
 +
|}
 +
{{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
 +
|-
 +
|}
 +
{{clear}}

Revisión del 17:41 28 abr 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
Obtenido de «http://felcowiki.thefactoryhka.com.co/index.php?title=API_ConsultarClientes&oldid=3980»