System Configuration

A single list of typed key/value settings that steer specific pieces of portal behaviour — from AIR's GST home state to the on/off switches for the daily background schedulers.

Built — viewing and editing are both live in the console today.
Permissions

Opening this list requires admin.view_system_config (or the super-admin role). The console does not check a separate permission before letting you save an edit — the same admin.view_system_config gate covers both the list and the edit screen. A distinct admin.edit_system_config permission is seeded for future use but is not yet wired to any check in this resource.

What this screen is

System Configuration is not a business record you create — it is a fixed catalogue of settings that ships with the code. Each row is one key (for example reservation.enabled) holding a current value. You cannot add a new key or delete an existing one from the console; keys are defined and seeded by developers. What you can do is open a key and, if it is marked editable, change its value.

Screenshot placeholderThe System Configuration list — columns Key, Group, Value, Editable, Updated at; no search box, filter panel or bulk actions above the table.

The list

Nav: Administration → System Configuration.

ColumnShows
keyThe setting's unique identifier, e.g. gst.home_state_code. Searchable and sortable.
groupA category label the setting belongs to, shown as a plain badge. Sortable.
valueThe current value, truncated to 40 characters in the list — open the record to see it in full.
is_editableA tick/cross icon. Ticked keys can have their value changed from this console; crossed keys are locked — even an administrator cannot change them here.
updated_atWhen the value last changed. Hidden by default — switch it on from the column toggle.

There are no filters on this list — with typically only a handful of keys in the whole system, the plain sortable/searchable table is enough to find what you need.

Editing a value

  1. Open the key

    Select Edit on the row. The edit screen shows key, group, type and description — all disabled. They are read-only reference information, not fields you change.

  2. Change the value, if you are allowed to

    The value field is a text box. It is only enabled when the row's is_editable flag is on; otherwise it appears disabled and the console will refuse the save regardless.

  3. Save

    Your input is validated and cast to the setting's underlying type before it is stored, and the cached copy of that key is cleared immediately — the new value takes effect straight away, with no restart or wait.

Screenshot placeholderThe edit form for one key — key/group/type/description shown disabled at the top, the value field below (enabled or greyed out depending on is_editable), Save button at the bottom.
Why the value is validated and cast, not just saved as text

Each key has a fixed underlying type. Saving does not simply store whatever text you type — it is parsed and converted to that type (for example, a JSON-typed value is JSON-encoded unless it is already a plain string) before it is written, so a mistyped value is rejected with an error instead of silently breaking whatever else in the portal reads that key.

Currently seeded keys

These are the settings shipped with the system today, in the order the seeder writes them. The Editable column tells you whether the value field is enabled when you open the key — a No here means the portal manages that value itself and the field is greyed out.

KeyWhat it controlsEditable
gst.home_state_codeAIR's home GST state code, shipped as 27 (Maharashtra). Billing compares an order's delivery state against this to decide whether GST is split as intra-state (CGST + SGST) or inter-state (IGST).Yes
placeholder.region_idA stand-in region ID, used internally wherever a process still needs a region reference that isn't otherwise resolvable — a stop-gap value, not a setting you would normally touch.No
placeholder.pincode_idThe same placeholder pattern as above, for pincode references.No
reservation.enabledThe kill-switch for the daily auto-reservation scheduler. Turn it off to pause automatic stock reservation across the whole portal.Yes
reservation.cod_in_transit_limitHow many despatched-but-unremitted COD packages a customer may have out before the nightly auto-reservation job holds their further cash-on-delivery items. Shipped as 5: a customer with more than five such packages out has their next COD items held as Too many unremitted COD packages already out for this customer until the cash is remitted. 0 switches the check off.Yes
reservation.rbp_in_transit_limitThe same check for carriers marked RBP / OLP carrier (see Warehouses & Carriers). Shipped as 1: a customer with more than one such package out, money not yet received, has further items on those carriers held. 0 switches it off.Yes
reservation.first_parts_on_creditHow many parts of a subscription line a customer marked send first parts on credit may receive before paying. Shipped as 3.Yes
wave.enabledThe kill-switch for the daily auto-wave-creation scheduler. Turn it off to stop new picking waves being created automatically.Yes
wave.expects_on_window_daysWhen a customer has asked for delivery on a later date, the nightly wave run picks up their reserved item only once that date is within this many days. Shipped as 5.Yes
wave.auto_close_enabledThe switch for the daily 06:00 run that marks despatched picking waves done once all their packages are delivered, returned, lost or cancelled. Shipped on.Yes
refund.create_journal_entryWhen on and both refund accounts below are filled in, issuing a refund also posts a balanced entry to the ledger. Shipped off.Yes
refund.debit_accountThe account code debited by that refund entry — the customer advance/liability being cleared. Shipped blank.Yes
refund.credit_accountThe account code credited by that refund entry — the bank or cash the refund is actually paid from. Shipped blank.Yes
bounced.create_journal_entryWhen on and both bounced accounts below are filled in, marking a payment voucher dishonoured posts a balanced reversal entry to the ledger. Shipped off.Yes
bounced.debit_accountThe account code debited by that reversal — the customer receivable being re-established. Shipped blank.Yes
bounced.credit_accountThe account code credited by that reversal — the bank or cash that did not clear. Shipped blank.Yes
purchase.create_journal_entryWhen on and all three purchase accounts below are filled in, posting a vendor bill also posts a balanced entry to the ledger. Shipped off.Yes
purchase.purchases_accountThe account code debited for the taxable amount of a posted vendor bill. Shipped blank.Yes
purchase.input_gst_accountThe account code debited for input GST on a posted vendor bill (CGST + SGST + IGST together). Shipped blank.Yes
purchase.payables_accountThe account code credited with the vendor payable — the bill's total amount. Shipped blank.Yes
purchase.payment_credit_accountThe account code (bank or cash) a vendor payment is paid from. Shipped blank.Yes
despatch.customer_location_idThe global virtual Customers endpoint every delivery ships to. The portal points this at the seeded location itself — you never set it by hand. See Warehouses & Carriers for what the virtual endpoints are.No
despatch.creation_enabledThe kill-switch for the nightly (01:00) run that creates despatch items for approved orders (see Background Schedulers). Shipped on. While off, items are created only by Create despatch items now on an order.Yes
despatch.batch_sizeHow many sale orders that nightly run loads at a time. Shipped as 500; there is normally no reason to change it.Yes
despatch.packing_efficiency_pctHow full a box may be packed, as a percentage of its internal volume, when a wave's packages are generated (1–100; default 85). Lower it if packed boxes come back too tight; raise it toward 100 if packages are being split more than they need to be. See Packages › How packages and boxes are chosen.Yes
Despatch ships from each warehouse's default location

There is no longer a single global despatch source setting. An order's despatch items ship from its warehouse's default location or, when it has none, from the warehouse's only in-use stock location (or only main stock location). An order whose warehouse has several main stock locations and no default is skipped by the nightly run and logged. Set it on the warehouse's edit form (Default despatch location); the first location added to a warehouse through the API becomes the default automatically. See Warehouses & Carriers.

The accounting keys come in sets — a half-filled set does nothing

The three refund.* keys, the three bounced.* keys and the four purchase.* keys each work as a group: the …create_journal_entry switch only takes effect once every account code in its set is filled in. Turning the switch on and leaving an account blank simply means no entry is posted — you get no error. See Accounting — Journal & GST for what each entry looks like once it is posted.

Kill-switches, not day-to-day settings

despatch.creation_enabled, reservation.enabled, wave.enabled and wave.auto_close_enabled are emergency/maintenance switches for background jobs, not values you change routinely. The reservation.*_limit keys are different — they are real business policy dials, shipped at the old system's values (more than 5 COD packages, more than 1 RBP/OLP package). See Background Schedulers for exactly what each job does, when it runs, and what happens while its switch is off.