API ConsultarClientes
Revisión del 17:41 28 abr 2023 de Dmrodriguez (discusión | contribuciones)
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:
|
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 |