BrewOS

Reserve ingredient units for a production batch (production-level reservation; base-measurement units). Does not consume stock — use production consumption tools for that.

allocate_production_ingredients

Link an existing product_stock entry to a shipment (allocation/pick).

allocate_shipment_stock

Archive (soft-delete) a customer by setting its state to deleted. BrewOS has no hard delete for customers.

archive_customer

Archive (soft-delete) an ingredient.

archive_ingredient

Cancel a product source that has no current stock. Sources still holding stock must be drawn down first.

archive_product_source

Archive a warehouse (set state=passive). BrewOS has no hard delete for warehouses with history.

archive_warehouse

Assign an EAN to a product, either by an existing ean_code_id (12-digit base) or an explicit code string (12 or 13 digits within an account range). Validates checksum, account range, uniqueness, and product ownership.

assign_ean_code

Record a customer payment (suoritus). Amount in euros. Optionally allocate it to an invoice. Not available when the account invoices through ProCountor, Netvisor or Fennoa: their payments are read from that system.

book_payment

Cancel a shipment's e-AD (only before the goods have left). Calls Vero if the API is enabled and an ARC exists; always marks the movement cancelled.

cancel_emcs_ead

Reverse an ingredient delivery (batch) by writing a stock row that zeroes its current units. The batch history is preserved (no hard delete).

cancel_ingredient_delivery

Cancel an invoice. Only non-active (draft) invoices not yet sent to an accounting system can be cancelled; active invoices must be reversed with a credit note.

cancel_invoice

Cancel a shipment. BrewOS has no hard delete for shipments; cancel is the safe terminal state (it also reverses stock/tax for picked/delivered shipments).

cancel_shipment

Clone a recipe. new_version=true creates a new version and marks the prior outdated; false makes an independent copy.

clone_recipe

Mark a confirmed production batch completed.

complete_production

Mark a production step ended (completed) now, or at a given Europe/Helsinki local datetime.

complete_production_step

Convert product stock between a multipackage and its single component in one warehouse, in place. "assemble" consumes pack_units x packs singles and adds packs multipacks; "disassemble" does the reverse. Volume (and excise/Valvira liability) is conserved and no tax event is created — those fire only on delivery. Cost, the earliest best-before, and the production link are carried to the new stock.

convert_multipack_stock

Create an EAN range. start/end are 12-digit GS1 bases; the span must be 10–10000 codes and must not overlap an existing range.

create_ean_range

Create a credit note that reverses all rows of an active invoice and links to it.

create_credit_note

Create a customer for the account. "name" is required; other fields are optional. Search first (search_customers) — duplicates are the common mistake. For a Finnish alcohol licensee prefer search_allu_licensees + create_customer_from_allu, which dedupes and fills registry data instead of retyping it. Never invent a business id, VAT number or address. When a domestic customer's Y-tunnus holds no alcohol licence in force in Valvira's register, the result carries "warnings" — tell the user.

create_customer

Create (or reuse) a customer from an Allu register licence and attach the licensed outlet. The outlet uses Allu's visiting address; a newly created customer's billing address is fetched from YTJ (PRH) by business id. Dedupes the customer by business id and stores the licence number on the outlet. Idempotent: re-running with the same license_id reuses the matching customer and outlet.

create_customer_from_allu

Create a customer group. Optionally set default payment terms (days).

create_customer_group

Create a delivery outlet for a customer. Accepts the same address fields as the web outlet form, including address line 2 (street2) and non-Finnish postal codes for export deliveries.

create_customer_outlet

Create an ingredient with a base measurement (volume|mass|unit).

create_ingredient

Create a draft invoice for a customer with rows. Each row: {total (euros, tax-free), vat_per (e.g. 0.255), description, product_id?, units?, vat_class_id?}. Activate separately with activate_invoice.

create_invoice

Create a draft invoice populated from a shipment's product rows (incl. deposits). Returns the new invoice id; activate it separately with activate_invoice.

create_invoice_from_shipment

Create a multipackage ("sales article", e.g. a 6-pack) from an existing single product. The single must be under 2 litres. The multipack is its own product (own id, EAN, price, stock) but shares the single's product base, so for excise, Valvira and beverage-packaging tax it reports as pack_units of the single under the single's identity. Optionally allocate an EAN and set a general price. container_size is derived (pack_units x the single) and returned in litres.

create_multipack

Create a product (a physical SKU: a container of a named, alcohol-bearing product base). Reuses an existing product base with the same name when the alcohol % matches, otherwise creates a new base. container_size is in litres. Products over 5 litres are exempt from beverage-packaging tax.

create_product

Create a product group (tuoteryhmä) in a dimension; put products in it with create_product or update_product. own_production false marks the group as resold/imported products: a product in it is not the brewery's own production (no small brewery reduction).

create_product_group

Create a product group dimension (e.g. type, country of origin, flavour, sales channel); add its groups with create_product_group. level is product_base when the groups describe the drink (set on the product base, so every package of it has them) or product when they are chosen per package; it cannot be changed later. multiple true lets a product have several of its groups (e.g. flavours), false at most one (e.g. type: red or white). The new dimension goes last among its level.

create_product_group_dimension

Create a recipe. production_size is the batch size in litres.

create_recipe

Add a step to a recipe.

create_recipe_step

Create a draft shipment for a customer, optionally with product rows. Use only after identifying the customer (search_customers) and each product (search_products); do not guess ids. Creates a draft only: it moves no stock and delivers nothing.

create_shipment

Apply several stock adjustments (auditable ledger deltas) in one warehouse. rows: [{item_type: product|ingredient, item_id, units_delta, product_source_id?/batch_id?, include_in_packing_report?}]. include_in_packing_report (product rows) works as in adjust_product_stock. BrewOS has no adjustment header entity, so this returns the resulting movements rather than an adjustment id.

create_stock_adjustment

Add a tank (production equipment). The name must be unique in the account. It starts washed and ready.

create_tank

Create a warehouse.

create_warehouse

Transfer several products between two warehouses in one transfer. rows: [{product_id, units (containers), product_source_id?}]. The arriving stock is always excluded from the Valvira packing notification (astiointi-ilmoitus), as in transfer_product_stock.

create_warehouse_transfer

Delete an EAN range. Only permitted when the range has NO allocated codes. BrewOS has no soft-archive for ranges, so this is a hard delete of an empty range.

delete_ean_range

Delete a customer group.

delete_customer_group

Cancel a packing entry (product source) that has not yet been stored to a warehouse. Stored packing must be reversed via warehouse tools.

delete_packing

Delete a product group; every drink and product in it leaves it. Not reversible: confirm with the user first, telling them how many products are in it (list_product_groups product_count).

delete_product_group