Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/teofilobetancourt/Restaurant-Equis/llms.txt

Use this file to discover all available pages before exploring further.

The Suppliers API manages the Inventario.Proveedores table — the directory of vendors that supply raw materials and other goods to the restaurant. Each supplier record stores company identification (including the Venezuelan RIF tax number), a designated contact person, and full location and communication details. All endpoints are available under /api/proveedores.
Every response object includes dual field names: a short lowercase alias (e.g. nombre, rif, contacto) and the original PascalCase database column name (e.g. Nombre_Empresa, Identificacion_RIF, Nombre_Encargado). Both names always carry the same value. When submitting request bodies you may use either form — the API resolves them with an or fallback pattern, checking the alias first and then the full column name.

List All Suppliers

curl -X GET https://your-api.com/api/proveedores
Returns all supplier records ordered alphabetically by Nombre_Empresa. No pagination or query filters are applied.

Response

Returns an array of supplier objects:
id_proveedor
integer
Alias for ID_Proveedor. The auto-incremented primary key used in path parameters for update and delete operations.
ID_Proveedor
integer
Primary key of the supplier record in the Inventario.Proveedores table.
nombre
string
Alias for Nombre_Empresa. Trading or legal name of the supplier company.
Nombre_Empresa
string
Company name, up to 150 characters.
rif
string
Alias for Identificacion_RIF. Venezuelan tax identification number, e.g. "J-12345678-9". Unique across all suppliers.
Identificacion_RIF
string
RIF (Registro de Información Fiscal) identifier. Stored up to 30 characters. Must be unique.
contacto
string
Alias for Nombre_Encargado. Name of the person responsible for managing the relationship with this supplier.
Nombre_Encargado
string
Full name of the supplier’s contact/account manager.
telefono
string
Alias for Telefono_Empresa. Main phone number for the supplier, up to 30 characters.
Telefono_Empresa
string
Company phone number.
email
string
Alias for Email_Empresa. Business email address for the supplier. Unique across all suppliers.
Email_Empresa
string
Supplier’s business email. Unique at the database level.
Ciudad
string
City where the supplier is located, e.g. "Caracas".
Direccion
string
Full street address of the supplier, up to 255 characters.

Create Supplier

curl -X POST https://your-api.com/api/proveedores \
  -H "Content-Type: application/json" \
  -d '{
    "nombre": "Distribuidora La Hortaliza",
    "rif": "J-29876543-1",
    "contacto": "Pedro Sánchez",
    "telefono": "0212-5551234",
    "email": "ventas@lahortaliza.com",
    "Ciudad": "Caracas",
    "Direccion": "Av. Sucre, Galpón 14, Los Dos Caminos"
  }'
Registers a new supplier in the directory. Returns 201 Created with the full supplier object.
Identificacion_RIF (alias: rif) is unique at the database level. Attempting to create two suppliers with the same RIF will result in a database integrity error. Similarly, Email_Empresa (alias: email) must be unique.

Request Body

nombre
string
Company or trading name of the supplier. Alias: Nombre_Empresa. Defaults to "Proveedor Desconocido" if omitted.
rif
string
Venezuelan RIF tax ID, e.g. "J-29876543-1". Alias: Identificacion_RIF. Must be unique. Defaults to "J-00000000-0" if omitted.
contacto
string
Name of the supplier’s account manager or primary contact. Alias: Nombre_Encargado. Defaults to "Encargado General" if omitted.
telefono
string
Company phone number. Alias: Telefono_Empresa. Defaults to "0000000000" if omitted.
email
string
Business email address. Alias: Email_Empresa. Must be unique. Auto-generated from a hash of the company name if omitted.
Ciudad
string
City where the supplier operates. Defaults to "Caracas" if omitted.
Direccion
string
Full street address. Defaults to "Dirección Principal" if omitted.

Response

Returns 201 Created with the full supplier object (same shape as the list response):
Example 201 response
{
  "id_proveedor": 5,
  "ID_Proveedor": 5,
  "nombre": "Distribuidora La Hortaliza",
  "Nombre_Empresa": "Distribuidora La Hortaliza",
  "rif": "J-29876543-1",
  "Identificacion_RIF": "J-29876543-1",
  "contacto": "Pedro Sánchez",
  "Nombre_Encargado": "Pedro Sánchez",
  "telefono": "0212-5551234",
  "Telefono_Empresa": "0212-5551234",
  "email": "ventas@lahortaliza.com",
  "Email_Empresa": "ventas@lahortaliza.com",
  "Ciudad": "Caracas",
  "Direccion": "Av. Sucre, Galpón 14, Los Dos Caminos"
}

Update Supplier

curl -X PUT https://your-api.com/api/proveedores/5 \
  -H "Content-Type: application/json" \
  -d '{
    "contacto": "Ana Ramírez",
    "telefono": "0414-9876543"
  }'
Partially updates an existing supplier record. Only the fields provided in the request body are changed; all other fields remain unchanged. Returns the updated supplier object on success. Raises 404 if no supplier with the given ID exists.

Path Parameters

id_proveedor
integer
required
The ID_Proveedor / id_proveedor of the supplier to update.

Request Body

All fields are optional. Include only the fields you want to change. Both alias and PascalCase names are accepted.
nombre
string
Updated company name. Alias: Nombre_Empresa.
rif
string
Updated RIF identifier. Alias: Identificacion_RIF. Must remain unique.
contacto
string
Updated contact person name. Alias: Nombre_Encargado.
telefono
string
Updated phone number. Alias: Telefono_Empresa.
email
string
Updated business email. Alias: Email_Empresa. Must remain unique.

Response

Returns the updated supplier object (same shape as the list response).

Delete Supplier

curl -X DELETE https://your-api.com/api/proveedores/5
Permanently removes a supplier record from the database. Returns 204 No Content on success. Raises 404 if no supplier with the given ID exists.

Path Parameters

id_proveedor
integer
required
The ID_Proveedor / id_proveedor of the supplier to delete.

Response

Returns 204 No Content with an empty body on success.
Deletion is permanent. Ensure no active inventory purchase orders reference this supplier before deleting the record.

Build docs developers (and LLMs) love