Using Saliox
Short, practical guides for the document platform - templates, branding, groups, and getting set up. Looking for the developer API? See the API reference.
Getting started
When you first sign in you'll see “How would you like to proceed?” on your dashboard. Choose:
- PDF API - start immediately. Grab an API key in Settings → API keys and generate documents from HTML, URLs or templates.
- Business Central & enterprise - tell us your expected volume and needs; we grant your licence, set up billing and help you onboard.
Dismissed that screen? You can reopen it anytime from Get Started, or use the “Grow your account” buttons on your dashboard.
Templates & the builder
Templates live under Templates. Start from the Library or create a blank one, then open the drag-and-drop builder.
Hosted templates, the template library and the builder are available on the Large plan and above.
- Blocks - add sections (columns), text, tables, totals, images, dividers and more from the left panel.
- Variables - insert
{{placeholders}}(e.g.{{invoice_number}}); your APIdatafills them at render time. Tables repeat over an array via a data key. - Preview - check the layout with sample data before you use it.
- Manage - rename, duplicate, set Active/Draft, move to a group, or delete from the ⋯ menu on each card.
For template variables, block types, starter templates and API usage, see the Templates section of the API docs. More builder guides will be added here separately.
Template logic & formulas
You can add logic to a template with short, code-style formulas - so a document only shows what's relevant. There are four places logic can act:
- Show or hide a block - e.g. only print a “Purchase order” box when there actually is a PO.
- Show or hide table rows - e.g. hide any line whose quantity is zero.
- Keep comment lines with their line - hide a line and its attached comment/description lines together.
- Conditional formatting - colour or bold a table cell when a condition is true (e.g. negative balances in red).
A formula only takes effect at render/preview with real data. The builder canvas still shows everything so you can keep editing - blocks that carry a rule are marked with a small “ƒ logic” tag. Leave a formula blank to do nothing (the block always shows / every row shows).
Where to write them
Open a template in the builder, select a block, and look in the Properties panel:
- Any block → Visibility (logic) → “Show this block only when…”.
- A table → Row visibility (logic) → “Show a row only when…”, and the “A row is a comment/attachment when…” box below it.
- A table column → Conditional format → a “when…” condition plus Text / Fill / Bold.
Every formula field has a ⤢ Editor button that opens a larger editor with clickable fields, operators and functions, live validation and examples.
Writing a formula
- Fields - reference your data by its name, unquoted:
quantity,type,total. Use a dot for nested values:customer.country. Inside a table, you can use that row's own column fields and document-level fields. - Numbers vs text - numbers are bare (
0,30,99.5); text goes in quotes ("Comment","Paid"). A bare word is always read as a field name, so quote your text values. - Compare -
==(equals),!=(not equals),<><=>=. - Combine -
&&(and),||(or),!(not), and parentheses( )for grouping. The wordsand,or,notwork too, e.g.isEmpty(sku) or type == "Comment". - Maths -
+ - * /, e.g.price * qty > 100.
Functions
| Function | What it does |
|---|---|
contains(text, find) | true if text contains find |
startsWith(text, find) | true if text begins with find |
endsWith(text, find) | true if text ends with find |
isEmpty(x) / notEmpty(x) | whether a value is blank / not blank |
lower(x) / upper(x) | change case - handy for case-insensitive matching |
trim(x) | remove spaces from the start and end |
len(x) | length of text (or number of items) |
abs(x), round(x, places), number(x) | maths helpers |
coalesce(a, b, …) | the first value that isn't blank |
Examples - row visibility
- Hide zero-quantity lines:
quantity != 0 - Hide blank description lines:
notEmpty(description) - Only lines over £100:
amount > 100 - Only backordered items:
status == "Backorder" - Ignore case when matching text:
contains(lower(description), "sample") - Two conditions at once:
quantity != 0 && amount > 0
Examples - show/hide a block
- Only show a PO block when there's a PO number:
notEmpty(po_number) - Hide a discount note unless there's a discount:
discount > 0 - Show a “PAID” stamp:
lower(status) == "paid" - Show only for large orders in the UK:
total >= 1000 && customer.country == "GB"
Keeping comment lines with their line
Business Central (and many ERPs) add comment/description lines that belong to the line above them. If you hide a line you usually want its comments to go too. Set two boxes on the table:
- Row visibility:
quantity != 0 - A row is a comment/attachment when:
type == "Comment"
Now a zero-quantity line and the comment lines beneath it disappear together, while comments under a visible line stay. A comment row “inherits” the visibility of the line above it, so you don't repeat the condition on it.
Condensing comment lines
Comment and description lines usually carry no quantity or price, so a full row of zeros wastes space. Tick “Condense comment rows” on the table (just under the comment box) and each comment renders as a single full-width, shaded, smaller line - its text (and any note, like a cut length) runs across the page, and the empty Qty / Price / VAT / Total cells disappear.
It uses the same “A row is a comment/attachment when…” rule, so set that first. Condensing and hide-with-parent grouping work together - a comment can be slimmed down and still vanish with its line when that line is hidden.
Column conditional formatting
On any table column, set a when… condition and choose a Text colour, a Fill colour and/or Bold. When that condition is true for a row, the cell is styled. The condition sees the whole row, so you can style one column based on another's value.
- Negative balances in red & bold - on the Balance column:
balance < 0 - Highlight overdue rows - on the Due date column:
daysOverdue > 30 - Flag large amounts:
amount >= 1000 - Amber for low stock:
quantity < reorder_point
Tips & gotchas
- Text is case-sensitive.
"Comment"≠"comment". Wrap both sides inlower()to ignore case:lower(type) == "comment". - Quote your text, not your fields.
type == "Item"compares the fieldtypeto the text"Item";type == Itemwould compare two fields. - Field names must match your data exactly (the same keys your API sends, or the table's column keys).
- Safe by default. A blank or invalid formula leaves content visible - a typo never silently drops data - so always confirm the result in Preview.
- Preview uses sample data. To watch rows actually disappear, preview with data that contains the zero/negative/blank values you're testing, or call the API with real data.
VAT, totals & tax
Saliox mirrors Business Central - it never recalculates tax. Every VAT figure on your document is the number Business Central already calculated and posted; Saliox reads those figures and prints them. Whatever your BC is configured for - rates, exemptions, reverse charge, rounding and currency - is exactly what appears on the PDF. The document can't disagree with BC.
The fields you can use
These come straight from the Business Central document (and are also what the PDF API expects in your data):
{{amount_excl_vat}}- net total, before VAT{{vat_amount}}- total VAT{{amount_incl_vat}}- gross total, the amount due{{currency}}- the document's currency code, taken from BC (e.g.GBP,EUR)- Per line:
unit_price,line_total(the net line amount) andtax_rate(the VAT % BC applied to that line)
The totals block
Select a Totals block in the builder and click “↺ Use Business Central totals”. This wires Subtotal / VAT / Total to {{amount_excl_vat}}, {{vat_amount}} and {{amount_incl_vat}} - the exact posted figures. Because BC does the maths, this is automatically correct with line discounts, invoice discounts and mixed VAT rates - things a naive “quantity × price” subtotal gets wrong.
Multiple VAT rates on one document
When a document mixes rates (say 20% and 0%), Business Central sends a per-rate breakdown your template can render. Turn on “Use BC-Computed VAT Breakdown” in the Saliox document config inside Business Central (see the Business Central extension guide), and these become available:
vat_summary- an array with one row per rate. Each row hasvat_percent,base(net),vat_amount,amount_incl_vat(gross) andvat_clause.vat_clauses- the distinct clause texts on the document (e.g. a reverse-charge note).has_multiple_vat_rates-truewhen more than one rate is present; pair it with a{{#if}}so the breakdown shows only when it's needed.
Add a table whose data key is vat_summary to print a “VAT summary” (Rate / Net / VAT / Gross), and show {{vat_clause}} for reverse-charge or exempt lines. The clause wording comes from your BC VAT Clauses, so it reads exactly as Business Central prints it.
Which tax systems are supported
- UK & EU VAT - fully supported. Standard, reduced and zero rates; several rates on one document; exempt; and reverse charge / intra-EU (wording from your BC VAT Clauses). Whether VAT applies, and at what rate, is decided by Business Central from the customer's VAT setup - so B2B and B2C both come through correctly; Saliox just prints BC's result.
- Currency - whatever the BC document uses. Multi-currency is supported: the amounts and
{{currency}}reflect the document's own currency in Business Central. - US sales tax and India GST - not supported yet. Business Central models these differently (US Tax Areas / Jurisdictions; India's GST engine) rather than as VAT. Header totals still come through, but there's no per-jurisdiction sales-tax or CGST/SGST/IGST breakdown. These are on the roadmap.
In short: if it's correct in Business Central, it's correct on your Saliox PDF. If a figure ever looks wrong, check the posted document in BC first - that's the source of truth Saliox is printing.
Groups
Groups are simple folders for organising templates - by company, brand, warehouse or however you work.
- Create a group from the sidebar on the Templates page; rename, duplicate (copies its templates too) or delete it (templates move to Ungrouped, never deleted).
- Move a template between groups from its ⋯ menu.
- A group can carry its own branding overrides (see below) - handy for, say, a UK vs another-country footer on the same template.
Branding
Set your look once in Branding: a logo, colour tokens, a font, three footer blocks, and a terms/disclaimer. It applies across all your templates.
Branding is available with hosted templates on the Large plan and above.
- Use from brand - in the builder, pick a brand colour token on any colour picker, or set an image to Use brand logo. Change the brand once and every template follows.
- Footers & logo as variables - drop
{{brand_footer_center}},{{brand_logo}}etc. into a template. - Terms page - tick “Append brand terms as a final page” in the builder's Page tab to add your terms on their own last page. Style its colour/size in Branding.
- Per-group overrides - override the logo, footers or terms for a specific group; blank fields inherit the global brand.
Enterprise & Business Central
To use the Business Central document extension or higher API volumes, request it from Get Started or the dashboard.
- Submit your expected monthly volume, storage needs and any notes.
- We review it (usually within one business day), start a trial so you can build and test, and email you.
- When you're ready, we issue your enterprise plan and provision your Business Central licence.
Trials are time-boxed - if a trial ends without converting to a paid plan, enterprise access and the BC licence pause automatically.
Partner programme
Partners manage documents across multiple customers and resell Saliox.
- Request partner access - get in touch via Contact (choose “Partnership”) or the “Become a partner” button on your dashboard.
- Invite customers - from your Partner dashboard, invite a customer; they accept, create their account, and build/test alongside you.
- Request trials & enterprise for a customer from your Partner → Clients area; we action licences and billing.
Business Central extension
Use the Saliox extension to generate PDFs from Microsoft Dynamics 365 Business Central documents. It supports Business Central 24 and later.
1. Download and install the extension
- Make sure your Business Central access has been activated. If not, request it through Get Started.
- Download the Saliox .app file and save it somewhere accessible to your Business Central administrator.
- In Business Central, search for Extension Management, choose Manage → Upload Extension, and select the downloaded file.
- Accept the required terms, start the deployment, then wait until the extension shows as Installed.
2. Assign permission sets
In Business Central, open the user or user group and assign the appropriate permission set:
- Saliox - Admin - for administrators who install, connect and configure the extension.
- Saliox - User - for people who generate documents using the approved configuration.
3. Connect Business Central to Saliox
- In Saliox, copy an API key from Settings → API keys. Your Business Central licence key is provided when your licence is activated.
- In Business Central, search for Saliox Setup.
- Leave the API endpoint as
https://saliox.com/api/v1, then enter the API key and licence key. - Choose Actions → Test Connection. Confirm that the status changes to Connected and that your plan and available features are shown.
- Under Enabled Document Types, switch on the documents your team will use. Set the default print behaviour and any logging or posting options you need.
4. Map document types to templates
- From Saliox Setup, choose Actions → Document Configuration.
- Choose Initialise All Document Types if you want Business Central to create the default configuration entries for you.
- Open a document type and enter its Template ID. You can find the ID in the Saliox builder URL; use
0only when you want the basic fallback layout. - Set the filename pattern, page size and margins, copies, watermark, password or compliance options as required.
- Choose the PDF Destination: open it in the browser, attach it to the Business Central record, or save it to Incoming Documents.
- Leave Use BC-Computed VAT Breakdown on when the template should use the VAT totals calculated by Business Central. Enable Auto Generate on Post only for document types that should render automatically after posting.
Build and preview templates in Templates. For the available template data and API examples, see the template documentation.
5. Add custom field mappings
- From Saliox Setup, choose Actions → Field Mapping.
- Add a row and select the Document Type, BC Table No. and BC Field No.
- Enter the JSON Key that matches the variable in your Saliox template.
- Turn on Header Field for a document-level value; leave it off for a value that belongs to each document line.
- Optionally enter a Static Value, mark the value as required, set its order, and make sure the mapping is enabled.
For example, map a custom Sales Invoice Line field to light_reference, then place {{light_reference}} inside the template's repeating line row.
6. Choose how users print
Set a default in Saliox Setup, then override it for individual document types in Document Configuration:
- Ribbon action only - Business Central's standard Print action is unchanged; users choose Generate PDF (Saliox) separately.
- Ask each time - the standard Print action asks whether to use the standard layout or Saliox.
- Replace standard Print - the standard Print action generates the Saliox PDF directly.
The native Print choices apply to posted sales invoices, posted sales credit memos, sales quotes, sales orders and purchase orders. Users can also generate with the Saliox ribbon action, email supported documents through Business Central's standard email editor, or use automatic generation after posting.
7. Test and troubleshoot
- Open an enabled document and choose Generate PDF (Saliox).
- Check that the selected template, filename and destination behave as expected.
- If generation fails, open Saliox Setup → Actions → Generation Log and review the latest entry.
- Turn on Support Mode only when Saliox support asks you to collect more detailed diagnostics.
If the Saliox action is missing, check that the document type is enabled and that the user has the Saliox - User or Saliox - Admin permission set.