Diferencia entre revisiones de «API EliminarCatalogoAsociado»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
← Edición anterior
Sin resumen de edición
Sin resumen de edición
 
(No se muestran 10 ediciones intermedias del mismo usuario)
Línea 1: Línea 1:
La API '''EliminarCatalogoAsociado''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de Eliminar un catalogo asociado a los registros del portal de factura electrónica en ambiente demo y en ambiente de producción.
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.
<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 '''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:
<br>
<br>


Línea 9: Línea 9:
  '''[[Tips_Urls_de_Emisión #EliminarCatalogoAsociado|EliminarCatalogoAsociado]]'''
  '''[[Tips_Urls_de_Emisión #EliminarCatalogoAsociado|EliminarCatalogoAsociado]]'''


A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio '''API EliminarCatalogoAsociado''' y de esta forma garantizar la implementación de este nuevo método:
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:




Línea 27: Línea 27:
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
|-
|-
|TokenPassword
|TokenClave
|-
|-
|String
|String
|ClaveSecreta
|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 <u>'''PROXIMAMENTE'''</u>
|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
|Este parámetro es Opcional puede reportar el nombre o ID del catalogoAsociado
|Nombre o identificador único del catálogo maestro al cual se desean asociar los elementos especificados en IdsCatalogo (ej. "UnidadesMedida").
|-
|-
|String
|Array de Strings
|IdsCatalogo
|IdsCatalogo
|Este parámetro es Opcional puede reportar el nombre o ID del catalogoAsociado
|(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>
<br>


<center>'''Ejemplo  Request EliminarCatalogoAsociado'''</center>
[[Archivo:RequestEliminarCatalogoAsociado.png|800px|sinmarco|centro|Request EliminarCatalogoAsociado]]
<br />
<br />


; RESPONSE: Parámetros a Recibir al consultar el Método EliminarCatalogoAsociado
; RESPONSE: Parámetros a Recibir al consultar el Método EliminarCatalogoAsociado
Línea 71: Línea 66:
|String
|String
|Nit
|Nit
|Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
|Número de documento del contribuyente.
|-
|-
|String
|String
Línea 79: Línea 74:
|String
|String
|Identificador
|Identificador
|Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
|Nombre del catalogo eliminado
|-
|-
|String
|String
|ids
|ids
|Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
|Codigo de la unidadMedida eliminada.
|-
|-
|String
|Array <Errores>
|Lista de errores en caso de error al consumo del servicio
|}  
|}  
{{clear}}
{{clear}}
<br>
<br>
<br>


<center>'''Ejemplo  Response EliminarCatalogoAsociado'''</center>
 
[[Archivo:ResponseEliminarCatalogoAsociado.png|800px|sinmarco|centro|Response EliminarCatalogoAsociado]]
<br />
<br />
<br />
<br />

Revisión actual - 15:03 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").
Array de Strings 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:
“Exitoso” ó “Error”
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





Obtenido de «http://felcowiki.thefactoryhka.com.co/index.php?title=API_EliminarCatalogoAsociado&oldid=8684»