Diferencia entre revisiones de «API LaFactura.co:Whisp Customer»
Ir a la navegación
Ir a la búsqueda
(Página creada con «==Objeto:customer (Datos de clientes)== Este servicio te permite conocer todos los datos de un cliente específico del sistema. Puedes hacer la consulta usando '''POST''' e…») |
|||
(No se muestran 12 ediciones intermedias del mismo usuario) | |||
Línea 24: | Línea 24: | ||
=====Resultados===== | =====Resultados===== | ||
− | Devuelve un objeto ''' | + | Devuelve un objeto '''result''' con el resultado de la operación |
{ | { | ||
Línea 33: | Línea 33: | ||
}, | }, | ||
"customer": { | "customer": { | ||
− | + | "additionalAccountID": "1", | |
− | + | "name": "PEPITO PEREZ Y CIA SAS", | |
− | + | "taxInfo": "R-99-PN", | |
− | + | "countryName": "Colombia", | |
− | + | "countryCode": "CO", | |
− | + | "city": "BOGOTÁ", | |
− | + | "countryEntity": "11", | |
− | + | "countrySubentity": "11001", | |
− | + | "addressLine": "CRA 21 NO. 21-21", | |
− | + | "documentType": "31", | |
− | + | "documentNumber": "900900900", | |
− | + | "telephone": "601-21212121", | |
− | + | "email": "xxxxxxxxxxxxxx@ejemplo.com", | |
− | + | "emailDIAN": { | |
− | + | "email": "xyz@ejemplo.com", | |
− | + | "lastUpdate": "20191104" | |
− | + | }, | |
− | + | "legal": { | |
− | + | "name": "PEPITO PEREZ Y CIA SAS", | |
− | + | "additionalName": "", | |
− | + | "fullID": "NIT 900900900 - 6", | |
− | + | "status": "ACTIVA", | |
− | + | "city": "BOGOTA", | |
− | + | "intID": "21212121", | |
− | + | "type": "SOCIEDADES POR ACCIONES SIMPLIFICADAS SAS" | |
− | + | } | |
} | } | ||
− | + | } | |
− | + | } | |
+ | |||
+ | |||
+ | =====Objeto:result===== | ||
+ | Informa los estados de error sobre el proceso realizado | ||
+ | |||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Parámetro !! Descripción !! Tipo !! Obligatorio | ||
+ | |- | ||
+ | | code || Código de estado<br><small>200 -> Resultado OK<br>201 -> Sólo se obtuvo el EMAIL de la DIAN<br>>=1000 Error</small> || cadena || SI | ||
+ | |- | ||
+ | | text || Texto explicativo del estado || cadena || SI | ||
+ | |} | ||
+ | |||
=====Objeto:customer===== | =====Objeto:customer===== | ||
Línea 70: | Línea 84: | ||
! Parámetro !! Descripción !! Tipo !! Obligatorio | ! Parámetro !! Descripción !! Tipo !! Obligatorio | ||
|- | |- | ||
− | | | + | | additionalAccountID || Tipo de cliente<br><small>"1" -> es persona jurídica<br>"2" ->es persona natural</small> || cadena || SI |
− | |||
− | |||
|- | |- | ||
− | | name || || cadena || SI | + | | name || Nombre de la empresa o persona || cadena || SI |
|- | |- | ||
− | | taxInfo || | + | | taxInfo || Datos referentes a las responsabilidades fiscales:<br><small>* O-13 -> Gran contribuyente<br/>* O-15 -> Autorretenedor<br/>* O-23 -> Agente de retención de IVA<br/>* O-47 -> Regimen simple de tributacion<br/>* R-99-PN -> No Aplica - Otros<br/>Puede contener mas de una obligación, separada por ";" (punto y coma)</small> || cadena || SI |
|- | |- | ||
− | | countryName || | + | | countryName || Nombre completo del pais || cadena || SI |
|- | |- | ||
− | | countryCode || | + | | countryCode || Código ISO de dos letras del país<small><br>Revisa los códigos aquí: https://es.wikipedia.org/wiki/ISO_3166-2</small> || cadena || SI |
|- | |- | ||
− | | city || | + | | city || Ciudad del cliente || cadena || SI |
|- | |- | ||
− | | countryEntity || | + | | countryEntity || Código del departamento según DIAN<small><br>[[API_LaFactura.co:Tabla_Departamentos|consultar tabla]]</small> || cadena || SI |
|- | |- | ||
− | | countrySubentity || || cadena || SI | + | | countrySubentity || Código del municipio según tabla DIAN<small><br>[[API_LaFactura.co:Tabla_Municipios|consultar tabla]]</small> || cadena || SI |
|- | |- | ||
− | | addressLine || | + | | addressLine || Dirección física del cliente || cadena || SI |
|- | |- | ||
− | | documentType || | + | | documentType || Tipo de documento según la DIAN<br><small>[[API_LaFactura.co:Tabla_Tipos_Documento|consultar tabla]]</small> || cadena || SI |
|- | |- | ||
− | | documentNumber || | + | | documentNumber || Identificación tributaria del cliente || cadena || SI |
|- | |- | ||
− | | telephone || | + | | telephone || Número telefónico del cliente || cadena || SI |
|- | |- | ||
− | | email || | + | | email || Correo electronico del cliente<br/><small>Pueden ser varios separados por ";".</small> || cadena || SI |
|- | |- | ||
− | | emailDIAN || | + | | emailDIAN || Información relacionada por la DIAN acerca del correo de facturación vinculado en su portal<small><br/><b>En personas naturales no registradas en la DIAN aparece en null</b></small> || objeto || NO |
|- | |- | ||
− | | emailDIAN/email || || cadena || SI | + | | emailDIAN/email || Correo reportado en la DIAN para facturación (puede ser null) || cadena || SI |
|- | |- | ||
− | | emailDIAN/lastUpdate || | + | | emailDIAN/lastUpdate || Ultima actualización del correo en la DIAN || cadena || SI |
|- | |- | ||
− | | legal || | + | | legal || Datos tomados del portal del RUES<small><b><br/>Puede ser null<br/>En el proceso Actual (2023.09.01) Aún no tenemos todos los registros activos con esta información</b></small> || objeto || NO |
|- | |- | ||
− | | legal/name || | + | | legal/name || Nombre legal de la empresa || cadena || SI |
|- | |- | ||
− | | legal/additionalName || | + | | legal/additionalName || Siglas de la empresa || cadena || SI |
|- | |- | ||
− | | legal/fullID || | + | | legal/fullID || NIT Completo || cadena || SI |
|- | |- | ||
− | | legal/Status || | + | | legal/Status || Estado de registro en cámara de comercio || cadena || SI |
|- | |- | ||
− | | legal/city || | + | | legal/city || Ciudad || cadena || SI |
|- | |- | ||
− | | legal/intID || | + | | legal/intID || Numero de registro en la cámara || cadena || SI |
|- | |- | ||
− | | legal/type || | + | | legal/type || Tipo de empresa || cadena || SI |
|} | |} | ||
Revisión actual del 20:02 31 ago 2023
Sumario
Objeto:customer (Datos de clientes)
Este servicio te permite conocer todos los datos de un cliente específico del sistema. Puedes hacer la consulta usando POST en la URL del servicio e incluir el siguiente objeto.
Ingreso: https://***.tas-la.com/whisp.v10/customer/ Solicita tu usuario y contraseña +57-601-7466664 No cobramos por el proceso de pruebas o desarrollo Y puedes empezar inmediatamente (sin certificados o papeleos)
{ "customer":"900900900" }
Campos
Envía la información referente al cliente a consultar
Parámetro | Descripción | Tipo | Obligatorio |
---|---|---|---|
customer | NIT o cédula del cliente a consultar .. sin puntos, guiones o dígitos de verificación | cadena | SI |
Resultados
Devuelve un objeto result con el resultado de la operación
{ "result":{ "status":{ "code": 200, "text":"Operación realizada con exito", }, "customer": { "additionalAccountID": "1", "name": "PEPITO PEREZ Y CIA SAS", "taxInfo": "R-99-PN", "countryName": "Colombia", "countryCode": "CO", "city": "BOGOTÁ", "countryEntity": "11", "countrySubentity": "11001", "addressLine": "CRA 21 NO. 21-21", "documentType": "31", "documentNumber": "900900900", "telephone": "601-21212121", "email": "[email protected]", "emailDIAN": { "email": "[email protected]", "lastUpdate": "20191104" }, "legal": { "name": "PEPITO PEREZ Y CIA SAS", "additionalName": "", "fullID": "NIT 900900900 - 6", "status": "ACTIVA", "city": "BOGOTA", "intID": "21212121", "type": "SOCIEDADES POR ACCIONES SIMPLIFICADAS SAS" } } } }
Objeto:result
Informa los estados de error sobre el proceso realizado
Parámetro | Descripción | Tipo | Obligatorio |
---|---|---|---|
code | Código de estado 200 -> Resultado OK 201 -> Sólo se obtuvo el EMAIL de la DIAN >=1000 Error |
cadena | SI |
text | Texto explicativo del estado | cadena | SI |
Objeto:customer
Contiene la relacion completa de información de clientes. El mismo contiene siempre los siguientes campos:
Parámetro | Descripción | Tipo | Obligatorio |
---|---|---|---|
additionalAccountID | Tipo de cliente "1" -> es persona jurídica "2" ->es persona natural |
cadena | SI |
name | Nombre de la empresa o persona | cadena | SI |
taxInfo | Datos referentes a las responsabilidades fiscales: * O-13 -> Gran contribuyente * O-15 -> Autorretenedor * O-23 -> Agente de retención de IVA * O-47 -> Regimen simple de tributacion * R-99-PN -> No Aplica - Otros Puede contener mas de una obligación, separada por ";" (punto y coma) |
cadena | SI |
countryName | Nombre completo del pais | cadena | SI |
countryCode | Código ISO de dos letras del país Revisa los códigos aquí: https://es.wikipedia.org/wiki/ISO_3166-2 |
cadena | SI |
city | Ciudad del cliente | cadena | SI |
countryEntity | Código del departamento según DIAN consultar tabla |
cadena | SI |
countrySubentity | Código del municipio según tabla DIAN consultar tabla |
cadena | SI |
addressLine | Dirección física del cliente | cadena | SI |
documentType | Tipo de documento según la DIAN consultar tabla |
cadena | SI |
documentNumber | Identificación tributaria del cliente | cadena | SI |
telephone | Número telefónico del cliente | cadena | SI |
Correo electronico del cliente Pueden ser varios separados por ";". |
cadena | SI | |
emailDIAN | Información relacionada por la DIAN acerca del correo de facturación vinculado en su portal En personas naturales no registradas en la DIAN aparece en null |
objeto | NO |
emailDIAN/email | Correo reportado en la DIAN para facturación (puede ser null) | cadena | SI |
emailDIAN/lastUpdate | Ultima actualización del correo en la DIAN | cadena | SI |
legal | Datos tomados del portal del RUES Puede ser null En el proceso Actual (2023.09.01) Aún no tenemos todos los registros activos con esta información |
objeto | NO |
legal/name | Nombre legal de la empresa | cadena | SI |
legal/additionalName | Siglas de la empresa | cadena | SI |
legal/fullID | NIT Completo | cadena | SI |
legal/Status | Estado de registro en cámara de comercio | cadena | SI |
legal/city | Ciudad | cadena | SI |
legal/intID | Numero de registro en la cámara | cadena | SI |
legal/type | Tipo de empresa | cadena | SI |
Temas complementarios
Enlaces
- LaFactura.co: https://lafactura.co
- GitHub: https://github.com/FacturacionElectronicaColombia/lafactura.co
Importante
Recuerda que nosotros no te cobramos absolutamente nada por que pruebes nuestra plataforma.
Si deseas tener un usuario y contraseña , comunícate con nosotros.