Saltar al contenido
Facturador

Editar cliente o proveedor

POST /api/persons/update

Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).

Edita una persona. Las direcciones adicionales se reemplazan por las enviadas: envía la lista completa (con su id) o se pierden.

Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor).

Formato de respuesta: heredado {success, message?, data?} sin paginación. Ante reglas de negocio puede responder HTTP 200 con success: false: revisa siempre success.

Campo Tipo Obligatorio Descripción / valores permitidos
id integer Sí Id de la persona.
type string Recomendado customers/suppliers; se usa en la validación de duplicados.
identity_document_type_id string Sí Tipo de documento (catálogo SUNAT 06): 0 sin documento, 1 DNI, 4 carné de extranjería, 6 RUC, 7 pasaporte.
number string Sí Número de documento. Único entre las personas habilitadas del mismo tipo (cliente/proveedor).
name string Sí Nombre o razón social. Único entre las personas habilitadas del mismo tipo.
trade_name string No Nombre comercial.
country_id string Sí País (código ISO de 2 letras, p. ej. PE).
address string No Dirección principal.
telephone string No Teléfono.
email string No Correo. Si se envía debe ser válido y único entre las personas habilitadas.
location_id array No Ubigeo principal [departamento, provincia, distrito], p. ej. ["15", "1501", "150101"] (ver Ubigeos). Si no trae 3 elementos se ignora.
addresses array No Direcciones adicionales. Una dirección sin address o sin location_id de 3 elementos se omite.
addresses[].address string Sí Dirección.
addresses[].location_id array Sí Ubigeo [departamento, provincia, distrito].
addresses[].country_id string No País (PE).
addresses[].phone / email string No Teléfono y correo de la dirección.
addresses[].main boolean No Dirección principal.
addresses[].establishment_code string No Código de establecimiento anexo SUNAT (4 dígitos).
addresses[].has_consigned boolean Sí (la clave) true si la dirección pertenece a un consignado. Envía siempre la clave.
addresses[].consigned_id integer No Id del consignado (ver sección Consignaciones, placas, e-commerce y Vendeya) cuando has_consigned es true; su teléfono se actualiza con phone.
addresses[].id integer Sí (la clave) Id de la dirección o null para una nueva.

Reglas:

  • country_id es obligatorio en la validación pero no se modifica con este endpoint.
  • El cliente Clientes varios no se puede editar: responde HTTP 200 con success: false.

Errores:

  • Validación: 422 con {success: false, message: {campo: [mensajes]}}.
  • Si el id no existe responde HTTP 404 con success: false y message Registro no encontrado.

Clientes - Varios (DNI 0 / 99999999, el cliente genérico de las boletas sin datos) es un registro del sistema protegido: intentar editarlo responde HTTP 200 con {"success": false, "message": "Clientes - Varios es un registro del sistema y no se puede editar."} y no se modifica.

Cuerpo

Content-Type: application/json

{
  "type": "customers",
  "identity_document_type_id": "6",
  "number": "20601234567",
  "name": "COMERCIAL NORTE E.I.R.L.",
  "trade_name": "COMERCIAL NORTE",
  "country_id": "PE",
  "address": "AV. PRINCIPAL 123, LIMA",
  "telephone": "987654321",
  "email": "compras@comercialnorte.pe",
  "location_id": [
    "15",
    "1501",
    "150101"
  ],
  "addresses": [
    {
      "id": 8,
      "address": "CALLE MERCADERES 456, AREQUIPA",
      "location_id": [
        "04",
        "0401",
        "040101"
      ],
      "country_id": "PE",
      "phone": "054223344",
      "email": "almacen@comercialnorte.pe",
      "main": false,
      "establishment_code": "0001",
      "has_consigned": false,
      "consigned_id": null
    }
  ],
  "id": "1"
}

Respuestas

200 — Actualizado

{
  "success": true,
  "message": "Cliente actualizado"
}

200 — Clientes varios

{
  "success": false,
  "message": "No se puede editar el cliente Clientes varios."
}

200 — Clientes - Varios protegido

{
  "success": false,
  "message": "Clientes - Varios es un registro del sistema y no se puede editar."
}

Pruébalo

Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.