activate_invoice
ChatGPTFinalise a draft invoice (draft → active), assigning an invoice number. Requires explicit user confirmation: once active the invoice is locked, cannot be cancelled, and is reversible only with create_credit_note. Review the rows (get_invoice) with the user first.
add_invoice_row
ChatGPTAdd a row to a draft invoice. total in euros (tax-free), vat_per as fraction.
add_production_note
ChatGPTAdd a note to a production batch.
add_recipe_ingredient
ChatGPTAdd or set an ingredient amount on a recipe step (units in the ingredient base measurement).
add_recipe_product
ChatGPTLink a target product base to a recipe.
add_shipment_product
ChatGPTAdd (or set) a product row on a draft shipment. units uses the product's container count: for a multipackage that is PACKS, not the single containers inside them, and the price is per pack. Optionally pass total (the tax-free line total in euros) to set the row price; if omitted, the customer/group/general price is used (unit price x units). Optionally pass discount_percent for a per-row discount; otherwise the order/customer discount applies. The stored line price is the discounted (effective) total. A row that prices a multipackage like a single container (or the reverse) is refused until confirm_pack_mismatch=true.
adjust_ingredient_stock
ChatGPTAdjust ingredient stock by a signed delta (base-measurement units). Positive creates a batch; negative consumes FIFO from oldest batches. Writes auditable stock rows.
adjust_product_stock
ChatGPTAdjust product stock by a signed DELTA in CONTAINERS. Positive creates an adjustment source; negative consumes FIFO. Writes auditable product_stock rows. include_in_packing_report decides whether the batch counts in the Valvira packing notification (astiointi-ilmoitus): a new source is included unless it is false, so pass false for a correction that is not newly packed product. Read the balance (get_product_stock_balance) first and confirm the change with the user; for a counted absolute figure use set_product_stock_count instead — mistaking the two corrupts the balance. This is for inventory corrections, never for storing a packing from record_packing: that is store_packing, which also charges the production licence litres. (For tax-reportable disposals use a coded consumption instead.)
allocate_next_ean_code
ChatGPTAllocate the next free EAN code from an account range (or the first range with capacity) and assign it to a product. Concurrency-safe (locked).
allocate_payment_to_invoice
ChatGPTAllocate (part of) an existing customer payment to an invoice. amount in euros; defaults to the invoice's open balance.
allocate_production_ingredients
ChatGPTReserve ingredient units for a production batch (production-level reservation; base-measurement units). Does not consume stock — use production consumption tools for that.
allocate_shipment_stock
ChatGPTLink an existing product_stock entry to a shipment (allocation/pick).
archive_customer
ChatGPTArchive (soft-delete) a customer by setting its state to deleted. BrewOS has no hard delete for customers.
archive_ingredient
ChatGPTArchive (soft-delete) an ingredient.
archive_product_source
ChatGPTCancel a product source that has no current stock. Sources still holding stock must be drawn down first.
archive_supplier
ChatGPTArchive a supplier (or with restore=true bring it back). An archived supplier drops out of the pickers and the shopping list; the deliveries bought from it keep it.
archive_warehouse
ChatGPTArchive a warehouse (set state=passive). BrewOS has no hard delete for warehouses with history.
assign_ean_code
ChatGPTAssign 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.
book_payment
ChatGPTRecord 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.
cancel_emcs_ead
ChatGPTCancel 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_ingredient_delivery
ChatGPTReverse an ingredient delivery (batch) by writing a stock row that zeroes its current units. The batch history is preserved (no hard delete).
cancel_invoice
ChatGPTCancel 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_shipment
ChatGPTCancel a shipment. BrewOS has no hard delete for shipments; cancel is the safe terminal state (it also reverses stock/tax for picked/delivered shipments).
clone_recipe
ChatGPTClone a recipe. new_version=true creates a new version and marks the prior outdated; false makes an independent copy.
complete_production
ChatGPTMark a confirmed production batch completed.
complete_production_step
ChatGPTMark a production step ended (completed) now, or at a given Europe/Helsinki local datetime.
consume_production_ingredient
ChatGPTRecord the actual consumption of an ingredient by a confirmed production batch in progress, as the batch's ingredient page does. Each call adds an entry to what was consumed before (from several warehouses: one call each); a wrong entry is corrected by removing it with undo_production_ingredient_consumption and recording the right amount. The units are taken from the warehouse oldest stock batch first, each stock row is linked to the production (traceability), their cost is added to the batch's ingredient cost, and the reservation is closed (what was reserved but not consumed is released; a later entry consumes the released units first). With production_step_id it is a recipe ingredient of that step, without it a batch-level extra ingredient. units defaults to what is reserved. When the warehouse holds too little the call is refused, unless allow_provisional covers the shortfall with a provisional stock batch (to be fixed when the delivery is booked). Summarise ingredient, units and warehouse and get confirmation first.
convert_multipack_stock
ChatGPTConvert 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.
create_credit_note
ChatGPTCreate a credit note that reverses all rows of an active invoice and links to it.
create_customer
ChatGPTCreate 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_from_allu
ChatGPTCreate (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_group
ChatGPTCreate a customer group. Optionally set default payment terms (days).
create_customer_outlet
ChatGPTCreate 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_ean_range
ChatGPTCreate 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_ingredient
ChatGPTCreate an ingredient with a base measurement (volume|mass|unit).
create_invoice
ChatGPTCreate 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_from_shipment
ChatGPTCreate a draft invoice populated from a shipment's product rows (incl. deposits). Returns the new invoice id; activate it separately with activate_invoice.
create_multipack
ChatGPTCreate 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_product
ChatGPTCreate 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_group
ChatGPTCreate 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_dimension
ChatGPTCreate 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_recipe
ChatGPTCreate a recipe. production_size is the batch size in litres.
create_recipe_step
ChatGPTAdd a step to a recipe.
create_shipment
ChatGPTCreate 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_stock_adjustment
ChatGPTApply 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_supplier
ChatGPTAdd an ingredient supplier. Link it to ingredients with set_ingredient_supplier.
create_tank
ChatGPTAdd a tank (production equipment). The name must be unique in the account. It starts washed and ready.
create_warehouse
ChatGPTCreate a warehouse.
create_warehouse_transfer
ChatGPTTransfer 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.
delete_customer_group
ChatGPTDelete a customer group.
delete_ean_range
ChatGPTDelete 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_packing
ChatGPTCancel a packing entry (product source) that has not yet been stored to a warehouse. Stored packing must be reversed via warehouse tools.
delete_product_group
ChatGPTDelete 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_dimension
ChatGPTDelete a product group dimension together with all its groups; every drink and product leaves them. Not reversible: confirm with the user first, telling them how many products are in its groups (list_product_groups product_count). A product left in no group that was marked not own production counts as own production again.
delete_production
ChatGPTDelete an unfinished (draft or confirmed) production batch. Open ingredient reservations are always released and asset bookings dropped. return_ingredients decides what happens to ingredients already consumed from stock: "none" (default) keeps them consumed, "all" returns every ingredient marked consumed (recipe and extra ingredients) to the stock batches it came from. Completed batches and batches with packings cannot be deleted. This cannot be undone, so summarise the batch and the return choice and get explicit confirmation first.
delete_production_note
ChatGPTDelete a production note (soft-delete).
delete_recipe
ChatGPTMark a recipe deleted (soft-delete).
delete_recipe_step
ChatGPTDelete a recipe step.
delete_tank
ChatGPTRemove a tank from the account. Its reservations stay on the batches but it no longer shows anywhere. Confirm with the user first.
delete_warehouse
ChatGPTRemove a warehouse from the account (state=deleted; nothing is deleted from the database, and restore_warehouse brings it back). A removed warehouse drops out of the warehouse list and pickers; its history stays. Stock still in it stays on the books — no stock or tax event is written — so if it still holds ingredients or products the call is refused unless confirm=true: ask the user first, and offer to transfer or remove the stock instead.
deliver_shipment
ChatGPTMark a shipment delivered (optionally at a given date YYYY-MM-DD). Requires explicit user confirmation: this creates tax events and consumes licence litres, and is reversible only by cancel_shipment. Verify the rows (list_shipment_products) first; it may fail if the licence is insufficient. If the delivery date is outside the outlet's alcohol licence validity window and the shipment contains alcoholic drinks, this returns an error asking for confirmation; retry with confirm_license_override=true only once the user has explicitly confirmed the override.
get_account
ChatGPTReturn the brewery account this token is bound to.
get_audit_trail
ChatGPTRead the audit trail. Pass object_type+object_id for one object (customer|shipment|invoice|product|recipe|production|ingredient), or object_type=account for the whole account.
get_customer
ChatGPTFull customer detail: all data fields, customer group, notes.
get_ean_code
ChatGPTFull EAN code detail by its 12-digit base id.
get_ean_range
ChatGPTEAN range detail with usage summary (capacity / allocated / assigned-to-product / remaining).
get_emcs_status
ChatGPTGet the EMCS e-AD movement state (state, ARC, last e-AD payload) for a shipment.
get_ingredient
ChatGPTIngredient detail: name, base measurement (volume|mass|unit), market price, unit cost, state, parent (common) ingredient.
get_ingredient_batch
ChatGPTStock batch detail incl. current units and unit cost. cost_estimated marks a price that is a guess awaiting the invoice. (A delivery is a batch.)
get_ingredient_delivery
ChatGPTIngredient delivery detail (a stock batch).
get_ingredient_stock_balance
ChatGPTCurrent ingredient balance in one warehouse, or summed across all warehouses if warehouse_id is omitted.
get_ingredient_stock_ledger
ChatGPTIngredient stock ledger (movements) for an ingredient, newest first; optional warehouse filter.
get_invoice
ChatGPTFull invoice detail: customer, rows, payments, shipment link, totals, VAT breakdown, due date, state, invoice number. For several invoices, call get_invoices once instead of this once per invoice.
get_invoices
ChatGPTFull detail for up to 50 invoices in one call — the same content get_invoice returns for one, as items[], each carrying its own invoice_id. Walking a list of invoices is one call to this, not one call per invoice.
get_product
ChatGPTProduct detail incl. its product base (name, alcohol %, tax type), packaging fields, and full EAN details (code, range, label, timestamps). container_size is in litres. image_url is the absolute URL of the product's default image (fetchable without authentication), or null when none is set. product.description is the marketing description and translations its per-language versions keyed by ISO 639-1 code (update_product writes both). Only pass a product_id you read from another tool's result (list_products, search_products, get_product_catalogue); ids are not sequential per account, so never guess one or derive it from a neighbouring id. If a search finds nothing, the product does not exist yet.
get_product_catalogue
ChatGPTProduct catalogue: every product with id, name, container, EAN code (if assigned), stock level, price and image_url (absolute URL of the product's default image, fetchable without authentication; null when none is set). Defaults to active products, the general price, and stock summed across all active warehouses. Optionally price each product for one customer or customer group (resolved customer -> group -> general), include non-active products, and/or take the stock level from a single warehouse. container_size is in litres; stock is in whole containers; prices are tax-free / VAT-inclusive euros.
get_product_source
ChatGPTProduct source detail (units, cost, best-before, state, production link, and include_in_packing_report: whether it counts in the Valvira packing notification). small_brewery tells where the beer comes from (origin: production = own production counted in the year's small-brewery ledger; derived = transfer/repack/multipack conversion inheriting the tiers of parent_source_ids; other = bought-in, return, correction or opening balance with a declared tier) and the pienpanimoalennus it is declared with when it leaves stock: tiers as reduction percent => share; classified false means no batch could be traced and the account default applies.
get_product_stock
ChatGPTRead a single product_stock ledger row by id. Units are whole containers.
get_product_stock_balance
ChatGPTCurrent product stock in one warehouse, broken down by source (with best-before and cost). Units in whole containers.
get_product_stock_ledger
ChatGPTStock breakdown (by source, with cost and best-before) for a product in one warehouse, optionally as of a date. For the same balance across many dates, use report_product_stock_history rather than calling this once per date.
get_production
ChatGPTFull production-batch detail: recipe, state, serial, steps (with step_name and reserved tanks), ingredients (reserved/consumed), measurements, notes, packing, planned vs actual size. production_size and actual_size are in litres. For several batches, call get_productions once instead of this once per batch.
get_productions
ChatGPTFull detail for up to 50 production batches in one call — the same content get_production returns for one, as items[], each carrying its own production_id. Walking a list of batches is one call to this, not one call per batch. Ids that are not batches of this account do not fail the call: they are listed under not_found, with serial_match_production_id when the number is the serial of a batch (the batch number the web UI shows).
get_recipe
ChatGPTFull recipe detail: steps, aggregated ingredients, target product bases, total task duration, version. production_size is in litres.
get_shipment
ChatGPTFull shipment detail: customer, outlet, product rows, stock allocations, totals, invoice linkage, and dates.
get_shipment_documents
ChatGPTReturn the available document paths for a shipment (packing list, delivery instructions, invoice attachment, combined). Paths are relative to the BrewOS host.
get_shopping_list
ChatGPTWhat ingredients to buy, grouped by supplier: the open reservations of confirmed productions (and of draft productions with include_drafts) plus each ingredient's minimum stock, less the current stock in all warehouses. A recipe line on an ingredient class can be met with any of its brands. Amounts are in the ingredient's base measurement; order_units is the shortage rounded up to whole packs. Suppliers last: the lines with no supplier (supplier_id null).
get_supplier
ChatGPTOne supplier with its contact details and the ingredients bought from it: the supplier's product code, pack size (pack_units, in the ingredient's base measurement) and pack price, and whether it is the ingredient's preferred supplier.
get_tax_event
ChatGPTOne tax event (verotilitapahtuma) with its issues and suggested fixes (same checks as its page in BrewOS), what created it (shipment, stock row, tap), and valvira_toimitus_state: whether the Valvira toimitusilmoitus of its month has already been sent through Allu ("sent"), failed ("error"), is prepared ("ready") or not made (null).
get_warehouse
ChatGPTWarehouse detail incl. state and Valvira/tax ids.
get_warehouse_transfer
ChatGPTProduct warehouse transfer detail incl. the moved product_stock rows.
list_account_users
ChatGPTOwner only: the account's active users with their role (owner, regular or sales), their name on this account and e-mail (null for a person who cannot sign in). Mirrors Asetukset > Käyttäjät. Use the user_id with set_account_user_role.
list_customer_groups
ChatGPTList the account's customer groups (with customer and seller counts).
list_customer_invoices
ChatGPTList a customer's invoices (newest first).
list_customer_outlets
ChatGPTList a customer's delivery outlets.
list_customer_payments
ChatGPTList a customer's payments (newest first).
list_customer_shipments
ChatGPTList one customer's shipments (newest first), or several customers' shipments in one call via customer_ids — every row carries its customer_id. Note: state/date filtering is not supported here; use list_shipments for that.
list_customers
ChatGPTList the account's customers (most recent first).
list_ean_codes
ChatGPTList EAN codes, filterable by product, range, and assigned/unassigned status.
list_ean_ranges
ChatGPTList the account's EAN ranges with capacity, used (allocated) and remaining counts.
list_export_customers
ChatGPTLEGACY — normally do NOT use. Reads the old export_customer table (foreign customers for warehouse special-sale / EMCS exports). Modern export customers are regular customers with customer_type eu/non_eu, so prefer list_customers / search_customers instead. Returns id, name, country (ISO 3166-1 alpha-3), business id and address, alphabetical by name; optional country filter.
list_ingredient_batches
ChatGPTList stock batches for an ingredient (newest first). cost_estimated marks a batch whose price is a guess awaiting the invoice.
list_ingredient_deliveries
ChatGPTList ingredient deliveries (stock batches) in a warehouse or for an ingredient. cost_estimated marks a delivery whose price is a guess awaiting the invoice. only_estimated on its own lists every estimated delivery of the account, oldest first — the worklist of prices still waiting for their invoice.
list_ingredient_prices
ChatGPTCurrent market price for an ingredient. BrewOS stores only the latest market price (no price history), so this returns a single current entry.
list_ingredient_stock
ChatGPTList ingredient stock batches in a warehouse or for an ingredient. Units in the ingredient base measurement.
list_ingredient_stock_movements
ChatGPTAlias of get_ingredient_stock_ledger: ingredient stock movements, newest first.
list_ingredients
ChatGPTList the account's ingredients (flat). Optional name search.
list_invoice_payments
ChatGPTList payment allocations against an invoice.
list_invoices
ChatGPTList invoices for the account (or one customer). Optional sending_state filter (not_sent|pending|sent|delivered|failed). Note: date-range and overdue filtering are not supported by the underlying model and are ignored.
list_measurements
ChatGPTList measurements recorded on a production batch.
list_pack_mismatch_issues
ChatGPTShipment rows where a multipackage looks mis-entered: priced like ONE single container (so the line total looks right while pack_units x too much is shipped, taxed and reported), or a single priced like a pack, or more packs ordered than exist while the singles would cover the count. With no dates only the open shipments (draft / waiting_warehouse / waiting_delivery) are scanned; with date_from/date_to every non-cancelled shipment in that window by delivery date (creation date when undelivered), delivered ones included. Rows are compared against TODAY'S price list, so older rows can read either way — this is a list to look through, not a verdict. Fix a draft row with update_shipment_product; a delivered one needs cancel_shipment (and a credit note if invoiced).
list_payment_methods
ChatGPTList the account's payment methods (bank account, cash, factoring).
list_product_groups
ChatGPTList the account's product group dimensions (e.g. type, country of origin, flavour) with their product groups (tuoteryhmät) and active product counts. A dimension's level is product_base when its groups describe the drink (set on the product base, so they apply to every package of it) or product when they describe the package (one product). A product can be in many groups, but in at most one group of a dimension whose multiple is false (e.g. type: red or white); a dimension with multiple true allows several (e.g. flavours). own_production tells whether the group holds the brewery's own products or resold/imported ones; a product is own production unless one of its groups says otherwise. Assign groups with create_product or update_product (product_group_ids, or product_group_id for one group). Manage the dimensions and groups themselves with create_/update_/move_/delete_product_group_dimension and create_/update_/delete_product_group.
list_product_prices
ChatGPTList a product's current general price plus all valid customer-group and customer-specific prices.
list_product_shipments
ChatGPTList deliveries (shipments) of a product, newest first. product_id is a product id (list_products / search_products), not a product_base_id or product_source_id. The response names the product it read, so you can confirm it is the one you meant.
list_product_source_stock
ChatGPTCurrent stock for a product source.
list_product_sources
ChatGPTList product sources (packed batches) for a warehouse, a production or a product. Give at least one of warehouse_id, production_id or product_id; product_id alone lists that product's packings in every warehouse (unstored ones included). The row id is a product_source_id, NOT a product id; each row also carries the product_id it holds, its production_id and its warehouse_id.
list_product_stock
ChatGPTCurrent stock of a product across the account's warehouses (or a single warehouse if warehouse_id is given).
list_product_stock_movements
ChatGPTProduct stock ledger (movements) for a product, newest first; optional warehouse filter. product_id must be a product id from list_products / search_products / get_product_catalogue — NOT the id of a product base (list_production_products, list_recipe_products) or of a packing entry (list_production_packing, list_product_sources). Those are separate id sequences whose numbers overlap, so a wrong one can quietly match a different product; the response names the product it read so you can check.
list_production_ingredient_allocations
ChatGPTList a production batch's ingredient allocations (reserved / consumed / released units).
list_production_ingredient_consumptions
ChatGPTList the stock rows a production batch has booked against ingredient stock, newest first: consumptions (negative units_delta) and returns or provisional top-ups (positive). Each row carries the production_step_id it was booked to (null: an extra ingredient, or an old row whose step is not known). With ingredient_id each row says whether it is an entry still in force (in_force: a consumption not returned); pass such a row's stock_id to undo_production_ingredient_consumption.
list_production_ingredients
ChatGPTList a production batch's ingredients with reserved/consumed/released units and consumption cost. Rows carry ingredient_id (pass that to the ingredient tools) and production_id. Accepts production_ids to cover up to 50 batches in one call.
list_production_notes
ChatGPTList notes (threaded) on a production batch.
list_production_packing
ChatGPTList the packing entries (astiointi → product sources) of a production batch. The row id is a product_source_id, NOT a product id; each row also carries the product_id it packed, the warehouse_id it landed in and its production_id. Accepts production_ids to cover up to 50 batches in one call.
list_production_products
ChatGPTList the target product bases of a production batch's recipe. The row id is a product_base_id, NOT a product id: a base is the beer, a product is the beer in one container size. Each row lists its packaged products under products (and their ids under product_ids) — take a product_id from there for the product/stock/shipment tools. Accepts production_ids to cover up to 50 batches in one call.
list_production_steps
ChatGPTList the steps of a production batch: step_name, planned start/end, actual started/ended, and the tanks reserved for each step (tanks[], see list_tanks).
list_productions
ChatGPTList the account's production batches. production_size is in litres.
list_products
ChatGPTList the account's products with current stock and EAN summary (ean_code + has_ean per row). Every row carries product_id (what the product/stock/shipment tools want) and product_base_id (the beer it is a packaging of), so this is how you turn a product_base_id from list_production_products or list_recipe_products into product ids. container_size is in litres. image_url is the absolute URL of the product's default image (fetchable without authentication), or null when none is set. Paginated, sorted by name: total_count is every matching product, so when offset + items is below it, fetch the next page before concluding a product does not exist (or use search_products).
list_products_missing_ean
ChatGPTActive products that have no EAN code assigned. Includes container type/size, fill, label version, alcohol %, and current stock. container_size is in litres. Note: low_fill products share the normal-fill variant's EAN and are excluded.
list_recipe_ingredients
ChatGPTList the aggregated ingredients of a recipe.
list_recipe_products
ChatGPTList the target product bases a recipe produces. The row id is a product_base_id, NOT a product id: a base is the beer, a product is the beer in one container size. Each row lists its packaged products under products (and their ids under product_ids) — take a product_id from there for the product/stock/shipment tools.
list_recipe_steps
ChatGPTList the steps of a recipe.
list_recipes
ChatGPTList the account's recipes. production_size is in litres.
list_shipment_products
ChatGPTList the product rows (order lines) of a shipment.
list_shipment_stock_allocations
ChatGPTList the warehouse stock entries (picks) allocated to a shipment.
list_shipments
ChatGPTList shipments for the account. Filter by state (draft|waiting_warehouse|waiting_delivery|delivered|delivered_not_invoiced|delivered_invoiced), by customer (customer_id, or customer_ids for several at once) and sort (number|customer|delivered|price). Returns customer_name and totals per row.
list_suppliers
ChatGPTList the account's ingredient suppliers with their contact details and how many ingredients each is linked to. Archived suppliers only with include_archived.
list_tanks
ChatGPTThe tank map: the account's production equipment (tuotantovälineet, usually tanks) with details, condition and the batches in each now. state is busy (a batch is in it), ready, cip (waiting for washing: a batch has left it since it was last marked washed) or maintenance. Each batch row has remaining_l = planned_l less packed_l and tapped_l. A batch stays in its last tank past its plan and after it is completed, until the tank is released (release_tank), it is all packed, a later batch comes into the tank, or 180 days pass. A remainder on a completed batch is often loss, not beer: ask before treating it as stock. litres_in_tank and fill_pct count remaining litres. next_batch is the coming reservation of an empty tank.
list_tax_event_issues
ChatGPTTax events (verotilitapahtumat — the ledger behind the excise return, the beverage-container tax and the Valvira toimitusilmoitus) that have problems, newest first, each with its issues and suggested fixes — the same checks as the tax event page in BrewOS. By default lists exactly the events on the faulty list (/raportit/verotapahtumat/virheet: missing product code, or missing/zero price), optionally within date_from..date_to. With scan_all and a date range of at most 31 days, checks every event in the range instead, which also finds wrong quantities, export codes/countries, licence numbers and dates. Unlike list_valvira_toimitus_issues it is not limited to one month or to alcohol products. Fix with update_tax_event.
list_valvira_astiointi_issues
ChatGPTProducts and warehouses with incomplete data for the Valvira containerisation declaration (astiointi-ilmoitus) in a reporting period. Products lacking both an EAN and a valvira_number report without a product code (fix at /tuote/{product_id}); warehouses without a Valvira facility id have their volume excluded (fix in warehouse settings). Pass date_from; the four-month period containing that date is used. Volumes are in litres.
list_valvira_toimitus_issues
ChatGPTTax events in a month that are missing data the Valvira delivery declaration (toimitusilmoitus) needs: product code/EAN, quantity, or price (price only required for licensed domestic sales). missing lists quantity, product_code, price, or price_rounds_to_zero: the report sums a licensed row's events (same licence and product code) and sends the price in whole euros, so a row totalling under 0,50 € goes out as 0 and Valvira refuses it; give those events their real price. Fix each at /raportit/verotapahtumat/{tax_event_id}. Pass date_from; the month (YYYY-MM) is used. Same scope as report_valvira (alcohol products only).
list_warehouse_transfers
ChatGPTList product warehouse transfers (account-scoped), optionally filtered by source/target warehouse and date.
list_warehouses
ChatGPTList the account's warehouses (id, name).
mark_invoice_sent
ChatGPTMark an invoice's sending state as sent. Records state only: it does NOT transmit anything via an e-invoice operator, so do not report to the user that the invoice reached the customer.
mark_shipment_ready_for_delivery
ChatGPTTransition a shipment to waiting_delivery.
mark_shipment_ready_for_warehouse
ChatGPTTransition a shipment to waiting_warehouse (ready for picking).
move_batch_to_tank
ChatGPTMove a batch step's reservation from one tank to another (as dragging a batch on the tank map). Warnings about the target tank are returned; the move is made anyway.
move_product_group_dimension
ChatGPTMove a product group dimension one place up or down among the dimensions of its level (the order of list_product_groups, product lists and filters). The first one cannot go up nor the last one down; moved false then says nothing changed.
perform_inventory_count
ChatGPTReconcile counted stock for several items in one warehouse (writes auditable deltas). rows: [{item_type: product|ingredient, item_id, counted_units, product_source_id?}]. Product rows require product_source_id (count is per source).
record_emcs_receipt
ChatGPTMark a shipment's e-AD movement as received/closed (report of receipt / export exit).
record_ingredient_delivery
ChatGPTRecord an ingredient delivery (a new stock batch) into a warehouse. Units are in the ingredient's base measurement.
record_measurement
ChatGPTRecord a measurement on a production batch. Use list of property ids: 1 specific gravity, 2 pH, 5 abv, 10 temperature, etc.
record_packing
ChatGPTRecord packing (astiointi) of a finished product from a production batch. units is the number of containers. This only records the packing: the containers are not in any warehouse and no licence litres are charged until store_packing puts them into one, which is the step to call next (and the only correct way to get a packing into stock).
release_tank
ChatGPTThe tank has been emptied: the batches in it now leave it (their steps in this tank are marked ended now) and it goes to cip or maintenance. Before calling, tell the user which batches leave and what list_tanks still shows as remaining_l, and get their confirmation.
remove_ean_code
ChatGPTRemove an unassigned or unused EAN code. Blocked when the assigned product has shipment/invoice history (historical safety) — BrewOS has no soft-deactivate for EAN codes.
remove_ingredient_supplier
ChatGPTUnlink a supplier from an ingredient. When the preferred supplier goes, the next one by name becomes preferred.
remove_invoice_row
ChatGPTDelete a row (by row number) from a draft invoice.
remove_recipe_ingredient
ChatGPTRemove an ingredient from a recipe step.
remove_recipe_product
ChatGPTUnlink a target product base from a recipe.
remove_shipment_product
ChatGPTRemove a product row from a draft shipment.
remove_tank_reservation
ChatGPTDrop a tank's reservation for a batch step.
report_accounts_receivable
ChatGPTOpen receivables, in euros. total_open_eur is the outstanding total over the account's active invoices, with credit notes netting out the invoices they credit and, for invoices whose payments are read back from ProCountor, Netvisor or Fennoa, nothing counted for one that system has settled or voided or that has not been read from it yet; items lists the customers with a positive open balance, largest first, and total_count is how many such customers there are. The two need not add up: customers whose balance is zero or negative, and open invoices that have no customer at all, count towards the total without appearing in the list. Page with limit/offset.
report_batch_traceability
ChatGPTTrace a product source or production: its packing sources, current stock by warehouse, and shipment allocations. Each traced source lists the sources it was derived from (parent_source_ids) and the sources moved or repacked from it (derived_source_ids); trace those for the stock that left by transfer or repack.
report_customer_sales
ChatGPTSales grouped by customer for a date range.
report_eu_sales_list
ChatGPTEU sales list (ALV-yhteenvetoilmoitus) data for a month: zero-rated EU intra-community supplies grouped by customer VAT number. Data-prep only — no VAT-number (VIES) validation or filing. Pass date_from; the month (YYYY-MM) is used.
report_expiring_stock
ChatGPTProduct sources with stock whose best-before is on/before a date. (Ingredients have no best-before in BrewOS.)
report_ingredient_stock
ChatGPTCurrent ingredient stock grouped by ingredient and warehouse (base-measurement units). Optional filters; include_zero to show empty.
report_invoices
ChatGPTInvoice totals grouped by state for an optional date range (invoice date). Amounts in euros.
report_low_stock
ChatGPTItems whose total current stock is at or below a threshold (default 0). item_type product|ingredient|all.
report_payments
ChatGPTCustomer payments in a date range (sum + rows). Amounts in euros.
report_product_sales
ChatGPTSales grouped by product for a date range. Omit product_id to get every product that sold in the range, one row each — that is the normal call. Only pass product_id to narrow to a single product; never call this once per product to build a list.
report_product_stock
ChatGPTCurrent product stock grouped by product and warehouse (units in whole containers). Optional warehouse/product filter; include_zero to show empty.
report_product_stock_history
ChatGPTHow a product's stock in one warehouse moved over a date range: the balance and its value at each step. This is the series version of get_product_stock_ledger, which answers a single date — use this for "stock over time" instead of calling get_product_stock_ledger once per month. Balances are whole units, value is euros at source cost. Each point is the balance at the start of that date.
report_productions
ChatGPTProduction batches started in a date range, optionally filtered by state or recipe. production_size is in litres.
report_sales
ChatGPTSales totals (tax-free euros, units, litres) from delivered shipments in a date range, grouped by customer or product.
report_shipments
ChatGPTDelivered-shipment totals (units, litres, tax-free euros) in a date range, optionally grouped by customer or product.
report_small_brewery
ChatGPTPienpanimoalennus (small-brewery excise reduction, alkoholiverolaki 9 §) for a calendar year: the year's beer production in the order it accrued (the small-brewery ledger: every packing from a tank and every tap sale with the cumulative production before it and its litres per tier), litres per tier and the day each tier was reached, the tier the next litre gets, whether the brewery is entitled for the year (lost entirely above 15 000 000 l or when marked ineligible), and how many batches changed tier after they were first classified (returns that declared them may need correcting; see /raportit/viranomaiset/pienpanimoalennus). Tiers are reduction percents: 50 up to 500 000 l, 30 up to 3 000 000, 20 up to 5 500 000, 10 up to 10 000 000, 0 = full excise. Excise returns declare beer by these batch tiers. For an account marked as a registered small producer of packaged beverages, beverage_packaging_small_producer gives the year against the juomapakkausvero limit (laki eräiden juomapakkausten valmisteverosta 1 § 3 mom.: no tax when the packages of at most 5 l released for consumption in the calendar year hold at most 70 000 litres, return-system packages included; above it the tax is due on the whole year): litres per month, cumulative, the month the limit was passed, and the de minimis aid in euros (the tax the packages outside a return system would have paid; cap 300 000 euros in three tax years).
report_stock_value
ChatGPTEstimated stock value in euros (product source cost + ingredient batch cost), optionally by warehouse / item type. ingredient_estimated_value is the part of the ingredient value that rests on estimated purchase prices.
report_valvira
ChatGPTValvira delivery declaration (toimitusilmoitus) rows for a month. Pass date_from; the month (YYYY-MM) is used.
report_warehouse_stock
ChatGPTPer-warehouse summary: total product units (whole containers) and ingredient units currently held.
report_warehouse_transfers
ChatGPTProduct warehouse transfers in a date range, with moved unit totals.
reserve_tank
ChatGPTReserve a tank for a batch step. A tank that is not ready, still holds another batch or is booked at the same time only gives warnings (returned); the reservation is made anyway, so pass them on to the user.
restore_warehouse
ChatGPTRestore an archived (passive) warehouse to active.
search_allu_licensees
ChatGPTSearch Valvira's Allu alcohol-licence register (synced locally, refreshed daily) for licensees by a prefix of name, business id (Y-tunnus), outlet location, or street. Each match carries its licence number (license_id) to pass to create_customer_from_allu, plus existing_customer_id when the business is already a customer in this account.
search_customers
ChatGPTSearch the account's customers by name / business id.
search_ean_codes
ChatGPTSearch the account's EAN codes by code string, EAN product name, product id, or product base name.
search_invoices
ChatGPTSearch invoices by invoice number or customer name. Account-scoped.
search_productions
ChatGPTList/search production batches by state, or look up by serial number. production_size is in litres.
search_products
ChatGPTSearch products by name or Valvira reporting code (valvira_number). container_size is in litres. image_url is the absolute URL of the product's default image (fetchable without authentication), or null when none is set.
search_recipes
ChatGPTList/search the account's recipes by state. production_size is in litres.
search_shipments
ChatGPTSearch shipments by customer name, reference, description, or shipment id. Account-scoped.
search_warehouses
ChatGPTSearch the account's warehouses by name.
set_account_user_role
ChatGPTOwner only: change another user's role on the account to owner (everything incl. settings and users), regular (everything but settings) or sales (catalogue, customers and shipments only). The change takes effect on the user's next request. You cannot change your own role, and the account must keep at least one owner. Find the user_id with list_account_users.
set_customer_sales_ban
ChatGPTPut a customer under a sales ban (banned true, optional reason) or lift it (banned false). While banned no new shipment can be created for the customer - create_shipment and the web forms refuse - but its existing shipments and invoices are left as they are. get_customer shows the ban.
set_emcs_arc
ChatGPTManually record the ARC for a shipment's e-AD after submitting it via the MyTax fallback procedure. Sets the movement state to confirmed.
set_ingredient_price
ChatGPTSet an ingredient's market price: total_cost (euros) for a given number of units of the ingredient's base measurement.
set_ingredient_reorder_level
ChatGPTSet an ingredient's minimum stock (in its base measurement), which the shopping list tops the stock up to; null or 0 clears it.
set_ingredient_stock_count
ChatGPTSet the counted ingredient stock in a warehouse (inventory count). Computes the delta vs current and writes auditable stock rows.
set_ingredient_supplier
ChatGPTLink a supplier to an ingredient, or change the link: the supplier's product code, pack size and pack price, and whether it is the ingredient's preferred supplier (the shopping list orders from the preferred one; an ingredient always has exactly one, so its only supplier is preferred and preferred=false passes the mark to another supplier; leave preferred out to keep the link's standing). An ingredient can have many suppliers and a supplier many ingredients. The other fields left out are cleared. An archived supplier cannot be linked.
set_invoice_settlement
ChatGPTMark an active, uncredited invoice paid ("paid") or void ("void") by hand so the receivables match the books - e.g. an old invoice whose payment never reached BrewOS - or clear the mark (settled null). A marked invoice counts nothing open in report_accounts_receivable, get_invoice and the invoice lists; reports for a past day count it open until date. Books no payment, credits nothing and sends nothing to the customer or the accounting system; to reverse an invoice towards the customer use create_credit_note instead.
set_product_excise
ChatGPTSet excise data on a product: EMCS identifiers (CN/tariff code, EU excise product code / EPC e.g. B000 beer, degree Plato) and/or the time-dimensioned excise groups (alcohol tax_type, soft-drink tax_type_2, beverage-packaging packing_tax_group, packing_exemption). A group is assigned effective from valid_from (yyyymm, default 200001 = baseline); pass a later valid_from to record a law-change reassignment without altering earlier periods.
set_product_price
ChatGPTSet a product price (tax-free euros). Optionally scope to a customer or customer group; omit both for the general price.
set_product_stock_count
ChatGPTSet the counted units (CONTAINERS) — an ABSOLUTE figure, not a delta — for a specific product source in a warehouse. Writes the difference as an auditable product_stock row. Read the balance first and confirm with the user; for a relative +/- change use adjust_product_stock instead. The source must already live in that warehouse: an unstored packing from record_packing is stored with store_packing, which charges the production licence litres.
set_production_state
ChatGPTSet a production batch state: confirmed (from draft, or revert from completed) or completed (from confirmed).
set_recipe_state
ChatGPTSet a recipe's state: draft, active, or deleted.
set_shipment_description
ChatGPTSet a shipment's description and/or customer reference (not allowed once delivered).
set_shipment_valvira
ChatGPTSet the Valvira special-delivery code (Tunnuskoodi) and export country (Vientimaa, ISO 3166-1 alpha-3) for a shipment (e.g. 04 tax-free, 02 diplomatic; pass empty strings to clear). Export customers default to 03 (vienti) + their destination country; call this only to override that default.
set_tank_condition
ChatGPTMark a tank washed and ready, waiting for CIP, or in maintenance. This does not take a batch out of the tank; use release_tank when the tank has been emptied.
start_production
ChatGPTStart a new production batch from a recipe. production_size is in litres. tank_id reserves a tank for it (as "Aloita erä" on the tank map): for tank_recipe_step_id, or by default the first fermenting step; warnings about the tank are returned, pass them on.
start_production_step
ChatGPTMark a production step started now, or at a given Europe/Helsinki local datetime. A started step stays in its tank until it is ended (complete_production_step) or the tank is released.
store_packing
ChatGPTStore a recorded packing (astiointi) into a warehouse: the packing adopts the warehouse, its litres are charged against the account's production licence, and the containers appear as stock. This is the step that consumes licence litres, and there is no undo other than cancelling the packing, so summarise product, container count, litres and warehouse and get explicit confirmation first; it fails when the remaining licence capacity is too small. Use it for every packing from record_packing — adjust_product_stock and set_product_stock_count only correct stock that is already stored, and would put the products in the warehouse without ever charging the licence.
submit_emcs_ead
ChatGPTCreate/submit the EMCS e-AD for a duty-suspended export shipment. Requires explicit user confirmation: when the Vero EMCS API is enabled this transmits a real declaration to the authority and stores the ARC. Check get_emcs_status first so an existing movement is not submitted twice. If the API is disabled it records a draft and returns the e-AD data for the manual fallback (submit in MyTax, then record the ARC with set_emcs_arc) — the "live" flag in the result says which happened. destination_type is auto-derived if omitted; leave it out rather than guessing.
suggest_ingredient_price
ChatGPTWhat an ingredient's next purchase is likely to cost, from its own purchase history. Use it to fill total_cost when recording a delivery whose invoice has not arrived - and set cost_estimated on that delivery, so the guess stays visible and correctable.
transfer_ingredient_stock
ChatGPTTransfer ingredient stock between two warehouses (FIFO from oldest batches).
transfer_product_stock
ChatGPTTransfer product stock (CONTAINERS) between two warehouses (FIFO source unless product_source_id is given). Records a warehouse transfer and auditable product_stock rows. The stock arriving in the target warehouse is always excluded from the Valvira packing notification (astiointi-ilmoitus): it was reported when it was packed.
unallocate_production_ingredient
ChatGPTRelease a production ingredient reservation (all reserved units, or a given amount).
unallocate_shipment_stock
ChatGPTRemove a product_stock allocation from a shipment.
undo_production_ingredient_consumption
ChatGPTUndo one consumption stock row of a production batch, as "Peruuta" on the batch's ingredient page: the units go back to the stock batch they came from and are taken off the consumed units and cost. stock_id is a consumption row from list_production_ingredient_consumptions (negative units_delta); a row booked to a step is undone on that step (production_step_id defaults to it); an old row whose step is not known needs production_step_id, or none for an extra ingredient. A row already returned is refused.
update_customer
ChatGPTUpdate fields of an existing customer. Only the fields you pass are changed.
update_customer_group
ChatGPTUpdate a customer group's name and/or default payment terms.
update_customer_outlet
ChatGPTUpdate fields of a customer outlet. Only the fields you pass are changed.
update_ean_code
ChatGPTUpdate an EAN code's label (product_name) or reassign it to another product. The code value itself cannot be changed (remove + assign a new one). Reassigning away from a product that has shipment/invoice history is blocked.
update_ingredient
ChatGPTUpdate an ingredient's name, marketing name, notes, or parent (common) ingredient.
update_ingredient_batch
ChatGPTCorrect a stock batch's received units and/or total cost.
update_invoice
ChatGPTUpdate a draft invoice's date/terms/reference. Active invoices are locked.
update_invoice_row
ChatGPTEdit a row of a draft invoice (identified by its row number). total in euros.
update_product
ChatGPTUpdate a product's product group, Valvira product code and/or marketing description. Only the fields you pass change; null clears one. valvira_number, when set, is the code the product reports under to Valvira in preference to its EAN code, which is only the fallback (e.g. the supplier's barcode on an imported product, which cannot be an EAN code here because it is outside the account's EAN ranges). A changed valvira_number that Valvira can accept as written is also written onto the product's tax events in every month whose toimitusilmoitus has not been sent; tax_events_repointed counts them, so a refused month can be resent. A multipackage has no code of its own: it reports under its single component's code, so set it there. The response lists format problems found in the stored code (valvira_number_issues); an error-level issue means Valvira will not accept it. description is the product's main marketing description (the Markkinointimateriaalit page; the sales catalogue shows it as the beer's blurb) and translations its per-language versions; get_product returns both. Description and translations are per product (one container size); pass apply_to_all_sizes to write them to every active product of the same beer, as the web page's copy option does. Show the user the new text before writing it.
update_product_group
ChatGPTRename a product group and/or change whether it holds the brewery's own products (own_production false = resold/imported, no small brewery reduction). A group cannot move to another dimension.
update_product_group_dimension
ChatGPTRename a product group dimension and/or change whether a product can have several of its groups. Turning it single-choice (multiple false) is refused while some drink or product has more than one of its groups; move them out first with update_product. The level cannot be changed.
update_product_source
ChatGPTUpdate a product source's description / best-before / total cost / packing day, or include or exclude it from the Valvira packing notification (astiointi-ilmoitus). For stock that is not own production (bought-in small-brewery beer, an opening balance) set the pienpanimoalennus it is declared with: small_brewery_reduction_percent 50/30/20/10, 0 for full excise, null for the account default. Own production gets its tier from the small-brewery ledger and refuses it.
update_production
ChatGPTUpdate a production batch's planned start (Europe/Helsinki local datetime) and/or serial number.
update_production_note
ChatGPTUpdate the content of a production note.
update_recipe
ChatGPTUpdate a recipe's name, manual text, or per-litre overhead cost (cents).
update_recipe_ingredient
ChatGPTSet the amount of an ingredient on a recipe step.
update_recipe_step
ChatGPTUpdate a recipe step's description, type, or duration (minutes).
update_shipment
ChatGPTUpdate a shipment's reference/description/outlet/sales person, or its order-level discount. Description and outlet cannot change once delivered.
update_shipment_product
ChatGPTSet the unit count (and optionally the price and/or per-row discount) of a product row on a draft shipment. units is the container count (PACKS for a multipackage). The stored line price is the discounted (effective) total. A row that prices a multipackage like a single container (or the reverse) is refused until confirm_pack_mismatch=true.
update_supplier
ChatGPTChange a supplier's details; the fields left out stay as they are, an empty string clears one.
update_tank
ChatGPTChange a tank's name or details. Fields left out keep their value; an empty string clears a text field.
update_tax_event
ChatGPTCorrect the reported fields of one tax event (verotilitapahtuma), as the tax event page in BrewOS does: pass only the fields to change. All are validated before any is written; an invalid value fails the whole call. Returns the event with its remaining issues, and the names of the fields that changed (empty when nothing did). Prefer the suggested values from list_tax_event_issues / get_tax_event. The change feeds the excise and Valvira reports from now on but re-files nothing: if valvira_toimitus_state is "sent" or the month's excise return is already filed, tell the user the filing has to be corrected separately. Show the user the old and new values and get their confirmation before calling.
update_warehouse
ChatGPTUpdate a warehouse name / Valvira id / tax id.
validate_ean_code
ChatGPTValidate/normalize an EAN code: checksum status, normalized value, duplicate status, whether it falls in an account range, and any existing product assignment.
whoami
ChatGPTReturn the identity and effective scope of the calling token, including the account_id it is bound to (pass this account_id to account-scoped tools).