Diferencia entre revisiones de «API CrearProducto»
Ir a la navegación
Ir a la búsqueda
Sin resumen de edición |
Sin resumen de edición |
||
| Línea 2: | Línea 2: | ||
<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> La API CrearProducto está construida en método POST. 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: | ||
<br> | <br> | ||
| Línea 34: | Línea 34: | ||
|Productos | |Productos | ||
|Parámetros que conforman la clase '''DetalleDeFactura''' del Objeto Factura'</u> | |Parámetros que conforman la clase '''DetalleDeFactura''' del Objeto Factura'</u> | ||
|- | |||
|Array | |||
|Establecimientos | |||
|Parámetros que se registra el establecimiento, inventario y ubicacion para el producto a crear. | |||
|} | |} | ||
<br> | <br> | ||
<br> | <br> | ||
; RESPONSE: Parámetros a Recibir al consultar el | |||
Donde Productos contiene la siguiente información: | |||
; REQUEST: Parámetros a Recibir Array Productos | |||
{| 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 | |||
|IdProducto | |||
|Identificador del Producto a crear | |||
|- | |||
|String | |||
|Tipo | |||
|Corresponde a la definicion si es Producto, Servicio u Otro | |||
|- | |||
|String | |||
|DescripcionTipo | |||
|Correspondiente de la descripcion de la variable. | |||
|- | |||
|String | |||
|Codigo | |||
|Codigo correspondiente al producto registrado | |||
|- | |||
|String | |||
|Descripcion | |||
|Descripcion del producto o servicio registrado | |||
|- | |||
|String | |||
|TipoCodigoEstandar | |||
|Descripcion del producto | |||
|- | |||
|String | |||
|DescripcionCodigoEstandar | |||
|Corresponde a las | |||
|- | |||
|String | |||
|CodigoEstandar | |||
|Descripcion del producto | |||
|- | |||
|String | |||
|IdUnidadMedida | |||
|Descripcion del producto | |||
|- | |||
|String | |||
|UnidadMedida | |||
|Descripcion del producto | |||
|} | |||
{ | |||
<br /> | |||
<br /> | |||
; RESPONSE: Parámetros a Recibir al consultar el Api CrearProducto | |||
{| class="mw-collapsible wikitable" | {| class="mw-collapsible wikitable" | ||
! style="background:#f2f2f2; text-align:center;"|Tipo | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
Revisión del 20:52 27 jun 2025
La API CrearProducto es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de crear todo el catalogo de productos los registrará al realizar algún documento electrónico, y posteriormente los podrá visualizar en el portal de HKA Factura en ambiente demo y en ambiente de producción o al realizar el consumo del servicio a través de la Api ConsultarProductos.
@IMPORTANTE: La API CrearProducto está construida en método POST. 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:
CrearProducto
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio CrearProductoy 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 emisor. |
| String | TokenEmpresa | Suministrado por The Factory HKA Colombia según el ambiente a consultar |
| TokenClave | ||
| String | ClaveSecreta | Definida por el contribuyente emisor desde el usuario root a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción PROXIMAMENTE |
| Array <Productos> | Productos | Parámetros que conforman la clase DetalleDeFactura del Objeto Factura' |
| Array | Establecimientos | Parámetros que se registra el establecimiento, inventario y ubicacion para el producto a crear. |
Donde Productos contiene la siguiente información:
- REQUEST
- Parámetros a Recibir Array Productos
| Tipo | Identificador | Descripción |
|---|---|---|
| String | IdProducto | Identificador del Producto a crear |
| String | Tipo | Corresponde a la definicion si es Producto, Servicio u Otro |
| String | DescripcionTipo | Correspondiente de la descripcion de la variable. |
| String | Codigo | Codigo correspondiente al producto registrado |
| String | Descripcion | Descripcion del producto o servicio registrado |
| String | TipoCodigoEstandar | Descripcion del producto |
| String | DescripcionCodigoEstandar | Corresponde a las |
| String | CodigoEstandar | Descripcion del producto |
| String | IdUnidadMedida | Descripcion del producto |
| String | UnidadMedida | Descripcion del producto |
{
- RESPONSE
- Parámetros a Recibir al consultar el Api CrearProducto
| 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 | Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) |
| String | idEmpresa | Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) |
| String | IdPorducto | Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) |