Supplier

Un proveedor de productos (Good) de un comercio (Branch). Se usa para registrar de quién se abastece cada producto. Usa soft delete y puede restaurarse.

Estructura de Datos

Atributo Tipo Descripción
id int
name string Nombre del proveedor
uid string Identificador fiscal del proveedor
address string Dirección del proveedor
phone string Teléfono del proveedor (se normaliza al guardar)
email string Email del proveedor
created_at datetime\|null
updated_at datetime\|null
deleted_at datetime\|null
branch_id int {@link Branch} dueña del proveedor
allLogs ApiLog>
branch Branch {@link Branch} dueña del proveedor
logs ApiLog> 
[]

Endpoints

Insertar Supplier

Insertar Supplier de Branch

Crear proveedor

Crea un Supplier para la Branch (name, uid, address, phone, email).

Método URI Cabeceras
POST /companies/{companyId}/branches/{branchId}/suppliers Authorization 
{
    "name": "required|string|max:64",
    "uid": "required|string|max:32",
    "address": "required|string|max:255",
    "phone": "required|string|max:32",
    "email": "required|email:rfc,filter|max:64"
}

Listar Supplier

Listar Supplier de Branch

{info} Soporta: Paginación Filters Carga dinámica

Listar proveedores de una sucursal

Devuelve los Supplier de la Branch indicada.

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/suppliers Authorization

Mostrar Supplier

{info} Soporta: Carga dinámica

Mostrar proveedor

Devuelve el Supplier por su id.

Método URI Cabeceras
GET /companies/{companyId}/suppliers/{supplierId} Authorization

Actualizar Supplier

Actualizar proveedor

Modifica name, uid, address, phone y email del Supplier.

Método URI Cabeceras
PATCH /companies/{companyId}/suppliers/{supplierId} Authorization 
{
    "name": "string|max:64",
    "uid": "string|max:32",
    "address": "string|max:255",
    "phone": "string|max:32",
    "email": "email:rfc,filter|max:64"
}

Eliminar Supplier

Eliminar proveedor

Hace un soft delete del Supplier; puede restaurarse con el endpoint de restauración.

Método URI Cabeceras
DELETE /companies/{companyId}/suppliers/{supplierId} Authorization

Restaurar Supplier

Restaurar proveedor

Revierte el soft delete de un Supplier eliminado.

Método URI Cabeceras
POST /companies/{companyId}/suppliers/{supplierId}/restore Authorization

Relaciones