Diferencia entre revisiones de «API EliminarCatalogoAsociado»
Sin resumen de edición |
Sin resumen de edición |
||
| Línea 31: | Línea 31: | ||
|String | |String | ||
|ClaveSecreta | |ClaveSecreta | ||
| | |Clave definida por el contribuyente emisor desde el usuario root en el portal HKA Factura Electrónica (aplicable tanto en ambientes de demo como de producción) para autorizar esta acción. | ||
|- | |- | ||
|String | |String | ||
|Identificador | |Identificador | ||
|Nombre del | |Nombre o identificador único del catálogo maestro al cual se desean asociar los elementos especificados en IdsCatalogo (ej. "UnidadesMedida"). | ||
|- | |- | ||
|String | |String | ||
|IdsCatalogo | |IdsCatalogo | ||
| | |(Lista/Array) Conjunto de códigos o identificadores de los elementos específicos del catálogo maestro (Identificador) que se desean asociar al contribuyente (ej. ["NIU", "UND"]). Cada elemento dentro de la lista debe ser una cadena de texto. | ||
|} | |} | ||
<br> | <br> | ||
Revisión del 14:57 9 sep 2025
La API EliminarCatalogoAsociado proporciona la funcionalidad para desvincular un catálogo de un contribuyente. Esta operación es útil para revocar el acceso a ciertos catálogos o para limpiar asociaciones obsoletas o incorrectas. Se utiliza el método PUT para actualizar el estado de la relación, marcándola como eliminada o inactiva, garantizando la idempotencia y la posibilidad de revertir la operación si fuera necesario.
@IMPORTANTE: La Api EliminarCatalogoAsociado esta construida en método PUT. 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:
EliminarCatalogoAsociado
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio EliminarCatalogoAsociado 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 |
| TokenClave | ||
| String | ClaveSecreta | Clave definida por el contribuyente emisor desde el usuario root en el portal HKA Factura Electrónica (aplicable tanto en ambientes de demo como de producción) para autorizar esta acción. |
| String | Identificador | Nombre o identificador único del catálogo maestro al cual se desean asociar los elementos especificados en IdsCatalogo (ej. "UnidadesMedida"). |
| String | IdsCatalogo | (Lista/Array) Conjunto de códigos o identificadores de los elementos específicos del catálogo maestro (Identificador) que se desean asociar al contribuyente (ej. ["NIU", "UND"]). Cada elemento dentro de la lista debe ser una cadena de texto. |
- RESPONSE
- Parámetros a Recibir al consultar el Método EliminarCatalogoAsociado
| 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. |
| String | idEmpresa | Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) |
| String | Identificador | Nombre del catalogo eliminado |
| String | ids | Codigo de la unidadMedida eliminada. |
| String | Array <Errores> | Lista de errores en caso de error al consumo del servicio |