Diferencia entre revisiones de «API ActualizarCliente»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
 
(No se muestra una edición intermedia de otro usuario)
Línea 25: Línea 25:
 
|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
Línea 155: Línea 155:
 
|}
 
|}
 
<br>
 
<br>
 +
 +
 +
<br>
 +
; RESPONSE: Parámetros a Recibir al consultar el Método ActualizarCliente
 +
{| 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
 +
|IdEmpresa
 +
|Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
 +
|-
 +
|String
 +
|IdCliente
 +
|Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
 +
|-
 +
|}
 +
{{clear}}
 +
<br>
 +
 +
<center>'''Ejemplo  Response ActualizarCliente '''</center>
 +
[[Archivo:ActualizarCliente.png|800px|sinmarco|centro|ActualizarCliente]]
 +
<br />
 +
<br />

Revisión actual del 03:33 13 jul 2024

La API ActualizarCliente es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de actualizar el catalogo de clientes registrados en el portal de HKA Factura en ambiente demo y en ambiente de producción o a realizar el consumo del servicio a través de la Api ActualizarCliente.

@IMPORTANTE: La Api ActualizarCliente tiene es 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: 

ActualizarCliente

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ActualizarClientey 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 a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción PROXIMAMENTE
Array <Cliente> Cliente Parámetros que conforman la clase Cliente del Objeto Factura
Direccion DireccionCliente Parámetros que conforman la clase DireccionCliente del Objeto Factura
Direccion DireccionFiscal Parámetros que conforman la clase DireccionFiscal del Objeto Factura
Array <Tributos> detallesTributarios Parámetros que conforman la clase detallesTributarios del Objeto Factura
Array <Obligaciones> Responsabilidades Parámetros que conforman la clase detallesTributarios del Objeto Factura
String ActividadesEconomicas Parámetros que conforma la clase Cliente del Objeto Factura
String ActividadesEconomicas Parámetros que conforma la clase Cliente del Objeto Factura

Donde Class.Cliente contiene la siguiente información:

Tipo Identificador Descripción
String IdCliente Código con el que se identifica el cliente.
String Activo Indica el estatus actual del cliente a actualizar
String TipoPersona Identificador de tipo de persona. El contenido de este atributo corresponde a uno de los valores de la Tabla 5
String DescripcionTipoPersona Indica si es Natural o Jurídica según catalogo
String RazonSocial Nombre o Razón Social del adquirente
String NombreComercial Nombre Comercial del adquiriente
String Nombres Nombre de Contacto
String Apellido de Contacto Nombre de Contacto
String IdTipoIdentificacion Id que identifica el tipo de identificación del adquiriente
String TipoIdentificacion Tipo de Identificación del adquiriente. El contenido de este atributo debe corresponder a uno de los valores de la Tabla 3
String DescripcionTipoIdentificacion Indica el tipo de documento del adquiriente
String NumeroIdentificacion Número del Documento o Identificación Fiscal del adquirente
String NumeroIdentificacionDv Digito de verificación NIT del adquiriente. Si tipoIdentificacion = 31.
String IdRegimen Código con el que se indica el régimen registrado.
String Regimen Régimen del adquiriente
String Correo Correo Electrónico del adquiriente que irá al XML/UBL fiscalRégimen del adquiriente
String Teléfono Teléfono del adquiriente
String Fax Telefax
String Referencia Registro de referencia del adquiriente
String NombreContacto Nombre de Contacto.
String Nota Nota adicional de contacto
String Notificar Activa el envío de email al adquirente. Valores posibles: “SI” o “NO”.




RESPONSE
Parámetros a Recibir al consultar el Método ActualizarCliente
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 IdEmpresa Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
String IdCliente Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)


Ejemplo Response ActualizarCliente
ActualizarCliente



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