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…»)
 
(No se muestran 8 ediciones intermedias de 2 usuarios)
Línea 7: Línea 7:
  
 
'''Para mayor información pude consultas las URL en la siguiente sección:'''
 
'''Para mayor información pude consultas las URL en la siguiente sección:'''
−
  '''[[Tips_Urls_de_Emisión #API API AsociarCatalogoAsociado|API AsociarCatalogoAsociado]]'''
+
  '''[[Tips_Urls_de_Emisión #AsociarCatalogoAsociado|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:
  
−
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>
+
|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.
 
|-
 
|-
 
|String
 
|String
 
|Identificador
 
|Identificador
−
|Este parámetro es Opcional puede reportar el nombre o ID del catalogoAsociado
+
|Nombre del catalogo que desea asociar
 
|-
 
|-
 
|String
 
|String
 
|IdsCatalogo
 
|IdsCatalogo
−
|Este parámetro es Opcional puede reportar el nombre o ID del catalogoAsociado
+
|Codigo de la unidadMedida a asociar.
 
|}
 
|}
 +
<br>
 +
<br>
 +
 +
<center>'''Ejemplo  Request AsociarCatalogoAsociado'''</center>
 +
[[Archivo:RequestAsociarCatalogo.png|800px|sinmarco|centro|Request Asociar Catalogo]]
 +
<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
 +
|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
 +
|}
 +
<br>
 +
<br>
 +
 +
<center>'''Ejemplo  Response AsociarCatalogoAsociado '''</center>
 +
[[Archivo:AsociarCatalogoAsociado.png|800px|sinmarco|centro|AsociarCatalogoAsociado]]
 +
<br>
 
<br>
 
<br>

Revisión del 16:44 22 ago 2024

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.

@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: 

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
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 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.
String Identificador Nombre del catalogo que desea asociar
String IdsCatalogo Codigo de la unidadMedida a asociar.



Ejemplo Request AsociarCatalogoAsociado
Request Asociar Catalogo


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



Ejemplo Response AsociarCatalogoAsociado
AsociarCatalogoAsociado



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