API CrearCategoria
La API CrearCategoria es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de crear diferentes categorias con las cuales podrá generar un control administrativo según del modelo de facturacion del emisor, a traves de esta Api podra crear Categorias de Productos, Clientes, entre otros; 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:
CrearCategoria
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio CrearCategoria 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 | ClaveSecreta | Definida por el contribuyente emisor a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción. |
Array <Categoria> | Categoria | 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 |
- RESPONSE
- Parámetros a Recibir al consultar el Método CrearCategoria
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 | Mensaje se confirmacion del consumo “Creacion Exitosa” ó “Mensaje de Error ” |
String | IdEmpresa | Identificador interno del Contribuyente emisor ante TFHKA |
String | IdCategoria | Identificador interno de la Categoria Contribuyente emisor ante TFHKA se genera automaricamente por el servicio y se puede consultar al consumir la Api ConsultarCategoria |
String | Activo | Código que indica el estatus actual del secuencial en la plataforma de web 0: Inactivo o 1: Activo. Uso interno TFHKA. |
String | Errores | Listo de errores en caso que inconsistencias en el consumo de la Api |