# Summary

The order summary block. Calculates and shows subtotal, tax, shipping, discount, and grand total. Two calculation modes: **local** (you specify a fixed tax rate and optional flat shipping) or **remote** (NetSuite calculates tax and shipping via SuiteScript).

In remote mode, the active **tax engine** is detected from your subsidiary settings — *legacy* (NetSuite's built-in), *Avalara*, or *Vertex*. Avalara and Vertex run as third-party tax services for advanced multi-jurisdiction calculation. A manual Recalculate button is available for fresh tax pulls when the engine supports it.

## Available in

* Order Form modules
* Public Page modules

## When to use

* Always include Summary on Order Form pages — it's the running tally users (and Payments) read for the order total.
* Cashier, B2B order entry, B2C checkout, drop-ship, quote — every order context needs Summary.

For non-financial transactions (Purchase Orders, Transfer Orders, Fulfilment Requests), Summary auto-hides the financial breakdown.

## Settings

| Setting       | Description                                                                                              |
| ------------- | -------------------------------------------------------------------------------------------------------- |
| **Configure** | Opens the configuration modal — calculation mode, tax rate, currency, title, record type, flat shipping. |

The configuration modal supports:

* **Use Local Calculation** — Yes (use Local Tax Rate and Flat Shipping) or No (let NetSuite/Avalara/Vertex calculate via the order summary service). Default: No.
* **Local Tax Rate** — fixed tax percentage (only when Local Calculation = Yes). Default: 0.
* **Currency** — display currency code. Default: USD.
* **Title** — heading shown above the summary. Default: *Order Summary*.
* **Record Type** — which transaction record type the summary represents (salesorder, cashsale, etc.). Default: salesorder.
* **Local Flat Shipping Cost** — fixed shipping amount for local mode. Default: 0.
* **Hotkey** — optional keyboard shortcut to scroll to and focus the order total (e.g. *ctrl+t*).

The active tax engine (legacy / Avalara / Vertex) and Avalara sandbox setting are read from the subsidiary configuration at runtime — they aren't picked here.

## How it works

1. Reads the line items, customer, and address from session state.
2. **Local mode** — applies the configured Local Tax Rate to the subtotal and adds Flat Shipping.
3. **Remote mode** — calls the OrderSummaryService for tax and shipping. The actual tax engine depends on the subsidiary's configured engine: legacy (NetSuite built-in), Avalara, or Vertex.
4. **Avalara / Vertex** — if either is enabled in the subsidiary, Summary detects it at mount and uses it for tax. Avalara calculates tax per line item for accurate multi-jurisdiction results. Vertex also re-runs tax automatically when the Payments block collects payment, so the final tax reflects any last-minute changes. For Avalara, the *Avalara Sandbox* subsidiary setting routes calls to the sandbox endpoint when on.
5. When **Use Location Address** is configured on the Address block, Summary uses the location's address for tax jurisdiction calculations on the relevant order types.
6. Recalculation is debounced — changes to line items, customer, or address trigger a fresh calc after a short delay.
7. For PurchaseOrder, TransferOrder, and FulfillmentRequest record types, the financial breakdown auto-hides (these don't have a customer-facing total).
8. If a Hotkey is configured, pressing it from anywhere on the page scrolls to the total and brings it into focus.

{% hint style="info" %}
Use **Local mode** for simpler workflows where tax is a single fixed rate and shipping is flat. Use **Remote** for anything where NetSuite should calculate (multi-jurisdiction tax, calculated shipping, custom rules). Avalara support is automatic when the subsidiary has it enabled.
{% endhint %}

## Examples

**Standard cashier flow.** Summary with Use Local Calculation = No, Title = *Order Summary*. NetSuite handles tax and shipping; Summary reflects whatever the order resolves to.

**Quick local-tax setup.** Use Local Calculation = Yes, Local Tax Rate = 8.25, Local Flat Shipping = 5. For a single-location workflow with simple tax, no NetSuite tax engine round-trip needed.

**Avalara-enabled retail.** Subsidiary with Avalara configured. Summary auto-detects, uses Avalara for tax, and offers a Recalculate button if the user wants a fresh tax pull (e.g. after changing the shipping address).

## Related

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Order Lines</strong></td><td>The line items Summary reads from.</td><td><a href="/pages/0XacQvdUpwJMX7gVJCf4">/pages/0XacQvdUpwJMX7gVJCf4</a></td></tr><tr><td><strong>Payments</strong></td><td>Reads the Summary total to know what to collect.</td><td><a href="/pages/9UpRZRjM7iTVfilhHOmR">/pages/9UpRZRjM7iTVfilhHOmR</a></td></tr><tr><td><strong>Discount Header</strong></td><td>Order-wide discounts that flow into the Summary.</td><td><a href="/pages/KwPchVKzF7YaQmTvHEIT">/pages/KwPchVKzF7YaQmTvHEIT</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.in8sync.com/client-admin-guide/active-workflows/getting-started/transaction-components/summary.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
