CredonixDocs
Referencia de la APIClientes

Editar

Actualiza parcialmente un cliente existente.

Descripción general

Este endpoint actualiza parcialmente un cliente. Todos los campos del cuerpo son opcionales:

  • Omitido → el campo conserva su valor actual.
  • null → el campo se limpia. name y send_weekly_message no aceptan null.

La API combina tus cambios con los datos guardados del cliente y valida el resultado completo con las reglas del formulario de la aplicación. Si un dato guardado no cumple las reglas actuales, por ejemplo un código postal que no tiene 5 dígitos, corrígelo en la misma solicitud.

Igual que en la aplicación, al guardar se actualizan el alias, la razón social, el RFC, el régimen fiscal y el código postal del cliente en todas sus órdenes de cobro. El campo note queda en el historial de actividad del cliente.

Una solicitud exitosa devuelve 200 con el cliente completo. Si no hay un tipo de cambio USD/MXN registrado, los totales de financial_summary llegan en null.

Requiere el permiso Administrar en Clientes.

Endpoint

PATCHhttps://app.credonix.mx/api/v1/customers/{customerId}

Path param: customerId — el id del cliente.

Actualizar datos fiscales


Envía solo los campos que quieras cambiar. El RFC y la razón social se normalizan igual que al crear, y contact_email conserva su valor porque no se envió. Los correos vacíos llegan como "".

{
  "tax_id": "xexx 010101 000",
  "legal_name": "grupo comercial del norte",
  "note": "Actualización de razón social y RFC"
}

Campos del cuerpo

CampoTipoNotas
namestringAlias del cliente. No puede ser vacío ni null.
send_weekly_messageboolean
legal_namestring | nullRazón social sin el tipo de sociedad. Se guarda en mayúsculas.
tax_idstring | nullRFC de 12 o 13 caracteres. null o "" lo limpian. Se guarda en mayúsculas y sin guiones ni espacios.
tax_regimestring | nullRégimen fiscal. null lo limpia.
website, address_street, address_exterior_number, address_interior_number, address_neighborhood, address_city, address_state, address_country, contact_namestring | nullTexto libre. null lo limpia.
address_zip_codestring | null5 dígitos, "" o null.
contact_phonestring | nullTeléfono válido en formato internacional, "" o null.
contact_email, contact_second_emailstring | nullCorreo válido o "". null se guarda como "".
notestringOpcional, máximo 500 caracteres. Se registra en el historial de actividad; no se guarda en el cliente.

No se aceptan campos adicionales.

Errores

400 — validación fallida

{
  "code": "VALIDATION_ERROR",
  "message": "La petición contiene datos inválidos. Revisa errors para ver el detalle de cada campo.",
  "errors": [
    {
      "field": "name",
      "code": "invalid_type",
      "message": "Entrada inválida: se esperaba texto, recibido nulo"
    }
  ],
  "request_id": "f8743583-85cd-41b2-aff8-f969e50dd5d5"
}
StatusCódigoCausa
400VALIDATION_ERROREl cuerpo no es un objeto JSON, un campo tiene formato inválido, se envió un campo desconocido o un dato guardado no cumple las reglas actuales.
403INSUFFICIENT_PERMISSIONSLa API key no tiene el permiso Administrar en Clientes.
404NOT_FOUNDEl cliente no existe en esta organización. Se valida antes que el cuerpo.
Abrir Credonix