Diferencia entre revisiones de «API AsociarCatalogoAsociado»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
Página creada con «La API '''AsociarCatalogoAsociado''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de Asociar un catalogo a los…»
 
Sin resumen de edición
 
(No se muestran 14 ediciones intermedias de 2 usuarios)
Línea 1: Línea 1:
La API '''AsociarCatalogoAsociado''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de Asociar un catalogo a los registros del portal de factura electrónica en ambiente demo y en ambiente de producción.
La API '''AsociarCatalogoAsociado''' facilita la vinculación de nuevos catálogos a un contribuyente. Esta API es utilizada para establecer la relación entre un catálogo existente y un contribuyente, habilitando así el uso de los ítems definidos en ese catálogo para dicho contribuyente en operaciones posteriores (ej., emisión de documentos fiscales).
<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 AsociarCatalogoAsociado está construida en metodo 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>
<br>
'''Para mayor información pude consultas las URL en la siguiente sección:'''
'''[[Tips_Urls_de_Emisión #AsociarCatalogoAsociado|AsociarCatalogoAsociado]]'''




'''Para mayor información pude consultas las URL en la siguiente sección:'''
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio '''AsociarCatalogoAsociado''' y de esta forma garantizar la implementación de este nuevo método:
'''[[Tips_Urls_de_Emisión #API API AsociarCatalogoAsociado|API AsociarCatalogoAsociado]]'''
 


A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio '''API AsociarCatalogoAsociado''' y de esta forma garantizar la implementación de este nuevo método:


; REQUEST: Parámetros a Enviar
; REQUEST: Parámetros a Enviar
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").
|-
|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.
|}
<br>
 
 
; RESPONSE: Parámetros a Recibir al consultar el Método AsociarCatalogoAsociado
{| 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"
|-
|int
|Código
|Indica el estado de la operación retornado por el servicio
|-
|-
|String
|String
|IdsCatalogo
|Resultado
|Este parámetro es Opcional puede reportar el nombre o ID del catalogoAsociado
|Resultado del consumo del método:
: “Exitoso” ó “Error”
|-
|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 interno del Contribuyente emisor ante TFHKA
|-
|String
|Identificador
|Nombre del catalogo asociado a la cuenta
|-
|String
|Ids
|Codigo de la unidadMedida asociada
|-
|String
|Array <Errores>
|Lista de errores en caso de error al consumo del servicio
|}
|}
<br>
<br>
<br>
<br>
<br>

Revisión actual - 14:48 9 sep 2025

La API AsociarCatalogoAsociado facilita la vinculación de nuevos catálogos a un contribuyente. Esta API es utilizada para establecer la relación entre un catálogo existente y un contribuyente, habilitando así el uso de los ítems definidos en ese catálogo para dicho contribuyente en operaciones posteriores (ej., emisión de documentos fiscales).

@IMPORTANTE: La API AsociarCatalogoAsociado está construida en metodo 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: 

AsociarCatalogoAsociado


A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio AsociarCatalogoAsociado 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 AsociarCatalogoAsociado
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 Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
String idEmpresa Identificador interno del Contribuyente emisor ante TFHKA
String Identificador Nombre del catalogo asociado a la cuenta
String Ids Codigo de la unidadMedida asociada
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_AsociarCatalogoAsociado&oldid=8681»