Upnify API Docs
ERP · /suite/erp/clientes

Clientes

Clientes - Creación

POST/suite/erp/clientes

Crea un cliente y su razón social predeterminada. Si se proporcionan datos de contacto, también registra o actualiza el contacto principal asociado.

Parámetros

NombreTipoValidaciónDescripción
empresavarcharNombre comercial del cliente.
tkIndustriavarcharIdentificador de la industria que se asocia al cliente.
tkCorporativovarcharIdentificador del corporativo que se asocia al cliente.
urlvarcharSitio web del cliente.
telefonoCorporativovarcharTeléfono corporativo. Si se omite, se usa telefono cuando esté disponible.
telefonovarcharTeléfono alternativo del cliente.
direccion1varcharPrimera línea del domicilio comercial. Si se omite, se usa calle cuando esté disponible.
direccion2varcharSegunda línea del domicilio comercial. Si se omite, se usa colonia cuando esté disponible.
callevarcharCalle del domicilio comercial.
coloniavarcharColonia del domicilio comercial.
ciudadvarcharCiudad del domicilio comercial.
idPaisvarcharCódigo de país del domicilio comercial.
idEstadovarcharCódigo de estado del domicilio comercial.
idMunicipiovarcharCódigo de municipio del domicilio comercial.
codigoPostalvarcharCódigo postal del domicilio comercial.
numeroInteriorvarcharNúmero interior del domicilio comercial.
numeroExteriorvarcharNúmero exterior del domicilio comercial.
idExternovarcharIdentificador del cliente en un sistema externo.
numeroEmpleadosintNúmero de empleados del cliente.
razonSocialvarcharNombre fiscal de la razón social predeterminada.
rfcvarcharRFC de la razón social.
registroFiscalvarcharRegistro fiscal adicional, si aplica.
idUsoCfdiintCódigo de uso de CFDI.
idRegimenintCódigo de régimen fiscal receptor.
idPaisRazonSocialvarcharCódigo de país del domicilio fiscal.
codigoPostalRazonSocialvarcharCódigo postal del domicilio fiscal.
datosContactointUsa 1 para indicar que se proporcionan datos de contacto; usa 0 en caso contrario.
nombreContactovarcharNombre del contacto principal.
apellidosContactovarcharApellidos del contacto principal.
telefonoContactovarcharTeléfono del contacto principal.
correoContactovarcharCorreo del contacto principal.
calleContactovarcharCalle del domicilio del contacto.
coloniaContactovarcharColonia del domicilio del contacto.
ciudadContactovarcharCiudad del domicilio del contacto.
idPaisContactovarcharCódigo de país del contacto. Si se omite, se usa la configuración de la cuenta.
idEstadoContactovarcharCódigo de estado del contacto. Si se omite, se usa la configuración de la cuenta.
cpvarcharValores de campos personalizados del cliente en formato JSON. No incluyas información sensible innecesaria.

Respuesta

NombreTipoDescripción
codeIntegerCódigo del resultado. Es 0 cuando el cliente se crea correctamente.
msgStringMensaje que describe el resultado de la operación.
detailsArray<Object>Detalle del resultado. Incluye el identificador tkEmpresa del cliente creado.

Solicitud

Crear un cliente

curl --request POST \
  --url 'https://api.upnify.com/suite/erp/clientes' \
  --header 'Content-Type: application/json' \
  --header 'token: 00000000-0000-4000-8000-000000000001' \
  --data '{"empresa":"Empresa Ejemplo, S.A. de C.V.","razonSocial":"Empresa Ejemplo, S.A. de C.V.","rfc":"AAA010101AAA","idPais":"MX","datosContacto":1,"nombreContacto":"Contacto","correoContacto":"contacto@example.com"}'

Respuesta

Cliente creado

JSON
[
  {
    "code": 0,
    "msg": "Ok",
    "details": [
      { "tkEmpresa": "00000000-0000-4000-8000-000000000010" }
    ]
  }
]