Configure Your Synq Tenant Inventory and Costing Settings

Tenant settings are the operational defaults that Synq uses across your entire account. They govern how inventory is reserved for orders, when purchase orders are triggered automatically, what stock level constitutes a low-stock condition, and how the cost of goods is calculated. Getting these values right up front ensures that downstream workflows — replenishment, reporting, and AI-driven recommendations — all behave consistently. Only users with the Admin role can update tenant settings; any role can read them.

Retrieve current settings

Fetch the active configuration for your tenant.

GET /api/v1/settings/tenant
Authorization: Bearer TOKEN
X-Tenant-ID: your-tenant-id
X-Org-ID: your-org-id

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "org_id": "org-uuid-here",
  "tenant_id": "tenant-uuid-here",
  "inventory_allocation_model": "HARD",
  "auto_po_enabled": true,
  "default_low_stock_threshold": 10,
  "costing_method": "WAC",
  "updated_by": "user-uuid-here",
  "created_at": "2024-10-01T08:00:00Z",
  "updated_at": "2024-11-15T12:30:00Z"
}

string

UUID that uniquely identifies this settings record.

string

UUID of the organization these settings belong to.

string

UUID of the tenant these settings apply to.

string

The active inventory allocation strategy (HARD or SOFT).

boolean

Whether automatic purchase order creation is enabled.

integer

Unit count below which a low-stock alert is raised.

string

The product costing calculation method (WAC or FIFO).

string

UUID of the user who last saved these settings.

string

ISO 8601 timestamp when the settings record was first created.

string

ISO 8601 timestamp of the most recent update.

Update tenant settings

Replace the current settings with new values. All four configurable fields are evaluated together — send the complete desired state, not just the fields you want to change.

Only Administrators can call this endpoint. Requests from Manager or Editor roles receive a 403 Forbidden response. Every successful update is written to the audit log automatically.

PUT /api/v1/settings/tenant
Authorization: Bearer TOKEN
X-Tenant-ID: your-tenant-id
X-Org-ID: your-org-id
Content-Type: application/json

{
  "inventory_allocation_model": "HARD",
  "auto_po_enabled": true,
  "default_low_stock_threshold": 10,
  "costing_method": "WAC"
}

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "org_id": "org-uuid-here",
  "tenant_id": "tenant-uuid-here",
  "inventory_allocation_model": "HARD",
  "auto_po_enabled": true,
  "default_low_stock_threshold": 10,
  "costing_method": "WAC",
  "updated_by": "user-uuid-here",
  "created_at": "2024-10-01T08:00:00Z",
  "updated_at": "2024-11-18T09:15:00Z"
}

Settings reference

inventory_allocation_model

string

required

Controls how Synq reserves inventory when an order is placed.

Value	Behavior
`HARD`	Stock is immediately decremented and held exclusively for the order. The units cannot be allocated to any other order until the original is cancelled or fulfilled. Use this when accuracy is critical and overselling is unacceptable.
`SOFT`	Stock is flagged as tentatively reserved but not decremented from available counts until the order is confirmed. Allows more flexibility, such as supporting reservation windows or high-volume flash sales.

Defaults to HARD if omitted.

auto_po_enabled

boolean

required

When true, Synq automatically creates a draft purchase order for a SKU as soon as its on-hand quantity drops to or below default_low_stock_threshold. The draft PO is surfaced in your purchasing queue for review before submission to the supplier.Set to false if you prefer to manage replenishment manually or through an external system.

default_low_stock_threshold

integer

required

The number of units at or below which Synq considers a SKU to be low in stock. This threshold drives:

Low-stock alerts in the dashboard and notification channels.
Automatic PO creation when auto_po_enabled is true.
AI task context when the Inventory Ops team scans for reorder candidates.

Must be 0 or greater. A value of 0 effectively disables threshold-based alerts.

costing_method

string

required

Determines how Synq calculates the cost of goods sold (COGS) and ending inventory value.

Value	Method	Description
`WAC`	Weighted Average Cost	The cost of each unit is the running weighted average of all units received. Smooths out price fluctuations and is simple to manage.
`FIFO`	First In, First Out	The oldest inventory layers are consumed first. Best reflects physical stock rotation and is often preferred for perishables or goods with expiry dates.

Defaults to WAC if omitted. Changing the costing method affects all future cost calculations; historical records are not retroactively recalculated.

The inventory_allocation_model and costing_method values are stored and evaluated in uppercase. Sending "hard" or "fifo" in lowercase is accepted — Synq normalizes them automatically.

If you are running Synq alongside an ERP, set auto_po_enabled: false and let the ERP own purchase order creation. Use Synq’s low-stock threshold purely for alerting.

Get Started

Core Concepts

Product Catalog

Orders & Inventory

Integrations

Platform

Configure Your Synq Tenant Inventory and Costing Settings

Retrieve current settings

Update tenant settings

Settings reference

inventory_allocation_model

auto_po_enabled

default_low_stock_threshold

costing_method

​Retrieve current settings

​Update tenant settings

​Settings reference

​inventory_allocation_model

​auto_po_enabled

​default_low_stock_threshold

​costing_method

Retrieve current settings

Update tenant settings

Settings reference

inventory_allocation_model

auto_po_enabled

default_low_stock_threshold

costing_method