API ConsultarCategoria
La API ConsultarCategoria es un desarrollo elaborado por el equipo de The Factory HKA el cual tiene como objetivo conocer las categorias que tiene cada contribuyente creadas según su modelo de facturacion, estas se pueden consultar 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:
ConsultarCategoria
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarCategoria 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 a consultar numeración TFHKA o DIAN |
- RESPONSE
- Parámetros a Recibir al consultar el Método ConsultarCategoria
| 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 | IdEmpresa | Identificador interno del Contribuyente emisor ante TFHKA |
| Array <Categorias> | Categorias | Parametros que conforman la informacion de cada una de las categorias |
Donde Class.Categoria contiene la siguiente información:
| Tipo | Identificador | Descripción |
|---|---|---|
| String | Id | Identificador interno autogestionado por el Contribuyente emisor ante TFHKA, no es obligatorio puede enviarse en null para que el sistema automaticamente le genere un Id |
| String | Codigo | Identificador interno autogestionado por el Contribuyente emisor ante TFHKA. |
| String | Nombre | Nombre de la Categoria que desea Crear |
| String | Descripcion | Descripcion de la Categoria que desea Crear |
| String | Activo | Código que indica el estatus actual del secuencial en la plataforma de web 0: Inactivo o 1: Activo. Uso interno TFHKA. |
