# Create a new quotation
Source: https://docs.zuper.co/Accounting/Create_New_Quote
A quotation, also known as an estimate, is a formal document provided to a customer that details the expected costs for a specific service or project. It includes a breakdown of services, materials, labor, and any additional expenses. As a preliminary agreement, a quotation helps set clear expectations for the scope of work and associated costs.
**Navigation**: *Accounting* *->* *Quotes* -> *+ New (Quote)*
1. Click the “**Accounting**” module from the left navigation menu and select "**Quotes.**"

2. Click “**+ New Quote**” to create a new quote.

3. Select either "**Customer** ", " **Organization**", or "**Property**" to associate with the quotation.
4. Click "**+ Add**" to associate the various modules.
> [!NOTE]
>
> You can now associate multiple assets with a quote.
5. A side panel will appear. Select the required module and click the "**Proceed**" button.
6. The billing and service contact details are automatically populated based on the selected customer or organization.
7. Fill in the mandatory fields in the **Quote Details** section:
* **Quote Date**
* **Expiry Date**
* **Quote Template**
> [!NOTE]
>
> The **Created By** field is automatically set to the user who creates the quote and cannot be changed after the quote is saved. If a different team member takes over the quote, the **Created By** field will continue to display the original creator's name. To reflect updated ownership, use the **Quote Sold By** field to assign the team member actively handling the quote. This field can be updated at any time and is used for ownership tracking, filtering, and sales performance reporting. **Important:** If a specific user needs to appear as the creator of a quote, they must create it themselves from their own login. The **Created By** field cannot be reassigned after creation.
> [!NOTE]
>
> **Note: Remarks field and PDF templates**\
> The **Remarks** field on a quote lets you add custom notes that appear on the quote record. However, whether these remarks appear in the generated PDF depends on how the quote template is configured.\
> \
> If the Remarks section in the PDF template is **hard-coded** (contains static text set during template creation), any changes made to the Remarks field on the quote will not be reflected in the PDF — the template's fixed text will display instead.\
> \
> To have the Remarks field value appear dynamically in the PDF, the template must be updated to use the dynamic Remarks field variable. Contact [**support@zuper.co**](mailto:support@zuper.co) to request this change.\
> \
> **Note:** Custom template changes affect all quotes using that template. Before requesting a change, confirm that updating the Remarks behavior will not affect other quotes currently relying on the static text.
8. Click "**+ Add**" in the **Parts & Services** section and select an option to add parts, products, or services to the quotation, such as *Line Item*, *Bundle*, [*Section*](https://docs.zuper.co/Accounting/Sections), *Item Group*, or *Custom Line Item*.

> [!TIP]
>
> If **Mandate asset association to line items** is enabled in the **Settings** and your quote includes one or more assets, ensure every line item has an asset selected. Otherwise, you won’t be able to save the quote.
> [!NOTE]
>
> When you add a non-billable item directly to a quote, its cost is included in the total, ensuring proper tracking. However, if a non-billable item is part of a transaction (such as a job or contract) and that document is later converted into a quote, the item will not appear on the invoice. This is because non-billable items are excluded from the billable total.
> [accordion] Updating markup and discount for Parts, Products, and Services
>
> After adding parts, products, and services, you can edit or update the Markup value and its discount by following these steps:
>
> 1. Locate the line item in the list of added parts, products, or services.
> 2. Click the **context menu** (three-dot ellipsis) next to the item you want to update.
> 3. Choose the **Edit** option. An **Edit Line Item** pop-up will open.
>
> 
>
> * Adjust the markup type to **Flat (+)**, **Percentage (%)**, or **Multiplier (x)** based on your requirement and enter the desired value for the selected markup condition.
>
> * Edit the discount as either a **percentage (%)** or a **fixed amount (USD)** and enter the desired value in the **Discount** field.
>
> 4. Click **Update** Line Item to apply the changes.
>
> 
9. If **Track Serial Number** is enabled and **Mandate Serial No** is turned on in Settings, you must need to enter a serial number before proceeding.
10. You can [add rebates](/Accounting/Rebates) to show your customer the potential savings available to them. Zuper uses the rebate amount to calculate and display the customer’s Net Investment without changing the quote Total or Amount Due.
11. After adding parts and services to the quote, transactional discounts and global taxes will be applied.
> [!NOTE]
>
> **Notes:**
>
> * If a line item includes a custom tax, transactional discounts, and global taxes cannot be applied.
> * Transactional-level discounts apply only when all parts and services in the quote are either fully taxable or fully non-taxable.
> * If a line item includes a custom tax, transactional discounts, and global taxes cannot be applied.
> * Transactional-level discounts apply only when all parts and services in the quote are either fully taxable or fully non-taxable.
> * When any line item on the quote has a custom tax applied, the **Transaction Level** option will not appear in the discount type selector. Removing the custom-tax line item, or updating it to be non-taxable or taxable without a custom tax, restores the **Transaction Level** option.
> [!NOTE]
>
> **Tax display in templates**
>
> The way taxes appear on your quote PDF — for example, whether tax is shown separately per line item or as a single total — is controlled by your document template settings. Some regional billing standards, such as Canadian invoicing requirements, require taxes to be displayed separately from each line item on the document. If you need to change how taxes appear on your quote or proposal templates, contact [Support ](mailto:support@zuper.co)
>
> Your administrator cannot change this setting directly.
11. Adjust the [margin percentage](/Accounting/Profit_Margin) to instantly recalculate markup % and the total selling price for all line items.
12. **Payment Methods:** Select the [payment methods](/Zuper-pay/Settings#configure-the-payment-methods-your-customers-can-see) you want to offer the customer for this quote. You can turn individual payment methods on or off as needed.
13. Enter the details for any custom fields configured in the settings.
14. Click "**+ Add Attachments"** to upload any quotation-related files.
15. Click " **Save as Draft"** to temporarily save the quotation. In the confirmation pop-up, click " **Save as Draft"** again to confirm.

15. The quotation is created successfully.
## Send a quotation
After you save a quotation, you can send it to the customer for review and acceptance.
1. Open the quotation from the **Quotes** listing page.
2. Select **Send** at the top right of the details page.
3. A send dialog appears. Before you send, review the **Document Template** field in the dialog.
> [!WARNING]
>
> The **Document Template** field in the send dialog controls which template is used to generate the PDF the customer receives. This is separate from the template you selected when you created the quote. If you change the template here, the PDF layout and content will reflect the newly selected template — not your original selection. Always confirm that the correct template is selected before sending.
> [!NOTE]
>
> **Email attachment size limit** When sending a quote by email, attachments are included directly in the email up to a combined size of **20MB**. If the total attachment size exceeds 20MB, Zuper automatically converts attachments to inline download links in the email body rather than sending them as attachments. Recipients can still access the files by clicking the links, but the files will not appear as standard email attachments. **Workaround:** If you need attachments to be delivered as standard email attachments, ensure the total size of all attached files is under 20MB before sending. Consider compressing large files or splitting them across multiple sends if needed.
4. Make any other adjustments to the email details, then select **Send**.
The customer receives the quotation as a PDF based on the template selected at send time.
> [!NOTE]
>
> **Note:** If you have recently edited a quote, wait at least one minute before sending the email. Sending immediately after making changes may result in the PDF attachment showing outdated values. The electronic signing link will always reflect the latest version.
>
> If you have edited the **Remarks** field, ensure the quote is explicitly saved (via **Save as Draft**) before exporting or sending the PDF. Remarks edits that are not saved prior to PDF generation may revert to the previously saved version.
### Set a default document template
To avoid selecting the wrong template each time you send, you can configure a default document template in your settings. The default template pre-populates the **Document Template** field whenever you send a quotation.
1. Go to **Settings**.
2. Go to **Accounting**, then select **Document Templates**.
3. Locate the template you want to set as the default.
4. Select the context menu (three-dot ellipsis) next to the template.
5. Select **Set as Default**.
The selected template now pre-populates the **Document Template** field each time you send a quotation.
> [!NOTE]
>
> **Note**: Setting a default template does not prevent you from selecting a different template at send time. Always review the **Document Template** field before sending to confirm that the correct template is selected.
> [!NOTE]
>
> **Note:** Setting a default template here only affects quotes sent or printed from the **Quotes** module. If you print or save a quote-related document from within a **Job** record, that document uses the **Job Card Template** assigned to the job instead — see [Configuring Job Card Templates](/Settings/Modules/Jobs/Configuring-job-card-template).
> [!WARNING]
>
> **Reversing an accepted quote:** A quote cannot be moved backward from
> **Accepted** to **Sent**, and it cannot be returned to **Draft** from the
> Quote Details page. Status transitions on quotes move forward only.
>
> If a customer changes their mind after approving a quote, you have two
> options:
>
> * **Clone the quote** and send the copy, keeping the original accepted record
> intact for audit purposes.
> * **Contact [Zuper Support](mailto:support@zuper.co)** with the quote number
> if the original record itself must be reverted.
Quotations are sent to customers for their review and acceptance before the job begins. Once the customer accepts the quotation, technicians can proceed with the services or replacement of parts listed in the document.
## Frequently asked questions
> [accordion] Does adding a rebate reduce the quote Total or Amount Due?
>
> No. The rebate is shown separately and is used only to calculate the customer's **Net Investment**.
> [accordion] Can I add multiple rebates to a quote?
>
> Yes. You can add multiple rebates to a quote, up to the supported limit. Zuper combines them when calculating **Net Investment**.
> [accordion] What happens if I edit a rebate template after adding it to a quote?
>
> The rebate already added to the quote does not change. Edit the rebate directly on the quote if you need to update it.
> [accordion] Who can see purchase tax fields
>
> Users see **Pre-Tax Cost** and **Purchase Tax %** only when their custom role has **View Purchase Tax** turned on. These fields appear only for stocked materials, and only when your organization has purchase tax enabled. The permission applies to both the web app and the Zuper Field Service app.
>
> To give a role access:
>
> 1. Select **Settings** from the left navigation menu, then select **Users & Teams** > **Custom Roles**.
> 2. Select the role, then select **Products** from the **List of Modules**.
> 3. Turn on **View Purchase Tax**, then click **Update Role**.
# Difference Between Proposals and Quotes
Source: https://docs.zuper.co/Accounting/Difference_Between_Proposals_and_Quotes
The following table outlines the key differences between **Proposals** and **Quotes** in Zuper, helping you understand their unique purposes and features.
| Feature | Proposal | Quote |
| - | - | - |
| **Purpose** | A preliminary document designed to showcase service offerings, pricing options, and flexibility during negotiations. | A formal document that finalizes the agreed-upon services, pricing, and terms. |
| **Customization** | Allows adding multiple service options with flexible pricing to let customers choose what suits them best. | Contains fixed details with no room for customization after customer approval. |
| **Negotiation** | Enables back-and-forth communication between the business and the customer to finalize terms and services. | Represents final, agreed-upon terms that are ready for execution without further negotiation. |
| **Approval Process** | Requires explicit customer approval before being converted into a quote. | Indicates services and pricing already approved by the customer and ready for execution. |
| **Uses** | Can present options like different service packages (e.g., basic, premium) for customer review and decision-making. | When the customer has selected an option, and the details are ready to move forward as a job or project. |
| **Workflow in Zuper** |
- Navigate to the **Proposals** section.
- Create a proposal by adding service options, pricing, and terms.
- Send it to the customer for review and approval.
- Convert it into a quote after approval.
| - Navigate to the **Quotes** section.
- Create a quote with finalized details.
- Share it with the customer for execution.
|
| **Examples** | - A service business presents multiple repair package options (e.g., **Basic Repair** vs. **Comprehensive Repair**) for the customer to choose from.
- A facility maintenance company sends a proposal with pricing for weekly, bi-weekly, and monthly maintenance plans for review.
| - After the customer approves the selected package, a finalized quote is created for the **Comprehensive Repair**.
- A quote for a fixed monthly maintenance plan is issued after the customer’s approval.
|
| **Associated Actions in Zuper** | - Send reminders to customers for proposal review.
- Update the proposal status (e.g., Draft, Sent, Approved, Declined).
- Convert a proposal into a quote for execution.
| - Track the status of the quote (e.g., Draft, Sent, Accepted).
- Clone quotes for similar jobs.
- Archive or cancel outdated quotes.
|
# Discounts
Source: https://docs.zuper.co/Accounting/Discounts
Discounts help you offer promotions, reward customers, match competitor pricing, or make approved price adjustments on quotes and invoices. In Zuper, you can apply a discount to the entire quote or invoice or to a specific line item. Zuper automatically updates the subtotal, tax, and total based on the discount you apply.
You can also add multiple discounts to the same quote or invoice when transaction-level discounts are enabled.
There are two ways to add discounts:
* **Transaction-level discounts** apply to the entire quote or invoice. Use them to stack multiple discounts such as promotions, loyalty discounts, or manager-approved adjustments.
* **Line-item discounts** apply to a specific product, part, or service. Use them when only certain items need a price adjustment.
You can add discounts in the Zuper web app and the Zuper Field Service app.
> [accordion] **Things to know**
>
> * Your organization can use either transaction-level discounts or line-item discounts. Only one discount method can be enabled at a time. Your admin set "**Apply discount at?**" in **Settings → Modules → Quotes and Invoices → General**.
> * To select from saved discounts, create them first in **Settings → Modules → Quotes and Invoices → Discount & Fees**. Learn more in Configuring Quotes and Invoices.
> * Role and trade-type restrictions determine which discounts users can access.
[https://drive.google.com/file/d/17ihETP5r8bdmM6EX58CELatDaZhkbCPm/preview](https://drive.google.com/file/d/17ihETP5r8bdmM6EX58CELatDaZhkbCPm/preview)
## Transaction-level discounts
A homeowner qualifies for a spring promotion and a veteran discount, and your sales manager approves an additional 5% discount. You can add each discount separately below the **Sub-Total** by clicking "Add Discount?", which makes it easy for your team to understand how the final price was calculated.
Zuper applies each discount to the remaining amount after the previous discount has been applied. Tax is calculated last, using the **Subtotal after discount**.
#### **To apply a discount to your quote or invoice:**
1. Create a quote or invoice, or navigate to an existing quote or invoice.
2. Add your line items.
3. Below **Sub-Total**, click **Add Discount?**.
4. Click **Enter label** and select a saved discount, or enter a name for a new discount.
5. Enter or update the value. Select **USD** for a fixed amount or **%** for a percentage.
6. Click outside the row to apply the discount. This discount will be deducted from the sub-total.
7. To add another discount, click **Add Discount?** again and repeat the process.

> [!WARNING]
>
> **Important**: Transaction-level discounts are applied sequentially. Each percentage discount is calculated on the remaining amount after previous discounts have been applied. Changing the order of discounts can change the final total.
## Line-item discounts
Line-item discounts are useful when only one product or service requires a price adjustment. For example, you may offer a discount on a specific part, or provide a one-time reduction on a service without affecting the rest of the quote.
Zuper strikes through the item's original total and displays the discounted total below it. The **Sub-Total** reflects the discounted line totals, and tax is calculated on that amount.
### To add a line-item discount
1. From your quote or invoice, click **Add line item**. If you are editing an already created quote or invoice, click (...) in the **Actions** column and select **Edit**.
2. In **Discount**, select **USD** or **%**.
3. Enter the discount value.
4. Click **Update Line Item**.

Zuper strikes through the original line total and displays the discounted total below it.

## Frequently asked questions
> [accordion] Why don't I see Add Discount?
>
> Your account is configured for line-item discounts. Use **Edit Item** on individual line items instead.
> [accordion] Why can't I find a saved discount in the Enter label list?
>
> Your admin may have restricted the discount to specific roles or trade types. The discount appears only when your user role and trade type match the configured restrictions.
> [accordion] Does my customer see individual discounts?
>
> Your team can view each discount separately on the quote or invoice details page. In the generated PDF, discounts are combined and displayed as a single **Discount** value.
> [accordion] Why did my total change when I added the same discounts in a different order?
>
> Percentage discounts are calculated on the remaining amount after previous discounts have been applied. Because of this, changing the order of discounts can change the final total.
> [accordion] Can I change a saved discount's value on one quote?
>
> Yes. After selecting a saved discount, you can edit its value before applying it to the quote or invoice.
# Managing accounts receivable
Source: https://docs.zuper.co/Accounting/Invoices/AR_management
Accounts Receivable (AR) represents the money owed to your business by customers for goods or services delivered but not yet paid for.
With Zuper, you can now efficiently track and manage your accounts receivable by gaining clear visibility into customers and organizations with outstanding invoice balances. Zuper also provides detailed aging information, helping you understand how long payments have been overdue.
By effective management of accounts receivable, you can reduce outstanding balances, improve liquidity, and minimize financial risks, contributing to better cash flow and overall financial health.
## Managing accounts receivable
To manage your account receivables, follow these steps:
1. Select the Accounting module from the left navigation menu and choose “**Invoices**.”
2. You will land on the invoices summary page, which displays details such as the Invoice Number, Invoice Date, Due Date, Customer, and more for each invoice.
3. Click “**AR management**” at the top right of the screen. This will take you to the AR Management dashboard, where you can access an overview and the AR Aging Summary.

### Dashboard insights
On the AR Management Dashboard (Overview), you can view the following key metrics and insights, providing a centralized view for efficiently monitoring overdue payments. The dashboard also includes clear prioritization indicators through charts and a list of the most overdue invoices.

* **Outstanding Balance**: Total amount owed by customers or total accounts receivable. This includes both current and overdue amounts.
* **Delinquent Accounts**: No. of customer/organization accounts that fall under an aging bucket, representing overdue invoice payments.
* **Bad Debt**: Amount that is considered unlikely to be collected.
* **Aging period**: Displayed as a donut chart, this provides a clear overview of payment statuses. It categorizes outstanding accounts receivable into time intervals based on how long they have been overdue. This includes:
1. **Current**: Payments not yet overdue.
2. **1–30 Days**: Payments overdue by 1 to 30 days.
3. **31–60 Days**: Payments overdue by 31 to 60 days.
4. **61–90 Days**: Payments overdue by 61 to 90 days.
5. **90+ Days**: Payments overdue for more than 90 days
* **Most overdue invoice**: Highlights the top 10 delinquent invoices that require urgent attention. This section includes key details such as actual due date, number of days overdue, invoice number, due amount, and the responsible customer’s name & phone number.

> [!NOTE]
>
> **Note**: From here, you can quickly send payment reminders to customers linked to selected invoices. Additionally, you can mark invoices as bad debt, if considered uncollectible, using the icon.
### A/R aging summary
The AR Aging Summary provides a detailed breakdown of accounts receivable categorized by aging periods. You can switch between different summary views to focus on data specific to:

1. Invoice
2. Customer/Organization
### Invoice view:
When you switch to the invoice view, the table includes the following details based on the filter applied. The filter criteria include customer, due date, and aging period.

1. **Invoice Number**: A unique identifier for each invoice.
2. **Due Date**: The date by which the invoice payment is expected.
3. **Customer Name**: The name of the customer responsible for the invoice.
4. **Customer Phone Number**: The contact number of the customer for easy communication.
5. **Days Overdue**: The number of days the payment has been overdue since the due date.
6. **Aging Period**: The time interval categorizing the overdue status (e.g., 1–30 days, 31–60 days, 61-90 days, and >90 days).
7. **Amount Due**: The total outstanding balance on the invoice.
> [!NOTE]
>
> **Note**: You can also customize the columns or fields displayed on the table to suit your needs. To do this, click the “**Columns**” option at the top right of the table and select or deselect the fields you want to show or hide.

In addition to viewing the AR Aging Summary by invoice, you can multi-select invoices and perform the following bulk actions. These options streamline account receivable management, saving time and enhancing efficiency.

* **Send Reminder**: Quickly send payment reminders to customers associated with the selected invoices to prompt timely payments. The reminders by default, include the attached invoices, ensuring customers have all the necessary details for easy reference and seamless payment processing.

* **Mark as Bad Debt**: Designate selected invoices as bad debt if they are deemed uncollectible, ensuring accurate financial reporting.
> [!NOTE]
>
> **Note**: You can also use the icon next to an invoice to "**Send Reminder"** or "**Mark as Bad Debt"** for that specific invoice.

### Customer/Organization view:
When you switch to the customer/organization view, the table displays the following details based on the filter applied.

1. **Customer/Org Name**: The name of the customer or organization associated with the account.
2. **Current**: The amount owed by the customer that has not yet passed the due date.
3. **1-30 Days**: The amount of accounts receivable overdue by 1 to 30 days.
4. **31-60 Days**: The amount overdue by 31 to 60 days.
5. **61-90 Days**: The amount overdue by 61 to 90 days.
6. **> 90 Days**: The amount overdue for more than 90 days.
7. **Amount Due**: This is the total amount owed by the customer/organization, including amounts from all aging periods.
In addition to viewing this information, you can send an aging report summarizing overdue amounts and their corresponding aging periods. Use the "" icon next to an individual customer or organization to send the report. Alternatively, select multiple customers or organizations using the checkboxes and choose "**Send Aging Report**" to send the reports in bulk.

## More actions
Along with viewing the A/R Aging Summary, you have access to additional features that provide more detailed insights and make managing accounts receivable more convenient. Below are the available actions:
### View specific aging period insights on the table
To drill down into specific time periods, click on any of the Key Performance Indicators (KPIs) — such as **Current, 1-30 days, 31-60 days, 61-90 days, or >90 days**. The table will then display detailed insights for the selected metric, helping you analyze overdue payments within a defined time range.

### Export
You can export the data currently displayed in the table to various formats for further analysis or sharing. The available formats are **PDF, Excel (XLSX), or Print**. This functionality is useful for generating reports or sharing data with other teams for follow-up actions. To do this, click "**Export**" at the top right of the screen and choose the format you prefer to export the data.

> [!NOTE]
>
> **Note**: Statement templates, also known as AR aging templates, are not available as a self-serve option. An AR aging template is a formatted document that summarizes a customer's outstanding invoice balances, grouped by how long each balance has been overdue. If your business needs a statement or AR aging template, contact [Zuper Support](mailto:support@zuper.co) to request a custom build.
# Creating a new invoice
Source: https://docs.zuper.co/Accounting/Invoices/Create_new_invoice
An invoice is a financial document that a field service business issues to its clients to request payment for services provided. It details the work completed, parts used, labor costs, and any applicable taxes or discounts. Invoices help track revenue, manage payments, and maintain clear financial records between your business and customers.
## To create an Invoice
**Navigation**: *Accounting ->Invoices -> + New Invoice*
1. Select the “**Accounting**” module from the left navigation menu and choose “**Invoices**.”

The Invoices page displays existing invoices and details such as invoice number, invoice date, due date, and status.
2. Select **+ New Invoice** in the top-right corner.

3. Select "**Customer**," "**Organization**," or "**Property**" to associate with the invoice.
4. To link the invoice to a job, property, quote, or project, select **+ Add** in the associations section. Select the required module and record, then select **Proceed**.
If the selected job has a linked quote, the **Set Up Invoice Line items** dialog appears. Choose how to handle the quote's line items before proceeding. For details, see [Choose how quote line items carry over](#choose-how-quote-line-items-carry-over).
> [accordion] Choose how quote line items carry over
>
> When a job has a linked quote, the **Set Up Invoice Line items** dialog lets you choose how the quote's line items are handled. The dialog also appears when you create an invoice from the job details page by selecting **+** and then **Invoice**. **Do not associate the quote** is selected by default.
>
> 
>
> * **Replace Job’s line items with the Quote’s line items:** Adds *only* the quote’s line items to the invoice and adds the quote to **Association(s).**
> * **Merge Quote’s line items:** Combines both the job’s and the quote’s line items together on the invoice and adds the quote to **Association(s)**.
> * **Only associate the quote:** Keeps *only* the job's line items on the invoice while still linking the quote to **Association(s)**. The quote's line items are not added.
> * **Do not associate the quote:** Keeps *only* the job’s line items on the invoice and does *not* link the quote to **Association(s)**.
>
> Select an option and click **Proceed**, or select **Cancel** to close the dialog without taking any action. You can still add, edit, or remove line items afterward.
>
> > [!NOTE]
> >
> > **Note:** To remove the quote later, select the **x** on the quote in **Association(s)**. If the invoice has line items from that quote, the **Remove Line Items** dialog opens. Select **Remove** to remove the quote and its line items.
5. The billing and service contact details are automatically populated based on the selected customer or organization.

6. Fill in the mandatory fields in the **Invoice Details** section:
1. **Invoice Date**
2. **Payment Term**
3. **Due Date**
4. **Invoice Template**
7. Click "**+ Add**" in the **Parts & Services** section and select an option to add parts, products, or services to the invoice, such as *Line Item*, *Bundle*, [*Section*](https://docs.zuper.co/Accounting/Sections), *Item Group*, or *Custom Line Item*.
> [!NOTE]
>
> **Note:** When you add a non-billable item directly to an invoice, the cost of that item will be included in the total. This ensures that non-billable items are tracked when manually added to the invoice. However, if you include a non-billable item in a transaction (such as a job or contract) and later convert that document into an invoice, the non-billable item will not appear on the invoice. This is because non-billable items are excluded from the billable total.
> [accordion] Updating markup for Parts, Products, and Services
>
> After adding parts, products, and services, you can edit or update the Markup value and its discount by following these steps:
>
> * Locate the line item in the list of added parts, products, or services.
>
> * Click the icon next to the item you want to update.
>
> 
>
> * Choose the **Edit** option. An **Edit Line Item** pop-up will open.
>
> * Adjust the markup type to **Flat (+)**,**Percentage (%)**, or **Multiplier (x)** based on your requirement and enter the desired value for the selected markup condition.
>
> 
>
> * Click **Update Line Item** to apply the changes.
8. If **Track Serial Number** is enabled and **Mandate Serial No** is turned on in Settings, you must enter a serial number before proceeding.
9. After adding parts and services to the invoice, transactional discounts and global taxes will be applied.
> [!NOTE]
>
> **Note**:
>
> * If a line item includes a custom tax, transactional discounts, and global taxes cannot be applied.
> * Transactional-level discounts apply only when all parts and services in the quote are either fully taxable or fully non-taxable.
10. **Payment Methods:** Select the [payment methods](/Zuper-pay/Settings#configure-the-payment-methods-your-customers-can-see) you want to offer the customer for this invoice. You can turn individual payment methods on or off as needed.
11. Enter the details for any custom fields configured in the settings.
12. Click "**+ Add Attachments**" to upload any invoice-related files.
13. Click "**Save as Draft**" in the top-right corner of the page to temporarily save the invoice. In the confirmation pop-up, click "**Save as Draft**" again to confirm.

The invoice is created successfully.
## Handle zero-amount invoices
A zero-amount invoice, such as one created for a warranty visit or a fully discounted job, does not automatically move to **Paid** status.
On the web app, payment may need to be recorded manually even when the amount due is \$0.
On the mobile app, use **Mark as Paid** to close a zero-amount invoice without recording a payment transaction. **Collect Payment** is not available for zero-amount invoices in Android v4.1.27 and the equivalent iOS version onward.
# Managing your invoices
Source: https://docs.zuper.co/Accounting/Invoices/Managing_invoices
Efficient invoice management is essential for maintaining accurate financial records and ensuring timely payments. Zuper provides a comprehensive platform to create, track, and manage invoices seamlessly. With robust features, businesses can streamline their billing processes, monitor payment statuses, and maintain transparency in financial transactions.
By centralizing invoice management, you can efficiently handle customer billing, track outstanding balances, and ensure smooth cash flow. This guide will help you understand how to access the Invoices listing page, perform key actions, and manage invoice details effectively.
**Navigation**: *Accounting ->Invoices -> Invoices listing page* -> *Invoice Details*
## Accessing the Invoices listing page
* Select the “**Accounting**” module from the left navigation menu and choose “**Invoices**.” You will land on the invoices listing page.
* On the **Invoices Listing** page, you can view an overview of existing invoices, including **Invoice No., Invoice Date, Due Date,** and more, based on the period selected at the top right corner of the page.

### Exploring the listing page
The invoices listing page is designed to help you stay organized and quickly access the information you need.
**Summary Cards:** On the top of the listing page, you’ll see summary cards displaying high-level information about your invoices. Each card highlights details such as:
* Total number of invoices
* Sent, paid invoices, and their total value
* Overdue, Partially Paid, and Bad Debt.

Use the "**Hide or Show KPIs**" option.
These cards provide a quick overview of your progress and help you identify areas that may need attention.
## Invoice Listing Views
Customize the Invoices listing by adding/removing or reordering columns, then Update View to overwrite or save it as a new view. Control visibility and sharing.
**Update View**
* Click Update View to modify the current view after changes.
**Save as a new view**
* Use the dropdown beside Update View → Save as new view.
**Create View dialog**
* Enter the View Name (mandatory), choose Share with (User/Team) and add users, toggle Visibility to all users, and click Create.
**Reset View**
* Click Reset View to restore the current view to the default.
**Permissions**
* **Edit**: Add/remove/reorder columns; save as new or overwrite existing views.
* **View-only**: Apply views but can’t edit; can Save as new view to copy without altering the original.
* **Manage view**: Rename, adjust Visibility (Only Me/User/Team or global toggle), Duplicate, or Delete (creator only; reverts to default/another saved view).
> [!NOTE]
>
> Not all columns in the invoice listing support sorting. Columns such as **Organization** can be added to your view, but do not support click-to-sort. To narrow invoices by organization, use the **Filter** option and select **Organization** as your filter criterion. You can pin this filter for quick access across sessions. For more details, see [Pinned filters](#pinned-filters).
## Pinned filters
Zuper's Invoices module lets you use pinned filters to streamline your filter experience. Pinned filters keep your most-used criteria readily accessible for quick application.
Pin up to 3 filters in any module.
**Navigation**: *Accounting ->Invoices -> Filters -> Pinned Filters*
1. Select the “**Accounting**” module from the left navigation menu and choose “**Invoices**.”

2. **Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

3. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters.

Not all columns in the Invoice listing support sorting. Columns such as **Organization** can be added to your view, but do not currently support click-to-sort. To group or narrow invoices by organization, use the **Filter** option and filter by Organization. You can pin this filter for quick reuse across sessions
**Open invoice details**
* After filtering, click an Invoice Number or Invoice Title to view and manage details.
**Note**
* Item/service changes within an invoice apply only to that specific invoice and will not be added to the master list.

## Managing invoice details
Once an invoice is created or accessed from the listing page, the **Invoice Details Page** becomes your central hub for managing its lifecycle. The page follows a two-column layout—**the left panel** displays primary details, while **the right panel** provides contextual insights and quick actions for efficient invoice management.

### **Left Panel**
The left panel is the primary section where details are displayed. It includes the following elements
* **Customer information**: You can view the billing details of the customer, including address and contact person's details.
* **Associated Records:** View the **Job and Quote** linked to the invoice.
* **Invoice Status:** Check and update the invoice status as needed.
* **Addresses:** Access the **Billing Address** and **Customer Address**.
* **Invoice Details:** View key invoice information such as **Total Invoice Amount, Invoice No., Invoice Date,** and **Due Date**.
* **View Parts Consumed:** Review the parts used for job completion, along with any applicable taxes, discounts, and payment terms.
### Right Panel
The **Right Panel** provides contextual information and quick actions related to the invoices. It is divided into collapsible sections for better organization:
**Organization and Contact**
* **Organization**: Displays the company name and location associated with the invoice.
* **Contact**: Displays the main contact person’s details, including their address, contact information, and credits & receivables.
**Payment History**
The **Payment History** section provides a detailed record of all payments associated with an invoice. It includes the following details:
* **Payer information** — The name of the person or organization that made the payment.
* **Date and time** — The exact date and time when the payment was recorded.
* **Payment method** — The mode of payment used, for example, credit card, bank transfer, or cash.
* **Payment status** — The current status of the payment: **Success**, **Pending**, **Failed**, or **Voided**.
From the **Payment History** section, you can void a manually recorded payment using the context menu (three-dot icon) next to the payment. Voiding cancels the payment and restores the invoice balance. For full steps, see [Recording payments](https://docs.zuper.co/Accounting/Invoices/Recording_payments).
> [!NOTE]
>
> Note: The invoice status is not updated immediately when a refund is initiated. The Partially Paid status will appear on the invoice only after the refund has been successfully transmitted to the customer's bank account in real time.

* **Payment status** — The current status of the payment:
* **Success** — Payment was collected and confirmed.
* **Pending** — Payment is awaiting processing or confirmation.
* **Failed** — Payment attempt was made but unsuccessful.
* **Voided** — A manually recorded payment that has been cancelled.
* **Cancelled** — A payment intent was created when the customer opened the payment link, but no payment was initiated before leaving the page. No transaction details are available from Stripe for these entries. This is expected behavior and does not indicate a billing error.
> [!NOTE]
>
> Cancelled payment entries appear when a customer opens a quote or invoice payment link but exits without completing payment. These records are retained intentionally for transaction tracking and audit purposes and cannot be deleted. To monitor payment activity, use the **Transaction Status** filter on the Invoices Listing page to view only successful or pending transactions.
**Associated Records**
You can view or associate various modules with the invoice. These include Property, Project, Job, and more. To associate a module, use the “**+**” icon next to the desired module.
## More Actions
Managing invoices doesn’t stop at viewing details. You can take various actions to keep things moving. Things you can do are:

> [accordion] New Job Creation
>
> To create a new job directly from the invoice to address additional service requests or follow-ups, use the "**New**" button at the top right of the details page.
>
> > [!NOTE]
> >
> > Note: If a job is already associated with the invoice, the "New" button will not be visible. Instead, you can view the associated job under the Job section.
>
> For step-by-step instructions on how to create a new job, see the [Creating a new job](https://docs.zuper.co/Work_Order_Management/Jobs/creating_a_new_job) article.
> [accordion] Print Invoice
>
> Use the "**Print**" button at the top right of the page to generate a physical copy of the invoice for record-keeping or customer reference.
> [accordion] Download Invoice
>
> To download or share the invoice as a PDF document, use the "**PDF**" button.
> [accordion] Email Invoice
>
> To email the invoice directly to the customer, use the "**Send**" button at the top right of the details page.
>
> > [!NOTE]
> >
> > **Email attachment size limit** When sending a quote by email, attachments are included directly in the email up to a combined size of **20MB**. If the total attachment size exceeds 20MB, Zuper automatically converts attachments to inline download links in the email body rather than sending them as attachments. Recipients can still access the files by clicking the links, but the files will not appear as standard email attachments.
> >
> > **Workaround:** If you need attachments to be delivered as standard email attachments, ensure the total size of all attached files is under 20MB before sending. Consider compressing large files or splitting them across multiple sends if needed.
> [accordion] Edit Invoice Details
>
> To modify invoice details if any updates are required, use the "**Edit**" button at the top right of the page.
> [accordion] Record Payments
>
> To log received payments and update the invoice status, click the "**More Actions**" button at the top right corner of the page and select "**Record Payment**." For more details, see the [Recording Payments article](https://docs.zuper.co/Accounting/Invoices/Recording_payments).
> [accordion] Mark as Bad Debt
>
> If an invoice remains unpaid after being sent to the customer, you can mark it as bad debt for accounting purposes. To do this, click the "**More Actions**" button at the top right corner of the page and select the "**Mark as Bad Debt**" option.
> [accordion] Share Invoice/Payment Link
>
> To generate and share a payment or invoice link to the customer for easy online transactions, follow these steps:
>
> * Click the "**More Actions**" button at the top right corner of the page and select the "**Share Link"** option.
> * A dialog will appear with the **Invoice Link** and **Payment Link** (available after the invoice has been sent to the customer). You can copy and share the link or send it using third-party apps.
> [accordion] Archive/Cancel/Delete
>
> You can also archive an invoice to retain its record while moving it to archives. If the invoice is no longer valid, you can cancel it. If removal is necessary, you can permanently delete the invoice using the desired options under the "**More Actions**" button.
>
> > [!NOTE]
> >
> > A **deleted** invoice can be restored from **Settings → Data Administration → [Recovery](/Settings/Data_Adminstration/Recovery)** within 90 days. A **cancelled** invoice cannot be restored. If you want to keep the option to recover an invoice, delete it rather than cancelling it.
> [accordion]
# Overview
Source: https://docs.zuper.co/Accounting/Invoices/Overview
In Zuper, the Invoices module simplifies the billing process by enabling businesses to create, manage, and track invoices efficiently. It ensures accurate financial records, timely payments, and seamless cash flow management while maintaining transparency with customers.
Invoices serve as formal requests for payment, detailing the services provided, associated costs, and applicable taxes or discounts. With Zuper, businesses can get real-time visibility into payment statuses, outstanding balances, and historical transactions, helping businesses stay organized and proactive in their financial operations. Whether it's sending invoices, recording payments, or tracking overdue amounts, Zuper’s invoicing tools empower businesses to streamline their financial workflows with ease.
**Main Benefits are:**
**Real-Time Invoice Tracking:** Monitor invoice statuses from creation to payment completion, ensuring better financial control and timely follow-ups.
**Comprehensive Invoice Activity Logs:** Maintain a detailed history of each invoice, including updates, modifications, and payments, for complete financial transparency and easy reference.
**Flexible Payment Management:** Record **partial, full, or multiple payments** for an invoice while maintaining a **clear transaction history**, ensuring accurate financial reporting.
**Credits & Receivables Tracking:** Easily identify **credits and outstanding receivables** for each customer, ensuring accurate account reconciliation and financial clarity.
**Automated Payment Reminders:** Set up **auto-reminders** for upcoming or overdue payments, reducing delays and improving collection rates effortlessly.
**Customizable Invoice Templates:** Personalize invoices with your **company logo, branding, and payment terms** to maintain a professional and consistent appearance.
**Multiple Payment Methods:** Accept payments via **credit cards, bank transfers, and digital wallets**, providing customers with convenient and flexible options.
**Aging Reports for Better Insights:** Get a **detailed breakdown of outstanding invoices** by aging periods (e.g., 30, 60, 90+ days) to track overdue payments and take necessary actions.
**User Roles & Permissions Control:** Define **access permissions** and approval workflows to ensure secure and efficient invoice management based on team roles and responsibilities.
With **Zuper’s Invoicing Module**, businesses can **streamline billing operations, enhance financial accuracy, and improve cash flow management—boosting efficiency and customer satisfaction**
# Recording payments
Source: https://docs.zuper.co/Accounting/Invoices/Recording_payments
Managing payments efficiently is crucial for maintaining accurate financial records. In this article, we will guide you through the process of recording payments for invoices sent to customers.
In Zuper, you can manually log payments received for an invoice after it has been sent to the customer. This ensures that the invoice status is updated and helps maintain transparency in financial transactions.
**Navigation**: *Accounting -> Invoices -> Invoice Listing Page -> Invoice Details -> More Actions-> Record Payment*
## **To Record a Payment**
* Navigate to the **Invoice Details** page of the invoice where you want to manually log the payment received.
* Click the "**More Actions"** button at the top right corner.
* Select "**Record Payment"** from the dropdown menu.

* A dialog box will appear where you need to enter the payment details.

1. **Choose Payment Mode** (*Mandatory*): Select the method used for the transaction. This includes Card, Bank Transfer, Check, Zuper Pay, Offline Cash, and Other third-party payment apps.
2. **Enter Amount Paid (In USD)** (*Mandatory*): Specify the exact amount received from the customer.
3. **Payment Reference Number**: Enter a reference number associated with the payment, such as a transaction ID or check number.
4. **Payment Date** (*Mandatory*): Choose the date of the payment using the date picker.
5. **Remarks**: Add any additional notes related to the payment, if necessary.
6. **Send Receipt / Thank You Note**: Check this box if you want to send a confirmation receipt or thank you message to the customer.
7. After entering the necessary details, click the "**Mark as Paid"** button to successfully record the payment. Once the payment is recorded, the invoice status will update accordingly, reflecting the recorded transaction and ensuring the customer’s commitment is accurately tracked.
> [!NOTE]
>
> Note: The invoice status is not updated immediately when a refund is initiated. The Partially Paid status will appear on the invoice only after the refund has been successfully transmitted to the customer's bank account in real time.

## Voiding a payment
When a payment has been recorded by mistake or entered with incorrect details, you can void it. Voiding cancels the payment record on that invoice and restores the outstanding balance. The invoice status updates automatically to reflect the change.
> **Note:** Voiding applies only to payments recorded manually in Zuper — for example, cash, check, or bank transfer. For payments processed through Zuper Pay, you need to issue a refund instead. See [Issuing refunds](https://docs.zuper.co/Zuper-pay/Refunds) for steps.
**Navigation:** *Accounting → Invoices → Invoice Details → Payment History*
1. Select the **Accounting** module from the left navigation menu and choose **Invoices**.
2. Select the invoice that contains the payment you want to void.
3. On the **Invoice Details** page, go to the **Payment History** section in the right panel.
4. Locate the payment you want to void.
5. Select the context menu (three-dot icon) next to the payment.
6. Select **Void**.
7. A confirmation dialog appears. Select **Confirm** to void the payment.
The payment status updates to **Voided**. The invoice balance is restored to reflect the outstanding amount.
## Deleting a payment mode
You can delete a payment mode from Zuper when it is no longer in use. Deleting a payment mode removes it from the list of available options across all invoices and quotes. This action cannot be undone.
> **Note:** Deleting a payment mode from Settings is different from voiding a payment on an invoice. Voiding cancels a specific payment transaction. Deleting a payment mode removes the payment method itself from your Zuper configuration.
**Navigation:** *Settings → Modules → Quotes & Invoices → Payment Modes & Terms*
1. Select **Settings** from the left navigation menu.
2. Under **Modules**, select **Quotes & Invoices**.
3. Select **Payment Modes & Terms**.
4. Under **Payment Mode**, locate the payment mode you want to delete.
5. Select the context menu (three-dot icon) next to the payment mode.
6. Select **Delete**.
7. A confirmation dialog appears. Select **Delete** to permanently remove the payment mode.
The payment mode is removed and will no longer appear as an option when recording payments.
# Collecting a Partial Payment
Source: https://docs.zuper.co/Accounting/Invoices/collecting-partial-payments
Learn how to request a partial payment from a customer, resend or cancel a payment link
A partial payment splits the total invoice into staged instalments, letting you collect a specific amount from a customer at each stage instead of the full balance at once. This helps your business stabilize cash flow and limits out-of-pocket costs so you can start work on time. In Zuper, instead of sending a payment request for the total invoice amount, you can request a specific amount from your customer and send them a secure payment link.
## Before you begin
* Your organization must have **Zuper Pay** enabled. Please contact Zuper Support for details.
* The **Request Payment** button only appears on invoices in **Sent** status. It is not available on draft or unsent invoices.
## Request a partial payment
1. Select the **Accounting** module from the left navigation menu and choose **Invoices**.
2. Open the invoice from the Invoices listing page.
3. Click **Request Payment**. Click **Request Payment**.

\
The **Request Payment** dialog opens. Review the following fields:
4. **From** - Displays your sender email.
5. **To** - Enter the customer's email address. This field is required.
6. **Cc / Bcc** - Optionally add additional recipients.
7. **Total Amount Due** - Shows the full outstanding balance on the invoice. This is read-only.
8. In the **Amount Requested** field, enter the partial amount you want to collect. The **Remaining Due** value updates automatically to show what will still be owed after this payment.
9. In the **Note (Optional)** field, enter a short message to your customer explaining what this payment is for.
10. Click **Send**. \
Zuper sends the customer a secure payment link for the requested amount.

## Resend or cancel a payment request
After you send a payment request, you can manage it directly from the invoice.
1. Click the context menu (three-dot icon) next to the **Requested Amount**.
2. Choose one of the following actions:
* **Resend Payment Link** - Sends the same payment link to the customer again. Use this if the customer did not receive the original email.
* **Cancel Payment Request** - Cancels the active payment link immediately. The customer can no longer use the link to pay. The Requested Amount row is removed from the invoice.

## Frequently asked questions
> [accordion] What happens if I cancel a payment request?
>
> The link is deactivated immediately. Your customer can no longer use it to pay. The Requested Amount row is removed from the invoice. You can send a new payment request at any time.
> [accordion] Can I have more than one active payment link on an invoice at the same time?
>
> No. Only one payment link can be active on an invoice at a time. Cancel the existing link before sending a new one.
> [accordion] What happens if the customer pays through the original invoice instead of the partial payment link?
>
> If the customer clicks **Pay Now** on the original invoice and completes the payment, the full outstanding invoice amount is charged. Any active partial payment links are automatically cancelled once the payment is successfully processed.
> [accordion] What happens if I send a new payment request after cancelling the previous one?
>
> A new payment request can be sent for any amount at any time, as long as the invoice is in **Sent** status and no other active payment link exists.
> [accordion] Can I make a partial payment for a quote deposit?
>
> No. Partial payments are not supported for quote deposits. The deposit amount must be paid in full.
# Edit Paid & Partially Paid Invoices
Source: https://docs.zuper.co/Accounting/Invoices/edit-paid-and-partially-paid-invoices
## Overview
Once you record a payment against an invoice, Zuper locks it to protect your financial records. That protection creates one specific situation to plan for. For example, if a technician collects 80 instead of 80.50 due, the invoice remains in **Partially Paid** status. You then need to resolve that small mismatch. Until now, resolving it meant refunding the payment, canceling the invoice, and recreating it from scratch adding extra steps to your accounting records every time.
The edit flow closes that gap. Admins can now edit a paid or partially paid invoice directly, without a refund or cancellation standing in the way. Think of it like adjusting a receipt after checkout: the payment already collected stays exactly where it is, while Zuper calculates what the customer still owes or what they overpaid once you save your changes.
That recalculation works the same way across all invoice types, including standalone invoices and those generated from jobs, quotes, contracts, and projects.
**Navigation:** *Accounting → Invoices → Invoice Details → Edit invoice*
***
## Before you begin
This capability is admin-gated. The following conditions must be met before you can use it.
* **Setting:** The **Enable Edit Invoices** setting must be turned on at the organization level (**Allow editing paid and partially paid invoices)**. Only then does the edit flow become available to anyone, regardless of role.
* **Role:** You need the **Admin** role, or a custom role with the **Edit Paid Invoices** permission enabled. This permission controls the **Edit invoice** button on the **Invoice Details** page and on the **Invoices** listing page. To enable this permission, go to **Settings**, select **Users & Teams**, select the custom role, then enable **Edit Paid Invoices** under **Payments**.
* **Invoice status:** The invoice must already be in **Paid** or **Partially Paid** status.
***
## Edit a paid or partially paid invoice
With the right permissions in place, here is how to reopen a locked invoice for editing.
1. Select the **Accounting** module from the left navigation menu, then select **Invoices**.
2. Select the invoice you want to edit.

3. The **Invoice Details** page opens. Select **Edit invoice**. The invoice enters edit mode.
> [!NOTE]
>
> Zuper does not save any changes until you select **Save**.
***
## Make your changes
Once you are in edit mode, the invoice behaves much like a draft again.
1. Add, remove, or update line items as needed.
2. Update tax and discount fields if the revised amount requires it.
3. Review the running total at the top of the page as you go. It updates with every change, so you always know where the invoice stands before you commit.
4. Select **Save & Send** to apply your changes.
> [!NOTE]
>
> Payments already recorded on the invoice stay read-only during edit mode. The edit flow is meant to correct the invoice, not the payment. To change a recorded payment amount, void or refund the payment instead. See [Recording Payments](https://docs.zuper.co/Accounting/Invoices/Recording_payments#recording-payments) or [Issuing Refunds](https://docs.zuper.co/Zuper-pay/Refunds#issuing-refunds).
> [!NOTE]
>
> Edit mode does not offer a **Save as Draft** option, and you cannot set the invoice status to **Sent** while editing. Because the invoice already has a payment recorded against it, Zuper keeps it out of the draft and unsent states.
***
## What happens after you save
Zuper compares the revised invoice total to the amount already paid, then walks you through one of three outcomes based on how the two numbers compare.
**New total matches the amount paid**
Zuper suggests marking the invoice as **Paid**. Select **Confirm** to apply this status.
**New total is higher than the amount paid**
The customer now owes more than they already paid. A previously **Partially Paid** invoice stays in that status, with Zuper updating the outstanding balance automatically. A previously **Paid** invoice moves to **Partially Paid**, since the payment on file no longer covers the full amount. Select **Request Payment** to collect the new **Balance Due** from the customer.



**New total is lower than the amount paid**
The customer has effectively overpaid. Zuper issues a credit note for the extra amount. The credit note stays attached to the customer's profile and can be reused. The same amount also appears in the **Credits** section of the customer's profile, where you can apply it to another open invoice or issue a refund.

> [!NOTE]
>
> Zuper never changes invoice status on its own. Whatever the outcome, you confirm the change before it takes effect.
Saving your changes also updates the invoice amount in QuickBooks Online (QBO), if your organization uses the two-way sync. Your accounting records stay aligned with what you just edited.
***
## Credits on the customer account
When a revised invoice total is lower than what the customer already paid, Zuper gives that overpayment a home in two places. On the invoice, you see the credit note that was issued. On the customer's profile, the same amount appears in the **Credits** section, ready for you to apply or refund. Zuper holds this amount as a credit against the customer — not as revenue — until you decide where it should go.
***
## Related articles
* [Recording Payments](https://docs.zuper.co/Accounting/Invoices/Recording_payments#recording-payments)
* [Issuing Refunds](https://docs.zuper.co/Zuper-pay/Refunds#issuing-refunds)
# Managing your proposals and quotes
Source: https://docs.zuper.co/Accounting/Managing_Quotes
Efficiently managing quotes and proposals is crucial for seamless customer engagement and effective project planning. Zuper provides a unified platform to create, customize, and track quotes and proposals effortlessly. These tools help businesses outline their service offerings, streamline the approval process, and transform opportunities into actionable tasks.
With a centralized approach, you can efficiently handle your quotes and proposals while maintaining visibility over their status and progress. This guide will help you understand how to access the Proposals and Quotes listing page, perform key actions, and manage proposal details effectively.
## Accessing the Quotes/Proposal listing page
**Navigation**: *Accounting -> Quotes --> Quotes listing page*
1. Select the “**Accounting**” module from the left navigation menu and choose “**Quotes**.”

2. You will land on the **Listing** page. The listing page provides a comprehensive view of all your quotes and proposals, including essential details such as their creation date, customer information, and status.

## Exploring Listing Page
The quotes and proposals listing page is designed to help you stay organized and quickly access the information you need. It includes the following elements.
**Summary Cards:** On the top of the listing page, you’ll see summary cards displaying high-level information about your proposals and quotes. Each card highlights details such as:
* Total number of quotes
* Drafts, sent quotes, and their total value
* Approved, declined, and canceled proposals. These cards provide a quick overview of your progress and help you identify areas that may need attention.

## Listing Views
Customize the Quotes listing by adding/removing or reordering columns, then Update View to overwrite or save it as a new view.
* **Update View**: Click Update View to modify the current view after changes.
* **Save as new view**: Use the dropdown beside Update View → Save as new view.
* **Create View dialog**: Enter the View Name (mandatory); choose Share with (User/Team) and add users; toggle Visibility to all users; click Create.
* **Reset View**: Click Reset View to restore the current view to the default.
* **Permissions**:
* **Edit**: Add/remove/reorder columns; save as new or overwrite existing views.
* **View-only**: Apply views but can’t edit; can Save as new view to copy without altering the original.
* **Manage view**: Rename, adjust Visibility (Only Me/User/Team or global toggle), Duplicate, or Delete (creator only; reverts to default/another saved view).
* **Open quote details**: After filtering, click a Quote Number or Quote Title to view and manage details.
Note: Item/service changes within a quote apply only to that specific quote and will not be added to the master list.

## Pinned filters
Zuper's Quotes module lets you use pinned filters to streamline your filter experience. Pinned filters keep your most-used criteria readily accessible for quick application.
Pin up to 3 filters in any module.
**Navigation**: *Accounting -> Quotes --> Filters --> Pinned Filters*
1. Select the “**Quotes**” module from the left navigation menu.

2. **Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

3. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters.

**Creating a new proposal or quote:** You can use the "**+ New"** button on the **Listing** page to create either a proposal or a quote. Select Proposal or Quote. From there, you can enter all the details you need, like customer or organization information, parts, services, and more. Once everything is filled in, you’re all set to save and share the proposal/quote with your client for their approval. If you need a more detailed guide on creating a quote, see Create a new proposal and a new Quote for a step-by-step walkthrough.
## Managing Proposal details
Once a proposal is created, the Proposal Details page becomes your go-to space for managing its lifecycle. The page is laid out in two columns, with the left side highlighting primary details and the right side offering contextual insights and quick actions.

### Left Panel
The left panel is the primary section where details are displayed. It includes the following elements.
* **Status update:** You can view the current status of the proposal (e.g., Draft, Sent, Accepted) and manually update it as needed.
* **Customer information**: You can review the billing details of the customer, including their address and the contact person’s information.
* **Proposal Options**: You can view the options available to the customer, allowing them to choose between different configurations.
* **Templates and Notes**: You can see the template used to create the proposal and review any additional notes.
### Right panel
The **Right Panel** provides you with contextual information and quick actions, organized into collapsible sections for easy navigation:
* **Quote Status:** You can track the proposal’s status changes through timestamps and see who performed each action.
* **Organization and Contact:** You can view the company information associated with the proposal.
* **Associated Records:** You can view or associate various modules (e.g., Property, Project, and so on) with the proposal. Use the **“**+**”** icon to add a module. You can quickly navigate to or manage associated records like organizations, properties, or projects using the provided links or icons.
### More actions
Managing proposals doesn’t stop at viewing details—you can take various actions to keep things moving. Things you can do are:

> [accordion] Quick actions
>
> * **Send:** You can share the proposal to the respective customer for your acceptance.
> * **Edit Proposal**: You can modify the proposal, including package details or other information, by clicking **Edit**.
> * **Save as Draft**: You can save changes to the proposal without sending it immediately by clicking **Save as Draft**.
> * **Mark as Accepted**: Once the customer agrees to the proposal, click **Mark as Accepted** to finalize the proposal. This marks the proposal as accepted and ready for the next steps. After marking the proposal as accepted, the proposal is automatically converted into a **Quote**, which means the proposal has been confirmed and the process is moving forward.
> * **Mark as declined**: You can record the customer’s decision to decline the proposal by clicking **Mark as Declined**.
> * **Archive/Delete**: You can archive or delete the proposal.
## Managing Quote details:
The **Quote Details Page** provides a comprehensive view of all information related to a specific quote, including customer details, product specifications, and associated records. The page uses a two-column layout: the **Left Panel** and the **Right Panel**, designed for easy navigation and quick actions.

### Left panel
The **Left panel** serves as the primary area for viewing the detailed breakdown of the quote. It includes the following sections:
* **Status Update**: You can see the current status of the quote (e.g., Draft, Sent, Accepted) and manually update it.
* **Customer/Organisation Details:** You can view the **Billing Address** for the customer and contact details of the customer or organization.
* **Product table:** You can review a detailed breakdown of all items included in the quote, along with their prices.
### Right panel
The **Right Panel** displays contextual information and quick actions related to the quote. It includes the following sections:
* **Quote Status:** You can view a timeline of the quote’s lifecycle, including timestamps and the user who performed each action.
* **Organization Details:** You can see the company associated with the quote, along with the number of contacts and their location.
* **Associated Records:** You can view or associate various modules (e.g., Property, Project, etc.) with the quote. Use the **“+”** icon to add a module. You can quickly navigate to or manage associated records using the provided links or icons.
### More Actions
You can perform the following actions to manage quotes effectively:

> [accordion] Quick actions
>
> * **New**: You can create Job, Contract, and Project via Quote.
> * **Print**: You can generate a physical copy of the quote for record-keeping or customer reference.
> * **Send**: You can send to customers for their review and acceptance before the job begins.
> * **Share Link**: You can generate and share a link to the quote.
> * **Clone**: You can duplicate the quote to create similar records.
> * **Archive**: You can archive the quote for record-keeping purposes.
> * **Cancel/Delete**: You can cancel or delete the quote as necessary.
### Pending option selection
If a line item in your proposal has options configured, but the option value is empty for any line item, Zuper marks the converted quote as **Pending option selection**. You can update or fill in the option value for each line item directly from the quote details page.
While a quote is in **Pending option selection** state:
* It cannot be converted to an invoice.
* Creation of a material request and purchase order is restricted.

> [!NOTE]
>
> If a customer opens a payment link on a quote but exits without completing payment, two separate records are created: a **"quote viewed"** entry in the Activity log and a Canceled entry in the Payments report. This is expected behavior. The Cancelled payment entry does not indicate an error — it reflects that a Stripe payment intent was created when the payment page loaded, but no transaction was completed.
> [!NOTE]
>
> **Editing accepted quotes:** An accepted quote remains editable only until it is converted into an invoice. Once a quote has been converted, editing is disabled, and the Edit option no longer appears on the Quote Details page. This is expected behavior; it preserves the integrity of the quote record from which the invoice was generated. If you need to make changes after conversion, update the invoice directly or clone the quote to create a new editable copy.
# Monitor pending quotes and set up sales alerts
When quotes are sent to customers but remain unanswered, your sales team needs a way to catch them before they go cold. Zuper doesn't have a single built-in "pending quote alert" button, but you can set up monitoring using a combination of approaches depending on how much automation you need.
> [accordion] Option 1 — Quotes listing pinned filter (manual, instant)
>
> The quickest approach. Filter the Quotes listing to show only sent quotes created before a specific date, then pin the filter for daily use.
>
> **1. Open the Quotes listing**
>
> Go to **Accounting → Quotes**.
>
> **2. Apply filters**
>
> Click **Filters** and set:
>
> * **Status** = Sent
> * **Created Date** = more than 3 days ago (or your preferred threshold)
>
> **3. Pin the filter**
>
> Click **Pin Filters** to save it. It will appear in one click on every future session.
>
> > [!NOTE]
> >
> > You can also add a **Created Date** column to your listing view so quote age is visible at a glance without opening each record.
> [accordion] Option 2 — Scheduled Report (automated daily email)
>
> Set up a Quote report that runs automatically and emails the Sales team each morning with a list of quotes that have been in Sent status for more than 3 days.
>
> **1. Open Report Builder**
>
> Go to **Reports** from the left navigation menu and click **+ New Report**.
>
> **2. Select the Quotes module**
>
> Choose **Quotes** as the primary module.
>
> **3. Add fields**
>
> Include: Quote Number, Customer Name, Quote Amount, Created Date, Expiry Date, Assigned To, and Quote Status.
>
> **4. Apply filters**
>
> Filter by:
>
> * **Status** = Sent
> * **Created Date** = older than 3 days (relative date filter)
>
> **5. Schedule the report**
>
> Click **Schedule**, set frequency to **Daily**, choose your preferred send time, and add the Sales team members as recipients.
>
> > [!NOTE]
> >
> > The Report Builder is available under **Reports** in the left navigation. Legacy reports (pre-built) are available under **Legacy Reports** in the same section.
> [accordion] Option 3 — Workflow Builder (automated internal notification)
>
> For teams that want a proactive push notification rather than a report email, the Workflow Builder can send an internal alert to Sales each day listing quotes that have gone unanswered.
>
> The general setup:
>
> 1. **Trigger:** Scheduled Trigger — daily at your preferred time (e.g., 9 AM)
> 2. **Get Records node:** Fetch Quotes where Status = Sent and Created Date is older than 3 days
> 3. **Condition node:** Check if the result list is non-empty
> 4. **Notification node:** Send an Internal Notification or email to the Sales team with the list of pending quotes
>
> Refer to the [Workflow Builder Overview](/Workflow_builder/Workflow_overview), [Triggers](/Workflow_builder/Triggers), and [Nodes](/Workflow_builder/workflow_builder_nodes) articles for full configuration steps.
> [accordion] Option 4 — Dashboard expiry KPI (passive monitoring)
>
> The Zuper Dashboard includes a built-in KPI under the Quotes module that surfaces **quotes approaching their expiry date**. If your quotes are configured with expiry dates, this gives the Sales team a daily visual signal without any setup.
>
> Navigate to your **Dashboard** and look for the Quotes section — the expiring quotes card will highlight records that need attention.
# Overview
Source: https://docs.zuper.co/Accounting/Overview
In Zuper, Quotes and Proposals play a vital role in simplifying the process of presenting cost estimates and service options to customers. Together, they offer a seamless experience for creating, managing, and tracking estimates while maintaining transparency and professionalism. Whether it's drafting a proposal to explore multiple service options or finalizing a quote to confirm costs, these ensure an efficient workflow and smooth transitions across various stages of customer interaction.
With Proposals, you can present customized service plans or multiple pricing options, making them ideal for scenarios that require flexibility or negotiation. Quotes, on the other hand, allow you to provide customers with detailed cost breakdowns for labor, parts, and services, helping them understand the pricing structure clearly.
**Main benefits are:**
* **Clear Cost Presentation**: Whether through a Quote or Proposal, provide detailed and transparent pricing to set the right expectations for your customers.
* **Personalization**: Add your branding, item descriptions, and custom templates for a consistent, professional presentation.
* **Seamless Workflow Integration**: Convert approved Quotes or Proposals into jobs, contracts, or projects effortlessly, eliminating the need for manual data entry.
* **Collaboration and Updates**: Attach files, add comments, and share updates to ensure all stakeholders remain informed throughout the process.
* **Status Visibility**: Instantly view the current status of Quotes and Proposals, helping you prioritize follow-ups and approvals.
For example, if a customer needs an itemized breakdown of services for comparison, you can start with a Proposal offering multiple pricing tiers or service options. Once the customer selects their preferred option, you can convert the approved Proposal into a finalized Quote with clear costs, ready for approval and conversion into a job or project.
Whether you're managing high-value negotiations or handling everyday cost estimates, Zuper ensures that Quotes and Proposals work together to provide a comprehensive and efficient solution for your business needs.
To learn the difference between proposals and quotes, click [here](Accounting/Overview).
# Payments Overview
Source: https://docs.zuper.co/Accounting/Payments
The Payments module in Zuper helps you track & manage payments you received across invoices & quote deposits through the platform
**Navigation**: *Accounting* -> *Payments*
1. Click the “**Accounting**” module from the left navigation menu and select "**Payments.**"

2. Under the"**Payments**" module, let us explore the "**Dashboard**."

3. Use the "**Calendar Picker**" to select a date range. The latest transactions are displayed based on that date range.

4. Use the icon to view the transaction details.

5. The transaction details are displayed.

6. Click the "**Void Transaction**" button.

7. Click the "**Void**" button to void the transaction.

8. The payment is canceled successfully.

* Switch to the "**Payment**s" tab. Then, use the "**Filters and Calendar Picker**" to view the details according to your selected criteria.
* Click the "**Export**" button to download Excel.
* Use the icon to view the transaction details.

> [!NOTE]
>
> Note: The invoice status is not updated immediately when a refund is initiated. The Partially Paid status will appear on the invoice only after the refund has been successfully transmitted to the customer's bank account in real time.

The Payments module in Zuper provides a seamless way to track and manage payments received across invoices and quote deposits, ensuring better financial transparency and control. By centralizing payment processing within the platform, businesses can streamline transactions, reduce manual efforts, and improve cash flow management.
If you are looking for a comprehensive Account Receivables (AR) management, please check out our [AR Management Guide](https://docs.zuper.co/Accounting/Invoices/AR_management)
# Profit Margin Slider
Source: https://docs.zuper.co/Accounting/Profit_Margin
Zuper offers a **Profit Margin Slider** that allows you to adjust the profit margin dynamically across *Quotes*, *Proposals*, and *Service* *Packages*. This feature removes the need for manual recalculations by enabling immediate adjustments to meet specific profit targets.

**Prerequisites:**
To access and use the **Profit Margin Slider**, the following conditions must be met:
* **Job Profitability** must be enabled for your account. To enable it, contact your account administrator or email [**support@zuper.co**](mailto:support@zuper.co).
* By default, *Admins* and *Team Leads* can view and manage the Profit Margin slider. However, if your business requires different visibility, you can configure access for specific roles.\
To do this, navigate to: **Settings** module > **Users & Teams** > **Quotes** > enable the **Manage Profit Slider** toggle. 
* Add at least one **billable line item** (part, product, service, or bundle) to a Quote, Proposal, or Service Package to make the slider visible.
* Define the allowable range for profit margin adjustments under:\
**Settings** module > **Quotes & Invoices** > **Quote and Invoice General Settings** > **Quote** tab > **Define Minimum and Maximum Profit Margin**. 
### To use the Profit Margin Slider
1. Open a **Quote**, **Proposal**, or **Service Package** via one of the following paths:
* Accounting module > Quotes
* Accounting module > Proposals
* Settings module > Quotes & Invoices > Service Packages
2. Click **“+ Add”** to include *parts*, *products*, *services*, or *bundles* from the **Parts** & **Services** section. Once at least one **billable item** is added, the **Profit Margin Slider** automatically appears.
> [!NOTE]
>
> **Note**: Items with a **Cost Price of \$0** and **negative line items** are also included in the profit margin calculation.

3. The slider displays the current overall profit margin percentage, calculated using the formula:
```markdown wrap theme={null}
Profit Margin% = (Total Sell Price-Total Cost Price/Total Sell Price)\* 100
```
> [!TIP]
>
> **Important**: **Fees** are excluded from the actual profit calculation and do not influence the slider’s behavior.
4. Drag the slider to your desired profit margin within the preconfigured minimum and maximum range.
> [!NOTE]
>
> **Note:** If you adjust the slider below the minimum or above the maximum predefined values, it turns red to indicate that the selected profit margin is outside the allowed range.
5. As you adjust the slider, Zuper instantly recalculates and updates:
* **Markup %** for each line item
* **Total Sell Price** across the document 
Zuper applies a change factor to proportionally adjust item prices, ensuring consistent and balanced profit distribution across all line items.
**View Cost and Profit Breakdown**
Let’s expand the **Cost & Profit Breakdown** panel beneath the slider to view a comprehensive summary, which includes:
* **Parts & Services cost**
* **Labor cost**
* **COGS** (combined cost of parts and labor)
* **Quote Total**
* **Profit Amount** = Sell Price – Cost Price

## **Frequently Asked Questions**
> [accordion] How do I give a field technician access to the Profit Margin Slider?
>
> By default, only Admins and Team Leads can view and manage the Profit Margin Slider. To let a field user use it, assign them a custom role with the following permissions enabled:
>
> **Quotes module**
>
> * **Create Quote / Update Quote**
> * **Update Line Item Price**
> * **Manage Profit Slider**
>
> **Product module**
>
> * **Show Selling Price in Transactions**
> * **Edit Selling Price**
>
> 
> [accordion] Can I use the Profit Margin Slider if some items have zero cost?
>
> Yes. Items with a Cost Price of \$0 and even negative line items are included in the profit margin calculation. The slider will still function and adjust pricing accordingly.
> [accordion] Are fees included in the profit margin calculation?
>
> No. Fees are excluded from the profit calculation and do not influence the slider's behavior. Only billable parts, products, services, and bundles are included in the calculation.
> [accordion] What happens if I adjust the profit margin beyond the allowed range?
>
> If you drag the slider below the minimum or above the maximum predefined values, the slider turns red to indicate that the selected profit margin is outside the allowed range. You'll need to adjust it back within the configured limits to proceed. 
> [accordion] Can I view Cost & Profit breakdowns on the Quote Details page?
>
> Yes, you can view cost & profit metrics directly on the Quote details page without opening the quote for editing. The **Cost & Profit breakdowns** display:
>
> * **Profit Margin %** – The overall profit margin percentage for the quote
> * **COGS** – The combined cost of goods sold. You can hover over this field to see a detailed breakdown of **Product/Parts** and **Service/Labor** costs.
> * **Quote Total** – The total quoted amount based on all item costs and configured profit margin.
> * **Profit** – The calculated profit amount (Sell Price – Cost Price)
>
> 
# Create a new proposal
Source: https://docs.zuper.co/Accounting/Proposal
In Zuper, a **Proposal** is a preliminary document that businesses can send to potential clients before providing an official quote or estimate. It helps define the project scope, outline service offerings, and align expectations before finalizing pricing. Zuper streamlines this process by enabling you to:
* Create structured **Service Packages** that bundle products and services.
* Use **Proposal Templates** to standardize and simplify proposal creation.
* Create, modify, and manage **Proposals** before converting them into quotes. This guide provides step-by-step instructions on configuring service packages, creating proposal templates, and generating proposals within the Zuper app. Let's get started!
**Navigation**: *Accounting* -> *Payments*
## **Add-ons:**
Zuper **Add-ons** allows you to offer optional products or services within a proposal. Customers can choose these add-ons during proposal acceptance. This helps you upsell services and increase quote value without modifying the base scope of work.
Add-ons are configured at the **Proposal Template** level and appear directly in proposals once enabled.
Configuring Add-ons:
[**Service Package**](https://docs.zuper.co/Accounting/Proposal#add-ons-in-the-service-package)
[**Standard Template**](https://docs.zuper.co/Accounting/Proposal#add-ons-in-the-proposal-template)
[**CPQ Template**](https://docs.zuper.co/Zuper_for_Roofing/Proposal_Template_with_CPQ#add-ons)
[Presenting Proposal to the Customer](https://docs.zuper.co/Settings/Modules/Quotes-Invoices/Proposal_Layout_builder#add-ons)
> [!NOTE]
>
> Note: The Add-ons are applicable only to those using [Proposal Layouts](https://docs.zuper.co/Settings/Modules/Quotes-Invoices/Proposal_Layout_builder).
## **Multi-Signer**
Once a proposal is created using a proposal layout, any [preconfigured co-signers and company authorization](https://docs.zuper.co/Settings/Modules/Quotes-Invoices/Proposal_Layout_builder#multi-signer-co-signer-%26-counter-signer) are automatically prefilled. The customer associated with the proposal is set as the primary signer by default. You can add or remove additional signers as needed; however, the primary signer cannot be removed.
Signatures are collected sequentially. After the primary signer selects their preference and signs, the proposal moves to **Awaiting Signature** status and becomes non-editable until all required signers have completed signing. If the proposal includes only the primary signer, it will automatically be converted into an **Accepted Quote** as soon as the primary signer signs.
The Signers & Authorization section controls who must review and electronically sign a proposal.
* Primary Signer (Pre-filled and non-editable).
* Co-Signers (Additional signers | up up toto 3 persons).
* Internal Signers (Your team members for company authorization).
**1. Managing Signers (Add / Delete)**
**Add a Signer**
* Go to Signers & Authorization section.
* Click the + button (top-right corner).

**Choose tab:**
**Co-Signer → Enter Full Name + Email.**

* Internal Signer → Select user from dropdown (company team member).

* Click Add Signer.
**Delete a Signer**
* Click the 🗑 trash icon next to any Co-Signer or Internal Signer.

Confirm in the dialog box by clicking Delete.
> [!NOTE]
>
> **Note**: Primary Signer cannot be deleted.

## **Full Signing Workflow (After Sending)**
Here’s what happens step by step once the proposal is ready:
**1. Send the Proposal**
* Click the **Send** button at the top of the screen.
* The proposal status changes to **Sent**.
**2. Primary Signer Notification**
* The primary signer (customer) receives an email notification to review and sign the proposal.
**3. Primary Signer Signs**
* The customer reviews the proposal, selects their preferred option, and signs.
**4. If There Are Additional Signers**
* If co-signers or internal signers are included, the next signer in the sequence automatically receives an email notification.
* The proposal status has been updated to **Awaiting Signature**.
* Any pending signature remains visible in the signer list.
**5. Once Everyone Has Signed**
* After all required signers have completed signing, the quote is fully approved.
| Stage | Status Shown | What Happens |
| :- | :- | :- |
| Before sending | Draft | You can edit signers, pricing, and details. |
| After clicking **Send** | Sent | Email notifications are sent to all signers. |
| Only primary signer (no co-signers) | Accepted | Proposal converts to a live Quote immediately. |
| Co-signer(s) still pending | Awaiting Signature | Quote waits until remaining signers complete. |
| All signatures completed | Approved | Fully signed and ready for next steps. |
## **A. Service Packages**
A **Service Package** is a proposed structured offering of specific solutions or services for a customer/client. You must define the **Service Package** before proceeding.
**To create a service package:**
1. Select the **Settings menu** from the left navigation menu.
2. Under **Configuration Settings**, click **Quotes & Invoices**.

3. Select **Service Packages** and click **+ New Package**.

4. Under **Service Package Details,** enter:
* **Name**: Enter the package name.
* **Description**: Enter a brief description.
* **Remarks**: Add any additional remarks.

5. Click the "**+ Add Item**" button to add individual parts, products, and services. Alternatively, use the dropdown menu next to the "**+ Add Item**" button to:
* **Line Item**: Add a part, product, or service as an individual item.
* **Bundle**: Add a part, product, or service bundle. Note that bundles added here will not appear as a product type in the filter menu.
* [**Section**](https://docs.zuper.co/Accounting/Sections): Add a section to help organize line items within the package.
* **Item Group**: Select a predefined group of items to include in the package.

10. Adjust the [margin percentage](/Accounting/Profit_Margin) to instantly recalculate markup % and the total sell price for all line items.
11. You can **[add rebates](/Accounting/Rebates)** to individual proposal options to show your customer the potential savings for each option. Zuper calculates a separate Net Investment for each option based on the rebates applied.\
For more information, see **Rebates and Net Investment**.
12. Click "**Create Package"** to successfully finalize and create the service package.

> [accordion] Managing service packages
>
> Once you have created a service package, you can manage it using the following functions available on the **Service Packages** listing page:
>
> 
>
> * **Reorder**: Click the **Reorder** button to rearrange items in the package.
> * **Clone**: Click the **Clone** icon to duplicate a package.
> * **Edit**: Click the **Edit** icon to modify the details of the package.
> * **Deactivate**: Click the **Deactivate** icon to disable the package.
## **Add-ons in the Service Package**
Once Add-ons are enabled in Quote settings, you can associate them with **Service Packages**. This allows you to configure optional Add-ons or services alongside a base package.
* In the service package editor, select the **Add-ons** tab.

* Add the necessary Add-ons and click save.

## **B. Proposal Templates**
A **Proposal Template** is a predefined format for linking service packages in a proposal. It serves as a basic structure for quotations, which can be customized.
**To create a proposal template:**
1. Navigate to **Settings** -> **Configuration Settings** -> **Quotes & Invoices**.

2. Select **Proposal Template** from the available options and click the **+ New Proposal Template** button to create a new template.

3. Enter a descriptive name and description for your proposal template and click **Create** to proceed.

4. Enter a **Label Name** and short description for the proposal template.
5. Add the Service Packages:
* Click the **+ Add Package** button to include a **Service Package** in your template.
* Choose the desired **Service Package** from the list and click **Save** to confirm.
> [!NOTE]
>
> Note: Recommended estimate options' image size: 720 × 240 px (3:1 ratio) — ensures the best fit in the proposal and proposal layout PDF.

6. Once added, click **Save Template** to finalize the template creation process.

After creating the template, you can navigate to **Accounting > Quotes & Invoices > + New > Proposal** to use this template while drafting proposals for your customers.
## **Add-ons in the Proposal Template**
When Add-ons are configured and linked to service packages, they automatically appear within proposal templates as **optional Add-ons**.
**Where Add-ons Appear?**
* Add-ons are displayed within each **proposal option card**, under a dedicated **Add-ons** section.
* They are grouped separately from the base service charges to clearly indicate that they are optional.

## **C. Create a New Proposal**
A **Proposal** is created before sending an estimate to a customer. Once the **Service Package** and **Proposal Template** are set up, you can send a proposal.
**Navigation** : *Accounting* --> *Quotes* --> *+ New (Proposal)*
**To create a proposal**
1. Click the “**Accounting**” module from the left navigation menu and select "**Quotes**".

2. Click the **+ New button** and select **Proposal**.

3. Select the appropriate template for your proposal and click the **“Choose Template”** button.

4. A new **Proposal Creation** page will appear.
5. Select either "**Customer**" or "**Organization**" to associate with the proposal.
6. Click "**+Add**" to associate the various modules.
7. A side panel will appear. Select the required module and click the "**Proceed**" button.
8. The billing and service contact details are automatically populated based on the selected customer or organization.
9. Fill in the mandatory fields in the **Proposal Details** section:
* **Proposal Title**
* **Proposal Date**
* **Expiry Date**
* **Quote Template**
10. You can **edit** or **delete** any selected packages as needed in the **Estimate Options** section.
11. The administrator can prefill the options by editing a product with predefined attributes.

12. Click **+ Add Attachments** to upload any relevant quotation-related attachments to the proposal.
13. Click the **Save & Send** button to save the proposal and proceed with sending it.

14. In the pop-up, confirm the **From ID**, **Email**, **Subject**, and **Body** of the email. Once confirmed, click **Send** again to send the proposal to the selected recipient.

> [accordion] Functions on the Proposal Details page
>
> The following perform following functions in the Proposal Details page.
>
> * **Edit Proposal**: Click the **Edit** button to modify the proposal, including package details and any other changes.
> * **Save as Draft**: After making changes, click **Save as Draft** to save the updated proposal without sending it immediately.
> * **Mark as Accepted**: Once the customer agrees to the proposal, click **Mark as Accepted** to finalize the proposal. This marks the proposal as accepted and ready for the next steps. After marking the proposal as accepted, the proposal is automatically converted into a **Quote**, which means the proposal has been confirmed and the process is moving forward.
>
> ### **Add-ons in the Proposal - Create / Edit**
>
> **Add-ons** let you include optional products or services in the proposal that are not part of the primary items. These are displayed under the **Additional Items** section of the proposal option.
>
> > [!NOTE]
> >
> > **Note:** If the Add-ons are enabled in the settings and configured in the standard or CPQ template, they are auto-fetched under the proposal options. Additionally, if any adjustments or changes are required before presenting to the customer, the items under the add-ons section can be updated in the proposal edit page.
## Frequently asked questions
> [accordion] Can different proposal options have different rebates?
>
> Yes. Each proposal option can have its own rebates and **Net Investment**.
> [accordion] What happens to rebates when the customer accepts a proposal option?
>
> The proposal retains the rebates associated with the accepted option.
> [accordion] What happens to rebates when I convert a quote to a proposal?
>
> Zuper adds the quote's rebates to the first proposal option.
> [accordion] Why can't the customer see the rebates on the proposal?
>
> Make sure **Show Rebates** is enabled in the Proposal Layout used by the proposal.
# Rebates
Source: https://docs.zuper.co/Accounting/Rebates
A rebate is an incentive offered to your customer by a manufacturer, utility provider, or another third-party organization.
In Zuper, your team can add rebate amounts directly to quotes and proposals to show customers their potential savings. Zuper displays each rebate separately and calculates the customer's estimated cost after rebates.
This helps your team communicate available incentives during the sales process while giving customers a clearer understanding of their potential out-of-pocket cost.
> [!NOTE]
>
> **Info**: Rebates are for informational purposes only. They do not reduce the quote or proposal total, taxes, deposit, amount due, or the amount your business charges or collects from the customer.
## How rebates work
When a rebate is added to a quote or proposal option, Zuper displays the rebate separately below the **Total** and calculates the value shown as **Net Investment**.
```nushell theme={null}
Net Investment = Total − Total rebate amount
```
For example, if the Total is \$10,000 and the customer receives a \$1,000 manufacturer rebate, Zuper displays:
**Total**: \$10,000.00\
**Manufacturer Rebate**: \$1,000.00\
**Net Investment:** \$9,000.00
You can also add more than one rebate when multiple incentives apply. Zuper combines all rebate amounts and subtracts the total from the quote or proposal Total.
> [!NOTE]
>
> **Note**: Rebates are available as fixed amounts only, and the combined value of all rebates cannot exceed the Total.
> [accordion] **Rebate rules and limitations**
>
> Before you start using rebates, keep these points in mind:
>
> * Rebates are available as fixed amounts only. Percentage-based rebates are not supported.
> * You can add up to 10 rebates to a quote or proposal option.
> * The combined rebate amount cannot exceed the Total.
> * Rebates affect only the Net Investment value. They do not change the Total, taxes, deposit, Amount Due, or the amount your business collects.
> * Rebates are available only on quotes and proposals. They are not supported on invoices.
> * Rebates on a quote apply to the entire quote. Each proposal option can have its own rebates and Net Investment.
> * When you convert a quote containing rebates to a proposal, Zuper adds those rebates to the first proposal option.
> * Updating a rebate template does not change rebates that have already been added to existing quotes or proposals.
> * You can select a saved rebate template or add a one-time rebate directly to a quote or proposal option.
## Enable rebates
**Navigation**: Settings → Modules → Quotes and Invoices → Quotes and Invoices General Settings
1. Open the **Quote** tab.
2. Turn on **Enable Rebates?**.
3. *(Optional)* In **Show Total After Rebates As**, enter a custom label for the net investment value. If you leave blank, Zuper displays **Net Investment** by default.
4. Click **Save**.

When **Enable Rebates?** is turned off, users cannot add or manage rebates. Any existing rebates are retained and become available again if you re-enable the setting.
> [!TIP]
>
> **Tips:** You can choose to hide rebates from customer-facing proposals. To do this, first turn off the "**Show Rebates**" option in the applicable Proposal Layout before disabling "Enable Rebates."
## Create a rebate template
Create rebate templates for rebates your team applies frequently. Templates help users quickly apply a predefined rebate name and default amount when creating quotes or proposal options.
**Navigation**: Settings → Modules → Quotes and Invoices → Discount & Fees
1. Click **+ New Discount/Fee**.
2. In **Type**, select **Rebate**.
3. Enter a **Name** (up to 26 characters). This name appears on the quote or proposal.
4. Enter the **Amount**.
5. *(Optional)* In **Restrict to Custom Roles**, select the custom roles that can use the rebate. If your company uses business units, you can also limit the rebate to specific business units.
6. Click **Create**.

## Add rebates to a quote or proposal
Once rebates are enabled, your team can add them from the pricing summary of a quote or proposal option.
> [tab] Web
>
> 1. Open or create the quote or proposal.
>
> 2. For a proposal, open the option you want to update.
>
> 3. Below **Total**, click **Add rebate?**.
>
> 4. Click **Add rebate?**.
>
> 5. Select an existing rebate template or enter a name for a one-time rebate.
>
> 6. Enter or update the rebate amount.
>
> 7. To add another rebate, click **Add rebate?** again and repeat the steps.
>
> 
>
> 8. Save the quote or update the proposal option.
>
> > [!NOTE]
> >
> > **Info**: To edit a rebate, hover over it and click the pencil icon. To remove a rebate, click the trash icon and confirm **Delete**.
> [tab] Mobile
>
> You can also add and manage rebates from the Zuper mobile app.
>
> 1. Open the quote or proposal.
> 2. Go to the pricing summary.
> 3. Next to **Rebate**, tap Add.
> 4. Select a rebate template or add a custom rebate with a name and amount.
> 5. Tap **Add**.
> 6. Save your changes.
>
> 
>
> > [!NOTE]
> >
> > **Info**: To edit or remove a rebate: → On **Android**, tap the rebate or its pencil icon. → On **iPhone**, press and hold the rebate, or swipe it in the line item editor.
Zuper displays each rebate separately and automatically recalculates the **Net Investment**.
> [!NOTE]
>
> **Note**: On a quote, rebates apply to the entire document. On a proposal, each option can have its own rebates and Net Investment.
## Frequently asked questions
> [accordion] Does a rebate reduce the amount the customer owes my business?
>
> No. Rebates affect only the customer's **Net Investment**. They do not reduce the **Total**, taxes, deposit, **Amount Due**, or the amount your business collects.
> [accordion] Can I add more than one rebate?
>
> Yes. You can add up to 10 rebates to a quote or proposal option. Zuper combines all rebate amounts when calculating **Net Investment**.
> [accordion] Can the combined rebate amount exceed the Total?
>
> No. The combined value of all rebates cannot exceed the **Total**.
> [accordion] Can I add a percentage-based rebate?
>
> No. Rebates support fixed amounts only.
> [accordion] Can I change the amount of a saved rebate template?
>
> Yes. You can change the amount after adding the template to a quote or proposal option. The change applies only to that document and does not update the original template.
> [accordion] Does updating a rebate template change existing quotes or proposals?
>
> No. Each quote and proposal keeps its own copy of the rebate after it is added.
> [accordion] Can I rename Net Investment?
>
> Yes. In **Quotes and Invoices General Settings**, enter a custom label in **Show Total After Rebates As**. Leave the field blank to use **Net Investment**.
> [accordion] Why can my team see rebates but the customer cannot?
>
> Customer-facing visibility is controlled separately. Turn on **Show Rebates** in the applicable Proposal Layout to display rebates and **Net Investment** on the customer proposal page and PDF.
# Recording a deposit on quotes
Source: https://docs.zuper.co/Accounting/Recording_a_Deposit_for_Quotes
If you need to collect money upfront from your client, you can add a required deposit to quotes. Customers will see that there is a deposit on the quote, so they know how much to pay you. When a deposit is recorded on a quote, it will transfer to the first invoice created for this job generated from the quote.
**Navigation**: *Accounting* -> *Quotations*
### Adding a required deposit to a quote
The deposit amount on quotes is determined by the settings configured for deposits in the **Organization Settings**. By default, this value is auto populated on quotes. However, if you need to update the deposit amount, you can do so easily.
To modify the deposit amount:
1. Click the icon next to the "**Collect Deposit**" section.

2. Update the amount as required.
3. Click "**Update Deposit**".

> [accordion] Setting up deposit amounts in Organization Settings
>
> The deposit amount on quotes is determined by the **Organization Settings**. To configure these settings:
>
> 1. Navigate to **Settings** from the left navigation menu and select **Organization Settings**.
>
> 
>
> 2. Click **Quotations and Invoices Settings**.
>
> 
>
> 3. Configure the following fields:
>
> * **Allow Deposit on Quote Approval**: Choose whether to enable deposits for quotes.
> * **Enter Threshold Amount**: Specify the maximum limit for deposit amounts.
> * **Type of Deposit Value**: Choose between a fixed deposit amount or a percentage of the quote value.
> * **Enter Deposit Value**: Define the default deposit amount or percentage.
> * **Allow Payment Collection**: Enable payment collection for deposits.
> * **Allow Sending Payment Link to Customer/Contact**: Enable sending payment links for deposits.
> * **Payment Mode Facilitating the Payment**: Specify available payment methods (e.g., Card, Zuper Pay, Cash, or third-party payment apps).
> * **Allow Field Executive to Collect Payment**: Allow field executives to log deposit payments.
>
> 
>
> By configuring these settings, the deposit amount will be automatically populated on quotes by default.
### Recording deposits on quotes
Once the quote is ready, you can email it to the customer. The customer can then pay the deposit amount directly by clicking the payment link in the email. Alternatively, if the customer pays by a different method, you can manually log the deposit received.
**To log a deposit:**
1. Click **Collect Deposit** in the product table details or navigate to **More Actions** -> **Collect Deposit**.

2. A **Collect Deposit** dialog box will appear. Enter the following details:
* **Payment Mode**: Select the method used for the deposit (e.g., Card, Zuper Pay, Offline Cash, or other third-party payment apps).
* **Deposit Amount (in USD)**: Enter the exact deposit amount received from the customer.
* **Payment Reference Number**: Provide a reference number, such as a transaction ID or check number, associated with the payment.
* **Payment Date**: Specify the deposited date.
* **Remarks**: Optionally, add any notes related to the deposit.
* **Send Receipt/Confirmation Note**: Check this box if you want to send a confirmation receipt or a thank-you message to the customer.
3. After entering the details, click **Collect** to successfully log the deposit.

Once the full required deposit amount has been recorded, an icon will appear beside the "**Deposit**" field on the quote, indicating that the deposit has been collected. You also have the option to void the quote transaction.

# Sections
Source: https://docs.zuper.co/Accounting/Sections
## Overview
Sections replace **Headers** across **Service Packages**, **Proposals**, **Quotes**, **Invoices**, and **Job** line items.
With Sections, you can control what customers see, from individual line-item details to whether a section appears at all.
## How sections work?
* When you add a section to a quote, invoice, or proposal, all line items inside it are treated as a group. Reordering a section moves every item in it together — you do not need to reorder each item individually.
* Each section has its own configuration settings that control what your customer sees in PDFs, public links, previews, and presentation mode.
* You can add line items directly to a section.
> [!NOTE]
>
> **Note**: To ensure Sections configuration works correctly, make sure the ‘**Price**’ toggle is enabled under Estimate Options in the Proposal layout, and ‘Show Selling Price in Transaction’ is enabled for the relevant custom role.
## **Adding sections in transactions**
> [tab] Web
>
> The web app supports Jobs, Quotes, Invoices, Proposals, and CPQ.
>
> 1. Use the “**+ Add**” button to add the Section:
>
> 
>
> 2. Enter the section name and select the “**Add Section**” button.
>
> 
>
> 3. Under “**Actions**,” select the context menu. Choose “[**Configure**](https://docs.zuper.co/Accounting/Sections#section-configuration)” to access the section settings.
>
> 
>
> Similarly, you can edit sections as well after creation.
> [tab] Mobile
>
> The Mobile app supports Quotes, Invoices, and Proposals.
>
> 1. Tap the “**+**” button to add the Section.
>
> 
>
> 2. Type the section title and tap the "**Add**" button.
>
> 
>
> 3. Under “**Actions**,” select the context menu. Choose “[**Configure**](https://docs.zuper.co/Accounting/Sections#section-configuration)” to access the section settings.
>
> 
> [!NOTE]
>
> **Note**: A line item added using the generic “**Add**” button, rather than being added to a specific section, is placed in the last section.
## Section configuration
Each section has four settings that control how it appears to the customer, in the PDFs, Public links, previews, and presentation mode.
When a new section is added, it inherits the configuration of the previous section.
| Setting | What it does | Default |
| - | - | - |
| **Show Line Items** | Displays individual line items to the customer within the section. | On |
| **Show Line-Item Prices** | Shows the unit cost, markup, and price for each individual line item in a section. | On |
| **Show Section Total** | Displays the sum of the section total. | Off |
| **Hide Section** | Completely hides the section and all its items from the customer. | Off |

Zuper carries over the section configuration when:
* You create a quote from a proposal option.
* You generate an invoice from a quote or job.
* You create a job from a quote or invoice.
## Key points to note on hiding a Section
* Customers cannot see hidden sections or their line items in PDFs, public links, or presentation mode.
* Hidden line items still count toward the overall estimated total.
* You can hide multiple sections at once.
* The section total and all line-item prices are hidden from the customer throughout the quote/invoice/proposal.
* When you enable Hide Section, Zuper turns off the Price toggle in **Proposal Layout** → **Estimate Options**.

## Section actions
* Configure — Controls how line items and prices appear within the section.
* Rename — Changes the section name.
* Clone — Duplicates the section and all its line items.
* Remove — Deletes the section. Select one of the following options:
* Remove header only — Deletes the section but keeps the line items.
* Remove section and all items — Deletes the section and all line items within it.

### Moving line items between sections:
You can move any line item out of a section or into a section.
* **Move out of Section** — Removes the item from its current section and places it at the top above all sections, ungrouped.
* **Move to Section** — Move a line item from a section or an ungrouped item to a preferred section.

### To move a line item
Locate the line item in the section.
* In the line item actions, select [**Move out of section**](https://docs.zuper.co/Accounting/Sections#moving-line-items-between-the-sections) or [**Move to section**](https://docs.zuper.co/Accounting/Sections#moving-line-items-between-the-sections) from the line-item actions, depending on the item's current position.
* If moving to a section, select the destination section from the list.

## Customer view
* When only **Show Section Total** is enabled, the customer sees only the section total. Individual line items and their prices stay hidden.

* When **Show Line Items**, **Show Line-Item Prices**, and **Show Section Total** are all enabled, the customer sees each line item, its unit cost, markup, and price. The section total also appears against the sections.

* When **Hide Section** is enabled, the customer does not see the section or any of its line items. Additionally, the prices for all the other line items are hidden from the customer as well.

## **Important note on templates**
**No changes required if:**
* You continue using the default configuration (where line items and prices are visible and section totals are hidden), your existing templates — both native and custom — will continue to work as expected.
If you use **new Section visibility options** (for example, hiding line items, prices, or entire sections)**:**
* **Proposals:** No impact. Sections are supported by default.
* **Quotes & Invoices (Native Templates):** You will need to create new templates to use these capabilities. Check out how to create [quote & invoice templates](https://docs.zuper.co/Settings/Modules/Quotes-Invoices/Quotes-Invoices-Settings#quotes-%26-invoices-templates).
* **Quotes & Invoices (Custom Templates):** Updates are required to support these capabilities. Please reach out to [**support@zuper.co**](mailto:support@zuper.co) for assistance.
> [!NOTE]
>
> **Note:** Custom template changes affect all documents using that template. Before requesting changes, confirm the update won't impact other quotes or invoices. For document-specific formatting, request a separate template from [support@zuper.co](mailto:support@zuper.co).
# Sending and Getting Customer Approval
Source: https://docs.zuper.co/Accounting/sending-a-proposal-and-getting-customer-approval
Give your customers a simple, self-serve experience where they can review your proposal online, choose an option, and approve it with a digital signature. You'll be notified the moment they approve, decline, or request a change so you can move on to the next step.
> [!WARNING]
>
> **Before you begin:**\
> The settings in **Settings → Modules → Quotes & Invoices → Quote and Invoice General Settings → Quote tab** control the proposal approval experience. Ensure those are configured correctly before sending. Refer to [Settings](/Settings/Modules/Quotes-Invoices/Quotes-Invoices-Settings#general-tab).
## Sending the proposal
The first step is to send the proposal by email to the customer. Sending moves the proposal status from **Draft** to **Sent**, and that is what activates the approval flow for your customer.
To send a proposal, open the **Proposal Details** page and click **Send** in the top right corner. If you are still building the proposal, you can click **Save & Send** instead. The **Send** dialog opens.

Review the fields and click **Send**.
> [!TIP]
>
> **Pro Tip:** When emailing a proposal, you can add multiple recipients by separating each address with a comma in the CC and BCC fields. You can also customize the **subject line** and **message body** before sending.

The proposal status changes from **Draft** to **Sent**.
Your customer receives an email with the proposal attached as a PDF and a **"View to Approve Proposal"** link that takes them to the interactive approval page.
## Sharing the proposal link
If you want to share the proposal through WhatsApp or any other channel outside Zuper's email system, you can use the **Share Links**. Click the **copy icon** to copy the URL to your clipboard, the **WhatsApp icon** to share the link directly via WhatsApp, or the **open in browser icon** to preview exactly what your customer will see.
Keep in mind that sharing the link does not change the proposal status. The customer approval flow is only active once you have sent the proposal by email and the status is **Sent**.
## What your customer sees
When your customer opens the **"View to Approve Proposal"** link from their email, they land on a branded proposal page with your company logo, the proposal title, their billing and contact details, and all package options with full pricing.
From here, your customer can take one of three actions: click **Review & Sign** to select a package and approve, click **Request Change** to send a change request back to your team, or click **Decline** to decline the proposal.

If **Notify Created User on Status Updates?** is set to **Yes** in settings, you'll receive a notification as soon as your customer takes any of these actions.
### How does your customer approve the proposal
When your customer clicks **Review & Sign**, the **Complete Your Signature** panel opens on the right side of the screen. Here's what they do:

#### Select a package
Your customer sees all available options; for example, **Basic**, **Advanced**, or **Installation Package** with pricing for each.
If you enabled financing for a package in the proposal template, that option shows a **monthly payment amount and term** (for example, "\$41.24/month for 10 years") alongside the cash price.
Once they pick an option, the **Item Summary** updates instantly with the line items, discounts, taxes, transaction fees, and total for that package.
#### Choose a payment method
Under **Payment Method**, your customer picks how they want to pay:
* **Cash Payment** - Pay the full amount upfront
* **Financing** - Monthly payments through your financing provider you configured, with the rate, term, and an "as low as" comparison shown.
> [!NOTE]
>
> **Note:** Financing only shows up if **Enable Financing?** is turned on in settings **and** financing is enabled for that package in your proposal template.
Once the proposal is **Approved**: If **Auto-convert Quote to Invoice?** is set to *Yes, Save as Draft* or *Yes, Save and Send*. Zuper creates an invoice from the approved proposal automatically.
# Appointments
Source: https://docs.zuper.co/Appointments/Appointments
Not all roofing work happens in a single visit. A job might need an inspection, an adjuster walkthrough, a pre-production check, and the installation itself. These often fall on different days, involve different people, and sometimes span trades such as roofing, gutters, and siding.
Appointments in Zuper let you manage all of that in one job. An appointment represents a scheduled visit. When you create a job, Zuper automatically creates an initial appointment. When a technician needs to return to the site, you can add additional appointments to the same job rather than creating separate jobs or rescheduling existing ones.
Every appointment on a job shares the same invoice, job notes, and job history. This keeps multi-day and multi-visit work on a single record, reduces duplicate data entry, and gives your team a clear view of each visit while managers and dispatchers maintain visibility into the full job.
## Things to Know
* A single appointment is automatically created when you create a new job under a dispatchable job category. If the job category is marked **Non-Dispatchable** (for example, Inspection), the job is created, but no appointment is added.
* You cannot add appointments to a job in a terminated job status, such as Closed or completed.
> [!TIP]
>
> Prerequisite: Account configuration is required to use this feature. Please contact the Support team for details.
### Add Appointments
1. Open the job you want to add an appointment to.
2. Navigate to the **Appointments** tab and click **Create Appointment**.\

3. Fill out the appointment details:
1. Add a title and, if needed, a description.
2. Select the appropriate **Appointment Type** from the dropdown based on the purpose of the appointment.
> [!NOTE]
>
> You can configure the appointment types from **Settings > Job Settings > Appointment Types**. Once configured, these types appear in the **Appointment Type** dropdown when you create an appointment.
>
> 
3. Assign technicians under **Assignee**.
4. Set the **Schedule Date** either *manually* or using [Assisted Scheduling](Work_Order_Management/Jobs/Assisted_Scheduling#assisted-scheduling).
> [!NOTE]
>
> Note: If the **Enable Due Date** setting is disabled, you can create appointments without a schedule.\\
>
> 
5. Choose the **trade type** if this appointment is tied to a specific trade.
6. Switch to the **Tasks** tab if you want to attach a task to this appointment, either by creating a new one or by linking to an existing one.
7. Switch to **Purchase Orders** if you want to associate a *Purchase Order* or *Material Order* with the appointment.
> [!NOTE]
>
> **Notes**:
>
> * Appointments work on Zuper's new [task](/Zuper_Dashboard/Tasks) experience feature, so if your organization is still on the older service task setup, reach out to [support@zuper.co](mailto:support@zuper.co) to get that switched.
> * When a technician is assigned to a task linked to an appointment, the user will be automatically added to a Job as well.
4. Click **Save**.\

The appointment is added to the job with the configured **Schedule Date**, **Assignee**, **Appointment Type**, and **Trade Type**. The selected tasks and associated orders are also linked to the appointment, if applicable.

### Managing an appointment
* **Edit**: Click the appointment's name to open and modify its details.
* **Delete**: Click the context menu and choose Remove.
* **Clone**: Click the context menu and choose Clone to create a copy of it.

* **Schedule**: Click the ***Unscheduled*** icon and choose either Manual or Assisted scheduling.
* **Assign**: Click the ***Assignee*** icon and select the user you want to assign to the appointment.
### Appointment status on the Jobs list
The Jobs list shows the status of each job’s appointments in the Scheduled Date column. Use the colored status bar to identify appointments that need scheduling or follow-up without opening the job.
* **Grey**: The appointment is unscheduled.
* **Blue**: The appointment is scheduled.
* **Green**: The appointment is completed.

When a job has multiple appointments, the bar is divided into one segment for each appointment. Each segment shows the status of its corresponding visit, so you can review all appointment statuses from a single job row.
### Frequently Asked Questions
> [accordion] When should I use Appointments instead of a Recurring Job?
>
> * Use Appointments when a single job needs multiple visits to the customer site with no fixed schedule. For example, a repair or replacement that spans several days, where each visit happens as the work requires rather than on a set cadence.
> * Use a Recurring Job when you need to visit the customer site at a regular frequency, such as monthly or yearly maintenance. A recurring job carries only one appointment, since appointments are meant for irregular, as-needed visits rather than fixed intervals.
> [accordion] Does scheduling one appointment schedule the entire job?
>
> No. Scheduling affects only the selected appointment. Other appointments associated with the same job keep their existing schedules.
> [accordion] Can different appointments have different technicians?
>
> Yes. Each appointment can be assigned to different users or teams.
> [accordion] What happens when I assign a technician to an appointment task?
>
> The technician is assigned to the task and will also be added to the associated appointment and parent job.
> [accordion] Can a task belong to multiple appointments?
>
> No. A task can be linked to only one appointment.
> [accordion] Can a purchase order be linked to multiple appointments?
>
> Yes. A purchase order can be linked to multiple appointments when the same materials are needed across visits.
> [accordion] Does an unfulfilled purchase order stop me from working on the appointment?
>
> No. A purchase order linked to an appointment remains visible on the appointment card as long as it hasn’t been fulfilled. Once it's fulfilled, it no longer shows on the card. Either way, it doesn't block you from working on or completing the appointment.
> [accordion] If I reorder tasks, can a task move to a different appointment?
>
> Yes. On the **Tasks** tab, tasks are grouped by the appointment they belong to. In reorder mode, dragging a task into another group re-links it to that appointment. Reorder carefully so each task stays with the correct appointment.\\
>
> 
> [accordion] How do notifications work when a job has appointments?
>
> Your existing [job notifications](/Settings/Modules/Jobs/configuring_job_notifications) continue to work when a job has appointments. Each one is based on a different trigger:
>
> * **Job Reminder** is based on the appointment start date and time. Customers can be reminded ahead of each scheduled visit.
> * **Job Delay Alert** is based on the job start time, end time, due date, or status.
> * **Job Status Alert** is based on the job status.
>
> Delay alerts and status alerts apply to the whole job, not to a single appointment. For example, an admin links a Job Status Alert to the On My Way status. When a technician sets the job to On My Way before a visit, the customer is notified. On a multi-visit job, the technician can set On My Way again, and the customer will be notified.
> [accordion] Are appointments and tasks the same?
>
> No. They serve different purposes on a job.
>
> An appointment is the schedule for a visit. It defines when the visit happens and who is going, with its own schedule, assignees, and trade type. A task is the work itself, such as an inspection or a repair step to be completed during the visit. You can link tasks to an appointment to show which work belongs to which visit, or leave them unlinked.
> [accordion] Are time logs tracked at the appointment level?
>
> No. Time logs are tracked at the job level. Work and travel time recorded by technicians roll up to the job as a whole, not to individual appointments.
> [accordion] Where can I configure Appointment Types?
>
> You can configure appointment types from **Settings > Job Settings > Appointment Types**. Once configured, the appointment types are available in the **Appointment Type** dropdown when creating an appointment from the **job creation page**, **Job Details page**, or the **job creation side sheet** accessed from the **Dispatch Board, Calendar, and Projects** modules.
>
> After an appointment type is selected, it is associated with the appointment and can be viewed on the **appointment card** in Job Details. You can also enable the **Appointment Type** attribute in the **Dispatch Board** and **Calendar** settings to display the appointment type on appointment cards in those views.
# Managing your appointments from the Dispatch Board
Source: https://docs.zuper.co/Appointments/Understanding-the-Dispatch-Board
Use the **Dispatch Board** to efficiently manage your users’ schedules and job appointments. You can quickly find appointments that need attention, assign the right technicians, schedule or reschedule visits, and review job and appointment details from one workspace.
Each appointment can have its own date, time, assignees, trade type, tasks, and linked dependencies while remaining connected to the same parent job. This makes it easier to coordinate multi-day, multi-trade, and multi-crew work without creating separate jobs.
For example, a roofing job can include separate appointments for inspection, material delivery, installation, and final verification. Each visit can be scheduled independently and assigned to the most suitable technician.
From the Dispatch Board, you can now:
* View all, unscheduled, assigned, or unassigned appointments.
* Drag and drop appointments into technician time slots.
* Add or change assignees.
* Reschedule appointments.
* Clear a schedule while keeping the appointment available for later planning.
* Open the parent job or the selected appointment for more details.
* Create another appointment when the job requires an additional visit.
> [!NOTE]
>
> **Note**: Once your organization uses Appointments, the Dispatch Board always dispatches by appointment. You can't switch back to dispatching by job.
## Understanding the Dispatch Board
The Dispatch Board contains four primary areas.\
* Appointment Queue
* Users
* Scheduler
* Map
Together, these views help you match the right technician with the right appointment at the right time.
## Find appointments that need attention
The appointment queue helps you identify work that still requires action.
Depending on your workflow, you may need to schedule appointments, assign technicians, or review appointments that have already been allocated.
1. Click the **Scheduling and Dispatching** module and select **Dispatch Board**.\

2. Select the required time zone.
3. Select a **Trade Type** when applicable.
4. (Optional) Select a Service Territory.
5. Select the required team.
6. Select the date you want to manage.
7. Open the appointment queue in the upper-left corner.
8. Select one of the following options:
* **All Appointments** - Displays all the appointments available to you.
* **Unscheduled Appointments** - Displays appointments without a confirmed start and end date and time. You can use this queue to schedule appointments.
* **Assigned Appointments** - Displays appointments assigned to one or more users. You can use this queue to review work that has already been allocated.
* **Unassigned Appointments** - Displays appointments that do not currently have an assigned user or team. You can use this queue when appointments need technicians.\

Use **Search**, **Filter**, and **Sort** to quickly locate the appointments you need.
## View job and appointment details
Before scheduling or assigning work, you may need additional information about the job or appointment.
The Dispatch Board allows you to review details without leaving your current view.
1. Locate the appointment in the dispatcher queue and right-click on it.
2. Select one of the following options:
1. **View Job Details**
2. **View Appointment Details**\

Zuper opens the selected record in a side panel without taking you away from the Dispatch Board.
## View all appointments associated with a job
1. Select **View Job Details**.
2. Click the **Appointments** tab.
3. Review all appointments associated with the job.\

4. Select an appointment to view its details.
## Create a new appointment
When an existing job requires an additional appointment, you can create it from the Dispatch Board itself. To do so, click the **+ Create Appointment** on the View Detail page. See [Add Appointments](/Appointments/Appointments#add-appointments)\

## Schedule an appointment
Unscheduled appointments appear in the appointment queue and are ready to be placed for a technician.
Scheduling an appointment reserves a time slot and assigns responsibility for the visit.
1. On the appointment queue, select **Unscheduled Appointments**.
2. Select the required team and date.
3. Review the appointment details, including the parent's job, trade type, and due date.
4. Locate an available technician in the **Users** section.
5. Drag the appointment from the queue to an available time slot in the technician's scheduler row. The **Schedule dialog** opens.
1. Enter or review the Appointment Start Time.
2. Enter or review the Appointment End Time.
3. Turn on **All day** when the appointment should cover the entire day. Zuper sets the start and end times to your business hours.
4. Click **Assign** to add technicians when required.
6. Click **Update**.\

Zuper schedules the appointment, assigns it to the selected technician, and displays it in the technician's scheduler row.
## Assign or reassign technicians
As schedules change throughout the day, you may need to add technicians or move work between team members.
The Dispatch Board allows you to update assignments.
### Assign additional technicians
1. Drag the appointment to a technician's scheduler row.
2. In the **Schedule** or **Reschedule** dialog, click **Assign More**.
3. Select the additional users.\

4. Review the appointment start and end times.
5. Click **Update**.
Zuper adds the selected users to the appointment.
### Reassign an appointment
1. Locate the appointment in the scheduler.
2. Drag the appointment from the current technician's row to another technician's row. The **Reschedule dialog** opens.
3. Review the new technician assignment.
4. Confirm the appointment start and end times.
5. Click **Update**.
Zuper assigns the appointment to the selected technician.
## Reschedule an appointment
Schedules often change because of customer availability, technician workload, weather conditions, or project timelines.
You can reschedule an appointment without affecting any other appointments associated with the same job.
1. Select Assigned Appointments or locate the appointment in the scheduler.
2. Drag the appointment to a different time slot or technician. The Reschedule dialog opens.
1. Update the Appointment Start Time.
2. Update the Appointment End Time.
3. Turn on All Day when required.
4. Review the assigned users.
5. Click **Assign More** to add additional users when needed.
3. Click **Update**.\

Zuper updates only the selected appointment.
## Clear an appointment schedule
If an appointment is still required but the date and time are no longer confirmed, you can remove the schedule and return the appointment to the queue for future planning.
1. Open the Reschedule dialog for the appointment.
2. Click **Clear Schedule**.\

3. Confirm the action when prompted. The appointment returns to the Unscheduled Appointments queue.\
Clearing the schedule removes only the scheduled date and time. The appointment remains associated with the job and can be scheduled again later.
# Managing appointments from the Calendar
Source: https://docs.zuper.co/Appointments/manage-appointments-from-calendar
The Calendar provides a centralized workspace for planning, scheduling, and managing appointments.
Instead of viewing appointments one at a time, the Calendar gives you a visual overview of scheduled and unscheduled appointments, helping you balance workloads, identify scheduling gaps, and coordinate upcoming visits.
Whether you're scheduling new appointments, adjusting existing schedules, or reviewing upcoming work, the Calendar helps you stay organized.
> [!NOTE]
>
> Using the classic Calendar? See [Calendar](/Scheduling_and_Dispatching/Calendar) for information about scheduling jobs.
## Accessing calendar
* Select the **Scheduling & Dispatching module** icon from the left navigation menu and choose **Calendar**.\

The calendar will display events based on the selected view. You can **filter** the Calendar by *Job Category*, *Teams*, *Users*, and other configured conditions.
## Understanding the Calendar
The Calendar brings everything you need to manage appointments into a single workspace.\

* **Calendar Views:** Switch between Month, Week, and Day views depending on how you want to review the schedule.
* **Date Navigation**: Use the navigation controls to move between dates, jump to today, or select a specific date from the mini calendar.
* **Filters**: Use filters to focus on the appointments you want to see.
## View scheduled appointments
Scheduled appointments appear directly on the Calendar based on their assigned date and time.
Depending on the selected view, you can quickly review upcoming work, technician commitments, and appointment distribution across your schedule.
1. Select the required Calendar view and date range.
2. Locate the appointment.
3. Click the appointment to view its details.\

## View unscheduledunscheduled appointments
Not every appointment is scheduled immediately. Unscheduled appointments remain available in a dedicated queue until you're ready to schedule.
1. Click **Unscheduled Appointments** in the upper-right corner.
2. A list of unscheduled appointments might appear.
3. Drag the appointment from the side panel to the required date and time.
4. Enter or confirm the Appointment Start Time.
5. Enter or confirm the Appointment End Time.\

6. Turn on **All day** when the appointment should cover the entire day. Zuper sets the start and end times to your business hours.
7. Click **Update**.
Once the appointment is scheduled successfully, you can view the job, reschedule, add a note, clone, delete the appointment,, or clear the schedule by right-clicking on the appointment card.
## Create a new job from the calendar
You can create a job directly from the calendar, without navigating away from the scheduling interface.
* Click Create Job in the top-right corner, or click and drag over the time slot you want the job scheduled for. See [Creating a new job](/Work_Order_Management/Jobs/creating_a_new_job) and [Appointments](/Appointments/Appointments#add-appointments) for how to fill in the job and appointment details.
* The job is created with its first appointment already scheduled and assigned, so there's no separate step needed to set up that initial visit.
## Create and review non-job events
A non-job event refers to any activity that a field technician or employee participates in that is not directly linked to a specific job. These events can include meetings, training sessions, administrative tasks, or any other non-job-related activities. To create a new non-job event from the calendar, refer to [Non-Job event](/Dispatch/Create_manage_non_job_event).
## Create and review a time-off request
Manage technician availability effectively by adding time-off requests directly in the calendar. This feature helps plan workloads efficiently while ensuring seamless scheduling. To create a new time-off request from the calendar, refer to [Time-Off](/Scheduling_and_Dispatching/Calendar#3-create-and-review-timeoff-requests).
# Work with appointments in the Zuper Mobile app
Source: https://docs.zuper.co/Appointments/work-with-appointments-in-the-zuper-mobile-app
An appointment is a scheduled visit for a job. When a job needs more than one visit, each visit can have its own schedule, assignee, and tasks.
From the Zuper Field Service app, you can check your scheduled appointments, review the work planned for each visit, and complete the associated tasks.
## Check your appointments for the day
Start your day from the Home screen, where every visit assigned to you is listed so you know where to be and when.\

1. Open the **Zuper Mobile** app.
2. On the **Home** tab, scroll to the **Appointments** section.
3. Review the appointments scheduled for you.
> [!TIP]
>
> **Tip**: Use the date selector to view appointments for other days.
4. Tap an appointment to open it.
When you open an appointment, Zuper takes you to the related job and displays the selected appointment along with the tasks linked to that visit.
## Complete the tasks for an appointment
Tasks linked to an appointment represent the work planned for that visit. Complete them as you go so your progress stays tied to the right visit.\

1. On the appointment details page, go to the **Tasks** tab.
2. Tap a task to open it.
3. Perform the task and update the task status.
4. If a checklist or inspection form is attached, complete it before you mark the task as completed. For more information, see [Tasks](/Zuper_Mobile_Apps/Tasks).
## Reschedule an appointment
Reschedule an appointment when the visit needs to move to a different date or time. This lets you manage your own schedule from the field.
1. Open the appointment.
2. Tap the **schedule** icon (date and time), then select **Edit**.
3. On the **Schedule** screen, change the date and time, or turn on **All day** if needed.\

4. Tap **Done** to save your changes.
> [!TIP]
>
> If you are already dispatched to or arrived at the visit, do not reschedule it. Add a [new appointment](/Appointments/work-with-appointments-in-the-zuper-mobile-app#add-an-appointment) for the additional work instead.
## Assign technicians to an appointment
Bring another technician on a visit when the work needs more than one person. You can add technicians to any appointment assigned to you.
1. On the appointment details page, tap the **Assign** icon. Your name appears here as the current assignee.
2. Choose **Assign users** to pick team members yourself, or **Assisted schedule** to let Zuper suggest available users.\

3. Select the users you want to add to the appointment.
## Add an appointment
Create a new appointment when a job needs another visit, or hand it to the office to schedule for you.
> [!NOTE]
>
> **Note**: Creating an appointment requires the appropriate permission for your role. Contact your administrator if you need access.
1. Open the job and go to the **Details** tab.
2. In the **Appointments** section, tap the **+** icon.
3. On the **New Appointment** screen, enter an **Appointment title**.
4. Enter a **Description**. This step is optional.
5. Tap **Assign users**, then choose **Assign users** to pick team members yourself, or **Assisted schedule** to let Zuper suggest available users.
6. Tap **Select date & time**. On the **Schedule** sheet, turn on **All day**, or set the **Date**, **From**, and **To** times, then tap **Done**.
7. Tap **Create**.\

Your new appointment appears in the job's **Appointments** section.
## Frequently asked questions
> [accordion] How do I mark an appointment as completed?
>
> Complete the tasks associated with the appointment, then update the job to match your organization's workflow.
> [accordion] Can I add another appointment?
>
> Yes. You can add another appointment from the **Appointments** section of the job.
> [accordion] Can I edit an appointment?
>
> Yes. Open the appointment, tap the **More options** icon, and select **Edit**.
> [accordion] How can I see all the tasks associated with a job?
>
> On the job's **Details** page, go to the **Tasks** tab and turn on **All Tasks** to list every task associated with the job.
# Channels
Source: https://docs.zuper.co/Chat/Channels
**Channels in Zuper** are shared spaces that help teams to communicate and collaborate in an organized way. By grouping related conversations in one place, channels make it easy to share updates, keep discussions focused, and find important information when needed.
Whether you’re coordinating across the entire organization, collaborating within a department, managing a project, or discussing a specific job in the field, channels ensure the right people have access to the right information at the right time.
Here are some examples of how teams commonly use channels:
* Company-wide announcements and updates.
* Department-specific discussions (e.g., Service, Sales, Operations)
* Project coordination or recurring operational workflows
* Job-specific communication for seamless field-to-office alignment
# **Types of Channels**
Zuper offers three primary types of channels to cater to various needs.
## 1. The General Channel
Every organization in Zuper automatically has a **#general** channel. All users are added to this channel by default.
You can use the **#general** channel for:
* Organization-wide announcements
* All-hands updates
* Information everyone needs to stay aligned
> [!NOTE]
>
> Note: The General channel cannot be archived.
## **2. Job-Specific Channels**
Job-specific channels are one of the most powerful features for field service teams.
These channels are directly linked to a particular job in Zuper and make it easy to keep all job-related communication in one place.
> [!NOTE]
>
> **UI Update:**\
> We've repositioned **Job Channels** into a dedicated section in the sidebar, separate from your other channels, for quicker access.
**With job-specific channels, you can:**
* Start a conversation instantly from the **Job Details page → Chat section**
* Share files, documents, and photos from the field
* Exchange real-time updates as the job progresses.
* Receive automated real-time job updates such as clock-in/out, quote acceptance/rejection status, invoice payments, status updates, and user assignment.

> [!NOTE]
>
> **Note**: Anyone who has permission to view the job can see and send messages in its channel. However, only users who are assigned to the job or manually added as channel members will receive notifications for new messages.
## **3. Custom Channels**
Custom channels are spaces you can create for ongoing topics, specific teams, or projects. They let you organize conversations to match the way your team works and keep communication focused.
# **Create and manage channels**
## Creating a Channel
You can create a channel to organize conversations around a team, project, operation, or topic. To start a custom channel:
> [tab] Web
>
> * Click the Work Order Management/Job module from the left navigation menu and select **Chat**.
> * Click the **+** icon in the header.
> * Select **Create a Channel**.
> * Enter a **channel name**.
> * Add members to the channel (optional—you can do this after the channel is created as well).
> * Click **Create**. A new channel will be created successfully.
>
> [https://drive.google.com/file/d/1dTg\_64\_FV4wUpCnw8EX0r6Fzec5tz9yN/preview](https://drive.google.com/file/d/1dTg_64_FV4wUpCnw8EX0r6Fzec5tz9yN/preview)
> [tab] Mobile
>
> * In the Chat home page, tap the **+** icon at the bottom.
> * Tap **Create Channel**.
> * Enter a channel name.
> * Search and add members to the channel.
> * Tap **Create** to finish.
>
> [https://drive.google.com/file/d/1eGhbLoD\_4GEatXgFQ4IhGQY\_uFTLrA-C/preview](https://drive.google.com/file/d/1eGhbLoD_4GEatXgFQ4IhGQY_uFTLrA-C/preview)
> [!NOTE]
>
> **Note**: Job-specific channels form automatically from the job page and keep their names fixed. However, you can edit names for custom channels if needed.
## Adding Members to a Channel
> [tab] Web
>
> * Open the channel you want to add people.
>
> * Click the member avatars in the top right of the channel header. From there, add or remove members.
>
> > [!NOTE]
> >
> > Note: Admins can include anyone. Team leads and field executives can add members from their own teams.
>
> * Click **Add Members**.
> * Select the members and click "**Add**." The selected member(s) will be added to the channel successfully.
>
> [https://drive.google.com/file/d/1oN5g1Cr2md1C3N68-N\_f8KV5r2W9V3Wh/preview](https://drive.google.com/file/d/1oN5g1Cr2md1C3N68-N_f8KV5r2W9V3Wh/preview)
> [tab] Mobile
>
> * Open the channel you want to add members to.
> * Tap the channel name at the top of the chat window. The Channel Details page opens.
> * Tap **+Add** at the top-right corner of the Channel Details page to select and add new members to the group.
>
> [https://drive.google.com/file/d/1zfBReznwqoeLHlYF7WnLT-RC5FWB7xH9/preview](https://drive.google.com/file/d/1zfBReznwqoeLHlYF7WnLT-RC5FWB7xH9/preview)
> [!NOTE]
>
> Note: The channel creator becomes the Channel Manager by default and can assign others. Channel Managers handle membership and moderation.
## Set a Notification Preference
Updated You can control how you are notified for each channel. Zuper gives you two levels of control, a global preference for all channels, and a channel-level preference for individual channels.
> [accordion] Global notification preference
>
> Your global preference sets the default notification behavior across all channels.
>
> > [tab] Web
> >
> > **Web**
> >
> > 1. Click the **Chat** icon in the top-right corner of the Header bar.
> > 2. Click the icon. A **Notification Preference** panel opens.
> > 3. Choose one of the following:
> > * **All**: You receive a notification for every message in every channel. This is the default.
> > * **Mentions and Direct Messages**: You are only notified when someone mentions you or sends you a Direct Message.
> > 4. Your preference is saved immediately.
> > > [!NOTE]
> > >
> > > **Note:** This setting applies to all channels where no channel-level preference has been set.
> > > 
>
> > [tab] Mobile
> >
> > 1. In the **Chat** home, tap on the icon.
> > 2. Choose **Everything** or **Mentions**.
> >
> > [https://drive.google.com/file/d/1ncI1JKQjjZgm2xV2ZBMRrp0O0gZO6QqI/preview](https://drive.google.com/file/d/1ncI1JKQjjZgm2xV2ZBMRrp0O0gZO6QqI/preview)
> [accordion] Channel-level notification preference
>
> You can override your global preference for any individual channel. Channel-level preferences always take precedence over your global settings.
>
> > [!NOTE]
> >
> > **Note:** Once a channel-level preference is set, it cannot be overridden by the global preference.
>
> > [tab] Web
> >
> > 1. Open the channel and click **More actions (⋮)** in the channel header.
> > 2. Select **Notification Preference**.
> > 3. Choose one of the following:
> > * **All**: You receive a notification for every message in this channel.
> > * **Mentions**: You are only notified when someone mentions you in this channel.
> > * **Mute**: You receive no notifications from this channel.
> >
> > 
>
> > [tab] Mobile
> >
> > 1. In the Chat home, tap and hold the channel name, or open the channel and tap its name to open the details page.
> > 2. Select **Notification Preference**.
> > 3. Choose **Muted**, **Everything**, or **Mentions**.
> >
> > [https://drive.google.com/file/d/1FPQIzaCKmrvay3XUgjRGLj2LvyyMhBN5/preview](https://drive.google.com/file/d/1FPQIzaCKmrvay3XUgjRGLj2LvyyMhBN5/preview)
### Muting a channel
You can mute a channel when you want to reduce notifications but still read messages later.
> [tab] Web
>
> * Hover over the channel name in the sidebar.
> * Click the **More actions (⋮)** icon.
> * Select **Mute Channel** to stop receiving notifications.
> * To unmute, repeat the same steps and select **Unmute Channel**.
>
> [https://drive.google.com/file/d/1knsTzSriGg1aNv6SArwjjRTEsE\_dZFxc/preview](https://drive.google.com/file/d/1knsTzSriGg1aNv6SArwjjRTEsE_dZFxc/preview)
> [!NOTE]
>
> Note: After opening a channel conversation, click the channel name at the top to view the job details.
## Pinning a Channel
Pinning a channel keeps your most active or critical conversations at the top of your sidebar (on web) or chat home (on mobile) for quick access.
> [tab] Web
>
> * Hover over the channel name in the sidebar.
> * Click the **More Actions** (⋮) icon and select **Pin this channel**.
> * The pinned channel will now appear in the **Pinned Conversations** section for quick access
> * To unpin, repeat the same steps and select **Unpin this channel**.
>
> Alternatively, you can also pin a channel from its details page.
>
> * Open the channel that you want to pin.
> * Click the **More actions** (⋮) icon at the top right of the channel header.
> * Select **Pin Channel**.
>
> [https://drive.google.com/file/d/1UHq2Xdj07c\_HXPXfUV49wJjgd7pHUKJb/preview](https://drive.google.com/file/d/1UHq2Xdj07c_HXPXfUV49wJjgd7pHUKJb/preview)
> [tab] Mobile
>
> * In the Chat Home, tap and hold the channel name. A pop-up menu appears.
> * Select **Pin channel**.
> * The pinned channel will now appear in the **Pinned Conversation** section for quick access.
> * To unpin, tap and hold again and select **Unpin channel**.
>
> [https://drive.google.com/file/d/1VI4ikmO\_7rZKjtKTWrKqiUoXIIfqKjUs/preview](https://drive.google.com/file/d/1VI4ikmO_7rZKjtKTWrKqiUoXIIfqKjUs/preview)
## Archiving a Channel
When a topic or project is complete, archive it to make it read-only and clean up your active list (can be restored later if needed).
> [!NOTE]
>
> Note: Archiving a channel archives it for everyone in the channel.
> [tab] Web
>
> * Open the channel that you want to archive from the sidebar.
> * Click the **More actions** (⋮) icon at the top right of the channel header and select **Archive for everyone**.
>
> [https://drive.google.com/file/d/1QOAJum27o0a357kihxjLuiSwkU9829n9/preview](https://drive.google.com/file/d/1QOAJum27o0a357kihxjLuiSwkU9829n9/preview)
>
> > [!NOTE]
> >
> > **Note:** The #*general* channel cannot be archived.
> [tab] Mobile
>
> * In the Chat Home, tap and hold the channel name. A pop-up menu appears.
> * Select **Archive for everyone**.
>
> [https://drive.google.com/file/d/1p1lAt61pX8nDjKEbpJYbx3tfj69Fb-tB/preview](https://drive.google.com/file/d/1p1lAt61pX8nDjKEbpJYbx3tfj69Fb-tB/preview)
>
> > [!NOTE]
> >
> > **Note:** The #*general* channel cannot be archived.
# Leaving a Channel
Leaving a channel removes you completely from the channel if it’s no longer relevant to you (no more access or notifications).
> [tab] Web
>
> * Hover over the channel name in the sidebar.
> * Click the **More Actions** (⋮) icon and select **Leave this channel**.
>
> Alternatively, you can also leave a channel from the details page.
>
> * From the channel details page, click the **More actions** (⋮) icon in the channel header and select **Leave Channel**.
>
> [https://drive.google.com/file/d/1\_udI9ZcwK2XHtESOCe07tLiYX5nlvQmT/preview](https://drive.google.com/file/d/1_udI9ZcwK2XHtESOCe07tLiYX5nlvQmT/preview)
> [tab] Mobile
>
> * In the Chat Home, tap and hold the channel you want to leave.
> * From the pop-up menu, select **Leave Channel**.
>
> Alternatively, you can also leave a channel or group from its details page.
>
> * Open the channel you want to leave from the Chat Home.
> * Tap the channel name at the top of the chat window to open the details page.
> * Select **Leave channel**, then confirm to exit the channel.
>
> [https://drive.google.com/file/d/1YaHlLGIb0yUfdAAzIbc00Q9if-jIZ\_vx/preview](https://drive.google.com/file/d/1YaHlLGIb0yUfdAAzIbc00Q9if-jIZ_vx/preview)
> [!NOTE]
>
> **Note**: Once you leave a channel, you will no longer see messages or receive notifications from this channel.
# Assigning a Channel Manager
The person who creates a channel automatically becomes its **Channel Manager**. Channel Managers can:
* Add/remove members
* Delete messages
* Assign additional managers
> [tab] Web
>
> * Open the channel where you want to assign a user as a channel manager.
> * Click the member avatars in the top right of the channel header.
> * Hover over a member and click the **More actions** (⋮) icon next to the member’s name.
> * Select **Make Channel Manager**. 
> [tab] Mobile
>
> * Open the channel and tap its name at the top.
> * In the member list, select a user.
> * Choose **Make Channel Manager**.
>
> [https://drive.google.com/file/d/1-tX2z-QAp8VHR7QZHvJYPZ3FfIZ8kQQS/preview](https://drive.google.com/file/d/1-tX2z-QAp8VHR7QZHvJYPZ3FfIZ8kQQS/preview)
> [!NOTE]
>
> Note: The assigned member will now have channel manager privileges and can manage channel settings, add or remove members, and moderate content.
# Removing a Member from a Channel
Removing a member from a channel restricts access for individuals who no longer need to participate in the conversation.
> [tab] Web
>
> * Open the channel from which you want to remove a member.
> * Click the member avatars in the top-right of the channel header to view all members.
> * Hover over the member’s name and click the **More actions** (⋮) icon.
> * Select **Remove from Channel**. 
> [tab] Mobile
>
> * Open the channel from which you want to remove a member.
> * Tap the channel name at the top of the chat window to view existing members.
> * From the members list, select a member.
> * Choose **Remove from Channel**.
>
> [https://drive.google.com/file/d/1-tX2z-QAp8VHR7QZHvJYPZ3FfIZ8kQQS/preview](https://drive.google.com/file/d/1-tX2z-QAp8VHR7QZHvJYPZ3FfIZ8kQQS/preview)
The removed member will no longer have access to the channel or its messages.
With Channels in Zuper Chat, your team can move faster, reduce scattered messages, and keep job-related discussions tightly connected to the actual work, all while maintaining clear organization and focus.
Whether you're in the office or on-site, Zuper Chat helps ensure nothing falls through the cracks.
# Direct Messages
Source: https://docs.zuper.co/Chat/Direct-Messages
A Direct Message (DM) is a private, one-to-one conversation between users that happens outside of channels. For instance, you can use DMs to quickly ask questions, clarify details with a specific user, or follow up on tasks, jobs, or requests without involving a larger audience.
> [!NOTE]
>
> **Note**: Admins can initiate direct messages with any user. Field Executives (FEs) and Team Leads (TLs) can start direct messages only with users within their own team. However, they can still access and continue direct messages that have already been initiated by admins.
# Starting a New DM
To initiate a private conversation with a user in Zuper, follow these steps:
> [tab] Web
>
> * Click the **+ icon** in the header.
> * Select **New Direct Chat**
> * Search for the member’s name and select them to start a DM.
>
> [https://drive.google.com/file/d/1dwPBHs\_tyLeiPETLEBdfJbumpp6A\_wV7/preview](https://drive.google.com/file/d/1dwPBHs_tyLeiPETLEBdfJbumpp6A_wV7/preview)
> [tab] Mobile
>
> * In the **Chat Home**, tap the **+** icon at the bottom-right.
> * Search for the user and tap their name to start a new DM.
>
> [https://drive.google.com/file/d/1jCuzK8CoVJG\_2pC\_nmnUUChVokdRcom8/preview](https://drive.google.com/file/d/1jCuzK8CoVJG_2pC_nmnUUChVokdRcom8/preview)
# Muting a DM
Muting a conversation helps you minimize distractions by pausing notifications from a direct message. You can still view messages at any time, but they just won’t trigger alerts or show the unread count.
> [tab] Web
>
> * Hover over the DM in the sidebar
> * Click the **More actions** (⋮) icon.
> * Select **Mute this conversation** to stop receiving notifications.
> * To unmute, repeat the same steps and select **Unmute this conversation**.
>
> Alternatively, you can also mute a conversation from its details page.
>
> * Open the DM that you want to mute.
> * Click the More actions (⋮) icon in the DM header and select **Mute Conversation**.
>
> [https://drive.google.com/file/d/1bCsCiocgZKk5Eq3uu2Wpo6ycxnaO3ii7/preview](https://drive.google.com/file/d/1bCsCiocgZKk5Eq3uu2Wpo6ycxnaO3ii7/preview)
> [tab] Mobile
>
> * In the Chat Home, tap and hold the user name. A pop-up menu appears.
> * Select **Mute conversation** to disable notifications.
> * To unmute, tap and hold again and select **Unmute conversation**.
>
> Alternatively, you can also mute a conversation from its details page.
>
> * Open the user name that you want to mute.
> * Tap the username at the top of the chat window.
> * In the conversation details page, **toggle on Mute** **conversation** to disable notifications.
>
> [https://drive.google.com/file/d/1A96t\_GAy94BlPdynk8stNRQajrUu1DyH/preview](https://drive.google.com/file/d/1A96t_GAy94BlPdynk8stNRQajrUu1DyH/preview)
# Pinning a DM
Pinning a conversation keeps it at the top of your sidebar (Web) or Chat Home (Mobile) under Pinned conversations, making frequently used DMs easy to access.
> [tab] Web
>
> * Hover over the DM in the sidebar.
>
> * Click the More actions (⋮) icon.
>
> * Select **Pin this conversation** to keep it at the top of your list.
>
> * To unpin, repeat the same steps and select **Unpin this conversation**.
>
> Alternatively, you can also pin a conversation from its details page.
>
> * Open the DM that you want to pin.
> * Click the More actions (⋮) icon in the DM header and select **Pin Conversation.**
>
> [https://drive.google.com/file/d/1J8s\_oVx5Iu0aEio252qTxlpnEPe9WzV5/preview](https://drive.google.com/file/d/1J8s_oVx5Iu0aEio252qTxlpnEPe9WzV5/preview)
> [tab] Mobile
>
> * In the **Chat Home**, tap and hold the user name. A pop-up menu appears.
> * Select **Pin conversation**.
> * To unpin, tap and hold again and select **Unpin conversation**.
>
> [https://drive.google.com/file/d/1hD3IcN16NOlHqPeguhW5d2yL32ZIr80u/preview](https://drive.google.com/file/d/1hD3IcN16NOlHqPeguhW5d2yL32ZIr80u/preview)
# Messages
Source: https://docs.zuper.co/Chat/Messages
The Chat module includes helpful message actions that make conversations easy to manage and follow. You can edit or delete messages, pin important updates, mark messages as unread, add attachments, react to messages, and reply in threads to keep discussions organized across channels and direct messages.
# Editing a Message
If you’ve made a typo or need to update the content, you can edit any message you’ve sent.
> [!NOTE]
>
> **Note**: Channel Managers and Admins cannot edit messages sent by other users.
> [tab] Web
>
> * Open the channel or DM from the sidebar
> * Hover over the message you want to edit.
> * Click the More Actions () icon.
> * Select **Edit message**.
> * Make your changes, then click the paper plane icon to send your updated message.
>
> 
> [tab] Mobile
>
> * Open the channel or DM from the home page.
> * Tap and hold the message you want to change.
> * Select **Edit Message** from the pop-up menu.
> * Make your edits and then tap the paper plane icon to send the updated message.
>
> 
> [!NOTE]
>
> Note: If you need to copy any message from a direct message chat to reuse or reference it elsewhere, select **Copy Message** from the menu. The text will be copied to your clipboard for reuse.
# Deleting a Message
If you no longer want a message to appear in a conversation, you can delete it.
> [tab] Web
>
> * Open the channel or DM.
> * Hover over the message you want to delete.
> * Click the More Actions () icon.
> * Select **Delete message**.
> * Click **Delete** again to confirm.
>
> 
> [tab] Mobile
>
> * Open the channel or DM.
> * Tap and hold the message you want to delete.
> * Select **"Delete Message"** from the pop-up menu, and then confirm by tapping **"OK"**.
>
> 
> [!NOTE]
>
> Note: Deleting a message is a permanent action that removes it for everyone in the channel or direct message. Channel Managers and Admins can delete messages of other users in a channel.
# Pinning a Message
Pinning a message allows you to highlight key information, such as important updates, links, or attachments, so that team members can easily refer to them later.
> [tab] Web
>
> * Open a channel or DM.
> * Hover over the message you want to pin and click the "**Pin**" icon.
> * The message will now appear under the **Pinned** tab in the conversation header for all members to view.
>
> [https://drive.google.com/file/d/1Cv-dvM1Z1gb8G-FY6WFr7MQXYlit8DAQ/preview](https://drive.google.com/file/d/1Cv-dvM1Z1gb8G-FY6WFr7MQXYlit8DAQ/preview)
> [tab] Mobile
>
> * Open the channel or DM.
> * Tap and hold the message you want to pin. A pop-up menu appears.
> * Select **Pin to this Chat**.
> * You can then view the pinned message by tapping the channel or user name at the top of the chat window and selecting **Pinned messages**.
>
> [https://drive.google.com/file/d/1dMzRPlu5otJCsqMO1V\_suH-LAWxYLhCl/preview](https://drive.google.com/file/d/1dMzRPlu5otJCsqMO1V_suH-LAWxYLhCl/preview)
# Marking Messages as Unread
If you want to revisit a message later, you can mark any message as unread. This helps you stay organized by treating the message and the following messages as new until you’re ready to respond.
> [tab] Web
>
> * Open a channel or DM.
> * Hover over the message you want to mark as unread.
> * Click the More actions ( ) icon.
> * Select **Mark as Unread**.
>
> 
> [tab] Mobile
>
> * Open the channel or DM.
> * Tap and hold the message you want to mark as unread. A pop-up menu appears.
> * Select **Mark as Unread**.
> The message will then be highlighted as unread, making it easy for you to find later.
>
> 
# Viewing Unread Messages
You can easily access all messages you haven’t opened or have marked as unread from the sidebar or home.
> [tab] Web
>
> * Navigate to the **Unread** tab in the Chat sidebar.
> * You can view all conversations (DMs and Channels) with unread messages.
>
> [https://drive.google.com/file/d/1gohUMyPkTREa\_XhJLF\_JC75qxsDTBbAf/preview](https://drive.google.com/file/d/1gohUMyPkTREa_XhJLF_JC75qxsDTBbAf/preview)
> [tab] Mobile
>
> * On the chat home screen, tap the **Unread** tab.
> * This opens a feed of all unread messages, including DMs and channel messages.
> * Tap a message to open it in the chat window.
>
> [https://drive.google.com/file/d/15YX9QgRr8lVESs5FqAh1khUja2YmIcQK/preview](https://drive.google.com/file/d/15YX9QgRr8lVESs5FqAh1khUja2YmIcQK/preview)
> [!NOTE]
>
> **Note**: Once an unread message is opened, it is automatically marked as read.
# Adding Attachments
You can add attachments in Chat to share important files, images, or videos with your team, whether it’s a project brief, invoice copy, or photos from the field.
You can easily access attachments in a conversation from the ‘**Files**’ and ‘**Photos** and **Videos**’ sections within a conversation.
> [tab] Web
>
> * Click the paper clip icon in the message composer.
> * Upload the necessary file(s) from your computer.
> * Click the paper plane icon to send the message with the attachment.
>
> [https://drive.google.com/file/d/1iiDu-YycU3GZ6J-2BEDIpBUWSrKl5OeE/preview](https://drive.google.com/file/d/1iiDu-YycU3GZ6J-2BEDIpBUWSrKl5OeE/preview)
> [tab] Mobile
>
> * Open the channel or direct message.
> * Tap the **+** (plus) icon next to the message field.
> * Choose from the available options:
> 1. **Take a picture**: Capture and attach a photo instantly using your mobile camera.
> 2. **Record a video**: Record a short video clip and share it directly in the chat.
> 3. **Choose from gallery**: Select an existing photo or video from your device’s gallery.
> 4. **Upload a file**: Attach documents, spreadsheets, PDFs, or other files stored on your device.
> 5. **Scan a document**: Use your camera to scan and upload physical documents as images or PDFs.
>
> Once you’ve added the desired attachment, tap the paper plane icon to share it in the conversation.
>
> [https://drive.google.com/file/d/1NDlAXrskl\_7P-IRAke3\_YKQIDHSCojeq/preview](https://drive.google.com/file/d/1NDlAXrskl_7P-IRAke3_YKQIDHSCojeq/preview)
# Using Emoji and Reactions
Emoji reactions let you respond quickly without sending another message.
> [tab] Web
>
> * Hover over the message and click the emoji icon.
> * Select an emoji from the menu to send.
> * To remove a reaction, click it again.
>
> 
> [tab] Mobile
>
> * Tap and hold the message you want to react to. A pop-up menu appears.
> * Tap the emoji you want to react with.
>
> 
# Mentioning Users & Entities
You can mention Users or share entities such as Jobs, Customers, Projects, Quotes, and Invoices directly in your messages.
> [tab] Web
>
> * In the message composer, type @ or click on the icon.
> * Select a user or entity from the list that appears or type the name to search.
> * You can mention multiple users or share multiple entities in the same message.
> * You can click the entity mentioned to open its details page for a complete view.
>
> [https://drive.google.com/file/d/1yl6nqS25rpz8ojiuXpHhXk8L8LoQPJnI/preview](https://drive.google.com/file/d/1yl6nqS25rpz8ojiuXpHhXk8L8LoQPJnI/preview)
> [tab] Mobile
>
> * Tap the icon in the message composer.
> * Select a user or entity from the list that appears, or type the name to search.
> * You can mention multiple users or entities in the same message.
> * You can click the entity mentioned to open its details page for a complete view.
>
> [https://drive.google.com/file/d/1LxvJpY1WmQsQQMYju9zapuPghdu8MzcP/preview](https://drive.google.com/file/d/1LxvJpY1WmQsQQMYju9zapuPghdu8MzcP/preview)
> [!NOTE]
>
> Note: Mentioned users are notified and can access the messages in which they are mentioned from the "Mentions" tab in the Sidebar (web) and from Home (mobile).
# Threads
Threads help keep conversations organized by allowing you to reply directly to a specific message instead of starting a new conversation in the main chat. This makes it easier to follow discussions and maintain context within busy channels.
### Viewing Threads
> [tab] Web
>
> * To view all your active or unread threads, click the **Ellipsis** (⋯) icon at the top right of the chat sidebar.
> * Select **Threads** to open a list of all ongoing threaded conversations.
> * Click any thread to open it directly in the chat window and view the complete discussion.
> [tab] Mobile
>
> * On the chat home screen, tap the **Threads** tab.
> * This opens a feed of all your active and unread threads.
> * Tap any thread to open it and view the full conversation.
### Replying to Threads
> [tab] Web
>
> * Open the specific channel or DM.
> * Hover over the message you want to reply to.
> * Click the thread reply icon.
> * A **Thread Reply** panel opens on the right side of the chat window.
> * Type your reply in the message field. You can also add attachments, mentions, or emojis if needed.
> * Click the paper plane icon to send your threaded reply.
>
> [https://drive.google.com/file/d/1ClkRW1zMmhC8OCyk89yas\_7j2hT\_pezd/preview](https://drive.google.com/file/d/1ClkRW1zMmhC8OCyk89yas_7j2hT_pezd/preview)
> [tab] Mobile
>
> * Open the specific channel or DM.
> * Tap and hold the message you want to reply to.
> * Select **Thread reply** from the pop-up menu.
> * A thread view opens where you can type your reply. Add attachments and mentions as needed.
> * Tap the paper plane icon to send your reply.
>
> [https://drive.google.com/file/d/15-XpwtESikpS-HTuCAql6x92-psWMu9d/preview](https://drive.google.com/file/d/15-XpwtESikpS-HTuCAql6x92-psWMu9d/preview)
# Notifications
You will be notified about new messages and mentions in DMs and Channels you are a member of.
Notifications can be accessed from the Chat Notification centre in the web app.
# Search in Chat
Source: https://docs.zuper.co/Chat/Search
The Search feature in Chat helps you quickly:
* Locate specific users, messages, and channels across the chat module.
* Sort message results by creation date.
* Filter message results by sender or channel.
> [tab] Web
>
> * Click the Search icon at the top right of the Chat sidebar.
> * Type your keyword — for example, a user’s name, message content, or channel name.
> * The search window displays categorized results under:
> 1. **Messages** – Displays messages that include the search term.
> 2. **Users** – Lists users whose names match your search term.
> 3. **Channels** – Shows channels containing the keyword in their title.
>
> **Using Filters in Search (Messages Only)**
>
> Filters are available when the **Messages** tab is selected, and help refine your results:
>
> You can organize and narrow results using the following options:
>
> * **Sort** (Created At): Use the Sort option to organize message results by their created date (Newest or Oldest).
> * **From**: Select and view messages shared by a specific user.
> * **In:** Select and view the channels where the message was sent.
>
> After applying the required filters, select a search result to open the corresponding conversation directly.
>
> [https://drive.google.com/file/d/1Jn2pcHw1GqfRMl4aDFmICaHQpcHrbi8z//preview](https://drive.google.com/file/d/1Jn2pcHw1GqfRMl4aDFmICaHQpcHrbi8z//preview)
> [tab] Mobile
>
> * In Chat Home, tap the Search bar.
> * Enter a keyword to search across DMs, channels, and messages. Results will be categorized under Messages, Channels, and Users.
>
> **Using Filters in Search (Messages Only)**
>
> Filters appear only within the Messages tab:
>
> * Tap **Sort & Filter** to organize results by:
> 1. Most Relevant- Displays messages that best match your search keywords.
> 2. Newest: Shows the most recently sent messages first.
> 3. Oldest: Displays the earliest sent messages first.
> * After selecting a sort option, you can refine further using:
> 1. **From** – Select and view messages shared by a specific user.
> 2. **In** – Select and view the channels where the message was sent.
> * Tap **Apply** to view the sorted results and select the desired search result to open the conversation directly in the chat window.
>
> [https://drive.google.com/file/d/14BB5Jo46dVePfZldT5wOXiiU3o-iJZgP/preview](https://drive.google.com/file/d/14BB5Jo46dVePfZldT5wOXiiU3o-iJZgP/preview)
# Quick Start Guide
Source: https://docs.zuper.co/Chat/quickstart-guide
The Chat feature enables faster team communication and real-time alignment through instant messaging. Use **Direct Messages** (DM) for private one-to-one discussions and **Channels** for group collaboration on teams, jobs, or topics. Chat is available on the web (V3) and mobile apps.
## Pre-requisites
Before you start, make sure the following requirements are met:
* Chat is available on Web V3, iOS v4.0.3+, and Android v4.1.7+.
* The Chat feature must be enabled for your organization. Contact your Customer Success Manager or email [support@zuper.co](mailto:support@zuper.co) to enable it.
* Your access and actions depend on your role (Admin, Team Lead, Field Executive).
## Getting Started: Sidebar (Web) / Home (Mobile)
The Sidebar on web and the Home screen on mobile are where all conversations live.
From here, you can:
* View all conversations, including Direct Messages, Channels, and Pinned conversations.
* Filter conversations by Unreads, Recents, Threads, or Mentions.
* Start a new Direct Message or Channel.
* Search across Messages, Users, and Channels.
> [tab] Web
>
> [https://drive.google.com/file/d/18hbHd4u-4FZsHlDZJSvQj\_OnNCm2f4R\_/preview](https://drive.google.com/file/d/18hbHd4u-4FZsHlDZJSvQj_OnNCm2f4R_/preview)
> [tab] Mobile
>
> [https://drive.google.com/file/d/1CP3coTAoNVhalAiI8sZByBcJ2F8NvAHQ/preview](https://drive.google.com/file/d/1CP3coTAoNVhalAiI8sZByBcJ2F8NvAHQ/preview)
## Direct Messages (DMs)
Direct Messages are one-to-one conversations between users.
**Who can start DMs**:
* Field Executives and Team Leads can start DMs with their own team members.
* Admins can start DMs with any user.
> [!NOTE]
>
> Note: Field Executives and Team Leads can view and reply to DMs initiated by Admins.
> [tab] Web
>
> [https://drive.google.com/file/d/1dwPBHs\_tyLeiPETLEBdfJbumpp6A\_wV7/preview](https://drive.google.com/file/d/1dwPBHs_tyLeiPETLEBdfJbumpp6A_wV7/preview)
> [tab] Mobile
>
> [https://drive.google.com/file/d/1jCuzK8CoVJG\_2pC\_nmnUUChVokdRcom8/preview](https://drive.google.com/file/d/1jCuzK8CoVJG_2pC_nmnUUChVokdRcom8/preview)
## **Channels**
Channels let teams collaborate in group conversations. Zuper supports three types of channels.
### **1. General Channel**
Every organization in Zuper automatically has a **#general** channel. All users are added to this channel by default.
You can use the **#general** channel for:
* Organization-wide announcements
* All-hands updates
* Information everyone needs to stay aligned
> [!NOTE]
>
> Note: The General channel cannot be archived.
### **2. Job-Specific Channels**
Job-specific channels are created to centralize all communication related to a particular job. Each Job Channel is identified by a suitcase icon and is named after the job it belongs to. These channels are initiated from the **Job Details page** → **Chat** → **Start Conversation** and are automatically linked to the job.
> [!NOTE]
>
> **UI Update:**\
> We've repositioned **Job Channels** into a dedicated section in the sidebar, separate from your other channels, for quicker access.

By using a job-specific channel, teams can:
* Share photos, documents, and files related to the job in one place
* Exchange real-time updates as the job progresses
* Receive automated real-time job updates such as clock-in/out, quote acceptance/rejection status, invoice payments, status updates, and user assignment
* Keep all job-related discussions contextually tied to the job details
* Ensure clear communication between office teams and field technicians
> [!NOTE]
>
> **Note**: Any user with permission to view a job can create a Job Channel using the **Start Conversation** button. By default, assigned users, their Team Leads, and users configured in Job General Settings are automatically added as channel members.
### **3. Custom Channels**
Custom channels are created to organize conversations around specific ongoing topics, teams, or projects.
By creating a custom channel, teams can:
* Keep conversations focused and relevant to a particular topic or project.
* Make it easier for members to find past discussions, files, and decisions.
* Collaborate efficiently with the right people, without unnecessary noise
* Maintain clarity as projects evolve or topics continue over time.
## Creating Custom Channels
You can create a channel with one or more members for collaboration.
> [tab] Web
>
> [https://drive.google.com/file/d/1dTg\_64\_FV4wUpCnw8EX0r6Fzec5tz9yN/preview](https://drive.google.com/file/d/1dTg_64_FV4wUpCnw8EX0r6Fzec5tz9yN/preview)
> [tab] Mobile
>
> [https://drive.google.com/file/d/1eGhbLoD\_4GEatXgFQ4IhGQY\_uFTLrA-C/preview](https://drive.google.com/file/d/1eGhbLoD_4GEatXgFQ4IhGQY_uFTLrA-C/preview)
### Channel Managers
Channel Managers can control member access and help keep conversations organized.
**Channel Managers can:**
* Add or remove channel members.
* Assign other users as Channel Managers.
* Delete messages in the channel.
**Who becomes a Channel Manager:**
* **#general channel:**\
All Admins are automatically assigned as Channel Managers.
* **Job channels:**\
The following users are automatically assigned as Channel Managers:
1. Team Leads of the assigned technicians.
2. Primary Technician of the job.
3. User who created the job (if enabled in Job General Settings).
4. Any Admins added to the channel.
* **Other channels:**\
The user who creates the channel is automatically assigned as the Channel Manager.
> [!NOTE]
>
> Note: Admins have Channel Manager permissions in any channel they join, even if not explicitly assigned.
## Managing Conversation
You can manage conversations to stay focused and respond faster. Zuper lets you pin important conversations, mute distractions, and archive channels when they’re no longer active.
### Pin a Conversation
Pinning keeps it at the top in the “Pinned Conversations” for quick access.
> [tab] Web
>
> [https://drive.google.com/file/d/1J8s\_oVx5Iu0aEio252qTxlpnEPe9WzV5/preview](https://drive.google.com/file/d/1J8s_oVx5Iu0aEio252qTxlpnEPe9WzV5/preview)
> [tab] Mobile
>
> [https://drive.google.com/file/d/1hD3IcN16NOlHqPeguhW5d2yL32ZIr80u/preview](https://drive.google.com/file/d/1hD3IcN16NOlHqPeguhW5d2yL32ZIr80u/preview)
### Set a Notification Preference
Updated You can control how you are notified for each channel. Zuper gives you two levels of control, a global preference for all channels, and a channel-level preference for individual channels.
> [accordion] Global notification preference
>
> Your global preference sets the default notification behavior across all channels.
>
> > [tab] Web
> >
> > **Web**
> >
> > 1. Click the **Chat** icon in the top-right corner of the Header bar.
> > 2. Click the icon. A **Notification Preference** panel opens.
> > 3. Choose one of the following:
> > * **All**: You receive a notification for every message in every channel. This is the default.
> > * **Mentions and Direct Messages**: You are only notified when someone mentions you or sends you a Direct Message.
> > 4. Your preference is saved immediately.
> > > [!NOTE]
> > >
> > > **Note:** This setting applies to all channels where no channel-level preference has been set.
> > > 
>
> > [tab] Mobile
> >
> > 1. In the **Chat** home, tap on the icon.
> > 2. Choose **Everything** or **Mentions**.
> >
> > [https://drive.google.com/file/d/1ncI1JKQjjZgm2xV2ZBMRrp0O0gZO6QqI/preview](https://drive.google.com/file/d/1ncI1JKQjjZgm2xV2ZBMRrp0O0gZO6QqI/preview)
> [accordion] Channel-level notification preference
>
> You can override your global preference for any individual channel. Channel-level preferences always take precedence over your global settings.
>
> > [!NOTE]
> >
> > **Note:** Once a channel-level preference is set, it cannot be overridden by the global preference.
>
> > [tab] Web
> >
> > 1. Open the channel and click **More actions (⋮)** in the channel header.
> > 2. Select **Notification Preference**.
> > 3. Choose one of the following:
> > * **All**: You receive a notification for every message in this channel.
> > * **Mentions**: You are only notified when someone mentions you in this channel.
> > * **Mute**: You receive no notifications from this channel.
> >
> > 
>
> > [tab] Mobile
> >
> > 1. In the Chat home, tap and hold the channel name, or open the channel and tap its name to open the details page.
> > 2. Select **Notification Preference**.
> > 3. Choose **Muted**, **Everything**, or **Mentions**.
> >
> > [https://drive.google.com/file/d/1FPQIzaCKmrvay3XUgjRGLj2LvyyMhBN5/preview](https://drive.google.com/file/d/1FPQIzaCKmrvay3XUgjRGLj2LvyyMhBN5/preview)
### Archive a channel
Removes it from view for all users (searchable and restorable later).
> [!NOTE]
>
> Note: DMs and the #general channel cannot be archived.
> [tab] Web
>
> [https://drive.google.com/file/d/1QOAJum27o0a357kihxjLuiSwkU9829n9/preview](https://drive.google.com/file/d/1QOAJum27o0a357kihxjLuiSwkU9829n9/preview)
> [tab] Mobile
>
> [https://drive.google.com/file/d/1p1lAt61pX8nDjKEbpJYbx3tfj69Fb-tB/preview](https://drive.google.com/file/d/1p1lAt61pX8nDjKEbpJYbx3tfj69Fb-tB/preview)
## Sending and Managing Messages
### Mentions
Tag users (@username) or entities (Jobs, Projects, Customers, Quotes, Invoices) — triggers notifications for user mentions; entity mentions link to details.
> [tab] Web
>
> [https://drive.google.com/file/d/1yl6nqS25rpz8ojiuXpHhXk8L8LoQPJnI/preview](https://drive.google.com/file/d/1yl6nqS25rpz8ojiuXpHhXk8L8LoQPJnI/preview)
> [tab] Mobile
>
> [https://drive.google.com/file/d/1LxvJpY1WmQsQQMYju9zapuPghdu8MzcP/preview](https://drive.google.com/file/d/1LxvJpY1WmQsQQMYju9zapuPghdu8MzcP/preview)
### Threads
Reply to a specific message to keep related discussions organized.
> [tab] Web
>
> [https://drive.google.com/file/d/1ClkRW1zMmhC8OCyk89yas\_7j2hT\_pezd/preview](https://drive.google.com/file/d/1ClkRW1zMmhC8OCyk89yas_7j2hT_pezd/preview)
> [tab] Mobile
>
> [https://drive.google.com/file/d/15-XpwtESikpS-HTuCAql6x92-psWMu9d/preview](https://drive.google.com/file/d/15-XpwtESikpS-HTuCAql6x92-psWMu9d/preview)
### Reactions
Add emojis to acknowledge messages quickly.
> [tab] Web
>
> 
> [tab] Mobile
>
> 
### Attachments
Share images, videos, documents — media appears in "**Photos & Videos**"; files in "**Files**" section.
> [tab] Web
>
> [https://drive.google.com/file/d/1iiDu-YycU3GZ6J-2BEDIpBUWSrKl5OeE/preview](https://drive.google.com/file/d/1iiDu-YycU3GZ6J-2BEDIpBUWSrKl5OeE/preview)
> [tab] Mobile
>
> [https://drive.google.com/file/d/1NDlAXrskl\_7P-IRAke3\_YKQIDHSCojeq/preview](https://drive.google.com/file/d/1NDlAXrskl_7P-IRAke3_YKQIDHSCojeq/preview)
### Pinning a message
Highlight key info within a conversation for easy reference.
> [tab] Web
>
> [https://drive.google.com/file/d/1Cv-dvM1Z1gb8G-FY6WFr7MQXYlit8DAQ/preview](https://drive.google.com/file/d/1Cv-dvM1Z1gb8G-FY6WFr7MQXYlit8DAQ/preview)
> [tab] Mobile
>
> [https://drive.google.com/file/d/1dMzRPlu5otJCsqMO1V\_suH-LAWxYLhCl/preview](https://drive.google.com/file/d/1dMzRPlu5otJCsqMO1V_suH-LAWxYLhCl/preview)
### Mark as unread
Flag messages to review later (thread replies excluded).
> [tab] Web
>
> 
> [tab] Mobile
>
> 
### Edit/Delete Messages:
* Users: Can edit/delete their own messages.
* Channel Managers: Can delete others' messages (but can’t edit them).
> [tab] Web
>
> 
> [tab] Mobile
>
> 
## Search
Quickly locate content:
* Search across Messages, Users, and Channels.
* Sort message results by creation date.
* Filter message results by sender or channel.
> [tab] Web
>
> [https://drive.google.com/file/d/1Jn2pcHw1GqfRMl4aDFmICaHQpcHrbi8z/preview](https://drive.google.com/file/d/1Jn2pcHw1GqfRMl4aDFmICaHQpcHrbi8z/preview)
> [tab] Mobile
>
> [https://drive.google.com/file/d/14BB5Jo46dVePfZldT5wOXiiU3o-iJZgP/preview](https://drive.google.com/file/d/14BB5Jo46dVePfZldT5wOXiiU3o-iJZgP/preview)
This streamlined guide focuses on essential steps to get you started quickly. For deeper details, refer to the articles below:
* **Channels**\
Learn how to create, manage, and collaborate with your team using channels.
* **Direct Messages**\
Learn how to start and manage private conversations with individuals.
* **Messages**\
Learn how to send, receive, and organize messages effectively.
* **Search**\
Learn how to quickly find messages, channels, and conversations using search.
# Applying credits
Source: https://docs.zuper.co/Client/Contact/Applying_credits
Zuper Credits feature allows users to manage and apply credits across modules, where payments can be obtained, such as Invoices, Quotes, and Customer Profiles. Credits can be added, applied, or voided, providing flexibility in payment processing.
**Navigation**: *CRM--> Contacts --> Select a Contact --> Credits --> +*
## **Adding credits**
1. Select the “**CRM**” module from the left navigation menu and choose "**Contacts**.” The Contacts listing page opens.

2. Select a contact from the listing to view its details.
3. On the details page, navigate to **Overview**>>**Highlights**>>**Credits**>>**Add Credits.**

4. Fill in the following details to add credits for the selected contact.

* **Credit Date** - The date on which the credit note needs to be created.
* **Credit Amount -** Enter the credit amount. (e.g., USD 450).
* **Payment Mode** - The mode of payment through which the payment was obtained. (e.g., Check).
* **Remarks** - Additional comments (e.g., pre-payment for services).
5. Click the “**Save**” button to save the credit note for the specified amount against the customer’s profile.
## Applying Credits
* **On Invoices/Quotes**: The "**Apply Credits**" tab displays available credit when you Record Payment for an unpaid invoice. Click the radio button by "**Apply Credits**" to view credit notes with a positive balance. Check the boxes to choose which credit notes to use and adjust the amounts if needed; the invoice amount should exceed the available credit in each note.
* The **Invoice Amount** is the total cost billed to the customer for the goods or services provided, including any taxes or additional fees.
* The **Total Credits** represent the cumulative sum of credits available to the customer, which can be used on the invoice or deposit payments on quotes.
* The **Total Applied Amount** is the portion of the available credits that has been used (or is being applied) to use against the current invoice.

## **Viewing Credits**
* In the Customer Profile, click "**View Credits**" to see credit memos with details like **Credit Name**, **Available Credit**, and **Status** (Unapplied, Partially Applied, Applied).
* **Unapplied** - The credit note has not been used to make any payments.
* **Partially applied** - The credit note has been applied to a payment, but the remaining amount can be used.
* **Applied**- The credit note has no remaining balance and has been fully utilized to make payments.

* Click "**View History**" to view the table showing **Credit Name**, **Available Credit**, **Used Credit**, **Amount Credited**, and **Status**.

## **Refunds and void**
* For non-Zuper Pay customers, clicking the kebab menu displays three options: View Details, which takes you to the transaction details; Void, which allows you to void the Payment; and Refund Transaction, which enables you to create a credit note for the customer.
> [!NOTE]
>
> **Note:** When you refund a customer, the payment status is switched to partially refunded, and the invoice status changes to partially paid.
### **For Zuper Pay Customers**
If Zuper Pay is enabled, you can initiate full or partial refunds directly from an Invoice or payment transaction. You can issue a credit note against this payment. A credit note is created from the customer’s profile.

## **Reporting**
Credit History Report: This report is exportable and has the following columns: Credit Note Number, Opening Balance, Closing Balance, Applied Amount, Transaction, Action, Credited, Remarks, and Date.
## **Notifications**
* Customers receive notifications via a dialog box when credits are added, deleted, or refunded.
## **Permissions**
* Only an Admin user has permission to create and apply credit notes.
## **Impact across modules**
* Invoices: The "**Record Payment**" button offers conventional payment methods and credit application tabs.
* **Quotes**: The Record Payment button offers payment methods and credit application tabs.
**Customers**: Edit screen includes fields for **Credit Name**, **Date**, **Payment Method**, **Amount**, and **Remarks**. A "**Download**" button generates a report.
## **Payment listing**
Payments made with credits have the payment mode as Credits.
There is a credit note beside the status for partially refunded transactions. The status of such transactions would be partially refunded.

# Adding new contact
Source: https://docs.zuper.co/Client/Contact/Create_contact
Adding a contact allows you to manage individual client information. This includes essential details such as the contact's name, phone number, email address, preferred time zone, and association with an organization or property.
By creating a contact, you can easily communicate with the right individuals, assign them to jobs or service requests, and maintain a detailed history of all interactions.
Follow the steps below to add a new contact and link them with organizations or properties as needed.
**Navigation**:CRM -> *Contacts* -> + *New Contact*
* Select the "**CRM**" module from the left navigation menu and choose "**Contacts**".
* The Contacts listing page opens.
* Click the "**+ New Contact**" button at the top right corner of the page.

Fill in the following sub-sections:
1. **Primary Details**
* **First Name** (*Mandatory*): Enter the contact’s first name.
* **Last Name**: Enter the contact’s last name. This field is optional but helps in full-name identification.
* **Organization**: Select the organization the contact is associated with. This links the contact to a business entity.
* **Email (***Mandatory***)**: Provide the contact's official email address. This email will be used for sending job-related notifications, invoices, and other communications.
Sending job-related notifications and updates.
Auto-populating the recipient field when sending invoices.
Delivering quote approvals and payment receipts.
> [!NOTE]
>
> If this field is left blank, the recipient email will not auto-populate when you send an invoice associated with this contact, requiring manual entry each time. Always ensure a valid email is saved here to enable seamless invoice delivery.
* **Preferred Timezone**: Choose the timezone that applies to the contact. This ensures that all time-sensitive activities, such as job scheduling and alerts, are correctly aligned with their local time.
* **Category**: Select a category that best classifies the contact (e.g., decision-maker, technician, billing). Helps in filtering and reporting.
* **Accessible by everyone**: Indicates if the contact should be visible to all users. Set to “**No**” by default to restrict visibility.
* **Account Manager** (*Mandatory*): Choose the internal user responsible for managing this contact. Required to ensure accountability.
* **Tags**: Add one or more tags to help categorize and search for the contact easily.
* **Has SLA**: Specify whether the contact is covered under a Service Level Agreement (SLA). Select an option from the dropdown.
* **Pricelis**t: Select the relevant price list to be applied when jobs or services are performed for this organization.
* **Description**: Provide a brief description for this contact.

### Lead Source
The **Track Lead Source** option helps you record the origin of your leads. Enabling this setting ensures every new customer or job record includes a field to capture and report the source of the lead. This feature improves marketing insights, sales performance tracking, and lead attribution.

**Prerequisites**
* Admin or user role with permission to manage customer and contact settings.
**Enable Lead Source Tracking**
To learn how to enable Lead Source Tracking, see [Enable Lead Source](https://docs.zuper.co/Settings/Modules/Customers-Contacts/Customers-Contacts-Settings#enable-lead-source)
**Create and Manage Lead Sources**
To learn how to create Lead Sources, see [Lead Sources](https://docs.zuper.co/Settings/Modules/Customers-Contacts/Customers-Contacts-Settings#lead-sources)
* These lead sources will appear as selectable options when users assign a source to a customer /contact or job record.
> [accordion] Using Lead Source Data
>
> ## **Using Lead Source Data**
>
> * View the lead source in customer /contact details or Job details.
> * Filter customers/contacts and jobs by lead source in lists by filtering them as "**Source**".
> * Use this data to evaluate which channels bring the most leads.
> > [!NOTE]
> >
> > Note: The first job will inherit the lead source from the customer record. The second job onwards, it should be manually selected.
>
> **Reporting and Analytics**
>
> **Reports**
>
> The **Source** field has been added as a column in core reports to enhance tracking and analysis:
>
> * **Job Master Report**
> * **Customer Master Report**
> * **Report Builder** (fully integrated for custom report creation)
>
> **Dashboard Widget**
>
> A new **Horizontal Bar Chart Widget** has been introduced to visualize Lead Source metrics directly on the dashboard:
>
> * **Lead source**: Displays the lead sources.
> * **No. of Jobs**: Shows the “**Total number of Jobs against that particular lead source**.”
> * **On hover**: Reveals the total job value against that particular lead source.
> * **Filterable by date range**: Users can apply custom date filters to focus on specific periods (e.g., quarterly or yearly trends).
>
> This widget enables you to identify top-performing lead sources and optimize your marketing efforts efficiently.
>
> **Bulk Operations**
>
> **Lead Source** is now available in the Bulk Update feature for efficient data management:
>
> * **Customer Module**: Update Lead Sources in bulk for multiple customers at once.
> * **Job Module**: Apply Lead Source changes across batches of jobs.
>
> This streamlines onboarding and corrections, eliminating the need for manual entry for each record.
>
> **Filtering**
>
> Enhanced filtering options have been added to improve search and navigation:
>
> * **Filter by Source** on the **Job Listing Page**.
> * **Filter by Source** on the **Customer Listing Page**.
>
> **Dynamic Updates**: Results refresh in real-time as users select or multi-select lead sources, ensuring quick and relevant views without page reloads.
>
> **Configuring Lead Source Sync in HubSpot-Zuper Integration**
>
> To enable seamless Lead Source tracking across HubSpot and Zuper, follow these steps for setup and mapping:
>
> • **Create Custom Lead Source Fields in HubSpot:** Individually add a custom field for "**Lead Source**" to the Contact and Deal entities in HubSpot. This field will capture the origin of leads.
>
> • **Map Fields in Zuper HubSpot Integration Settings**: Once created, navigate to Zuper Settings > Integrations > HubSpot. Map these HubSpot fields to Zuper's primary Lead Source fields in the Customer/Contact and Jobs modules.
>
> • **Sync Direction and Data Flow:** With mapping complete, Lead Source information flows bidirectionally: Depending on the integration direction (**HubSpot** → **Zuper** or **Zuper** → **HubSpot**, or **both ways**), updates propagate automatically, ensuring consistency across platforms.
>
> **Best Practices**
>
> * Define a standard list of lead sources to maintain consistency.
> * Encourage team members to fill in the lead source for every new record.
> * Utilize reports or dashboards to analyze trends in lead sources.
>
> ### Edge Cases & Validations
>
> In Zuper, the Lead Source feature is designed to be flexible and user-friendly, but it's essential to understand how it behaves in various edge cases. Below is a summary of common scenarios, their expected behaviors, and any relevant notes. This ensures smooth data management and avoids unexpected issues during implementation.
>
> | **Scenario** | **Expected Behavior** | **Notes** |
> | :- | :- | :- |
> | **Job created without a lead source** | Allowed – field is optional. | Users can proceed without selecting a Lead Source; the job will be created successfully, and the field will remain blank. This supports quick entry for non-critical tracking. |
> | **Lead Source removed from master list** | Existing records retain the old value (now marked as inactive). | Removed sources won't appear in new dropdowns or selections, but historical data is preserved for reporting and auditing. No automatic cleanup or migration occurs. |
> | **The customer has no lead source, but the job has the lead source** | Allowed – no backfill required. | Lead Sources are independent per record type (Customer vs. Job). |
> | **User disables "Track Lead Source"** | The field is hidden across the entire UI and not populated for new records. | This global setting (under Admin > Settings) removes the field from forms, reports, dashboards, and filters. Existing data remains intact but is no longer visible or editable until re-enabled. |
2. **Contact Information**
* **Home Number**: Enter the contact’s home phone number. Useful for personal or after-hours communication.
* **Mobile Number**: Enter the contact’s mobile number. This is typically the primary method of communication.
* **Work Number**: Enter the contact’s office or work phone number. Ideal for professional interactions.
3. **Portal Details**
* Portal Access: Specify whether the contact should have access to the customer portal. Set to "**Yes**" to enable access and allow self-service features like viewing jobs, invoices, and quotes.
4. **Tax Details**: Choose the applicable tax settings for the contact based on your region or internal policies. These settings will automatically be applied to invoices and billing documents.
* **Tax Preference**: Choose whether the contact is **Taxable** or **Tax Exempt**. This affects how taxes are calculated for this contact in quotes and invoices.
* **Tax Group**: Pick the appropriate tax group that applies to this contact. Tax groups define the specific tax rates or rules used.
5. **Account Details**
* **Billing Frequency**: Choose how often the contact should be billed (e.g., monthly, quarterly, yearly). Helps automate and manage billing cycles.
* **Payment Term**: Select the agreed-upon payment term for the contact. This defines the time frame within which payment is expected.
6. **Property:** You can associate properties with the contact to ensure seamless tracking of service history and work orders. To add a property,
* Click "**+ Pick Property**" next to the Property section.
* Use the pop-up to search for and select the relevant properties that belong to the contact.
7. **Service and Billing Address**: Add the contact's service and billing locations. You can specify these details in two ways.
* Address Entry: Type the full physical address.
* Geo-Coordinates: Enter latitude and longitude if you want to use exact map-based positioning.
> [!TIP]
>
> For the most accurate location data, use the **"Pick from Map"** option. This allows you to pinpoint the address directly on the map interface.\
> Once you've selected the correct location, click "**Use this Address**" to save the information.
8. **Other Details:** If any custom fields are added under the settings, you can fill in the details here.

After filling in all the details, click **Save Contact**. The Contact will be saved successfully and can be linked to any jobs, quotes, invoices, or service requests.

## Auto-Create property
When [**Auto-Create Property**](https://docs.zuper.co/Settings/Modules/Customers-Contacts/Customers-Contacts-Settings#auto-create-property) is enabled, Zuper creates a property record the moment you save a contact with a valid service address. You do not need to build a property separately or link it manually.
**Note:** Zuper uses the street name from the service address as the property name. For example, a service address of 500 Main Street, New York, creates a property named **500 Main Street**.
When you save, Zuper automatically:
* Creates a new property using the street name as the property name.
* Displays the property under **Properties Associated** in the right panel of the contact detail page, and you can view the property details.
### Address sync between customer/contact and property
Because the contact and property are linked, you never need to update both records separately.
| **If you update…** | **Zuper updates…** |
| :- | :- |
| The service address on the contact | The address on the linked property |
| The address on the property | The service address on the linked contact |

This works in both directions, so it does not matter which record you update first.
> [!NOTE]
>
> **Note:** Sync only works when a property is already linked to a contact. If you saved the contact without a service address, Zuper did not create a property at that point. Adding an address later does not trigger a new property. In that case, create the property manually and link it using **+ Pick Property** on the contact detail page.
# Managing the Contact Detail
Source: https://docs.zuper.co/Client/Contact/Manage_contact
Effectively managing contact information is vital for delivering personalized communication, enhancing customer engagement, and ensuring smooth field operations. Zuper provides a centralized platform to create, organize, and maintain detailed contact profiles that serve as the primary touchpoints for customer interactions.
By consolidating key details such as phone numbers, email addresses, associated organizations or properties, tax preferences, and portal access, Zuper enables your team to interact with the right person at the right time, ensuring faster resolutions and stronger relationships.
This guide will walk you through how to access the Contacts module and efficiently manage contact-related data.
## Accessing the contacts listing page
**Navigation**: Clients -> *Contacts -> Contacts listing page*
* Select the “**Client**” module from the left navigation menu and choose “**Contacts**.”
* You will land on the Listing page, which provides a comprehensive view of all your contacts with key information such as *Contact Name, Status, Email, Work number*, and more.

## **Exploring the listing page**
The Customer/Contact Listing Page layout in Zuper includes view management, column selection, views, and saving customized views. This process is performed directly on the module’s listing page.
**Default Listing Behavior**
The system retains its existing default listing behavior, ensuring that pre-set configurations or default views are preserved. When you first access the Customer/Contact Module Listing Page, you’ll see the default view with columns such as Customer/Contact Number, Customer/Contact Address, Customer/Contact Tags, and Customer/Contact Status.
## **Create view configuration**
**Selecting Columns**
You can choose which columns to display to focus on relevant data:
1. Select the “**Customer/Contacts**” module from the left navigation menu. You can view the listing page.

2. From the “Views” list, click “**+Create new view**.”

3. A “**Create View**” dialog box appears.
View Name (**Mandatory**) – Enter the view name.
Share with - Select any one of the options (User, Team), and you can add the relevant users.
Visibility to all users – Toggle on to make this view visible.
Click "**Create**" to create a new view.

4. Once you click “**Create**,” the **Columns** sidebar appears, showing “**Available Columns**” and “**Displayed Columns**.” To add a column, drag it from the “**Available Columns**” list on the left to the “**Displayed Columns**” list on the right. You can click “**Continue**.”

5. To remove a column, drag it from the “**Displayed Columns**” list back to the “**Available Columns**” list or click the **-** next to the column name. Click **Continue** to apply the changes.

6. If you wish not to add any filter, click “**Skip and Save**” to create the view.

7. The view is saved successfully.

## **Applying filters**
The Filter feature lets you refine your view by applying multiple filters based on available attributes. For example, you can select an attribute like "**Customer/Contact Status Type**," choose conditions such as "**Equal to**," "**Contains**," or "**Does Not Contain**," and choose the desired value. Once the filter is applied, the results will update to show only the Customer/Contacts that meet your criteria, making it easier to find and manage relevant Customer/Contacts.
1. Click "**Filter"** at the top left of the page. Choose the attributes you want to filter by, apply the desired conditions, and click the "**Add"** button to view the results.

2. Click “**Update View**” to modify the existing view.

3. The new view is set successfully with the filter. You can view the filter created and the filter name from the view list.

## **Update view**
An update view allows you to modify the current display settings of the "**Customer/Contacts**" section. After making changes, you can save the updated configuration to the existing one or name it a new view.
1. Add/remove the existing columns and click “**Update View**” to modify the existing view.

2. The view is updated successfully.

3. Click the down arrow below the “**Update View**” to create a new view by clicking “**Save as new view**.”

4. A “**Create View**” dialog box appears.
* View Name (**Mandatory**) – Enter the view name.
* Share with - Select any one of the options (User, Team), and you can add the relevant users.
* Visibility to all users – Toggle on to make this view visible.
Click “**Create**” to create the new view.

5. Click “**Reset View**” to reset the current view.

## **Setting permissions for views**
### **Edit Permissions**
Users with edit permissions can modify the layout:
* They can add/remove columns, reorder them, and adjust views as described above.
* If permission is given, changes can be saved as a new view or overwritten as an existing one.
### **View Permissions**
Users with view-only permissions can see the layout but cannot make changes:
* They can view the customized columns and filters but cannot edit them. To ensure consistency for viewers, they can save them as a new “**View**.”
### **Make changes to the view**
* **Rename**: This option allows you to change the view's name (e.g., from “New\_Customer” to something else).
* **Visibility**: This lets you adjust who can see the view. Options include sharing with a user or team or keeping it private (“Only Me”), as well as toggling visibility for all users in Zuper (as shown in the “Create a View” dialog in prior images).
* **Duplicate**: This function creates a copy of the “New\_Customer” view, allowing you to modify the duplicate without affecting the original.
* **Delete**: Removes the view entirely. Since this is a custom view, deleting it would revert the listing to the default view or another saved view. Only the created user can delete the view.

The Customer/Contact Module Listing Page in Zuper allows for flexible layout customization directly on the listing page. You can select and reorder columns, apply views, save customized views, and set permissions to ensure the right level of access for your team. Use the steps above to tailor the view to your workflow and save it for future use.
## Pinned filters
Zuper's Customers module lets you use pinned filters to streamline your filter experience. Pinned filters keep your most-used criteria readily accessible for quick application.
Pin up to 3 filters in any module.
Navigation: *Clients -> Customers -> Filters -> Pinned Filter*
1. Select the “**Clients**” module from the left navigation menu. Choose the “**Customers/Contacts**.”

2. **Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

3. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters.

After filtering a specific Customer/Contact, click the “**Name**” on the listing page to view and manage its details on the Customer/Contact details page.
### Creating a new contact
You can quickly create a new contact directly from the listing page.
1. Click the "**+ New Contact**" button in the top right corner.
2. Fill in the required fields such as Contact Name, Contact Information, Tax Details, and Service Addresses.
3. For a step-by-step walkthrough, refer to the [Creating a new contact](https://docs.zuper.co/Client/Contact/Create_contact) article.

## **Managing contact details**
Once you select a contact from the Contacts listing page, the Contact Details page opens. It provides a centralized workspace to view and manage contact information, associated records, recent activity, notes, and attachments. The page follows a three-panel layout consisting of the left panel, center panel, and right panel.

### Left Panel- Contact Information
The left panel displays the contact's basic information and provides quick access to commonly used actions.
At the top of the panel, you can view the contact's name and address. You can also access quick actions to create a related record, send an email, make a call, add a note, or perform other contact-related actions.
Below the contact information, the Primary Details section displays key information, including:
* Organization: The organization associated with the contact.
* Category: The category assigned to the contact.
* Email: The contact's email address.
* Home: The contact's home phone number.
* Work: The contact's work phone number.
* Mobile: The contact's mobile number.
* Tags: Tags associated with the contact.
* Lead Source: The source from which the contact was acquired.
* Pricelist: The pricelist associated with the contact.
* Status: The current status of the contact.
* Service Address: The address where services are provided.
* Billing Address: The contact's billing address.
* Portal Access: Indicates whether the contact has access to the customer portal.
* Tax Preference: Displays the contact's tax preference.
## Center Panel – Contact Workspace
The center panel provides access to contact-related information through different tabs. These tabs help you view and manage records associated with the contact.
> [accordion] Overview
>
> The Overview tab provides a summary of the contact's information, including key highlights, recent activity, and associated records.
>
> You can view the following sections:
>
> * Highlights: Displays key financial and communication information, such as receivables, credits, and the last email date.
> * Recent Activity: Shows the latest actions and updates performed on the contact.
> * Recent Jobs: Displays jobs associated with the contact, including job numbers, statuses, and scheduled dates.
> * Recent Quotes: Displays quotes created for the contact, along with their estimate numbers, due dates, statuses, and total amounts.
> * Recent Invoices: Displays invoices associated with the contact and their details.
> [accordion] Jobs
>
> The Jobs tab displays all jobs associated with the contact. You can review job details, track their statuses, and access individual job records.
> [accordion] Quotes
>
> The Quotes tab displays quotes created for the contact. You can review estimate numbers, due dates, statuses, and total amounts.
> [accordion] Invoices
>
> The Invoices tab displays invoices associated with the contact, helping you review billing records and payment statuses.
> [accordion] Payments
>
> The Payments tab displays payments received from the contact, allowing you to review payment-related records.
> [accordion] Projects
>
> The Projects tab displays projects associated with the contact. You can access the project records to review their details and track progress.
> [accordion] Work Orders
>
> The Work Orders tab displays work orders associated with the contact, allowing you to review and manage related service work.
> [accordion] Material Orders
>
> The Material Orders tab displays material orders associated with the contact, helping you track requested materials and their fulfillment.
> [accordion] Requests
>
> The Requests tab displays service requests raised by the contact. You can review and manage the requests from this section.
> [accordion] Communication
>
> The Communication tab displays communication records associated with the contact, such as emails and calls.
> [accordion] Assets
>
> The Assets tab displays assets associated with the contact, providing access to their related records.
> [accordion] Contracts
>
> The Contracts tab displays contracts linked to the contact, allowing you to review the associated agreements.
> [accordion] Properties
>
> The Properties tab displays properties associated with the contact. You can access these records to view property-related information.
> [accordion] Outbound Logs
>
> The Outbound Logs tab displays logs of outbound communications sent to the contact.
> [accordion] Notes
>
> The Notes tab displays notes added to the contact. You can add comments, reminders, or supporting information and review existing notes.
> [accordion] Activity
>
> The Activity tab provides a chronological history of actions and updates performed on the contact. It helps you track changes and monitor contact-related activities.
> [accordion] Gallery
>
> The Gallery in Contacts includes photos and videos associated with the contact, bringing all contact-related media into one unified view. You can browse, filter, and organize media uploaded across jobs linked to the contact.
>
> For more information about the available Gallery actions, see the [Jobs Gallery](https://docs.zuper.co/Work_Order_Management/Jobs/Jobs_gallery) article.
>
> 
>
> > [!NOTE]
> >
> > **Note**: Photos and videos added to a job's Gallery are also available in the associated customer's Gallery. However, media uploaded directly to the customer's Gallery is not automatically associated with jobs created for that customer. When you select [**Filter > Show Related**](https://docs.zuper.co/Work_Order_Management/Jobs/Jobs_gallery#filtering-media) in the Job's Gallery, all media uploaded directly to the customer's Gallery is also displayed.
### Right panel
The right panel displays files attached to the contact. You can view existing attachments and upload additional files using the + icon or the Add Attachments button.
## More actions
The More Actions menu at the top-right corner of the page provides additional options for managing the contact. The available actions include:

> [accordion] Edit Contact
>
> Update the contact’s information, such as name, email, phone numbers, or associated organization.
>
> > [!NOTE]
> >
> > **Updating a contact's email does not update existing jobs.**
> >
> > When you change the email address on a contact profile, Zuper saves the new email on the profile only. Jobs that were already created keep the original email address in their service contact details. You must update each existing job manually to reflect the new email.
> [accordion] Email/Text
>
> Instantly send an email or text to the contact directly from the system for quick communication.
> [accordion] Print/Send Statement
>
> Generate and share a print-friendly version of the contact’s financial statement, including invoices and payment history.
> [accordion] Merge Contact
>
> Combine duplicate contacts into a single profile to avoid redundancy and maintain clean records.
> [accordion] Deactivate
>
> Temporarily disable a contact without deleting their data, preserving historical information for future reference. Once deactivated, you will have the option to activate or delete the contact.
### View Auto-Created Property
When Auto-Create Property is enabled, Zuper automatically creates a property record when you save a contact with a valid service address. You don't need to create or associate the property manually.
To view the auto-created property:
1. Open the contact details page.
2. Locate the Properties tab.
3. Select the property to view its details. A quick-view panel opens showing the property name, location, number of jobs, and associated contacts. This is a good way to get a summary without leaving the page.
4. To see the full property record, select **View details in a new tab** in the quick-view panel.

## FAQs
> [accordion] I updated a contact's email address. Why do my existing jobs still show the old email?
>
> Zuper saves the new email on the contact profile only. It does not automatically apply the change to jobs that were created before the update. Each existing job stores its own copy of the service contact details at the time the job was created.
>
> To update the email on an existing job, open the job and edit the service contact details directly. You must do this for each affected job individually.
>
> If the issue continues, contact [Support](mailto:support@zuper.co).
> [accordion] Why did an SMS notification reach the wrong person?
>
> SMS notifications are delivered to the phone number saved on the contact record. If the same number is saved on more than one contact — for example, on both a primary customer and a secondary contact — the message is delivered to whoever owns that number, while the message content and outbound log continue to reference the primary customer.
>
> To prevent messages reaching an unintended recipient, make sure each contact record holds only that contact's own phone number, and check for duplicate numbers across related contacts.
# Adding new organization
Source: https://docs.zuper.co/Client/Organization/Create_Organization
Adding an organization allows you to manage business-level client information. This includes essential details such as the organization's name, location, tax and billing information, and primary points of contact.
By setting up an organization, you can group multiple customers under one business entity, making it easier to handle corporate accounts, manage multi-site service needs, and generate consolidated reports.
Follow the steps below to set up an organization and link it with customers and service locations effectively.
**Navigation**: Clients -> *Organizations* -> + *New Organization*
1. Select the "**Clients**" module from the left navigation menu and choose "**Organizations**".

2. The **Organizations** listing page appears.
3. Click the "**+ New Organization**" button at the top right corner of the page.

4. Fill in the following sub-sections:
1. **Primary Details**
* **Organization Name**: Enter the official name of the organization.
* **Organization Logo**: Upload a logo to visually identify the organization in the platform.
* **Organization Email**: Provide the organization's official email address. This email will be used for sending job-related notifications, invoices, and other communications.
* **Preferred Timezone**: Choose the timezone in which the organization primarily operates. This ensure that all time-sensitive activities, such as job scheduling, and alerts are correctly aligned with their local time.
* **Pricelist**: Select the relevant price list to be applied when jobs or services are performed for this organization.

2. **Tax Details**
Choose the applicable tax settings for the organization based on your region or internal policies. These settings will automatically be applied to invoices and billing documents.

3. **Service and Billing Address**
Add the organization's service and billing locations. You can specify these details in two ways.
1. Address Entry: Type the full physical address.
2. Geo-Coordinates: Enter latitude and longitude if you want to use exact map-based positioning.

> [!TIP]
>
> For the most accurate location data, use the **"Pick from Map"** option. This allows you to pinpoint the address directly on the map interface.\
> Once you've selected the correct location, click "**Use this Address**" to save the information.
>
> 
4. **Customers/Contacts and Properties information**
You can associate customers and their properties with the organization to ensure seamless tracking of service history and work orders.
> [accordion] To add contacts
>
> * Click **"+ Pick Contacts"** in the *Primary Information* section.
> * A pop-up will appear listing all available customers/contacts. Select one or more to link them to the organization.
>
> 
> [accordion] To add properties
>
> * Click **"+ Pick Property"** next to the *Property* section.
> * Use the pop-up to search and select the relevant properties that belong to the organization.
>
> 
5. **Other Details**
If any custom fields are added under the settings, you can fill in the details here.
6. **Save organization**
After entering all the necessary details, click the "**Save Organization**" button to successfully create the organization.

The Organization module contains different company details linked to the customer contacts. Associating these modules can help the field technician operate efficiently.
# Managing the organization detail
Source: https://docs.zuper.co/Client/Organization/Managing_Organization
Effectively managing organizational information is essential for delivering personalized service, maintaining accurate records, and streamlining field operations. Zuper offers a centralized platform to create, organize, and maintain comprehensive organization profiles that are a single source of truth for your customer data.
By consolidating key details such as contact information, service addresses, tax preferences, and linked customers or properties, Zuper enables businesses to deliver better customer experiences and improve job execution. Organizations are the foundation for associating jobs, invoices, contracts, and assets, making them critical to day-to-day operations.
With a structured and unified approach, you can easily manage all your organization's records while maintaining visibility into the entities you serve. This guide will walk you through accessing the Organizations module, creating new records, and managing organization-related data efficiently.
## Accessing the Organization listing page
**Navigation**: Clients -> *Organizations -> Organization listing page*
The Organization Listing Page layout in Zuper includes view management, column selection, views, and saving customized views. This process is performed directly on the module’s listing page.
**Default Listing Behavior**
The system retains its existing default listing behavior, ensuring that pre-set configurations or default views are preserved. When you first access the Organization Module Listing Page, you’ll see the default view with columns such as Organization Number, Organization Address, Organization Tags, and Organization Status.
## **Create View Configuration**
**Selecting Columns**
You can choose which columns to display to focus on relevant data:
1. Select the “**Organization**” module from the left navigation menu. You can view the listing page.

2. From the “**Views**” list, click “**+Create new view**.”

3. A “**Create View**” dialog box appears.
View Name (**Mandatory**) – Enter the view name.
Share with - Select any one of the options (User, Team), and you can add the relevant users.
Visibility to all users – Toggle on to make this view visible.

4. Once you click “**Create**,” the **Columns** sidebar appears, showing “**Available Columns**” and “**Displayed Columns**.” To add a column, drag and drop it from the “**Available Columns**” list on the left to the “**Displayed Columns**” list on the right. You can click “**Continue**.”

5. To remove a column, drag it from the “**Displayed Columns**” list back to the “**Available Columns**” list or click the **-** next to the column name. Click **Continue** to apply the changes.

6. If you wish not to add any filter, click “**Skip and Save**” to create the view.

7. The view is saved successfully.

## **Applying filters**
The Filter feature lets you refine your view by applying multiple filters based on available attributes. For example, you can select an attribute like "**Organization Status Type**," choose conditions such as "**Equal to**," "**Contains**," or "**Does Not Contain**," and choose the desired value. Once the filter is applied, the results will update to show only the Organizations that meet your criteria, making it easier to find and manage relevant Organizations.
1. Click "**Filter"** at the top left of the page. Choose the attributes you want to filter by, apply the desired conditions, and click the "**Add"** button to view the results.

2. Click “**Update View**” to modify the existing view.

3. The new view is set successfully with the filter. You can view the filter created and the filter name from the view list.

## **Update View**
An update view allows you to modify the current display settings of the "**Organization**" section. After making changes, you can save the updated configuration to the existing one or name it a new view.
1. Add/remove the existing columns and click “**Update View**” to modify the existing view.

2. The view is updated successfully.

3. Click the down arrow below the “**Update View**” to create a new view by clicking “**Save as new view**.”

4. A “**Create View**” dialog box appears.
* View Name (**Mandatory**) – Enter the view name.
* Share with - Select any one of the options (User, Team), and you can add the relevant users.
* Visibility to all users – Toggle on to make this view visible.
Click “**Create**” to create the new view.

5. Click “**Reset View**” to reset the current view.

## **Setting Permissions for Views**
### **Edit Permissions**
Users with edit permissions can modify the layout:
* They can add/remove columns, reorder them, and adjust views as described above.
* If permission is given, changes can be saved as a new view or overwritten as an existing one.
### **View Permissions**
Users with view-only permissions can see the layout but cannot make changes:
* They can view the customized columns and filters but cannot edit them. To ensure consistency for viewers, they can save them as a new “**View**.”
### **Make changes to the view**
* **Rename**: This option allows you to change the view's name (e.g., from “**Org**” to something else).
* **Visibility**: This lets you adjust who can see the view. Options include sharing with a user or team or keeping it private (“**Only Me**”), as well as toggling visibility for all users in Zuper (as shown in the “Create a View” dialog in prior images).
* **Duplicate**: This function creates a copy of the “**Org**” view, allowing you to modify the duplicate without affecting the original.
* **Delete**: Removes the view entirely. Since this is a custom view, deleting it would revert the listing to the default view or another saved view. Only the created user can delete the view.

## Pinned filters
Zuper's Organizations module lets you use pinned filters to streamline your filter experience. Pinned filters keep your most-used criteria readily accessible for quick application.
Pin up to 3 filters in any module.
***Navigation***: Clients -> Organizations -> Filters -> Pinned Filter
1. Select the “**Clients**” module from the left navigation menu. Choose the “**Organizations**.”

2. **Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

3. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters.

The Organization Listing Page in Zuper allows for flexible layout customization directly on the listing page. You can select and reorder columns, apply views, save customized views, and set permissions to ensure the right level of access for your team. Use the steps above to tailor the view to your workflow and save it for future use.
After filtering a specific Organization, click the “**Organization** **Name**” on the listing page to view and manage its details on the Organization details page.
### Creating a new organization
You can quickly create a new organization directly from the listing page.
1. Click the "**+ New Organization**" button at the top right corner.
2. Fill in the required fields such as *Organization Name, Contact Information, Tax Details,* and *Service Addresses*.
3. For a step-by-step walkthrough, refer to the [Creating a new organization](https://docs.zuper.co/Client/Organization/Create_Organization) article.

***
### **Managing organization details**
Once you select an organization from the Organizations listing page, the **Organization Details** page opens. It provides a centralized workspace to view and manage organization information, associated records, recent activity, and attachments.
The page follows a three-panel layout consisting of the left panel, center panel, and right panel.

## Left panel – Organization Information
The left panel displays the organization's basic information and provides quick access to commonly used actions.
At the top of the panel, you can view the **Organization Name** and **Service Address**. You can also use the quick actions to create a related record, send an email, or add a note to the organization.
Below the organization information, the **Primary Details** section displays key information, including:
* **Email:** The organization's email address.
* **Pricelist:** The pricelist associated with the organization.
* **Service Address:** The primary address where services are provided.
* **Billing Address:** The organization's billing address.
* **Tax Preference:** Indicates whether the organization is taxable or tax-exempt.
* **Tax Group:** The tax group associated with the organization.
* **Created By:** The user who created the organization.
* **Last Updated at:** The date the organization details were last updated.
The **Description** section displays additional information about the organization.
## Center Panel – Organization Workspace
The center panel provides access to organization-related information through different tabs. These tabs help you view and manage records associated with the organization.
## Right panel
In the right panel, you can view the other module details interlinked with the organization module, such as contacts, property, project, quotes, invoice contract, and assets association for the organization.
> [accordion] Overview
>
> The **Overview** tab provides a summary of the organization's recent activities and associated records.
>
> You can view the following sections:
>
> * **Recent Activity:** Displays the latest actions and updates performed on the organization, helping you track changes made by users.
> * **Recent Jobs:** Displays jobs associated with the organization, along with their job numbers, statuses, and scheduled dates.
> * **Recent Quotes:** Displays quotes created for the organization, including estimate numbers, due dates, statuses, and total amounts.
> * **Recent Invoices:** Displays invoices associated with the organization, along with their invoice details and payment statuses.
> [accordion] Jobs
>
> The **Jobs** tab displays all jobs associated with the organization. You can review job details, track their statuses, and access individual job records.
> [accordion] Quotes
>
> The **Quotes** tab displays quotes created for the organization. You can review quote details, including estimate numbers, due dates, statuses, and total amounts.
> [accordion] Invoices
>
> The **Invoices** tab displays invoices associated with the organization. You can review invoice details and track their payment statuses.
> [accordion] Projects
>
> The **Projects** tab displays projects associated with the organization, allowing you to access and manage their related records.
> [accordion] Requests
>
> The **Requests** tab displays service requests associated with the organization. You can review and track the requests submitted by or for the organization.
> [accordion] Assets
>
> The **Assets** tab displays assets associated with the organization, providing access to their related records.
> [accordion] Contracts
>
> The **Contracts** tab displays contracts associated with the organization, allowing you to review and access contract details.
> [accordion] Properties
>
> The **Properties** tab displays properties associated with the organization, along with their related information.
> [accordion] Contacts
>
> The **Contacts** tab displays contacts associated with the organization. You can access individual contact records and review their details.
> [accordion] Notes
>
> The **Notes** tab displays notes added to the organization. Notes can include text, images, videos, or documents that provide useful information about the organization.
> [accordion] Activity
>
> The **Activity** tab provides a chronological history of actions and updates performed on the organization. It helps you track changes and monitor organization-related activities.
## Right Panel – Attachments
The right panel displays files attached to the organization. You can view existing attachments and upload additional files using the **+** icon or the **Add Attachments** button.
## More Actions
The **More Actions** menu at the top-right corner of the page provides additional options for managing the organization. The available actions include:

> [accordion] Edit Organization
>
> Opens the organization details for editing. You can update the organization's information as needed.
> [accordion] Print/Send Statement
>
> Allows you to print or send the organization's statement.
> [accordion] Deactivate
>
> Allows you to temporarily disable an organization without losing data.
> [!NOTE]
>
> **How Field Executives access organizations**
>
> Field Executives see only organizations they have personally created in
> their default Organizations list. Organizations created by other users
> do not appear in the list, even if the FE is assigned to a job at that
> organization.
>
> * **Via job records**: Organizations linked to a job are accessible
> from within the job record and appear in search results, but are
> not added to the FE's default list.
> * **"Assigned" means via jobs**: There is no direct
> organization-to-user assignment in Zuper. A FE being "assigned"
> to an organization means they have at least one job associated
> with that organization.
>
> **To give Field Executives visibility into all organizations**, enable
> the **Allow Field Executive to View All Organizations** setting in
> **Settings → \[confirm path]**. See
> [Managing Your Users](/Settings/Users_Teams/Users_Creation) for
> related access settings.
# Overview
Source: https://docs.zuper.co/Client/Overview
The **Client module** in Zuper serves as the foundation for managing all your customer-related information. Whether you're scheduling a job, dispatching a technician, generating an invoice, or reviewing service history, it all starts with your client data, organized into **Customers**, **Organizations**, and **Properties**.
Understanding how these components work together helps you deliver better service, streamline operations, and maintain clean, structured records for every interaction.
## What is the client module used for?
The Client module is where you:
* Add and manage individual **customers** and their contact details.
* Group customers under **organizations** (such as companies or franchises).
* Define **properties** (locations) where field jobs are performed.
* Track service history, jobs, invoices, and communications by customer, organization, or property.
* Ensure accurate job scheduling, invoicing, and reporting.
It provides a single source of truth for your service operations.
## Customers/Contacts
A **Customer** in Zuper refers to an individual person who receives your services or communicates with your field teams. The **Customers** page allows you to manage individual clients and their essential contact details, such as names, phone numbers, email addresses, and service preferences. Each customer profile can also store a complete history of jobs, invoices, and communications, making providing personalized and responsive service easier.
Customers can be standalone records or linked to an organization or a specific property, depending on the nature of the service relationship.
## Organizations
An **Organization** represents a *business*, *company*, or *corporate entity*. The **Organizations** page captures company-level details, ideal for managing business-to-business (B2B) relationships. It includes fields for company name, headquarters location, tax and billing information, and primary contacts.
Organizations help to group multiple customer contacts under a single corporate entity, making it easier to manage clients with multiple branches or teams. This structure enables consolidated reporting, unified billing, and streamlined service management across departments or locations, while still maintaining individual-level records for each customer contact.
## Properties
A **Property** is a physical location where your field team delivers services. This could be a home, office, warehouse, apartment complex, or store. Each property record stores address information, associated contact persons, site-specific resources, and a complete service history. Zuper allows you to associate multiple properties with a single customer or organization, enabling independent, accurate scheduling, technician dispatch, and asset tracking for each site. This is particularly beneficial for service providers handling operations across multiple client locations or managing facilities.
> [!NOTE]
>
> Each property can be linked to only one organization at a time. If a property already belongs to an organization, it will not be available to select for another. To reassign a property to a different organization, open the property record and select **Edit** to update the organization. Learn more about [managing properties](https://docs.zuper.co/Client/Property/Managing_Property).
Together, these three elements—Customers, Organizations, and Properties—create a powerful, flexible structure that helps teams deliver efficient, accurate, and personalized service with recurring maintenance needs.
# Adding new property
Source: https://docs.zuper.co/Client/Property/Create_property
Adding a property allows you to define the exact physical location where services need to be delivered. A property may represent a customer’s office, retail store, or residence and includes vital information like the address, contact person, and service history. Setting up properties ensures accurate job scheduling, technician dispatching, and record-keeping, especially when a customer has multiple service locations.
**Navigation**: Clients -> *Properties ->+ New Property*
1. Select the "**Clients**" module from the left navigation menu and choose **Properties**. 
2. The **Properties** listing page opens.
3. Click the "**+ New Property**" button at the top right corner of the page. A new property creation page will appear. 
4. Fill in the following sub-sections:
1. **Primary Details**
* **Choose Organization**: Select the organization that this property belongs to.
* **Property Name**: Enter the name of the property.
* **Property Image**: Upload an image to visually identify the property.
* **Choose Parent Property**: If this property is a child property, choose a parent property.
* **Pricelist**: Select the relevant price list to be applied when jobs or services are performed for this property. 
2. **Tax Details** Choose the applicable tax settings for the property based on your region or internal policies. These settings will automatically be applied to invoices and billing documents. 
3. **Property Address** Add the property locations. You can specify these details in two ways.
* **Address Entry**: Type the full physical address.
* **Geo-Coordinates**: Enter latitude and longitude if you want to use exact map-based positioning. 
> [!TIP]
>
> For the most accurate location data, use the **"Pick from Map"** option. This allows you to pinpoint the address directly on the map interface.\
> \
> Once you've selected the correct location, click "**Use this Address**" to save the information. 
4. **Contacts**: Add customer information for this property. 
5. **Other Details** If any custom fields are added under the settings, you can fill in the details.
6. **Save Property** After entering all the necessary details, click the "**Save Property**" button to successfully create the property. 
### Address sync with customer/contacts
If this property is linked to a contact, Zuper keeps the addresses on both records in sync. Update the address here, and Zuper updates the service address on the linked contact automatically and vice versa.
Creating a property is essential for associating it with multiple modules, such as assets and contacts. This association enables field technicians to efficiently provide services to end contacts.

# Managing the property detail
Source: https://docs.zuper.co/Client/Property/Managing_Property
Efficiently managing property information is crucial for delivering high-quality service, ensuring accurate job allocation, and maintaining clear visibility across all service locations. Zuper provides a centralized and structured property module that allows you to create, organize, and maintain detailed property records, serving as a single source of truth for all location-based customer data.
With Zuper, you can consolidate key details like property address, contact information, tax details, and linked customer or organization records. Properties act as foundational entities for associating jobs, invoices, assets, and projects, making them essential to the day-to-day functioning of your field service operations.
This guide will help you access the Properties module, create new property records, and manage property-related information effectively.
## Accessing the property listing page
The Property Listing Page layout in Zuper includes view management, column selection, views, and saving customized views. This process is performed directly on the module’s listing page.
## **Default Listing Behavior**
The system retains its existing default listing behavior, ensuring that pre-set configurations or default views are preserved. When you first access the Property Module Listing Page, you’ll see the default view with columns such as Property Number, Property Address, Property Tags, and Property Status.
**Navigation**: Clients ->*Properties* -> *Properties listing page*
* Select the "**Client**" module from the left navigation menu and choose "**Properties**."
* You will land on the **Properties** listing page, which provides a comprehensive view of all your properties with key information such as Property Name, Status, Associated Customer or Organization, and Created By.

2. From the “**Views**” list, click “**+Create new view**.”

3. A “**Create View**” dialog box appears.
View Name (**Mandatory**) – Enter the view name.
Share with - Select any one of the options (User, Team), and you can add the relevant users.
Visibility to all users – Toggle on to make this view visible.

4. Once you click “**Create**,” the **Columns** sidebar appears, showing “**Available Columns**” and “**Displayed Columns**.” To add a column, drag and drop it from the “**Available Columns**” list on the left to the “**Displayed Columns**” list on the right. You can click “**Continue**.”

5. To remove a column, drag it from the “**Displayed Columns**” list back to the “**Available Columns**” list or click the **-** next to the column name. Click **Continue** to apply the changes.

6. If you wish not to add any filter, click “**Skip and Save**” to create the view.

7. The view is saved successfully.

### **Applying filters**
The Filter feature lets you refine your view by applying multiple filters based on available attributes. For example, you can select an attribute like "**Contact Status Type**," choose conditions such as "**Equal to**," "**Contains**," or "**Does Not Contain**," and choose the desired value. Once the filter is applied, the results will update to show only the Properties that meet your criteria, making it easier to find and manage relevant Properties.
1. Click "**Filter"** at the top left of the page. Choose the attributes you want to filter by, apply the desired conditions, and click the "**Add"** button to view the results.

2. Click “**Update View**” to modify the existing view.

4. The new view is set successfully with the filter. You can view the filter created and the filter name from the view list.

## **Update View**
An update view allows you to modify the current display settings of the "**Property**" section. After making changes, you can save the updated configuration to the existing one or name it a new view.
1. Add/remove the existing columns and click “**Update View**” to modify the existing view.

2. The view is updated successfully.

3. Click the down arrow below the “**Update View**” to create a new view by clicking “**Save as new view**.”

4. A “**Create View**” dialog box appears.
* View Name (**Mandatory**) – Enter the view name.
* Share with - Select any one of the options (User, Team), and you can add the relevant users.
* Visibility to all users – Toggle on to make this view visible.
Click “**Create**” to create the new view.

5. Click “**Reset View**” to reset the current view.

## **Setting Permissions for Views**
### **Edit Permissions**
Users with edit permissions can modify the layout:
* They can add/remove columns, reorder them, and adjust views as described above.
* If permission is given, changes can be saved as a new view or overwritten as an existing one.
### **View Permissions**
Users with view-only permissions can see the layout but cannot make changes:
* They can view the customized columns and filters but cannot edit them. To ensure consistency for viewers, they can save them as a new “**View**.”
### **Make changes to the view**
* **Rename**: This option allows you to change the view's name (e.g., from “**Prop**” to something else).
* **Visibility**: This lets you adjust who can see the view. Options include sharing with a user or team or keeping it private (“Only Me”), as well as toggling visibility for all users in Zuper (as shown in the “Create a View” dialog in prior images).
* **Duplicate**: This function creates a copy of the “**Prop**” view, allowing you to modify the duplicate without affecting the original.
* **Delete**: Removes the view entirely. Since this is a custom view, deleting it would revert the listing to the default view or another saved view. Only the created user can delete the view.

## Pinned filters
Zuper's Properties module lets you use pinned filters to streamline your filter experience. Pinned filters keep your most-used criteria readily accessible for quick application.
Pin up to 3 filters in any module.
**Navigation**: *Clients -> Properties à Filters -> Pinned Filter*
1. Select the “**Clients**” module from the left navigation menu. Choose the “**Properties**.”

2. **Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

3. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters and return to the full job list.

## Creating a new property
You can quickly create a new property directly from the listing page.
1. Click the "**+ New Property**" button in the top right corner.
2. Fill in the required fields such as *Property Name, Property Address, Contact Information*, and *Tax Details*.
3. For a step-by-step walkthrough, refer to the [Creating a new property](https://docs.zuper.co/Client/Property/Create_property) article.

### **Managing property details**
Once you select a property from the Properties listing page, the Property Details page opens. It provides a centralized workspace to view and manage property information, associated records, recent activities, and attachments.

### Left Panel – Property Information
The left panel displays the property's basic information and provides quick access to create property-related records, such as Jobs, Projects, Quotes, and Invoices, as well as to add notes.
At the top, you can view the following details:
* Property Name: Displays the name of the property.
* Property Address: Displays the property's location.
Below this, the Primary Details section displays the following information:
* Organization: The organization associated with the property.
* Parent Property: The parent property, if applicable.
* Pricelist: The pricelist associated with the property.
* Property Address: The property's registered address.
* Assigned To: The users or teams assigned to the property.
* Tax Preference: The property's applicable tax preference.
* Tags: Tags associated with the property.
* Created By: The user who created the property.
* Last Updated At: The date and time when the property was last updated.
## Center Panel
The center panel provides access to property-related information through different tabs.
> [accordion] Overview
>
> The Overview tab provides a snapshot of the property's recent activities and associated records.
> [accordion] Jobs
>
> Displays the jobs associated with the property. You can review job details, track job statuses, and access individual job records.
> [accordion] Quotes
>
> Displays quotes created for the property. You can review quote details, including estimate numbers, dates, statuses, and amounts.
> [accordion] Invoices
>
> Displays invoices associated with the property, allowing you to review invoice details and track their status.
> [accordion] Projects
>
> Displays projects associated with the property. You can access the linked projects and review their details.
> [accordion] Requests
>
> Displays service requests associated with the property, helping you track customer-reported issues and service requirements.
> [accordion] Assets
>
> Displays assets registered or associated with the property. You can access asset details and track the equipment or items maintained at the property.
> [accordion] Contracts
>
> Displays contracts associated with the property, allowing you to review the applicable service agreements.
> [accordion] Notes
>
> Displays notes added to the property. You can add comments, reminders, attachments, and other relevant information for future reference.
> [accordion] Activity
>
> Displays a chronological history of actions performed on the property, helping you track property-related updates and changes.
> [accordion] Gallery
>
> The Gallery in Properties includes photos and videos associated with the property, bringing all property-related media into one unified view. You can browse, filter, and organize media uploaded to the property.
>
> 
>
> For more information about the available Gallery actions, see the [Jobs Gallery](https://docs.zuper.co/Work_Order_Management/Jobs/Jobs_gallery) article.
>
> > [!NOTE]
> >
> > **Note**: Photos and videos added to a job's Gallery are also available in the associated property's Gallery. However, media uploaded directly to the property's Gallery is not automatically associated with jobs linked to that property. Selecting Filter > Show Related in the Job Gallery does not display media uploaded directly to the property's Gallery.
### Right Panel – Attachments
The right panel displays files attached to the property. You can view existing attachments and upload additional files using the + icon.
## More Actions
The More Actions menu at the top-right corner provides additional options for managing the property.

> [accordion] Edit Property
>
> Select this option to modify the existing property details.
> [accordion] Deactivate
>
> Select this option to deactivate the property when it is no longer active.
>
> > [!NOTE]
> >
> > Note: You can temporarily disable a property without losing data. Once deactivated, you have the option to activate or delete the property as needed.
### FAQs
1. **Why can I not edit the address on a completed job?**
Completed and closed jobs lock the property and schedule fields to preserve the service record. Edit the property record itself (Client > Properties > Edit Property) and the updated address will apply to all future jobs at that property.
2. **Can I change the property on an accepted quote?**
No. Once a quote is accepted, the associated customer and property are locked. Clone the quote to create an editable version with the correct property.
3. **I edited the property address b,ut the invoice still shows the old address. Why?**
Invoices capture the billing address at the time they were created. Editing the property after invoice creation does not update the address on existing invoices. To correct an invoice address: void the invoice, update the property, then re-create the invoice.
# Setting up commissions
Source: https://docs.zuper.co/Commissions/Commissions
Commissions in Zuper allow you to define and track performance-based commission values for employees based on Job performance. This helps you align incentives with business outcomes. You can reward teams for closing higher-value jobs, maintaining healthy margins, and delivering profitable work. It ensures commission values are structured, measurable, and tied to actual performance.
Commissions are configured in **Job Costing & Expenses** and applied directly within the Job workflow. Once added, they are reflected in financial tracking and reporting. For Jobs, commissions are included in job cost calculations.
By managing commissions inside the system, you reduce manual calculations and gain clear visibility into both commission values and their impact on profitability.
### **Prerequisites**
Before tracking Commissions:
* Commission must be enabled for your account. To enable it, contact your account administrator or email [support@zuper.co](mailto:support@zuper.co).
* By default, Admins can view and manage Commissions. However, if your business requires different visibility, you can configure access for specific roles. To do this, navigate to:\
**Settings > Users & Teams > Custom Roles > Job/Project**, then enable the **Manage Commissions** toggle.
* You must have at least one user/team member assigned to the Job to add a commission. Only assigned users are eligible to receive commission.
## **Set up Commission Rates**
Before you can start assigning or tracking commissions on Jobs, you need to set commission rates for your team members. This is a one-time setup. Once completed, commissions can be automatically calculated based on performance.
**To assign a commission structure to a user:**
1. Navigate to **More** > **Settings** in the left navigation bar.
2. Click the **Jobs** module in Settings and choose **Job Costing & Expenses**.

3. Go to the **Commissions** tab.
4. Click **+ Add Commission**.

5. The **Build Commission Structure** page will open. Here, you can:
6. Provide a clear and descriptive commission **name**.
7. Select the **users** eligible under this structure.
> [!NOTE]
>
> **Note**: You can define only one commission structure per user. Multiple commission structures for the same user are not allowed.
**Define Commission Options**
8. Click **+ Add Commission** under Commission Options.
9. Choose the financial metric by **selecting** **Commission** **Type**:
* Planned Revenue
* Planned Profit
* Planned Profit Margin
* Actual Profit
* Actual Profit Margin
> [!NOTE]
>
> **Note**: **Actual Revenue** is not available as a selectable Commission Type.\
> By default, Actual Total Revenue is locked to the sum of accepted quote subtotals, based on the revenue configuration defined in Settings. This ensures that profitability and commission calculations are always measured against the customer’s committed contract value, even if job line items are modified during execution.
10. Define the **condition**.
11. Enter the threshold **value**.
**Define Commission value**
12. Enter the commission value in the **Add Rate** field.
13. Select value type:
* Flat Value
* % of Actual Revenue
* % of Actual Profit
* % of Planned Revenue
* % of Planned Profit
14. Click **+** to add additional tiers if required. You can configure multiple conditions and multiple payout tiers within the same structure.
15. Click **Save** once completed.

**Managing a Commission Structure**
Once a commission structure is created, you can modify it anytime.
From the **Commission** list page:
* Click the three-dot menu beside a commission structure.
* Choose **Edit** to update the configuration.
* Choose **Disable** to make it inactive.
Disabling a structure prevents it from being applied to new jobs. A disabled structure can then be deleted if required.

## **Managing Commissions in Job Costing**
In roofing businesses, incentives often play a key role in driving sales performance and job completion efficiency. To ensure complete financial visibility, Zuper allows commissions to be included as part of [job costing](/Zuper_for_Roofing/Job_Costing).
When commissions are added to a Job, they are automatically included in **Actual COGS**. This means profitability calculations reflect not only materials, labor, and expenses, but also commission values.
For example, if a sales representative earns commission on a roofing job, that payout is treated as part of the job’s cost. If costs increase due to commissions or additional labor, the **Actual Profit and Margin** update automatically.
This real-time visibility helps you understand the full financial impact of each job and make informed pricing or margin decisions moving forward.
### Adding a commission to a Job
1. Open the **Job** details page.
2. Navigate to the **Line Item** section.

3. On the Commission tab, click + **Add Commission**.

4. Select the **user** to whom you are assigning commission. Now, you can assign a commission to users already assigned to the job, users referenced in custom lookup fields on the job, or any other user in your organisation, including members of non-dispatchable teams.
5. If a commission structure is defined for the user, the system automatically calculates the commission value, and you can choose an appropriate one from the list.
6. If no structure is defined, Zuper allows you to manually define the commission rate for the user within the Job.

7. Click **Save** to apply the changes.

> [!NOTE]
>
> **Note:** When multiple commissions are added to a job, each commission is evaluated independently based on the defined metric. The second commission is not recalculated based on the profitability updated after the first commission is applied. Additionally, commission values are dynamically recalculated when profitability changes.\
> For example, if a commission is defined as 10% of Actual Profit and the Job initially has \$1,000 Actual Profit, the commission value will be \$100. If material or labor changes increase Actual Profit to \$2,000, the commission value automatically updates to \$200. You do not need to update it manually.
The commission will now be recorded in **Job Costing**. To view its impact:
Click on **Actual** **COGS/Overhead** to see the breakdown, including commission as part of Actual Cost.

#### How overhead affects Actual Profit commissions
If your organisation has overhead configured in **J[ob Costing & Expenses > General Settings](/Zuper_for_Roofing/Job_Costing_Settings#general-settings)**, it changes how commissions based on the **Actual Profit** commission type are calculated.
When Overhead is applied, Zuper deducts the Overhead amount from Gross Profit before calculating the commission. This ensures commissions are calculated using the profit remaining after indirect business costs are accounted for.
**Example:** If a job has a Gross Profit of **\$1,000** and Overhead of **\$200**, the Actual Profit type used for commission calculations is **\$800**. If the commission rate is **10%**, the commission amount is **\$80** instead of **\$100**.
Other commission types, including **Flat Rate**, **Planned Revenue**, **Planned Profit**, and **Actual Revenue**, are not affected by Overhead.
### Recording a Payout from the Job
You can record a commission payout directly from the job without going to the Commissions Listing page.
Add a Payout
1. Click the **three-dot menu (⋯)** next to the commission you want to pay out.
2. Select **Add Payout**. The Add Payout dialog opens.

3. Review or update the **Payment Date**. It defaults to today.
4. Enter the **Amount**.
5. Add an optional note in **Payout Notes**.
6. Click **Record Payout**.

The Payment Status updates automatically, **Paid** for a full payment, or **Partially Paid** if a balance remains.
> [!NOTE]
>
> **Note:** You can record multiple partial payouts against the same commission until it is fully settled.
> [!TIP]
>
> **Need to Pay Multiple Commissions at Once?**
>
> Use the Commissions Listing page in the Accounting module for bulk payouts. See [Managing Commission Payouts](/Managing-commission-payouts).
## **Managing Commissions in a Project**
When a Job is associated with a Project, the commission value defined for that Job is automatically reflected within the Project under:
**Navigation**: *Project > Financials > Commissions*
This allows you to view consolidated commission values across all Jobs linked to the Project.

In addition to Job-level commissions, you can also add a **Flat Value commission** directly within the Project.
### **Adding a Commission in a Project**
1. Click **+ Add Commission**.
2. In the **Add Commission** dialog box:
1. Select **User** – Choose the team member receiving the commission.
2. Enter the *flat value*.
3. Click **Add**.

The commission will appear in the Project’s commission list.
**Managing Existing Project Commissions**
For commissions added directly at the Project level, you can perform the following actions from the menu (⋯):
* Edit the commission rate
* Delete the commission entry if needed
All updates are reflected immediately in the total commission amount shown for the Project.
If a Job is part of the Project, its commission values will automatically roll up and be displayed here. These Job-level commissions are read-only within the Project and must be edited from the respective Job.

**Things to Know**
1. When the commission type is based on **Planned Revenue** or **Planned Profit**, only the value from accepted quotes is considered for commission calculation. Quotes in Draft or Sent status are not included.
2. Each commission added to a Job is calculated independently based on the selected metric. If multiple users receive commission on the same Job, their payouts are evaluated separately.
3. Commission structures apply only to **Jobs**.
4. Project-level commissions support **Flat Value only**. Profitability-based or metric-based commission structures are not available in Projects.
5. Only users assigned to the Job or Project are eligible to receive commission.
6. If a Job runs at a loss, commission based on profit will not result in a negative value.\
For example, if Actual Profit is -\$500 and the commission is defined as 10% of Actual Profit, the commission value will be calculated as \$0. Negative commission values are not applied.
## **Commissions Report**
After assigning users to line items and tracking commissions on jobs, use the Commissions Master Report to view how commissions are recorded across jobs and projects within a selected date range.
This report helps you:
* View commissions by employee or salesperson
* Track commission details at the job and line item level
* Identify commission types (actual, proportional, or flat)
* Review commission amounts and creation details
**To access the Commission Report**
1. Navigate to **More** > **Reporting** > **Reports** in the left navigation bar.
2. Navigate to **Miscellaneous Reports >** **Commissions Master Report**.
3. Set the **From Date** and **To Date**.
4. Choose the **Commission Date** type.
5. Click **Generate Report**.

# Creating and managing PPM
Source: https://docs.zuper.co/Contracts_and_Assets_Management/Assets/Creating_PPM
Planned Preventive Maintenance (PPM) is a proactive approach to maintaining equipment, machinery, or systems by scheduling regular inspections, servicing, and repairs before any issues arise. The goal of PPM is to minimize the risk of unexpected failures, reduce downtime, and extend asset lifespans.
Let’s get started with creating and managing a new PPM for an asset in Zuper!
> [!NOTE]
>
> **Common terms for this feature**
>
> Customers may refer to assets using different terms depending on their industry. In Zuper, the following are all equivalent:
>
> | What customers call it | Zuper term |
> | - | - |
> | Station / stations | Asset / assets |
> | Unit / units | Asset / assets |
> | Service location | Asset / property |
> | Multiple stations | Multiple assets |
> | One job per station | One job per asset |
> | Contract covers stations | Contract covering multiple assets |
> | Multi-site PPM | PPM across multiple assets or locations |
>
> When this article refers to **assets**, it includes stations, units, and service locations.
**Navigation:** Contracts and Assets Management module -> Assets-> Assets listing page -> Asset detail page
## To create a PPM
* Select the **Contracts and Assets Management** module from the left navigation menu and choose “**Assets**." You will view the list of assets (both active and inactive) on the asset listing page.

* Choose the asset for which you want to add a new PPM from the asset listing page. The selected asset details page appears.
* On the asset details page, scroll down to the PPM section in the right pane and click the\*\* "+\*\*" icon. A side pane will appear, and you can create a new PPM.

> [!NOTE]
>
> Note: To add PPM for an asset, it must be linked to an organization or customer. Unlinked assets (referred to as "Orphan" assets) will not display the + (Plus) button. You can associate the asset with an organization or customer first, then go ahead and add PPM.
> [!NOTE]
>
> **Keeping future maintenance out of your active jobs list**
>
> Scheduling a PPM does not create jobs for every future service date. Jobs are
> created only when the **Generate Job in Advance** lead time is reached — so a PPM
> recurring every 6 or 12 months produces a job shortly before each service, not a
> backlog of future-dated jobs in your active list.
>
> To see the full forward schedule, use **Manage PPM** on the asset listing page,
> which lists each PPM with its last and next service dates.
### Primary Details
Fill in the following primary details:
* **PPM Name:** Enter a name for the PPM.
* **PPM Description:** Provide a brief description of the PPM.
* **Choose Property**: Select a property of an org/customer to associate with the PPM.
* **Choose Asset**(*Mandatory*): Select one or more assets for which you want to create a new PPM. You can choose assets currently associated with the contract or any other existing assets, as needed.
* *Example: A service contract covers 3 water pump stations. You select all 3 assets in the Choose Asset field and enable Auto-Generate Job. Zuper creates a PPM for each asset. On the scheduled date, 3 separate jobs are auto-generated — one per station — and each appears individually in the Jobs listing."*
> [!NOTE]
>
> **Note**: When you select multiple assets, Zuper creates one separate PPM entry per asset. If Auto-Generate Job is enabled, each asset generates its own independent job on the scheduled date not one combined job for all assets.

* **Choose Part/Service**: Select a part or service associated with the contract to include in the PPM.
* **Priority** (*Mandatory*): Select the priority from the drop-down list. Options include Low, Medium, and High.
* **Auto-Generate Job**: By default, it will be set to "**No**." If you want to auto-generate a job based on the PPM, select "**Yes**."
> [accordion] If selected "Yes" for Autogenerate job. Follow these steps:
>
> Job Settings
>
> * **Generate Job in Advance** (*Mandatory*): Set how many days before the scheduled date the job should be created automatically.
>
> * **Job Category**: Choose the job category from the drop-down list.
>
> 
>
> * **Street Address**: Click "**Pick from Map**" to fill in the street address information.
>
> After completing the primary details, click the "**Next**" button to proceed to the scheduling step for the PPM.
### PPM Schedule
Provide the following details to schedule:
* **PPM Start Date**: Select the start date of the PPM.
* **PPM End Date**: Select the end date of the PPM.

* **Recurrence**: Select how often this PPM should occur - Daily, Weekly, Monthly, Yearly, or Custom.
* **Schedule Dates**: These dates are **automatically populated** for upcoming schedules (service dates) based on the chosen recurrence.
After filling in all of these details, click the “**Create PPM**” button. A new PPM will be created and successfully added to the asset.
## Manage PPM
Once a PPM has been created for an asset, you can also edit or delete the PPM as needed. To manage PPM, follow these steps:
* Click "**Manage PPM**" at the top right of the asset listing page.

* You can access all PPMs for assets, including PPM ID, name, last service date, next service date, and more. You can also use the **search bar** to search and view specific asset's PPM details.
* From there, you can view, edit, or delete PPM by using the icon under **Actions**.

> [!NOTE]
>
> **Note**: The job icon next to the PPM ID indicates that a **job will be auto-generated** for this PPM on the scheduled dates. This is because you've chosen "**Yes**" to "Auto Generate Job" while creating a PPM.
## Scheduling PPM
In Zuper, PPM tasks can be automatically converted into jobs for field technicians to complete on scheduled dates.
However, if the **autogenerate jobs** option was not enabled during PPM creation, you can still manually issue PPMs as jobs. Here's how:
* On the PPM listing page, identify the PPMs that do not have autogenerate jobs enabled.

* Select the PPM(s) that need job creation. An action bar will appear at the bottom.
> [!NOTE]
>
> **Note**: The checkbox is enabled only for PPMs that do not have autogenerate jobs configured.
* Click "**Issue Chosen PPMs**". A Preview PPMs pop-up will appear.

* Select the **Job Category** from the dropdown menu and set the **Start Time** and **End Time** for each PPM.

* Click "**Submit**" to create PPM jobs successfully.
So, that's the process of creating and managing PPM in the Zuper Web App. By following these step-by-step instructions, you can efficiently create and manage these maintenance schedules, ensuring optimal performance and longevity of assets.
# Creating an asset
Source: https://docs.zuper.co/Contracts_and_Assets_Management/Assets/Creating_asset
Any item purchased by a company as a product and, when distributed to a customer service location to fulfill a job, contract, or service agreement, is referred to as an asset. It can either be owned by the customer or by the company itself.
Let’s get started with creating a new asset in Zuper!
**Navigation**: *Contracts and Assets Management module -> Assets → + New Asset*
## To create a new asset
* Select the “**Contracts and Assets Management**” module from the left navigation menu and choose “**Assets**.”

* On the assets listing page, you will see an overview of existing assets, including Asset Code, Asset Name, Asset status, and more.
* Click the “**+ New Asset**” button at the top right corner of the page to begin creating a new asset.

* The new asset creation page appears in a user-friendly layout, making data entry easier:
### A. Primary Details
* **Product**: Select the product you want to distribute to a customer from the inventory. The asset code and name will be auto-filled based on the selected product.
* **Asset Code**(*Mandatory*): It is ideally the product model used to identify the kind of asset. This field is auto-filled based on the selected product.
* **Asset Name**(*Mandatory*): The name of the asset. This field is auto-filled based on the selected product.
* **Asset Serial Number**: A unique identifier (letters, digits, or dashes) used for business-owned or customer-owned assets.

* **Asset Category**(*Mandatory*): The category to which the asset belongs.
* **Asset Image**: Upload an image to help identify the asset.
* **Asset Status**: The current status of the asset.
* **Asset Ownership**: Indicates whether the asset is customer-owned or company-owned.
* **Purchase Date**: The date when the asset was purchased.
* **Purchase Price**: The actual purchase price of the asset.
* **Warranty Expiry Date**: The date when the asset’s warranty expires.
* **Placed in Service Date**: The date when the asset was put into service.
* **Residual Price**: The estimated remaining value of the asset.
* **Useful Life**: The expected duration the asset can be used (in days, months, or years).
* **Asset inspection form**: Select the asset inspection form from the dropdown menu. This is the checklist used by field technicians to assess an asset’s condition and record maintenance details.
* **Asset Description**: A brief summary of the asset.
### B. Primary Information
Customer information includes details about the organization or customer associated with the asset.
When entering customer information:
* You can select an organization, a customer, or both.
* If the selected organization and customer are linked, their details will be auto-filled.

> [!NOTE]
>
> **Note**: Based on the customer or organization you've chosen, the service and billing address will be auto-filled. You can modify the address if needed.
### C. Association(s)
You can also associate a property or parent asset with this new asset. To do this, click the "**+ Add**" button, choose the property or parent asset as needed, and click "**Proceed**."
### D. Service/Billing Address
The service or billing address indicates where the asset is provided. It is automatically filled based on the selected customer or organization, but you can change it if necessary.

### E. Add Part
Parts are individual components or materials associated with an asset, which may be required for its operation, maintenance, or repairs. To add parts to an asset:
* Click the **"+ Line Item"** button.
* Select the required parts and specify the quantity.
* Click **"Add Part"** to include them in the asset.

After adding parts, you can view, edit, or remove them using the icon under the "**Actions**" column.
### F. Asset Attachments
You can add relevant files and attachments to the asset. To do this:
* Click the "+ **Add Attachments**" button. A pop-up will appear.
* Click to upload or drag and drop a file from your computer.
* Once uploaded, click the "**Close**" button.
* You can also preview or remove attachments as needed.
After filling in all of these details, click the "**Save Asset**" button at the top right corner of the page.

A "**Create Asset**" dialog box appears. Click the "**Create**" button to create the asset.
The new asset is created successfully.
# Managing inspection forms
Source: https://docs.zuper.co/Contracts_and_Assets_Management/Assets/Inspection_form
Asset inspection forms are essential tools that field technicians use to perform thorough asset inspections and document maintenance activities. These checklists streamline the inspection process, ensuring that asset conditions and maintenance needs are accurately recorded.
In this guide, we'll walk you through the steps to configure, associate, and complete an asset inspection form within a job, helping you maintain high standards of asset management and job completion.
**Navigation**:
* *Settings-> Modules -> Assets -> Inspection Forms*
* *Assets -> Asset Listing page -> + New Asset -> Asset Inspection Form*
* *Jobs -> Job Listing page -> + New Job -> Asset Inspection Form*
## **Configure an Asset Inspection Form**
To efficiently associate an asset inspection form with Jobs, it is important to configure the inspection form in settings. Follow these steps:
* Select Settings from the left navigation menu.
* Click **Modules** and choose **Asset** to open the Asset Settings page.
* Select **Inspection Forms**. The inspection forms listing page will appear.

* Click **+ New Form** to create a new inspection form.

* Enter the following details and click **Proceed** to begin customizing the inspection form.

* **Inspection Form Name** (*Mandatory*) – Enter a name for the inspection form.
* **Description** – Provide a brief description of the inspection form.
**Customizing the inspection form**
To customize the inspection form, simply drag and drop fields from the right panel into the form layout. Arrange them as needed to suit your inspection requirements.
You can also **edit, clone, or delete** fields using the action menu available next to each field.

> [accordion] Available fields
>
> 1. Text
> * Single-Line Input: This allows you to create a field to enter a single line of free text.
> * Multi-Line Input: This allows you to create a field to enter multiple lines of free text.
>
> 2. Date
> * Date: This allows you to create a field to select a specific date from a calendar.
> * Time: This allows you to create a field where you can select a specific time.
> * Date & Time: This allows you to create a field where both date and time can be selected.
>
> 3. Selection
> * Single-Selection: This allows you to create a radio input Field where one of the provided options can be selected.
> * Multi-Selection: This allows you to create check boxes where the provided options can be checked.
> * Drop-Down: This allows you to create a drop-down field with the required list of options.
>
> 4. Media
> * Upload: This allows you to create a file input field to upload files.
> * Single Image: This allows you to upload a single image as input.
> * Multi Images: This allows you to upload multiple images in one field.
> * Barcode Scan: This allows you to scan and capture barcodes using a device camera or scanner.
>
> 5. Misc
>
> * Look up: This allows you to create a file input field to look up the products from the parts and services module.
>
> * Data Table: This allows you to create a dynamic table field to input structured data in rows and columns.
>
> * Signature: This allows you to sign directly within the form using touch or a mouse input.
>
> > [!NOTE]
> >
> > Note: You can also control the behavior and visibility of each field using the following options:
> >
> > * Mark as Required Field- Makes the field mandatory to fill out before submitting the form.
> > * Mark as Read Only- Displays the field as non-editable; users can view the value but cannot modify it.
> > * Mark as hidden field- Hides the field from all users; it will not appear in the form interface.
> > * Hide to FE/Technician- Makes the field invisible specifically to technicians or front-end users during form access.
## **Associate an Inspection Form with an Asset**
After you have successfully configured and created a new inspection form, you can associate an inspection form with an asset in any of the following ways:
> [accordion] Create a new asset with an Inspection Form
>
> * In the left navigation menu, select **Contracts and Assets Management** and choose **Assets**.
>
> * On the asset listing page, select **+ New Asset**. The new asset creation page will appear.
>
> 
>
> * In the **Primary Details** section, fill in the following information:
>
> 1. **Product** (*Mandatory*) – Select the product to be assigned as an asset.
> 2. **Asset Code** – Auto-generated based on the selected product.
> 3. **Asset Name** – Auto-filled based on the selected product.
> 4. **Asset Serial Number** – Enter a unique identifier (letters, numbers, or dashes).
> 5. **Asset Category** (*Mandatory*) – Select the asset category.
> 6. **Asset Image** – Upload an optional image.
> 7. **Asset Status** – Select the asset’s current status.
> 8. **Asset Ownership** – Choose **Customer-owned** or **Company-owned**.
> 9. **Purchase Date** – Select the date of purchase.
> 10. **Purchase Price** – Enter the asset’s purchase cost.
> 11. **Warranty Expiry Date** – Select the warranty expiration date.
> 12. **Placed in Service** – Enter the asset’s service start date.
> 13. **Residual Price** – Enter the estimated residual value.
> 14. **Useful Life** – Define the asset’s lifespan (days, months, or years).
> 15. **Asset Description** – Enter optional details about the asset.
> 16. **Asset Inspection Form** – Select an inspection form from the dropdown.
>
> 
>
> * Enter additional details such as **Customer Information**, **Service Address**, and **Attachments**.
>
> * Select **Save Asset** to create the asset with the associated inspection form.
> [accordion] Edit an existing asset to add an Inspection Form
>
> * Navigate to the Assets listing page.
>
> * On the **Asset Listing** page, locate the asset you want to edit.
>
> * Select the ellipsis icon () next to the asset and choose **Edit Asset**.
>
> 
>
> * Update the asset details, including adding an **Inspection Form**.
>
> * Select **Update Asset** to save the changes.
## **Associate an Inspection Form with a Job**
After linking an inspection form to an asset, you can associate the asset with jobs. This ensures that field technicians complete the inspection form before marking the job as complete.
### **Create a Job with an Inspection Form**
* Navigate to the **Jobs** module in the left navigation menu. You will land on the jobs listing page.

* On the **Job Listing** page, select **+ New Job**.

* Enter job details such as **Job Title, Job Category, Due Date, Service Address**, and **Customer Information**.
* Under **Assets**, select **+ Add Asset**.

* Choose an asset that has an **Inspection Form.** The Asset with an inspection form will be added to the job.

* Select **Create Job** to save the job.
### **Complete an Asset Inspection Form in a Job**
After creating a job with an asset inspection form, here's how you can complete the asset inspection form in a Job.
* Open the job details page.
* In the **Assets Associated** section, select the icon next to the asset.

* Select **Fill Inspection Form**.
* Complete the form based on asset requirements and observations.

* Select **Submit**.
By following the steps outlined in this guide, you can efficiently configure, associate, and complete asset inspection forms within your jobs. This ensures that field technicians are equipped with the necessary tools to conduct comprehensive inspections and complete jobs accurately. With streamlined documentation and a more efficient inspection process, you can maintain better oversight of asset conditions and improve overall service delivery.
# Overview
Source: https://docs.zuper.co/Contracts_and_Assets_Management/Assets/Overview
Zuper’s Assets Module streamlines asset management by enabling businesses to track, maintain, and optimize their physical assets efficiently. By centralizing asset data, businesses can minimize downtime, extend equipment lifespan, and improve service delivery.
With features like preventive maintenance scheduling, asset history tracking, and seamless association with jobs, contracts, and customers, Zuper ensures peak operational efficiency—all within a unified platform.
### **Key Benefits of the Assets Module**
**Comprehensive Asset Tracking**
Easily track and manage all assets in a centralized system. Record essential details such as asset codes, serial numbers, purchase dates, warranty details, and current status for complete visibility and control.
**Preventive Maintenance Scheduling**
Plan and schedule **preventive maintenance (PPM)** to keep assets in optimal condition, reducing unexpected breakdowns and minimizing downtime.
**Seamless Asset Associations**
Link assets with **contracts, customers, jobs, projects, and properties**, creating a structured asset management workflow that enhances operational efficiency.
**Parts & Services Management**
Track parts usage and service requirements for each asset to ensure timely repairs and maintenance. Maintain inventory control and prevent service delays due to missing components.
**Detailed Asset History** Access a complete history of each asset, including maintenance activities, service records, and repair logs, to gain insights into asset performance and make informed decisions about replacements or upgrades.
**Custom Attributes & Reporting**
Customize asset attributes based on your business needs and generate detailed reports on asset performance, maintenance schedules, and key operational metrics to drive data-driven decision-making.
# Managing your assets
Source: https://docs.zuper.co/Contracts_and_Assets_Management/Assets/managing_assets
Efficient asset management ensures operational efficiency and extends equipment lifespan. Zuper’s unified platform enables seamless asset creation, tracking, and management. With centralized control, businesses can monitor asset status, track history, and streamline maintenance.
This guide covers accessing the Assets listing page, key actions, and managing asset details effectively.
**Navigation**: *Contracts and Assets Management module -> Assets-> Assets listing page -> Asset Details*
## Accessing the assets listing page
The asset listing page is designed to help you stay organized by providing a centralized view of all assets and enabling quick access to critical asset details. The page includes several key features to streamline asset management:

## Listing View
Customize the Assets listing by adding/removing or reordering columns, then Update View to overwrite or save it as a new view.
**Update View**
Click Update View to modify the current view after changes.
**Save as a new view**
Use the dropdown beside Update View → Save as new view.
**Create View dialog**
Enter the View Name (mandatory), choose Share with (User/Team) and add users, toggle Visibility to all users, and click Create.
**Reset View**
Click Reset View to restore the current view to the default.
**Permissions**
* **Edit**: Add/remove/reorder columns; save as new or overwrite existing views.
* **View-only**: Apply views but can’t edit; can Save as new view to copy without altering the original.
* **Manage view**: Rename, adjust Visibility (Only Me/User/Team or global toggle), Duplicate, or Delete (creator only; reverts to default/another saved view).
## Pinned filters
Zuper's Assets module lets you use pinned filters to streamline your filter experience. Pinned filters keep your most-used criteria readily accessible for quick application.
1. **Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

2. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters.

**Open asset details**
After filtering, click an Asset Number or Asset ID to view and manage details in the Zuper Assets Module.

### Bulk Action:
The bulk printing of QR codes on the Assets is possible. With this, Assets can get their QR code printed in size.
1. Select the list of assets you want to bulk update and choose the option “**Print QR Code.**”

2. The QR Codes are successfully printed in bulk.

> [!NOTE]
>
> **Note:** The Bulk Print QR code is available for less than **100** assets at a time; if more than **100** assets are selected, the PDF is generated and sent over email. We can print the QR code using any printer.
**Compatibility:**
> [!TIP]
>
> **The exported PDF will print to 1” x 2 5/8” sized labels—this format prints on the Avery Template Presta 94200 template.**
With this new feature, businesses can save time by updating the asset status and asset fields for multiple assets with a single click.
The assets will have a QR code for identification for internal purposes, and a list of QR codes will be sent to field executives during field service. This bulk option helps them print multiple QR codes easily.
### **Manage PPM** (Planned Preventive Maintenance)
Easily oversee and manage planned preventive maintenance schedules for assets to ensure timely servicing and reduce unexpected breakdowns. To do this, click the "**Manage PPM**" button at the top right of the listing page. For a more detailed guide on how to manage PPM, see the Creating and Managing PPM article.

### **New asset creation**
Quickly create new assets directly from the listing page, streamlining asset management. To do this, click the "**+ New Asset**" button at the top right corner. For more detailed guide on how to create a new asset, see creating a new asset article.

### **Filter assets**
Refine your asset view by applying multiple filters based on predefined criteria such as **Asset Type, Status, Location, Warranty Expiry**, and more. Click [here](https://docs.zuper.co/Work_Order_Management/Jobs/managing_your_jobs#applying-filters) for more details on how to apply multiple filters and find specific assets quickly.

After filtering an asset, click the “**Asset Name**” or “**Asset Code**” to view and manage its details.
## Managing Asset Details
Once an asset is created or accessed from the listing page, the **Asset Details Page** becomes your central hub for managing its lifecycle. The page follows a three-column layout, the left panel displays the asset's primary details, while the right panel provides contextual insights and quick actions for efficient asset management.

## Left panel
The left panel contains asset-related details such as the asset name and code. Below this, you will find the quick actions bar, which provides contextual action buttons, including options to view the history of performed actions, create a new job or project, add notes, and view the asset's QR code (which can be printed and affixed to the physical asset for tracking and identification purposes).
From here, you also have quick access to view information such as asset details, associated parts, notes, history, activity, and jobs.
> [accordion] View history
>
> Use the " **History"** button to view a chronological log of all actions performed on the asset. This includes Status updates (e.g., asset activation, deactivation, or maintenance), Job and project associations, Parts added, and more.
>
> 
> [accordion] Create new job/project
>
> Use the “**+ New**” button to create a new job or a project for the asset, if required.
>
> 
>
> * For step-by-step instructions on how to create a new job, see the [Creating a new job](https://zuperinc.mintlify.app/Work_Order_Management/Jobs/creating_a_new_job) article.
> * For step-by-step instructions on how to create a new project, see the [Creating a new project](https://docs.zuper.co/Projects/Creating_a_new_project) article.
> [accordion] Add notes
>
> Use the "**+ Add Note**" button to create a new note. Notes are comments or information added to an asset over its course. Your notes can be anything ranging from a simple text reminder to an image of the item, service, video, or document. All added notes can be viewed under the **Notes** Section.
>
> 
> [accordion] View & print QR code
>
> Use the " **QR Code**" button to view and print the asset’s QR code, which can be attached to the physical asset for streamlined tracking and identification.
>
> 
> [accordion] View asset details
>
> The asset details section offers a comprehensive overview of the asset, including its code, ownership, status, warranty status, last service date, purchase date, price, location, description, and other relevant details.
>
> 
> [accordion] View asset parts
>
> 1. This section allows you to view all the parts associated with the asset. To add new parts to the asset, click the "**+ Add item**" button at the top right of the page.
>
> 
>
> 2. Select the parts with quantity and click "**Add Part.**" The parts will be updated successfully to the asset.
> [accordion] View notes
>
> 1. The Notes section allows you to view, add, and manage notes related to the asset. From here, you can use the rich text editor to add any new note. To tag a user to a note, you can use @ and key in the name to tag the user.
>
> 2. You can attach multimedia files such as images, audio, video, and documents related to the contract. Use the “**+**” option to associate the notes with other modules such as customer, property, etc.
>
> 3. You can also choose one of the following options for how you’d like the notes to be visible:
>
> * **Public**- This privacy setting will help you make the note public to all, including the customer.
> * **Internal**(Default) – This privacy setting will help you make the note visible to all your Zuper users in your account.
> * **Only me**– This note is visible only to the user who created the note.
>
> After adding the notes, click the “**Post Note**” button to post the notes.
>
> 
>
> 1. Once the notes have been posted, you can sort them based on the newest or oldest.
>
> > [!NOTE]
> >
> > **Note**: Asset notes can be edited or deleted only by the user who created them.
> [accordion] View asset history
>
> The asset history section allows you to view a chronological log of all actions performed on the asset.
>
> 
> [accordion] View activity
>
> The activity section on the details page displays a log or timeline of all actions and updates related to this asset, helping you stay informed about recent changes and track the asset’s status.
>
> 
> [accordion] View asset jobs
>
> The asset jobs section allows you to view all jobs associated with the asset. This includes new, ongoing and completed jobs, providing you with a comprehensive overview of job statuses, schedule, and related details.
>
> 
## Right panel
In the right panel, view the organization or contact information associated with the asset, and manage its links to various modules, such as properties, projects, contracts, organizations, PPM, and more. To associate a module, click the “**+**” icon next to the desired module.

## More actions
Managing assets doesn’t stop at viewing details—you can perform various actions such as editing, cloning, printing, sharing, and deactivating the asset. To do this, click the "**More Actions**" button at the top right corner of the page and select the desired option.

> [accordion] Edit Asset
>
> Use the **Edit Asset** option to modify existing asset details as needed.
> [accordion] Clone
>
> Use the **Clone** **Asset option** to quickly create a replica of an existing asset, saving time. The current asset details will be duplicated onto a new asset page, where you can make any necessary edits before saving.
> [accordion] Print/Save as PDF
>
> Use this option to print the asset details or save them as a PDF for documentation purposes.
> [accordion] Share via Email
>
> This option enables you to share asset details via email directly from the platform.
> [accordion] Deactivate
>
> Use the Deactivate option to disable the asset. Once deactivated, you will have the option to **delete** the asset, if needed.
Managing assets efficiently is crucial for ensuring their optimal usage, tracking their status, and maintaining accurate records. With Zuper, you have a centralized platform to oversee all asset-related activities—from creation and modification to tracking history, managing associated parts, and linking jobs or projects.
# Creating a contract
Source: https://docs.zuper.co/Contracts_and_Assets_Management/Contract/Creating_Contract
A service contract is an agreement between a business and its customer that outlines the services to be performed, the timeline for completion, and other essential details. It serves as a formal record of the mutual commitments, ensuring clear expectations and accountability for both parties.
Let’s get started by creating a new contract for Zuper!
**Navigation**: *Contracts and Assets Management module -> Contracts -> + New Contract*
## To create a new contract
* Select the "**Contracts and Assets Management**” module from the left navigation menu and choose “**Contracts**."

* On the contracts listing page, you will see an overview of existing contracts, including Contract Names, Start & End Dates, Status, and more.
* Click the “**+ New Contract**” button at the top right corner of the page to begin creating a new contract.

* The new contract creation page appears in a user-friendly three-pane layout, making data entry easier:
1. **Left Panel**: Enter the contract details, term, and address.
2. **Center Panel**: Add important contract information such as contract type (new/renewed), description, and associated parts & services.
3. **Right Panel**: Associate contracts with relevant modules like customers, invoice history, properties, assets, and more.
### A. Contract Details

* **Contract Package**: Select a package from the dropdown menu. These packages can be configured under **Settings** > **Configuration Settings** > **Contracts** > **Contract Packages**.
> [!NOTE]
>
> **Note**: When selecting a package, the contract period, type, and parts & services will be auto-filled based on the package details.
* **Contract Prefix**: Enter a prefix to help identify the contract.
* **Contract Name**(*Mandatory*): Provide a unique name to identify the contract
### B. Contract Period
* **Contract Term**(*Mandatory*): Define the contract period in months.
* **Contract Start Date**(*Mandatory*): Set the start date of the contract.

> [!NOTE]
>
> **Note**: Once the start date is selected, the invoice details are automatically populated based on the chosen package.
* **Contract Expiry Date**(*Mandatory):* Enter the contract's end date.
* **Activation Date**: Specify the date on which the contract becomes active and its services are available to the customer. Please note that the activation date can be the same as or later than the Contract Start Date, depending on when the customer begins using the contracted services.
### C. Primary Details
* **Contract Ref No**: Assign a unique reference number to the contract.
* **Contract Type**(*Mandatory*): Choose the contract type (e.g., New or Renewed).

* **Contract Template**: Select the standard template to be used for the contract.
* **Contract Description**(*Mandatory*): Enter a brief description of the contract.
### D. Part/Service Details
Parts & services will be automatically populated based on the selected contract package in the details section. Additionally, you can add items by clicking the "**+ Add**" button.

After adding the parts and services to the contract, based on the organization settings, either a transaction-level or line-item *discount* will be applied to that contract.
### Options
Choose the preferred [Option](https://docs.zuper.co/Inventory_Management/Parts_Services/Create_New_Part_Service#3-options) for each line item in the contract parts list.

> [accordion] Updating Discount Type
>
> To update the discount amount, click the icon next to "Discount" or use the icon in the Parts & Services details section to update Discount Type Settings.
>
> 
>
> Depending on your Organization settings, you can choose how discounts to be applied:
>
> * **Line-item level**: Apply discounts to each individual item in the quote.
> * **Transactional level**: Apply discounts based on the subtotal of all items in the quote.
> [!NOTE]
>
> **Note**: If a line item has a custom tax and the contract includes both taxable and non-taxable parts and services:
>
> * Only line-item level discounts can be applied.
> * Transaction-level discounts cannot be applied in such cases.
>
> Transaction-level discounts are only applicable when all parts and services in the contract are either fully taxable or fully non-taxable. This restriction ensures accurate discount and tax calculations, preventing any miscalculations.
### E. Associations
When creating a contract, you can associate various modules with the contract as needed to streamline field service operations and maintain a centralized record of all relevant information related to the contract. These associations help ensure seamless contract execution and tracking.
Click the “**+**” icon next to each section to associate the modules, further enhancing the contract management process and keeping all pertinent information in one easily accessible location.

> [accordion] Organization/contact
>
> Associating a contact or organization with a contract, you can maintain details of businesses and key contacts linked to the contract. Based on the contact/organization chosen, the service address will be auto-filled. You can then change as needed.
> [accordion] Properties
>
> Associating properties with the contract helps streamline scheduling and dispatching, ensuring technicians are assigned to the correct locations.
> [accordion] Projects
>
> By associating a project with a contract, you can manage complex service agreements more effectively, ensuring that all jobs related to the project are aligned with the contract terms.
> [accordion] Invoice History
>
> The **Invoice History** section provides a chronological log of all actions and updates related to an invoice. This helps maintain a clear record of changes, ensuring transparency and easy tracking of invoice modifications, status updates, and payments. During contract creation, you can set up recurring invoices for contracts.
>
> > [accordion] Setting Up Recurring Invoicing for Contracts
> >
> > Recurring invoicing ensures timely billing for ongoing service contracts, helping businesses maintain a consistent cash flow while reducing manual effort. To enable automated invoice generation, follow these steps:
> >
> > 1. **Billing Period**: Choose the frequency of invoicing—**Quarterly, Yearly, or Monthly**.
> > 2. **Generate Invoice Before (In Days)**: Specify how many days in advance the invoice should be created (e.g., 5 days before the due date).
> > 3. **Payment Term**: Set the payment term (e.g., Monthly).
> > 4. **Invoice Template**: Select an invoice template from the available options.
> > 5. **Automatically Generate Invoice**: Choose **Yes** to enable automatic invoice creation or **No** for manual generation.
> >
> > 
> >
> > Based on the configured settings, invoice dates will be generated automatically.
>
> > [accordion] To view invoice history
> >
> > 1. Navigate to the **Contract Details** page.
> > 2. In the right panel, locate the **Invoice History** section.
> > 3. Here, you can see a detailed log of all actions taken on the invoice.
> [accordion] Assets
>
> Associating assets with the contract enables you to track specific assets covered under the contract, ensuring that they receive the necessary maintenance and servicing. This helps manage the assets' lifecycle and maintain optimal operational performance.
> [accordion] Planned Preventive Maintenance (PPM)
>
> By associating PPM tasks with the contract, you can schedule recurring maintenance to prevent service disruptions. This ensures that all required preventive measures are in place, reducing downtime and extending the longevity of the equipment.
>
> > [accordion] Steps to create a new PPM
> >
> > To create a new PPM,
> >
> > **1. Step 1**
> >
> > Click the "**+ Create PPM**" button. A sidebar will appear to create a new PPM.
> >
> > 
> >
> > **2. Step 2: Primary Details**
> >
> > Fill in the following primary details:
> >
> > * **PPM Name:** Enter a name for the PPM.
> >
> > * **PPM Description:** Provide a brief description of the PPM.
> >
> > * **Choose Property:** Select a property of an org/customer to associate with the PPM.
> >
> > * **Choose Asset (Mandatory):** Select one or more assets for which you want to create a new PPM. You can choose assets currently associated with the contract or any other existing assets, as needed.
> >
> > 
> >
> > * **Choose Part/Service:** Select a part or service associated with the contract to include in the PPM.
> >
> > * **Priority (Mandatory):** Select the priority from the drop-down list. Options include Low, Medium, and High.
> >
> > * **Auto Generate Job:** By default, it will be set to "**No**." If you want to auto-generate a job based on the PPM, select "**Yes**."
> >
> > **3. Step 3 (Optional): If selected "Yes" for Autogenerate job. Follow these steps:**
> >
> > Job Settings
> >
> > * **Generate Job in Advance (Mandatory)**: Set how many days before the scheduled date the job should be created automatically.
> >
> > * **Job Category**: Choose the job category from the drop-down list.
> >
> > 
> >
> > * **Street Address**: Click "**Pick from Map**" to fill in the street address information.
> >
> > After completing the primary details, click the "**Next**" button to proceed to the scheduling step for the PPM.
> >
> > **4. Step 4: PPM Schedule**
> >
> > Provide the following details to schedule:
> >
> > * **PPM Start Date**: Select the start date of the PPM.
> >
> > * **PPM End Date**: Select the end date of the PPM.
> >
> > 
> >
> > * **Recurrence**: Select how often this PPM should occur- Daily, Weekly, Monthly, Yearly, or Custom.
> >
> > * **Schedule Dates**: These dates are **automatically populated** for upcoming schedules (service dates) based on the chosen recurrence.
> >
> > **5. Step 5**
> >
> > After filling in all of these details, click the “**Create PPM**” button. A new PPM will be created and added to the contract successfully. After creating a PPM, you can edit/delete it as needed by clicking the icon next to it.
> >
> > 
> >
> > > [!NOTE]
> > >
> > > **Note**: You can also create a new PPM directly under the "**Asset** " column after adding an asset. Once the PPM has been created and associated with this contract, you can view it under the "PPM" section.
> [accordion] Attachments
>
> Adding attachments to the contract allows you to store and manage important documents such as agreements, service reports, or manuals. This ensures easy access to vital information whenever needed, keeping all contract-related documentation organized and readily available.
* After filling in all the required details, click the "Save Contract" button at the top right corner of the page.
* A "Save Contract" dialog box appears. Click the "**Create**" button."

* A new contract will be created successfully.
# Overview
Source: https://docs.zuper.co/Contracts_and_Assets_Management/Contract/Overview
In Zuper, the **Contracts Module** enables businesses to efficiently manage service agreements, ensuring seamless execution, tracking, and maintenance of contractual obligations. It provides a centralized platform for defining contract terms, automating invoice generation, and monitoring contract-based jobs, helping businesses stay compliant and organized while delivering consistent service.
*For contracts covering multiple assets or stations, PPM is configured per asset — each asset gets its own schedule and auto-generates its own job independently. See Creating and managing PPM for step-by-step instructions*
### **Key Benefits of the Contracts Module**
**Automated Invoice Generation** Effortlessly generate recurring invoices based on predefined billing periods, payment terms, and invoice templates, reducing manual work and ensuring timely payments.
**Seamless Contract Associations** Link contracts with customers, assets, properties, jobs, and invoices, centralizing all contract-related data for streamlined workflow management.
**Recurring Service & Maintenance Automation** Schedule and automate preventive maintenance and recurring job assignments to ensure timely service fulfillment and contract compliance.
**Parts & Services Management** Automatically populate contract-specific parts and services, apply predefined pricing structures, and offer discounts at the transactional or line-item level based on business needs.
**Advanced Contract Filtering & Search** Apply and save custom filters to quickly locate specific contracts based on status, renewal dates, contract types, and other attributes, improving accessibility and organization.
**Invoice & Payment History Tracking** Maintain a detailed record of contract-related invoices, modifications, and payments, ensuring complete financial transparency and easy auditability.
**Follow up Reminders** Set up automated reminders for contract renewals and expirations, helping businesses take proactive action to extend agreements and maintain uninterrupted service.
**Customizable Contract Templates** Personalize contract formats with company branding, service terms, and payment conditions, ensuring consistency and professionalism in customer interactions.
**User Roles & Permissions** Define access controls and approval workflows by assigning contract-related permissions to specific team members, enhancing security and operational control.
***
# Managing your contracts
Source: https://docs.zuper.co/Contracts_and_Assets_Management/Contract/managing_your_contract
Efficient contract management is essential for maintaining clear agreements, ensuring compliance, and optimizing service operations. Zuper provides a centralized platform to track, update, and manage contracts seamlessly. With powerful features, businesses can monitor contract statuses, manage associated records, and ensure that all contract details remain accurate and aligned with business needs.
This article will walk you through the steps to access the Contracts listing page, update contract details, and manage contracts effectively in Zuper.
**Navigation**: *Contracts and Assets Management module -> Contracts -> Contracts listing page -> Contract Details*
# Accessing the contracts listing page
* Select the “**Contracts and Assets Management**” module from the left navigation menu and choose “**Contracts**.” You will land on the contracts listing page.

* On the contracts listing page, you can view an overview of existing contracts, including the Contract Name, Start & End Dates, Status, and more.
# Exploring the listing page
Customize the Contracts listing by adding/removing or reordering columns, then Update View to overwrite or save it as a new view.
**Update View**
Click Update View to modify the current view after changes.
**Save as a new view**
Use the dropdown beside Update View → Save as new view.
**Create View dialog**
Enter the View Name (mandatory), choose Share with (User/Team) and add users, toggle Visibility to all users, and click Create.
**Reset View**
Click Reset View to restore the current view to the default.
**Permissions**
* Edit: Add/remove/reorder columns; save as new or overwrite existing views.
* View-only: Apply views but can’t edit; can Save as new view to copy without altering the original.
* Manage view: Rename, adjust Visibility (Only Me/User/Team or global toggle), Duplicate, or Delete (creator only; reverts to default/another saved view).
**Open contract details**
After filtering, click a Contract Number or Contract ID to view and manage details in the Zuper Contracts Module.
## Pinned filters
Zuper's Contracts module lets you use pinned filters to streamline your filter experience. Pinned filters keep your most-used criteria readily accessible for quick application.
Pin up to 3 filters in any module.
**Navigation**: *Contracts and Assets Management module -> Contracts -> Filters -> Pinned Filter*
1. Select the “**Contracts**” module from the left navigation menu.

2. **Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

3. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters.

# Managing contract details
Once a contract is created or accessed from the listing page, the Contract Details Page serves as your central hub for managing its lifecycle. The details page has a three-column layout, providing quick access to information and actions within each panel.

## Left panel
The left panel contains contract-related details such as the contract name and number. Below this, you will find the quick actions bar, which provides contextual action buttons, including options to email the customer, add notes, and create a new job for the contract. From here, you also have quick access to view information such as contract details, associated notes, parts & services, jobs, and activities.
> [accordion] Mail customer
>
> Use the "**Mail**" button to view and mail the contact or the organization for whom you’re creating this contract.
>
> 
> [accordion] Create new job
>
> Use the “**+ New**” button to create a new job for the contract, if required.
>
> For step-by-step instructions on how to create a new job, see the [Creating a new job](https://zuperinc.mintlify.app/Work_Order_Management/Jobs/creating_a_new_job) article.
>
> 
> [accordion] Add note
>
> Use the "**+ Add Note**" button to create a new note. Notes are comments or information added to a contract over its course. Your notes can be anything ranging from a simple text reminder to an image of the item, service, video, or document. All added notes can be viewed under the Notes Section.
>
> 
> [accordion] View contract details
>
> The contract details section provides an overview of all contract-related information, including the contract number, contract type, contract period, invoice details, contract address, and more.
>
> 
> [accordion] View notes
>
> 1. The Notes section allows you to view, add, and manage notes related to the contract. From here, you can use the rich text editor to add any new note. To tag a user to a note, you can use **@** and key in the name to tag the user.
>
> 2. You can attach multimedia files such as images, audio, video, and documents related to the contract. Use the “**+**” option to associate the notes with other modules such as customer, property, etc.
>
> 
>
> 3. You can also choose one of the following options for how you’d like the notes to be visible:
>
> * **Public** - This privacy setting will help you make the note public to all, including the customer.
> * **Internal** (Default) – This privacy setting will help you make the note visible to all your Zuper users in your account.
> * **Only me** – This note is visible only to the user who created the note.
>
> After adding the notes, click the “**Post Note**” button to post the notes. Once the notes have been posted, you can sort them based on the newest or oldest.
>
> > [!NOTE]
> >
> > **Note**: Contract notes can be edited or deleted only by the user who created them.
> [accordion] View associated parts & services
>
> This section allows you to view the parts and services associated with the contract. It provides an overview of all the items included, whether automatically populated from the contract package or manually added.
>
> 
> [accordion] View associated jobs
>
> The Jobs section allows you to view all jobs associated with the contract. This includes both ongoing and completed jobs, providing you with a comprehensive overview of job statuses, schedule, and related details.
>
> 
> [accordion] View activity
>
> The activity section on the details page displays a log or timeline of all actions and updates related to the contract, helping you stay informed about recent changes and track the contract’s progress.
>
> 
## Right panel
In the right panel, view the organization or contact information associated with the asset, and manage its links to various modules, such as properties, assets, projects, organizations, and more. To associate a module, click the “**+**” icon next to the desired module.

## More actions
Managing contracts doesn’t stop at viewing details—you can perform various actions such as printing, sharing, editing, cloning, or deactivating the contract as needed.
> [accordion] Print and Share
>
> To print or share the contract via email, click the “**Print/Share**” option from the top right corner of the job details page and choose either “**Print/Save as PDF**” or “**Share via email**” option.
>
> 
> [accordion] Edit contract
>
> To modify any of the existing contract details, click “**More Actions**” at the top right corner of the page and select '**Edit Contract**.
>
> 
> [accordion] Clone existing contract
>
> The Clone option allows you to quickly create a replica of an existing contract, saving you time. To do this, click "**More Actions**" at the top right corner of the page and select "**Clone**." The current contract details will be duplicated onto a new contract page, where you can make any necessary edits before saving.
> [accordion] Deactivate contract
>
> To deactivate/disable the contract, click “**More Actions**” at the top right corner of the page and select “**Deactivate**.” Once deactivated, you will have the option to delete it if needed.
Managing contracts efficiently is essential for seamless operations, compliance, and financial accuracy. With Zuper, you have a comprehensive platform to oversee every aspect of your contracts, from creation and tracking to modifications and associated actions, ensuring they remain well-organized, up-to-date, and aligned with your business objectives
# Create a Widget
Source: https://docs.zuper.co/Create-a-Widget
Creating a widget takes only a few minutes. Start by choosing the widget type that best matches your customer journey: **instant estimate**, **online booking**, **estimate & book**, or **lead capture**, and then configure how submissions should be handled in Zuper.
Every new widget begins in **Draft** status. You can complete the setup, test the experience, and make changes without exposing it to homeowners until you're ready to activate it.
## Create a new widget
1. Go to **Settings** from the left navigation menu.
2. Under **Customer Experience**, select **Website Widget**.
3. Select **+ New Widget** at the top right.
4. Enter a **Widget** **Name**. This name is for internal reference and isn't shown to homeowners. Zuper also uses the widget name as a tag to help identify and manage submissions created through the widget.
5. Optionally, add a **Description** for your team's reference.
6. Select a **Widget** **Type**: *Online Booking, Instant Estimate, Estimate & Book, or Lead Capture*.
7. Turn on **Create a Job** if you want Zuper to automatically create a job for every submission. When enabled, a **Job Category** field appears, allowing you to select the category assigned to those jobs.
Leave this setting turned off if you prefer to review submissions before creating jobs manually.
8. Select **Next**. Zuper saves the widget as a draft and opens the next step, Appearance.

## What's next
Continue through the setup to configure the experience for homeowners. The remaining steps depend on the widget type and may include appearance, questions, roofing options/service, and other settings.
Choose the setup guide for your widget:
> [card] [Online Booking](/Setting-up-Online-Booking-Widget)
>
> Let homeowners choose a service and book directly.
> [card] [Instant Estimate](/Zuper_for_Roofing/Website_Widget/Instant_Estimate)
>
> Show or share pricing options before a homeowner calls.
> [card] [Estimate & Book](/Zuper_for_Roofing/Estimate_and_Book_widget)
>
> Combine a price estimate with scheduling a visit.
> [card] [Lead Capture](/Zuper_for_Roofing/Setting-up-Lead-Capture-widget)
>
> Collect project details for your team to follow up.
## Frequently asked questions
> [accordion] How many widgets can I create?
>
> You can create up to **20 widgets**. Each widget is independent, with its own type, branding, questions, and settings, allowing you to tailor widgets for different customer journeys and campaigns.
> [accordion] Should I turn on Create a Job?
>
> Turn it on if you want every submission to become a job automatically, ready for your team to schedule without an extra step. Leave it off if you'd rather review each submission first, for example, to confirm scope or filter out low-quality leads, before it becomes a job.
>
> > [!NOTE]
> >
> > **Note**: For Estimate & Book widgets, Zuper creates a job once a homeowner books a visit, regardless of this setting.
> [accordion] Will Zuper create a contact and property from a submission?
>
> Yes. When a homeowner submits a response, Zuper checks your account for a matching contact and property. If a match already exists, Zuper links the submission to those existing records instead of creating duplicates. If no match exists, Zuper creates a new contact and property as a lead intake.
# Adding and Managing Cards in Your Wallet
Source: https://docs.zuper.co/Customer_Portal/Cards
This guide explains how to add, manage, and use payment cards in the Customer Portal's Wallet. The Wallet saves up to five cards on file for quick and secure payments, eliminating the need to re-enter card details for every transaction.
**Navigation**: *Settings -> Customer/Contact Settings -> Allow Payment Card on File*.
## **For Business:**
### **Pre-requisites**
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Customer/Contact**.” Select the “**Customer/Contact General Settings**.”

2. **Allow payment card on file?**

## **For Customers:**
**Navigation**: *Customer Portal* *-> Cards*
### **Accessing the Wallet**
1. Log in to the Customer Portal. If the business has enabled the card addition option, you’ll see a **Wallet** menu item in the navigation.

2. Click **Wallet** to view your saved cards and Transaction history.

### **Adding a Card to Your Wallet**
You can add up to five cards to your Wallet, including any cards added during previous transactions with the business. Follow these steps to add a card:
1. Navigate to the **Wallet** section in the Customer Portal.
2. Click the **Add Card** button.
* Enter the card details in the provided fields, Card number
* Expiration date
* CVC code
* Country
* Zip code

3. If you want the new card to be your primary card, check the **Set as primary card** checkbox. (See the details of the “**Setting a Primary Card**” section below.) Click **Save** to add the card.

**Actions You Can Take:**
* **Set as Default**: Select a card and click **Set as Default** to make it the payment default.
* **Delete a Card**: Select a card and click **Delete**. If it’s the Default card and you have other cards, you’ll be prompted to choose a new Default card.
* **View Details**: See card details like the brand and last four digits (full card numbers are never shown for security).
The Default card is the default card used for payments during checkout. Here’s how Default cards work:
* **One Default Card**: Only one card can be set as Default.
* **Mandatory Default Card**: A Default card must be set if you have at least one card.
* If you have only one card, it is automatically set as the Default card.
* If you have multiple cards, the first added card is the default, but you can change it.
* **Setting a Default Card**:
* When adding a new card, check the **Set as Default card** checkbox to make it the Default card.
* To change the Default card, go to the Wallet, select a different card, and click **Set as Default**.
* During Checkout, when using a new card to pay, a Set as default card checkbox appears (unchecked by default). Check it to set the new card as the Default.
* **Deleting a Default Card**: If you delete the Default card and have two or more remaining cards, you’ll be prompted to select a new Default card.
If you have only one card, you can delete it even if it is the Default card.
**Managing Cards in Your Wallet**
In the Wallet, you can view and manage all cards saved on file, including those added by the business. Each card displays:
* Card brand (e.g., Visa, Mastercard).
* Last four digits.
* Expiration date.
* Default card status (if applicable).


## **Using a Saved Card During Checkout**
You can use saved cards to make payments quickly during checkout in the Customer Portal. Here’s how:
1. Proceed to the checkout page.
2. Your default card is selected by default in the payment section.
3. Select a different saved card from the list of saved cards to use.
4. The selected card’s details (e.g., card number, expiration date) are pre-filled for convenience.
5. Complete the payment.
**Notes:**
* **Disabled Card Types**: You cannot select those cards during checkout if the business disables a card type or brand.
**Using a New Card**: If you pay with a new card instead of a saved one, you’ll see a **Save card for future payments** checkbox. Check it to add the card to your Wallet. A Set as Default card checkbox appears (unchecked by default) if checked. \
\
**Invoice Payments:**
1. Click any one of the invoices to view the details.

2. Click the “**Pay**” button to pay for the invoice.

3. Select the payment method and click “**Pay Now**.”

4. The payment is successfully done.

## **Quote Payments:**
1. Click any one of the quotes to view the details.

2. Click the “**Pay Deposit**” button to pay for the quote.

3. Select the payment method and click “**Pay Now**.”

4. The payment is successfully done.

## **Frequently Asked Questions**
**Why can’t I see the Wallet in the Customer Portal?**
The Wallet is only visible if the business has enabled the “Allow customers to add cards on file” setting. Contact the business to confirm.
**How secure is my card information?**
Stripe, a trusted payment processor, encrypts and securely stores your card details. Neither the business, Zuper, nor any other intermediaries can access your card information.
**Can I add more than five cards?**
No, a customer record is limited to five saved cards, including those added by the business. However, if the business has your cards saved for future transactions, they will be reflected, even if there are more than five.
**What happens if I delete my only card?**
You can delete your only card, but you must add a new card or enter payment details manually for future transactions.
**How do I know when my saved card is charged?**
You’ll receive an email notification whenever a saved card is charged for approved work.
## Customer Portal User Manual link
[Customer Portal Settings](https://docs.zuper.co/Settings/Customer_Portal/Customer_Portal)
[**Login to your customer portal**](https://docs.zuper.co/Customer_Portal/Login_to_customer_portal)
To learn more about the Customer Portal usage, click [here](https://drive.google.com/file/d/10KQUozMwYmoUhS7GEsjY0QG_ACSIz2Ib/view?usp=sharing)
# Login to your customer portal
Source: https://docs.zuper.co/Customer_Portal/Login_to_customer_portal
The customer portal is your one-stop solution for viewing your field service-related activities. You must log in and provide your user ID and password to enter our portal, or you can use your email ID and OTP.
## Pre-Requisites
To do the setup correctly, use the link below:
[**Customer Portal**](https://docs.zuper.co/Settings/Customer_Portal/Customer_Portal)
## **Login via Password**
1. Enter the URL:
`{{company-login-name}}.stagingzuperhub.com` -> Staging\
`{{company-login-name}}.zuperhub.com` -> Live
Login to Zuper customer portal account. Enter the "**Email ID**" and click next.

2. Enter the email ID and password. (Note: this is applicable if you have opted for a user ID and a password.)
Click the "**Login**" button.

3. The login is successful.

4. To change your password, click the "**Reset Password**" button.

5. The password reset email will be sent to the registered email ID.

6. Check the registered email. Click the "**Set Password**" button.

7. Enter the password and reconfirm the password.
Click the "**Reset Password**" button.

8. The password is reset successfully.

9. Enter the email ID and password. (Note: this is applicable if you have opted for a user ID and a password.)
Click the "**Login**" button.

10. The login is successful.

## **Login via OTP**
Alternatively, you can login using your email ID and the OTP received in your email ID.
1. Login to the Zuper customer portal account. Enter the "**Email ID**" and click "**Send OTP**."

2. Check the email to get the "**OTP**."

3. Enter the OTP received and select the “**Sign in**” button.

4. The login is successful.

## Customer Portal User Manual link
[Customer Portal Settings](https://docs.zuper.co/Settings/Customer_Portal/Customer_Portal)
[**Adding and Managing Cards in Your Wallet**](https://docs.zuper.co/Customer_Portal/Cards)
To learn more about the Customer Portal usage, click [here](https://drive.google.com/file/d/10KQUozMwYmoUhS7GEsjY0QG_ACSIz2Ib/view?usp=sharing)
A secure login process safeguards your personal and financial information on a customer portal. It allows only authorized users to access sensitive data, such as account details, billing information, and order history.
# Dispatch Assistant
Source: https://docs.zuper.co/Dispatch/Assistant-Dispatch
Find the Right Technician, Every Time
Dispatching isn’t just about assigning *any* technician; it’s about assigning the right technician at the right time. Zuper’s **Dispatch Assistant** on the Dispatch Board helps dispatchers do exactly that, in seconds.
Dispatch Assistant intelligently shortlists the most suitable technicians by evaluating job location, technician base location, and existing scheduled jobs, along with availability, skills, service territories, shifts, and workload. By factoring in both where a technician starts and where they are headed next, it clusters assignments more effectively and significantly reduces unnecessary travel.

This smart evaluation enables dispatchers to:
* Assign jobs faster with confidence
* Optimize assignments and minimize travel time
* Improve on-time arrivals and job sequencing
* Balance workloads across technicians
With Dispatch Assistant, dispatchers move from manual guesswork to data-driven decisions, improving operational efficiency while delivering a better experience for both technicians and customers.
> [!TIP]
>
> **Availability** \
> Dispatch PRO must be enabled for your organization. Please contact our [support team](support@zuper.co) to enable this feature.
## Accessing Assisted Scheduling
You can launch **Dispatch Assistant** directly from the **Dispatch Board** by right-clicking on the relevant job and selecting “**Dispatch Assistant**”.

The panel opens; Dispatch Assistant automatically evaluates the job details and begins shortlisting eligible technicians.
### Understanding the Dispatch Assistant Panel
Dispatch Assistant progressively narrows down technicians using configurable criteria that are automatically pre-filled from the job details. You can also edit each criterion directly from the panel to fine-tune technician selection.
* **Duration (Job Duration)** \
Job Duration reflects the total time required to complete the job. For scheduled jobs, it is derived from the scheduled start and end times. For unscheduled jobs, it uses the [Estimated Duration](/Settings/Modules/Jobs/configuring_Job_categories) defined in the job category. Only technicians who can accommodate the entire duration are considered.
* **Slot Duration** \
Slot Duration defines the time window in which Dispatch Assistant searches for technicians who have enough continuous availability to complete the entire job. For scheduled jobs, it is automatically derived from the job’s scheduled start and end times. For unscheduled jobs, it defaults to your organization’s business hours. You can adjust it manually if needed, but the slot duration must always be equal to or longer than the job duration.\
**Examples**:
* A 1-hour job with a slot duration set from 10:00 AM to 3:00 PM: Dispatch Assistant looks for any technician available for a continuous 1-hour period anywhere within those 5 hours.
* A 1-hour job with a slot duration set from 10:00 AM to 11:00 AM: Dispatch Assistant looks for technicians free for the full fixed hour between 10:00 AM and 11:00 AM.
* A 1-hour job cannot have a slot duration of 10:00 AM to 10:30 AM, as the slot (30 minutes) is shorter than the job duration (1 hour), this is not allowed.
* **Skills and Skill Levels**\
Dispatch Assistant matches technicians who possess the required skills when shortlisting the technicians. Technicians will be shortlisted if they hold any of the necessary skill(s). The skillset filter is automatically inherited from the job, based on [job category](/Settings/Modules/Jobs/configuring_Job_categories#creating-skillsets-for-a-job-category) mapping.
* **Service Territory** \
Technicians & teams are filtered based on the selected Service Territory to ensure territory alignment. This will be picked up automatically from the job, if applicable.
* **Team Selection** \
Assisted Scheduling adapts to how you’re already using the Dispatch Board. When launched from the Dispatch Board, the currently selected team is pre-applied. However, if you want to look out for technicians from other teams, you can update the team from the dispatch assistant panel directly and search for the right technicians.
> [!NOTE]
>
> **Note**: If that team doesn’t belong to the chosen Service Territory, Zuper automatically switches to **Any Team** and shows all eligible technicians.
* **Consider User Shifts** \
When enabled, Dispatch Assistant respects real-world availability by factoring in existing job assignments, shift timings, work hours, time-offs, and non-job events. Only technicians whose shifts align with the selected arrival window are shown.
* **Only Available Technicians** \
This toggle controls how strictly availability is enforced. When enabled, only technicians with uninterrupted availability throughout the job duration are shown. When disabled, even if they are occupied, closet technicians are considered. This is useful when prioritizing critical or high-priority jobs.

### Technician Shortlisting and Sorting
After considering the key criteria, a list of technicians is shown. \
By default, technicians are sorted by **Distance** (proximity), so the nearest technicians appear at the top, helping you quickly find the technician closest to the job from their scheduled job or base location, minimizing travel.
You can refine the technician list using the **Sort By** options:

* **Distance (Default):** Lists technicians closest to their scheduled job or base location, reducing travel time.
* **Available Duration:** Shows technicians with the most free hours at the top, helping assign jobs to underutilized team members.
* **Available Slots:** Prioritizes technicians with the highest number of free slots, supporting flexible, multi-job scheduling.
* **Number of Jobs:** Highlights technicians with the fewest scheduled jobs, helping balance workloads across the team.
* **Base Location:** Lists technicians by proximity to their base location, optimizing start-and end-of-day efficiency and enhancing work-life balance.
> [accordion] Base Location
>
> A technician’s **Base Location** represents their primary start or end point for the workday, such as a home address, office, or depot. Base Location is configured on the technician’s user profile under **Settings > Users > Edit Profile > Location**.
>
> \
> Dispatch Assistant considers the base location alongside job locations when prioritizing technicians. This is especially helpful for early-morning or end-of-day assignments. For example, if one technician is finishing a job slightly farther away, but another technician’s base location is closer to the new job, the Dispatch Assistant prioritizes the technician with the shorter overall travel distance. This improves routing efficiency and supports better work-life balance for technicians.
### Crown Indicator
The **crown icon** highlights the technician whose scheduled job or base location is closest to the job being dispatched. This indicates the technician who is likely to require the **least travel**.
When you hover over a crowned technician card:
* The estimated travel distance and time are displayed.
* Zuper shows the **route on the map** between the technician’s previous job or base location and the selected job.
If Zuper detects that a technician may arrive late to their next scheduled job due to projected travel time, a **conflict message** appears on the technician card. This helps you review alternatives before assigning the job.

Dispatchers can rely on the crown indicator for both current and future assignments to reduce travel and improve routing efficiency.
## Assigning a Technician
1. Review the shortlisted technicians.
2. Select the desired technician.
3. Click **Assign Technician**, or click an available free slot to schedule the job.

4. Confirm the assignment.
You can view the job on the map and visually confirm that the job has been scheduled successfully.
# Creating and managing a non-job event
Source: https://docs.zuper.co/Dispatch/Create_manage_non_job_event
A non-job event refers to any activity that a field technician or other employees engage in that is not directly related to a specific job or work order. Creating these event(s) informs dispatchers that the technician is unavailable for job assignments during this period, enabling better scheduling and resource management.
You can create a non-job event from either the **Dispatch Board** or the **Calendar**.
**Navigation:** *Dispatch Board -> -> Non-Job Event*
## Create a non-job event
1. Select the **Scheduling and Dispatching** module from the left navigation menu and choose either *Calendar* or *Dispatch Board*.

2. Click the **drop-down** menu next to the "**Create Job**" button located at the top-right corner of the page and select “**New Non Job Event**”.

3. A **Create Non Job Event** sidebar will appear.
> [!NOTE]
>
> **Note**: You can create a non-job event for a specific time period on the **Dispatch Board** by clicking and dragging the cursor across the desired time range in the scheduler. Once selected, choose "**Create a Non-Job Event**" from the available options.
4. Fill in the Primary Details section:
* **Event Name (mandatory)**: Provide a name for the event, with a maximum limit of 200 characters.
* **Category (mandatory)**: Choose the category for the event from the list. If needed, you can also create a new category directly from here.
> [accordion] To create a new category
>
> 1. Click "**Create New Category**".
>
> 
>
> 2. Provide the category name, color, and description.
>
> 3. If you want to set the default availability for the event to busy, check the “**Mark Attendees as busy**” checkbox. This will set the availability to ‘Busy’ for any event in the category by default and can be changed at the event level.
>
> 
>
> 4. Click the "**Save**" button. The new category will be created and added to the existing list.
>
> 
* **Event Description**: Provide a description of the event, with a maximum limit of 8000 characters.
* **Attendees**: Select the user(s) who will be engaged in this non-job event.
* **Event Address**: Select and add the event address using the map.

5. Fill in the **Schedule** section:
* **Schedule On (mandatory)**: Set the **start** and **end times** for the selected date, along with the preferred time zone.
* Optionally, toggle '**All Day**' on or off at the top right. When enabled, the **start** and **end** **times** default to business hours in the selected time zone, which can be adjusted as needed.

> [!NOTE]
>
> **Note**: Non-job events can only be scheduled for a single day, not multiple days.
6. **Availability**: Choose whether the attendees will be marked as "**Busy**" or "**Free**" for the event.
> [accordion] Busy
>
> The scheduled time will be blocked for the attendees in Assisted Scheduling. If there is a conflict between a job and the non-job event, the dispatcher will be notified
> [accordion] Free
>
> The scheduled time will remain open, allowing the dispatcher to schedule jobs for the attendees during the non-job event. In this case, the dispatcher will not be notified of any conflicts with the non-job event.
7. **Notify Attendees**: If this checkbox is selected, attendees will receive notifications via push messages on both mobile and desktop devices.

> [!NOTE]
>
> **Note**: Notifications will also be sent to attendees when there are changes to the event's schedule, assignment, or address.
8. **Repeat**: Select how often this non-job event will occur:
* **None** (one-time event).
* **Repeats**: Set the event to repeat daily, weekly, monthly, or yearly based on the scheduled date or day. If you choose to repeat the event, you will be prompted to specify when the recurrence should end.

* **Ends (mandatory)**: Choose either an end date or the number of occurrences after which the recurrence will stop.

9. After entering the required details, click the **Create** button. The non-job event will be successfully created for the selected date and time and will appear on the **Dispatch Board** and the **Calendar** alongside the attendees.

## Managing non-job event
Once the non-job event is created, you can view, edit, or delete it as needed. The event will appear in gray, with a ribbon on the left side that may be striped or unstriped, depending on the attendees' availability:
* A **striped ribbon** indicates that the attendees are **available**.
* A **solid ribbon** (no stripes) indicates that the attendees are **busy**.

### **Edit non-job event details**
To view and edit a non-job event, follow these steps:
1. Select the specific event on the calendar or dispatch board. This will open the non-job event details on the right, showing all relevant information.

2. Click the ellipsis icon (three dots) at the top-right corner of the page to update the event details and select **Edit**. Alternatively, you can right-click on the event and choose the **Edit** option.

> [!NOTE]
>
> Note: If the event is part of a recurring series, a pop-up will appear prompting you to choose one of the following options:
>
> * **Update this event only:** Changes will apply only to the selected instance of the event.
> * **Update this and upcoming events:** Changes will apply to the selected event and all subsequent events in the series.
>
> 
3. Once you’ve made the necessary changes, click the “**Update**” button to save the updated event details. The changes will also be notified to the relevant attendees.

> [!NOTE]
>
> **Note**: When you update a single instance of a recurring event, that instance will no longer be part of the recurrence and will become a single event.

### Delete non-job event
To delete a non-job event, follow these steps:
1. Select the specific event on the calendar or dispatch board. This will open the non-job event details on the right, showing all relevant information.

2. Click the ellipsis icon (three dots) at the top right of the page and select "**Delete**.” A confirmation pop-up will appear. Click “**Delete**” to proceed. Alternatively, you can also right-click on an event and choose the “**Delete**” option.

> [!NOTE]
>
> **Note:** If the event is part of a recurring series, a pop-up will appear, prompting you to choose one of the following options:
>
> * **Delete this event only**: Deletes only this specific instance.
> * **Delete this and upcoming events**: Deletes this event and all future occurrences in the series.
>
> 
3. Click the “**Delete**” button to proceed with deleting the event.

## **Non-job events on mobile**
After creating a non-job event, attendees will receive a notification on their mobile device. From the mobile app, they can view the event details and delete the event as needed. Recurring events are indicated with a ‘**recurring**’ icon.

> [!NOTE]
>
> **Note**: If the event is part of a recurring series, users can only delete a specific instance and cannot delete the entire series.
# Creating and managing recurring routes
Source: https://docs.zuper.co/Dispatch/Create_manage_recurring_route
***
The **Recurring Routes** feature in Zuper enables dispatchers to create multiple instances of routes with predefined frequencies and associate them with recurring jobs of the same cadence.
This means you may have repeated jobs that need to be done at the same route regularly, such as daily, weekly, or monthly. These recurring routes ensure efficient route planning and management, leading to improved productivity and consistent service delivery.
**Navigation**: ***Dispatch Board -> Routes***
## **Creating a recurring route**
The creation of a recurring route carefully considers multiple aspects automatically, including:
* Technician availability
* Route's available duration
* Frequency of job recurrences
* Geographical proximity of jobs to the route
This enables you to create routes that not only optimize travel time and efficiency but also ensure that frequent jobs are completed on time and to a high standard by the assigned technician. The assigned technician benefits from familiarity with both customers and routes.
## **Creating a recurring route series**
Creating a recurring route series involves specifying the start and end locations and the frequency of repetition. This can include:
* Daily, weekly, or monthly schedules
* Specific hours of the day, days of the week, or dates of the month
Based on the chosen frequency (recurrence), multiple route instances will be created within the *Recurring Route Series*.
Once the recurring route series is created, you can add an eligible recurring job series containing multiple job instances and assign it to a technician. This allows the assigned technician to efficiently manage their schedule and ensure consistent job completion on the assigned route at the designated time and frequency.
[https://drive.google.com/file/d/1E9WFyTog4lJy8qmHi-g5DCVf88gHmLFp/preview](https://drive.google.com/file/d/1E9WFyTog4lJy8qmHi-g5DCVf88gHmLFp/preview)
## To create a recurring route
1. From the **Dispatch Board**, select the **“Routes”** stream.

2. Click the “**Create**” button at the top right of the page and choose "**Route**' from the drop-down menu.

1. A quick sidebar appears. Specify the following details in each of these sections:
#### **Primary Details:**
* **Route Title (Mandatory)**: Provide an identifiable name for the route.
* **Route Description**: Provide additional details or instructions related to the route.
* **Assigned to**: Specify the individual for this route.
> [!NOTE]
>
> **Note**: Since you’re creating a recurring route, the selected technician will be assigned to all the route instances (and the jobs within them).
* **Start Location (Mandatory):** Provide the starting point or address from where the route begins its journey using the map.
* **End Location**: Provide the final destination or address where the route concludes (this is optional). If it’s not provided, the last job will be considered as the last location of the route.

#### **Schedule:**
* **Duration (Mandatory):** Set the Planned duration (total duration of travels + total duration of accomplishing jobs) for every instance of the route.
* **Date & Time (Mandatory):** Set the start date and time for the route.
* **Recurrence:** Choose how often this route will occur, whether it's a one-time event (does not repeat) or repeats daily, weekly, monthly, or on a custom schedule.
> [!NOTE]
>
> **Note**: Since we are creating a recurring route series, you need to select every day, every week, every month, or every year from the chosen date or day. Alternatively, you can provide custom dates.
* **Ends (Mandatory):** Set either the specific end date and time or specify after how many occurrences the route should end. Based on your input, the route will take place with the total number of route instances determined.

#### **Additional Details:**
* **Route Color**: Choose a unique color for this route to make it easily identifiable on the map.
* **Mode of Transport**: Choose the method of transportation used for this route, such as car / semi-truck, truck, or pedestrian.
* **Route Type**: Choose an ideal route type: Fastest Travel Time, Shortest Distance.
* Once you have filled in all of these details, click the “**Create**” button to create a route.
> [!NOTE]
>
> **Note**: If you want to add more details to the route, click the "**Detailed Route Creation**" button at the top right corner. This will expand the route creation with additional surfaces that enable provision not only to add jobs but also to view the route on the map as shown below.

## Add recurring jobs to recurring routes
If you haven't leveraged the **Detailed Route Creation** option to add the jobs during the initial route creation, consider doing so. This option allows for a more comprehensive setup by adding jobs at the outset, ensuring all relevant factors are considered from the beginning.
[https://drive.google.com/file/d/1kHOqVkN\_aC3VTuV1dFzn9tUlxDGolBej/preview](https://drive.google.com/file/d/1kHOqVkN_aC3VTuV1dFzn9tUlxDGolBej/preview)
So, once the recurring route has been created, our system's intelligent matching technology makes it easy for you to identify the right set of recurring jobs by considering multiple attributes such as route capacity, job schedule and cadence, required skillsets, and technician availability. By associating these jobs with the appropriate recurring routes, our system ensures that the recurring job instances are efficiently allocated.
> [!NOTE]
>
> **Note**: To add a recurring job, make sure while creating a route, you’ve selected an option from the dropdown menu under **recurrence**: every day, every week, every month, or every year.
**To add a recurring job series to a recurring route series, follow these steps:**
1. Click the “**+ Add Job**” button under the Route itinerary. A sidebar will appear, displaying the right set of recurring job series that:
* Has the overall time span that is less than that of the route (route span must be > job's)
* Has the number of job instances less than the number of route instances. (route's count must be > job's)
* Has job cadence less than the route's (e.g., a daily route can be associated with a weekly job, but not vice versa)
* Has valid Geo Coordinates

Additionally, you can view any conflicts associated with the existing Recurring Route Series. To view the associated conflicts, click the dropdown menu next to icon.

The conflicts that may occur include User Conflict, Frequency Conflict, Date Conflict, Duration Conflict, and Skill Conflict.
> [!NOTE]
>
> **Info:** Conflicts are the list of potential exceptions while associating recurring jobs to routes. While you can always override them, the intent is to enable you to take informed business decisions while planning the routes.
| **Conflict Type** | **Description** |
| - | - |
| User Conflict | This conflict occurs when the job is assigned to a technician different from that of the recurring route series/instance. For example, you have a recurring maintenance route scheduled every Monday and assigned to Technician A. In such a case, a job on this route that is scheduled and assigned to Technician B instead of Technician A will be highlighted as a user conflict. However, you can override this conflict. By doing so, the route technician will be assigned to all the job instances. |
| Frequency Conflict | This conflict occurs if both the recurring route & job series do not have synchronized frequency. For example, if a recurring route is scheduled every Tuesday, but a job meant for this route recurs every alternate Tuesday, this conflict will occur. If you override this conflict, the job will be assigned to the route instance based on the job frequency. |
| Date Conflict | A date conflict occurs when the job's date differs from any of the route instances under the recurring route series. For example, if a route is scheduled for every Monday, and a job is scheduled for every Wednesday, this difference in scheduling days causes a date conflict. This type of conflict typically arises when recurring jobs are scheduled on a different day of the week compared to the recurring route instances. In such cases, we will auto-align the schedules of all future job instances with the recurring route instances. This means that when you select jobs that do not exactly match the route's schedule/dates, they will be automatically adjusted to match. |
| Duration Conflict | This conflict occurs when the total number of hours spent by a technician on jobs and travel overshoots the overall allocated ‘Duration’ of the route instance. For example, A technician is allocated 8 hours for a day's route, but the combined time for the jobs and travel amounts to 10 hours, exceeding the allocated duration causes this conflict. However, you can supersede this conflict, doing so, the route duration exceeds based on the job duration. |
| Skill Conflict | This conflict occurs when there is a mismatch between the skill set of the assigned route technician and the skill set required to complete the job. For example: A job requiring advanced electrical skills is assigned to a route technician specializing in plumbing, leading to a skill conflict. However, you can override this conflict. Doing so, the route technician will be assigned to all the job instances. |
1. Select the recurring job(s) series that you want to this recurring route series.

2. Once chosen, click the “**Choose Job**” button. The recurring job series (master job) will be added to the recurring route series.

3. From here, you can also perform actions such as viewing the added job location on the map or removing the job by clicking the "**kebab**" (three-dot) icon next to it. Additionally, you can add more jobs to this route using the "**+ Add Job**" button and to reorder the jobs within the route so as to achieve the optimal route, avoiding unnecessary travel.

5. Once added, click the "**Create**" button. The recurring route series and the recurring job series will be created successfully. This means that each future job instance within the recurring job series (master job) will be associated with the corresponding recurring route instances, as shown below:

From the above image, you can see that the first job instance within a recurring job series is associated with the start of the route instance. Subsequently, based on the job frequency, it continues to associate with the route instances accordingly.
Certainly! Here's an example that showcases the associations between jobs and route:
**Example:**
Suppose you have a biweekly job that starts on 2024/08/15 (Thursday) and weekly routes that start on 2024/08/09 (Friday). The job is scheduled to occur every two weeks, while the route follows a weekly schedule. In this case, here's how the association would be:

**Associations:**
* The job on 2024/08/15 will be associated with the route on 2024/08/09.
* The job on 2024/08/29 will be associated with the route on 2024/08/23.
From this example, you can understand that each job instance within the biweekly job series is directly associated with the start of the weekly route instance and continue to align correctly to the route based on their respective frequencies. In other words, job scheduled on 15th of Aug is rescheduled to 09th Aug and the job scheduled 29th of Aug is automatically rescheduled to 23rd Aug.
## To manage recurring routes
Beyond typical functions such as *List, Edit, Delete, Lock*, etc., you can manage movement of jobs between routes by delicately balancing the intricacies of target route’s capacity (Scheduler View) and geographical proximity of a job to the target route (Map View).
[https://drive.google.com/file/d/1kwpNqISdYIUthimGoTauwxKcbMTdWGtk/preview](https://drive.google.com/file/d/1kwpNqISdYIUthimGoTauwxKcbMTdWGtk/preview)
1. To manage recurring routes, choose the “**Planning**” section in the dispatch board from the "**Routes"** Stream as shown below:

2. Once navigated to the “**Planning**” section, choose the “**Recurring Routes**” option from the dropdown menu under the **Routes** section. You can view the list of recurring route series with details such as the number of route instances and jobs within each series, travel time, distance, and assigned users.

3. Choose any of the recurring route series. On the next page, you can view the following details on the left.
* Recurring route series name.
* Recurring route description (if added).
* Assigned users to the route.
If users are not assigned, you can also assign a user by clicking the “**Assign User**” button. Once assigned, you can **assign/unassign** the user directly from here. To do so, click the user profile icon in the recurring route series card. A scrolling pop-up appears with the list of users. You can either choose to assign or unassign the user from the route.
> [!NOTE]
>
> **Note**: Any changes made to the recurring route series will apply to all route instances within it.
* Route frequency
* Jobs within the recurring route series (if added). This includes the master job, which is linked to all recurring route instances at the right. If you remove any of the job instances within recurring route series, all the job instances will be removed.
> [!NOTE]
>
> **Note**: Any One-Off jobs (non-recurring) added to individual route instances will not be visible here.

1. You can also add or remove a master job from the left. To add a job, click the “**Add Job**” button at the bottom left. To remove the job from the route series, click the “**Kebab**” icon under “**Jobs**” at the left and select “**Remove Job**.”

> [!NOTE]
>
> **Note**: When you remove the master job, it will be removed from all the route instances.
5. On the right, you can view and manage all upcoming and past route instances. This includes actions such as adding or removing users, viewing conflicts, locking or deleting route instances, adding one-off jobs to the recurring route instance, viewing or removing jobs, and moving jobs from the route instance.
This in turn helps you handle the day-to-day details at the route instance level rather than at the master level, ensuring each route instance is managed with precision, enhancing overall scheduling efficiency and operational flexibility.
[https://drive.google.com/file/d/1eO20m\_cZCX\_5iEAOpYseD9L55kL5RiBK/preview](https://drive.google.com/file/d/1eO20m_cZCX_5iEAOpYseD9L55kL5RiBK/preview)
1. To view and manage any of the route instances within a route series, click the specific route instance.
2. You can view details such as route instance name, occurrence date and time, associated user, jobs and conflicts (if any).

### Add/Remove users
You can directly add or remove a user from any route instance to manage assignments effectively. Here’s how:
1. Click the **user profile** icon in the recurring route instance.

2. A scrolling pop-up will appear with the list of users. You can then choose to assign or unassign the user from the route instance. Once done, click the “**Save**” button.

3. The selected user will be successfully added to the instance.

> [!NOTE]
>
> **Note**: Any action taken will affect this specific route instance only and not the complete recurring route instances within a recurring route series. This feature is handy for managing ad-hoc situations, such as when the designated technician for the recurring route is unavailable and it's necessary to allocate a particular recurring route instance to a different technician.
### View conflicts
Identify and resolve conflicts associated with the route instance (if any).
1. To view the associated conflicts, click the “**View**” button next to “**Conflicts in this Instance**.”

2. A pop-up appears listing the conflicts associated with the specific route instance. Based on the conflicts, you can choose to continue with them (or) make necessary changes to the route instance, such as assigning a different user, rescheduling jobs from the instance, moving jobs, and so on.

### Lock/Delete route instances
You can also lock or delete any of the route instances within the recurring route series. When you lock a route instance, you won't be able to update it. This means you cannot assign or unassign users, edit jobs within it, move jobs, add jobs to the route, or reorder them until it is unlocked.
1. To lock or delete a route instance, click the “**kebab**” icon next to the route instance.
2. From there, you can choose either “**Lock Route**” or “**Delete Route Instance.”**

> [!NOTE]
>
> **Note**: Deleting the route will only remove the route, but the jobs will be there with the schedule (without assignment though).
### Add One-off jobs to the recurring route instance
For a recurring route instance, you can add one-off jobs, but not recurring jobs, since the instance is part of a recurring route series. One-off jobs are jobs that occur only once, rather than being part of a regular schedule.
You can add one-off jobs by considering factors such as route instance duration, technician availability, geographical proximity of these jobs to the route, and the current job schedule. Here’s how:
1. Click the "**Edit Route**" button under the route instance.

2. An "**Edit Route**" sidebar will appear where you can make necessary changes to the route, such as adding one-off jobs, assigning or unassigning users, changing the route start and end locations, adjusting the route schedule, and more.

3. After making the necessary changes, click the "**Update**" button to save them.

> [!NOTE]
>
> **Note**: Any changes made here will affect this route instance only and not the entire recurring route series containing multiple instances.
### View/Remove job
1. Based on the conflicts, if you need to make necessary changes to a job in this instance, click the “**kebab**” icon under Jobs and select either “**View Job**” or “**Remove Job**.”

2. When you click "**View Job**," a sidebar appears with job details, allowing for quick field edits. From this sidebar, you can also view full details, clone the job, or delete it using the "**ellipsis**" icon at the top right.

### Move route jobs
There will be situations when a job must be off-loaded from one of the instances of a recurring route to another due to unforeseen circumstances such as technician unavailability, customer preference, equipment failure, or urgent high-priority tasks arising unexpectedly.
In such cases, you can move jobs efficiently and seamlessly between routes by carefully considering various aspects such as proximity and travel time to the job location, current workload of the destination route, along with technician's skills and availability. This ensures that the movement of the job is done with minimal disruption and maximum efficiency.
You can move route jobs from the source to the destination using any of the following options:
* Directly choosing the destination route
* Using the Map view
* Using the Scheduler view
> [!NOTE]
>
> **Note**: When moving one of the job instances from a recurring job series that [satisfies the condition](/Dispatch/Create_manage_recurring_route#add-recurring-jobs-to-recurring-routes), you will have an additional option to move not just the current instance but all future instances of the recurring job series to the target route. Whereas if you move one-off jobs or recurring jobs whose schedule range exceeds that of the target route, only the selected job instances will be moved to the target route.
### **Directly choosing the destination route**
Use this option only if you are quite sure about the destination route to which you want to move the job(s) to, and the user assigned to the destination route has the same skill set to complete the job.
[https://drive.google.com/file/d/1jXfsh9LVlJAhwsQK6rviN-mrbRw6KS82/preview](https://drive.google.com/file/d/1jXfsh9LVlJAhwsQK6rviN-mrbRw6KS82/preview)
To move route jobs, follow these steps:
1. Click the “**Move Jobs**” button under the route instance.

2. The **Move Route Jobs screen appears**, displaying the source route, its date and time, and the associated jobs on the left.

3. To move the job from the existing route (source) to another (target or destination), on the right, under “**Destination route,**” click the dropdown menu and choose either a "**one-off route**" or a "**recurring route**."

4. Based on your selection, you can view the available routes. Choose the destination route that is near the source route.

1. Once the destination route has been chosen, simply drag and drop the job from the source route to the destination route and click the "**Save**" button to update the changes.

### Use the map view
If you're unsure which destination route to move the job to, switch to the Map view. The Map view also helps you find a destination route that is proximate to the current route (source). Here's how:
[https://drive.google.com/file/d/1FIsIS0g772qpp5dFhekWgvdi0V\_9ggDb/preview](https://drive.google.com/file/d/1FIsIS0g772qpp5dFhekWgvdi0V_9ggDb/preview)
1. Select "**Map**” on the right and click “**Show all routes**” at the top. This will display all created routes on the map for the selected date, including recurring and one-off routes.

2. You can also use "**Filter**" to refine the routes displayed on the map based on skill sets, date, and users. After setting the filters, click the “**Apply**” button.

1. From the filtered routes, choose the closest route to the source route of your choice by considering the overall route duration, jobs already assigned to the route, and travel time necessary between jobs, and choose it as the destination route by clicking the “**Set as Destination Route**” button.

4. After choosing the destination route, simply drag and drop the job that you want to move from the source route to the destination route and click the "**Save**" button to update the changes.

### **Use the scheduler view**
If you need to move a route job to another route based on the customer's preferred date and time, the “**Scheduler**” view is your best choice. Here, you can simultaneously view both the technician availability and capacity of each route on a selected date. Based on this data, you can choose the destination route. Here's how:
[https://drive.google.com/file/d/1hOYaxNIgrDHi\_Ykt6jKqTuAg8CiXaPuj/preview](https://drive.google.com/file/d/1hOYaxNIgrDHi_Ykt6jKqTuAg8CiXaPuj/preview)
1. Click "**Scheduler**" on the right. You will see all available routes with their duration based on the source route date by default.

2. You can also change the date according to the customer’s preference using the "**date picker**" on the top right. This allows you to view the selected date's routes along with their duration and associated jobs on the scheduler.

> [!NOTE]
>
> **Note**: You can also apply other filters such as skill sets, and users to refine the routes displayed on the scheduler. After setting the filters, click the “**Apply**” button.

**Set as Destination Route**
1. Based on the routes available, choose the right destination route by considering the overall route duration, jobs already assigned to the route, technician availability at the customer's preferred time, and proximity and travel time to the job location, and “**Set as Destination Route**” by right clicking the route on the scheduler.

2. Once the route is set as the destination route, you can then simply drag and drop the jobs that you want to move from the source route to the destination route and click the "**Save**" button. The job will be moved from the source route to the destination route successfully.

So, that's a comprehensive overview of the "Recurring Routes" feature within the dispatcher module. With these step-by-step instructions, you can now leverage the recurring route feature completely to create recurring routes with predefined frequencies and associate them with recurring jobs, and ensure all recurring jobs are managed regularly within the recurring routes.
# Dispatcher Queue
Source: https://docs.zuper.co/Dispatch/Deep_dive_into_dispatcher_queue
A dispatcher queue is one of the important layouts on the dispatch board that helps you (*dispatchers*) identify and prioritize pending jobs/routes, assign them efficiently, and monitor their progress.
**Navigation:** ***Dispatch Board --> Settings***
In Zuper, the dispatcher queue has been broadly categorized into two dispatching streams: “***Jobs***” and “***Routes***”. This provides the flexibility to choose the stream that best suits your business needs.

The key guiding factors are:
1. **Jobs Stream**: Ideal for businesses primarily driven by the availability of technicians, rather than technician travel. The objective here is to directly assign/schedule jobs to technicians based on their availability (drag & drop to the schedule) and geographical location of the jobs e.g., proximity of a new job to the existing ones.
2. **Routes Stream**: Suited for businesses where technician travels is extensive. The objective here is to directly assign the routes to technicians based on their availability (drag & drop to the schedule), followed by assigning jobs to the scheduled route based on the route capability and proximity of a job to an existing route (drag & drop to an existing route within the schedule).
> [!NOTE]
>
> **Note**: When businesses decide on the “**Routes**” stream, scheduling or assigning a job cannot commence without first assigning a route to the technician.
As a business user, it is essential to identify your specific needs and select either the “**Jobs**” or “**Routes**” stream before delving into the dispatching features of Zuper.
## Assigning/Scheduling a job to an available technician
Assign jobs to technicians by balancing not only the technician's schedule but also the geographical proximity of the job to other jobs, enabling you to cluster job assignments.
However, to assign the job to an available technician, you first need to identify the pending jobs. Here's how:
To view pending jobs and assign/schedule them to the available technician, choose the **“Jobs”** dispatching stream.

You can view the list of jobs on the dispatcher queue based on the selected job type from the dropdown menu. The job type includes:
| **Job Type** | **Description** |
| - | - |
| Unscheduled Jobs | These are the jobs that have not yet been scheduled, i.e., there is no start and end time for the technician to perform the job. |
| Assigned Jobs | These are the jobs assigned to a specific technician at a given time. This contains jobs of all statuses, such as on my way, started, completed, and so on. |
| Unassigned Jobs | These are the jobs that have not yet been assigned to any technician. |
| Overdue Jobs | These are the jobs that have passed their due date and still need to be completed. |
Once you filter and identify the required job, you can assign or schedule it to an available technician.\
In Zuper, you can assign and schedule a job in **two ways**:
1. **Manually (Drag and Drop)**
2. **Using Dispatch Assistant**
### Manually assisging or Scheduling a Job
1. Select the "**Team**" and "**Date**" when you need to schedule the job. Based on the team selected, you can view the technicians within the team and their availability for the selected date in the scheduler.

2. Depending on the technician's availability, simply drag and drop the job from the dispatcher queue onto an available technician (from a selected team) in the scheduler, where you’ll be asked to provide the start and end date and time to schedule/reschedule the pending jobs. To schedule the job for the full business day, turn on **All day** at the top right of the dialog. Zuper sets the start and end times to your business hours.

3. Once the job has been assigned, the field technician gets notified to get the job done on the set date and time. You can also view the job location on the map by right-clicking the job in the scheduler and selecting the **'Show on Map**' option.

> [!NOTE]
>
> **Note**: You can simultaneously view locations of shortlisted jobs from the Dispatcher Queue and jobs assigned to technicians in the Scheduler on the map. You can also assign technicians to jobs directly from the map.
### Using Dispatch Assistant
Select [**Dispatch Assistant**](/Dispatch/Assistant-Dispatch) from the job’s right-click menu to launch Zuper’s intelligent technician recommendation panel.

Dispatch Assistant evaluates job requirements such as:
* Job duration
* Required skills and skill levels
* Service territory
* Technician availability and workload
Based on these factors, Dispatch Assistant shortlists the most suitable technicians, helping you assign the job quickly while minimizing travel time and scheduling conflicts.
### **Actions from the Dispatcher Queue**
From the **Dispatcher Queue**, dispatchers can take quick actions on any job using the right-click menu. These actions help you view job details, find the right technician, or use intelligent assistance to dispatch jobs faster.
To access these options, right-click any job card in the Dispatcher Queue.
#### View Details
Select **View Details** to open the **Job Side Sheet**.

\
The Job Side Sheet displays complete job information, including schedule, service address, assigned users, and job metadata. From here, you can:
* Assign or update technicians
* Set a **Primary Technician** while assigning users
* Review job priority, dates, and service territory
This option is typically used when you need to review or update job information before dispatching.
#### Find Live Technician
Select [**Find Live Technician**](/Dispatch/Live_View) to locate technicians who are currently available and closest to the job location.

\
This action switches the Dispatch Board to **Nearby mode**, where you can:
* View live technicians on the map
* Check distance and estimated travel time
* Assign the job directly to a suitable technician
This option is ideal for urgent or same-day jobs that need immediate assignment.
#### Dispatch Assistant
Select [**Dispatch Assistant**](/Dispatch/Assistant-Dispatch) to launch Zuper’s intelligent technician recommendation panel.

#### Call Customer
You can call a customer directly from the Dispatcher Queue without opening their profile. This is useful when you need to confirm a schedule, clarify job details, or share an update while dispatching a job. Calls are placed through Zuper Connect.
To call a customer from the Dispatcher Queue:
1. Right-click a job card in the Dispatcher Queue.
2. Hover over **Call**, followed by the customer's name, to view the available phone numbers.
3. Select the number you want to call.
> [!NOTE]
>
> **Note**: Zuper Connect must be set up for your account to call customers from the Dispatcher Queue. For more information, see [Using Connect on Web](/Zuper_Connect/Using_Connect_on_web).

## Assign an unassigned route to the available technician (Tracking View)
Informed assignment of routes to the right technicians with consideration for their schedule, viz., shift/business hours, time-off, etc.
Unassigned Routes refer to predefined pathways that have not yet been allocated to a specific technician. From the dispatch board, you can assign an unassigned route to an available technician based on their availability and proximity to current jobs/routes for the selected date.
To view unassigned routes and assign to the available technician, choose the “**Routes**” dispatching stream.

This stream is divided into two sections: **Jobs** and **Routes** in the dispatcher queue. Additionally, you have dedicated options such as **Tracking** and **Planning** (available next to the Routes).\\

| **Tracking** | **Planning** |
| - | - |
| This is the default view when switched to “Routes” stream that enables you to track all the jobs & unassigned routes for a specific day, leveraging the powers of both scheduler and maps in parallel. **Note**: In tracking view, you cannot select dates beyond tomorrow; you can choose and track until the next day, today, and previous dates scheduled routes and jobs within a route. | This allows you to plan routes well in advance. You can create a route for the future and assign jobs for multiple weeks/months in advance. **Note**: In planning view, you will have the flexibility to change the dates and months as needed. This allows you to plan and create routes well in advance. |
To assign unassigned routes, follow these steps:
1. Select the “**Routes**” section under the “**Routes**” stream in the dispatcher queue.

2. You can view all the unassigned routes in the dispatcher queue and track their location on the map as well.

In addition to this, you can also track the following on the map:
* Location of the job type selected in the dispatcher queue.
* Location of routes (if any) scheduled for the technician on the selected date.
3. Select the "**Team"** and "**Date**" to schedule the route. Based on the team selected, you can view the technicians within the team and their availability for the selected date in the scheduler.

4. Depending on technician availability, you can assign any unassigned route from the "**Unassigned Routes**" section by either clicking "**Assign User**" in the dispatcher queue or dragging and dropping the route next to the technician in the scheduler with the right consideration of their availability and proximity to current jobs/routes for the selected date.

5. The Route will be assigned successfully to the technician for the selected date.  6/. After assigning a route to the technician, you can reschedule the route, view the location of the route on the map , and more by right-clicking the assigned route in the scheduler.

7/. You can also access various details by clicking on the route, such as:
* **Primary Details:** This includes the route color, mode of transport, route type, and no. of. Jobs were assigned to that route, technicians were assigned, and so on.
* **Jobs:** This includes the jobs that are added to that route. You can also choose to add/remove a job from this route and assign to another route.
In addition to viewing this information, you can also easily perform several actions by using the quick action icons located at the top right corner of this page. These actions include locking a route, assigning a user, editing, deleting, and cloning routes.

> [!NOTE]
>
> **Note**: When you lock the route, you won't be able to update it. This means you can't change the route location, reschedule, add more jobs to the route, or reorder them until they are unlocked.
## Assigning job to the technician route
Efficiently assign multiple jobs to a route by balancing key factors such as overall route duration, job schedules, and total travel time between jobs based on the mode of transport (e.g., car, truck, semi-truck). This can be done using either the scheduler or the map.
#### Using the Scheduler:
Once a route has been assigned to an available technician, you can add jobs to the route by dragging and dropping them. Prioritize jobs that are geographically close to minimize travel time.
To assign a job to a technician's route using the Scheduler view, follow these steps:
1. Under the Routes stream, click the "**Jobs**" section on the dispatcher queue and shortlist any of the jobs from the dropdown menu.

2. Once shortlisted, choose an appropriate job that aligns with the route duration and **drag and drop** it onto the technician assigned route for the selected date. 
> [!NOTE]
>
> **Note**: You can also reschedule the job duration while assigning it to the technician's route.
3. The job will be assigned to the technician route successfully. The field technician will then receive a notification to complete the job on the scheduled date and time on that route.  .
4. Upon successfully assigning a job to the technician's route, you can perform certain quick actions such as rescheduling the job, assigning the job to another route, removing the job from the route, and so on, by right-clicking on it.

#### Using the Map:
The map view allows you to directly see the locations of jobs and routes, making it easier to assign jobs efficiently by considering geographical proximity, overall route duration, and existing jobs on the route.
You can assign jobs to the nearest route by drawing shapes around job locations or using the arrow pointer. Here's how:
1. Go to the Maps layout on the Dispatch Board.
2. On the right side of the map, you’ll find tools that help you select job(s). These tools include:
> [!NOTE]
>
> **Note**: The tools will be visible only when you select the "**Route**" layer from the map.

**Arrow Pointer**
The intent of this option is to selectively choose a few jobs amidst a cluster, considering various attributes such as status, schedule, technician assignment, etc.
A classic example is an attempt to associate one of a recurring job instances (repeating at the same address) to a nearby route, (or) a case where jobs of various schedules and statuses are in the location, and you want to assign only a selected few to a nearby route
1. Select the arrow pointer located on the right-hand side.

2. During the arrow select mode, job details are displayed on hovering over the job cards. This will help choose jobs based on their schedule, status, technician assignment, etc.

3. Manually select individual job(s) on the map by clicking on them.  4. The order in which you select jobs using the pointer will determine the sequence in which they are added to the destination route.
> [!NOTE]
>
> **Note**: To unselect jobs, click "**Clear selection**" at the top of the map.

**Shapes**
The intent of this option is to select multiple jobs at once and assign them to a nearby, existing route. It’s useful when you have several open jobs clustered in a specific location and want to optimize technician travel.
1. Choose a shape from the available options (Pentagon, Rectangle, Circle) on the right of the map. 
2. Click and drag on the map to draw the shape around multiple jobs at once. All jobs within the shape will be selected. 
> [!NOTE]
>
> **Note**: To switch to a different shape and clear the current selection, click "**Clear selection**" at the top of the map.

**Assign Jobs to a Route** Once jobs are selected, either with the arrow pointer or a shape:
1. Hover over the nearest route, which will be bolded when hovered over.

2. Click on the Route of your choice (based on its proximity to the selected jobs) to view its details – Name, Start Date & Time, Consumed Duration, etc.

3. Based on the route details, select the route and click the "**Add 'n' job(s) to route**" button. A pop-up will appear.

**Review and Finalize Job Assignment**
1. A pop-up window will appear displaying details about the selected jobs, including job name, status, assignee, and scheduled date and time.

2. Review the information, select the jobs you want to add to the route, and click the "**Add 'n' job(s) to route**" button to finalize the assignment.

> [!NOTE]
>
> **Note**: When you use an arrow pointer to select jobs, the job(s) will be added in the order they were selected. For example, if there are already 3 jobs in the route, the newly selected jobs will be added as the 4th, 5th, and 6th jobs in the sequence.
### Plan and Schedule Route to the Available Technician (Planning View)
Enable advanced planning of routes and potential technicians ahead of weeks by leveraging these options - Offers early insights into schedules of teams and technicians viz., pre-planned route/jobs assignments, time-offs, shift/business hours, etc.
In addition to tracking past/ongoing routes and jobs within it, businesses can plan to schedule jobs/routes to future dates based on the requirement. To do so,
1. Switch to “Planning” view in the Routes dispatching stream.

2. Once you switched to planning, you have two dedicated views “**Scheduler**” and “**Map**.”

| **Scheduler** | **Map** |
| - | - |
| This view is intended to plan routes/jobs with the right consideration for schedule of various teams & technicians across a date range. Hence, the scheduler view takes precedence while leveraging this option. | This view is intended for dispatchers to plan routes/jobs with consideration for the location covered by existing routes. The idea is to enable adding jobs to routes that are proximate enough to existing routes. |
Using the scheduler view (dispatch board), you can plan and schedule routes/jobs based on the availability of technicians belonging to teams across a date range. To do so, follow these steps:
1. From the scheduler view, click the **"Date"** tab and choose the **future dates**.

> [!NOTE]
>
> **Note**: Future dates can only be selected within a week in a month.
2. Once the date is set, you can easily/visually identify the technicians and their available schedules across the selected date range (including non-business hours & time-offs) in the scheduler view.

3. Choose any of the unassigned routes under the “**Routes**” section and drag & drop it next to the available technician in the scheduler.

> [!NOTE]
>
> **Note**: When dragging and dropping the route from the dispatcher queue to the available technician in the scheduler, you can schedule/reschedule the route start & end date and time.
4. The route will be assigned successfully to the technician for the future date. 
### Plan and assign jobs to scheduled routes
Assign and schedule jobs into routes that're scheduled and pre-assigned to technicians by balancing - overall route duration, jobs already assigned to the route, and travel time necessary between jobs.
In addition to scheduling a route and individual jobs directly to a technician, you can also assign any of the jobs (be it assigned, unassigned, or unscheduled jobs) to a technician's route well in advance if the job is intended to be part of a route a technician is planned to carry out (this typically includes jobs that needs to be performed in the future or moved to future dates). This can be done using either the **dispatch board scheduler** or the **map**.
> [!NOTE]
>
> For instructions on how to assign jobs to a scheduled route, [refer to the steps above](https://care.zuper.co/portal/en/kb/articles/dispatch-board-deep-dive-into-dispatcher-queue#Using_the_Map). Please note, in this case, you will need to select the "**Map**" section next to the Dispatch Board to complete the activity.
#### **Using Scheduler**
1. Click "**Jobs**" on the dispatcher queue and shortlist any of the jobs from the drop-down menu.

2. Once shortlisted, drag and drop the job (job should be within the route duration) onto the technician's scheduled route for the future.

3. The job will be assigned to the route well in advance.

## Plan and create a Route Using a Map
Using a map, you can locate all unassigned routes and plan routes/jobs based on the location proximity of a job to an existing unassigned route or vice-versa. There are multiple ways through which Maps helps a dispatcher plan. Here’s how:
> [!NOTE]
>
> **Note**: You cannot schedule from this view. To schedule, you must switch to the schedule option in the planning section.
#### Map-based Route Planning:
The map-based route planning enables you (dispatcher) in more than one way:
1. **Create new routes by clustering jobs** that are geographically proximate to one other, leveraging simple polygons drawn on a map surface - A perfect means to create routes that are extremely efficient; reducing technicians' overall time on road.
2. **Plan and associate jobs to existing routes** that are nearest to it - Minimized travel & detour for a technician assigned to the route; thereby increasing the overall efficiency (no. of jobs per route/day) and customer experience. 
> [!TIP]
>
> From the image above, it's evident that the "#JOB2024422 AC Service Task" job is located near the "Job Route 405" route. With this recognition, you can efficiently plan and create a route to complete the job.
#### Map-based Route Creation:
As mentioned above, you can create new routes by clustering jobs that are geographically proximate to one other, leveraging simple polygons drawn on a map surface. here's how:
1. Choose any shape (**circle, rectangle, pentagon**) to plot an area on the map. 
2. Once the shape has been chosen, drag and select the job(s). After selecting the job(s), click the “**Create Route**” button at the top right corner. 
3. Provide route details such as route name, color, route type, star location, end location, etc., and click the "**Create**" button. The route will be created successfully for the selected job on the map.
> [!NOTE]
>
> **Note**: You can also delete the jobs or add more jobs to the route by clicking "**+ Add Job**" button.
By optimizing the scheduling and dispatching processes, this feature improves service delivery, reduces downtime, and ensures that technicians are deployed to the right locations with the right tools and information. Ultimately, the Dispatch Board in Zuper streamlines operations, leading to better customer satisfaction and increased productivity.
# Users, Scheduler, and Map layouts
Source: https://docs.zuper.co/Dispatch/Detailed_Overview
In addition to the dispatcher queue, the dispatch board includes several other interconnected layouts: **Users, Scheduler,** and **Map**. These layouts work together seamlessly to provide a comprehensive view of operations and enhance the efficiency of task management.
**Navigation**: ***Dispatch Board -> Users | Scheduler | Maps***
Here's how each layout contributes to the overall functionality of the dispatch board:
## Users
The user layout on the Dispatch Board enables you to shortlist technicians based on teams and schedule dates. This helps you track and plan routes/jobs more effectively by focusing on specific teams and daily schedules.\
\
To select a team, view the technicians in that team (along with their assigned jobs/routes on the selected date in the **Scheduler** view), and optimize your planning, follow these steps:
1. Select the *team* *name* from the drop-down menu. All technicians in the selected team will appear in the Scheduler, along with any assigned jobs or routes for the chosen date. If jobs are assigned on that date, their locations are also visible on the Map.
> [!NOTE]
>
> **Note**: The team picker on the Dispatch Board only shows dispatchable teams. If you cannot find a team in the list, it may have been marked as non-dispatchable in **Settings -> Users & Teams -> Team Management**. To make the team available again, uncheck the **Non-Dispatchable** checkbox for that team.

2. Change the *date* using the date picker. This lets you quickly view a technician’s schedule for any specific date and plan assignments accordingly.

3. You can also refine the only available technicians using the new quick filter:
* Toggle on the “**Only Available Technicians**” in the Users filters area.
* When enabled, the Users panel automatically hides technicians who are unavailable for the entire selected day due to:
1. An **All-Day Time-Off** entry, or
2. An **All-Day Non-Job Event** marked as **Busy**.
* Partial-day time-offs or non-job events do **not** hide technicians; they remain visible with their open time slots shown. This reduces clutter, prevents accidental assignments to fully unavailable technicians, and helps you focus faster on those with real availability.

4. Once the team, date, and filtered list are set, review each technician’s load and availability:
* Hover over a technician to see their current job count (load).
* Check the Scheduler slots for any planned time blocks on the selected date. Based on this, drag and drop the job or route from the Dispatcher Queue directly onto an available technician in the Scheduler. You’ll be prompted to confirm the start and end times.

### Quick notes
Add short notes to a technician card to track availability gaps, scheduling caveats, or reminders, so you don't need sticky notes or separate messages.
1. Hover over a technician card in the **Users** layout.
2. In the **Quick Notes** section at the bottom of the tooltip, click **Add a note**.
3. Enter your note. A note can have up to 200 characters.
4. (Optional) Click **Set expiry (optional)**, select a date and time, and click **OK**. The note clears automatically after the expiry passes.
5. Click **Save note**. 
To edit or delete a note, hover over it, click the three-dot menu, and select **Edit note** or **Delete note**.
> [!NOTE]
>
> Quick notes are visible only to dispatchers on the Dispatch Board. They aren't attached to jobs, aren't visible to technicians in the Zuper Field Service app, and are separate from job notes.
## Scheduler
As dispatcher queue, the Scheduler is also one of the essential layouts in the dispatch board that helps you perform the following activities.
1. Schedule a job/route for the user at a specific date/time and view the scheduled/assigned jobs/routes to the user.
2. Create a Job and New Time-Off.
### Schedule/View Assigned Jobs/Routes in the Scheduler
In the scheduler, you can schedule and view all the jobs and routes that have been assigned to technicians. This view provides a detailed overview of each technician’s schedule and helps you manage and optimize technicians' workload effectively.
To schedule and view jobs/routes in the scheduler, you need to go to the dispatcher queue and select either the “**Jobs**” or “**Routes**” stream. Once selected, you can assign/schedule Jobs/Routes in the Scheduler.
For example, if you have selected the Jobs stream and shortlisted "**Unassigned Jobs**" from the dropdown menu, you can view all the unassigned jobs that have not been assigned to any user (field technician) in the dispatcher queue.
**To assign/schedule the shortlisted job in the scheduler, follow these steps:**
1. Select the “**team name**” and “**date**” when you need to schedule the job. Based on the team selected, you can review user's availability and proximity to current jobs for the selected date in the scheduler.

2. Depending on the user availability, simply drag and drop the shortlisted job from the dispatcher queue onto an available technician (from a selected team) in the scheduler, where you’ll be asked to provide the start and end date and time to schedule/reschedule the pending jobs. To schedule the job for the full business day, turn on **All day** at the top right of the dialog. Zuper sets the start and end times to your business hours.

From the image above, you can see that the shortlisted unassigned job "**#384 AC repair**” is assigned to the user “**Richard Mathew**,” who belongs to the “**Beta Team**” team from **12:03 PM to 12:58 PM on 04/30/2024**. Once the job has been assigned to the user, the field technician gets notified to get the job done on the set date and time.
### Create a New Job or Time-Off
You can create a new job or time-off for a user directly from the scheduler. This quickly enables you to manage the technician’s workload and availability efficiently, ensuring seamless operations and optimal resource utilization.
#### Scheduler – Creating New Job
To create a new job from the scheduler, follow these steps:
1. Simply click & swipe the cursor from left to right next to the user at a specific date/time in the scheduler.
2. A pop-up appears, prompting you to choose an action: “**New Time-Off**” or “**New Job.**”

3. In the pop-up, click “**New Job.**" A sidebar will appear with the prefilled details such as user's name and scheduled date/time to create a new job.

4. Provide other job details such as *Job title*, *org/customer name*, *property name*, *category*, *tags*, *priority*, *due date*, and *service/billing address*, and click the “**Save**” button. A new job will be created and assigned to the user successfully on a specific date and time.

5. If you want to add more details to the job, click "**Create Detailed Job**" at the top right corner of the new job creation sidebar. This will redirect you to the **Job** Creation page.

6. On the Job page, add information, such as service tasks, parts/services, assets, contracts, and any attachments to the job, and click "**Create Job**". The job will be created successfully. For detailed step-by-step instructions on how to create a job, click [here](/Work_Order_Management/Jobs/creating_a_new_job) 7. After creating the job, you can reschedule, unassign, add notes, view it on the map, or delete it by right-clicking the job on the scheduler.

> [!NOTE]
>
> **Note**: You can also create a new job by clicking the "**+Create Job**" button at the top right corner. You will then need to follow the same steps as mentioned above, but keep in mind that the details won't be prefilled since you are creating a new job from scratch.

#### Scheduler – Create New Time-Off
To create a new time off from the scheduler, follow these steps:
1. In the pop-up, click “**New Timeoff**”, and a dialog appears with prefilled details such as date/time and the user.

2. Choose ‘**Reason**” for the time off and click the “**Submit**” button.

> [!NOTE]
>
> **Note**: You can also customize the time/dates from here.
3. A new time off will be created successfully for the user at the particular date/time. You can also view job and time off details on the scheduler by hovering over the respective card.

### Scheduler Views
Based on your choice, you can view the scheduler on a daily, weekly, or monthly basis. To change the view, follow these steps:
1. Click the box above the scheduler and select either “*Day*,” “*Week*,” or “*Month*” from the drop-down menu.
2. Based on your choice, you can view the day and timings in the scheduler. You can also change the date by clicking the **date box** on the left, shown below. 
Here’s a preview of how the scheduler looks if chosen as day, week, or month. 
## Map
Map is one of the critical layouts on the dispatch board, located on the right side, and it provides an overview of jobs, routes, users, customers, properties, assets, and service territory locations on the map.
You can also choose which locations to display on the map by selecting a specific layer from the top of the map. Once chosen, click the “**Apply**” button. Based on the applied layer, you can view only the specific entities locations. For example, when you select both jobs and routes, you can view the locations of jobs and routes, as well as the jobs listed in the dispatcher queue and scheduler, all displayed on the map.

Additionally, there's a provision to set custom colors and icons for entities displayed on the map, such as Jobs, Customers, Assets, and Properties.
These colors and icons are defined by the user based on a pre-configured rule set. This enables you to efficiently manage day-to-day operations by creating color profiles tailored to your preferences, helping you quickly identify and prioritize entities that require critical attention on the map.
For example:
1. **Jobs**: Use different colors/icons based on **status** (e.g., on-hold jobs in red, completed jobs in green, in-progress jobs in blue) or **category** (e.g., Installation job category in blue, Maintenance job category in Green, delivery job category in Red).
2. **Customers**: Assign colors/icons by **category** (e.g., VIP customers in red, regular customers in blue, new customers in green) or by **organization** (e.g., customers under Organization A in orange, Organization B in purple, Organization C in red).
3. **Assets**: Assign colors/icons by **category** (e.g., HVAC equipment in green, plumbing tools in purple) or **status** (e.g., functional assets in blue, under-maintenance in orange, decommissioned in black).
4. **Properties**: Differentiate by **organization** (e.g., Organization A’s properties are orange, Organization B’s are red, and Organization C’s are blue).
This customization allows you to visualize and prioritize critical tasks/entities without the need to dig deep into details of individual items on the map.
## Custom colors/icons
You can customize colors and icons in either of the following ways:
1. **From the color profile icon on the map:** Select the color profile icon located at the bottom of the map.

2. **From map settings:** Click the settings icon at the top right of the map and select “**Customise colours and icons**” next to Enable Map View. A sidebar will appear for you to configure your preferences.

3. Choose the entity/legend that you like to set custom color/icon from the dropdown.

4. Click the icon to select a custom color or icon from the predefined options.

4. Once set, provide a name for the rule under the Name column.

**Add Condition**
1. Under the "**Apply When**" section, click "**Add Condition**".

2. Choose a filter from the available options and click the “**Add**” button to apply the condition.

> [!NOTE]
>
> **Note**: The filters displayed will depend on the entity/legend selected, such as Jobs, Customer, Property or Assets.
3. Finally, click the "**Save**" button to save the custom color/icon for the selected entity.

**Add multiple conditions**
1. You can also add multiple conditions under a single entity. When adding multiple conditions within a single entity, you will be prompted to specify how they should be applied, either using **AND** or **OR** conditions.

2. **Use AND:** Apply rules when all selected conditions must be met.
**Example**: If you choose the "Customer" entity, a specific color/icon can be applied to customers who are in the "VIP" category **AND** belong to "Organization A."
3. **Use OR**: Apply rules when any one of the selected conditions is met.
**Example**: A color/icon can apply to customers who are either in the "Exclusive" category **OR** the "Non-VIP" category.
> [accordion] Understanding Key Rule Behavior in Zuper's Custom Color/Icon Logic
>
> 1. Zuper evaluates rules sequentially, starting with Rule 1.
>
> 2. If a rule’s conditions are not fully met, Zuper continues to check subsequent rules.
>
> 3. Once the rule with the most conditions satisfied is identified, its associated custom color or icon is dynamically applied to the map.
>
> > [!NOTE]
> >
> > **Note**: If there is more than one rule defined against an entity such as Job, Contacts, Property, etc., the rule satisfying the greatest number of conditions will be applied. When there is more than one rule with an equal number of conditions satisfied, the one at the top of the sequence will be applied on the map.
**Here's a real-world scenario for your example** Consider a **customer** named “**Alex**”, who is a regular client of **GPS Pvt. Ltd** with the *email XXX*. Alex's details are evaluated against four predefined rules, with the rule satisfying the most conditions taking precedence. If conditions are equally met, the first rule in sequence is applied, ensuring the most relevant custom color or icon is dynamically displayed on the map for Alex’s profile.
**Interpretation and result:**
**1. Observation:**
Rule 1 satisfies 3 conditions, while Rule 2 satisfies 2 conditions, Rule 3 satisfies 3 conditions, and Rule 4 satisfies 1 condition.
**Precedence**: Although Rule 1 and Rule 3 both satisfy 3 conditions, Rule 1 takes precedence as it satisfies more conditions, and it appears earlier in the sequence.
**2. Custom Icon/Color Application:**
Zuper applies the custom color/icon associated with Rule 1 to the customer “Alex” on the map.
By configuring these conditions, Zuper dynamically applies the designated colors or icons to entities, ensuring an intuitive and visually distinctive map layout based on your preferences.
> [!NOTE]
>
> **Note**: These settings apply organization-wide and are not specific to individual users. You can apply up to 10 rules per entity/legend.
## Color profiles
After creating color profiles for entity(s), you can:
1. **Edit**: Modify the existing conditions or criteria within the color profile.
2. **Delete**: Permanently remove a color profile that is no longer needed.

3. **Enable/Disable**: Turn specific rules on or off without deleting them, allowing for flexible application as needed.
4. **Reorder**: Change the order of the color profiles.
> [!NOTE]
>
> **Note**: Any changes made to color profiles will immediately reflect across the organization, ensuring consistency in visual representation.
**Things to Remember:**
When both routes and custom icons/colors are part of your landscape, the impact on routes and color profiles is as follows:
1. **Routes with Assigned Jobs**: If jobs are assigned to routes, the color profiles will not apply. Instead, the route color will take precedence, ensuring that route-based assignments remain visually distinct.
2. **Unassigned Jobs**: For jobs that are not assigned to any route but meet the conditions of the color profile, the custom color will be applied. This ensures that unassigned jobs are still visually categorized based on the defined rules.
This distinction helps maintain clarity in job and route visualization while leveraging the benefits of both routes and custom color profiles.
# Service Territory filter
The Service Territory filter on the Dispatch Board allows you to refine job visibility based on specific territories. It enables Dispatchers (Team Leaders) to manage jobs and teams more effectively without needing to be part of a specific team.
> [!NOTE]
>
> **Note:** The Service Territory filter will appear on the Dispatch Board once the “**Enable Service Territory**” option is activated in **Settings** > **Organization Settings** > **Service Territory**. The options available in the filter correspond to the ownership permissions configured in **Settings** > **Service Territory**.
* **Dispatcher Queue**: The Dispatcher Queue will filter jobs based on the selected Service Territory, such as Assigned, Unassigned, Unscheduled, or Overdue.
* **Jobs:** The Jobs layout will display only the jobs in the selected Service Territories.
* **Users:** Only teams assigned to the selected Service Territory will be available for selection from the drop-down. For more details on how the '**Can Team Leader Access Jobs Based on Service Territory Ownership?**' setting and other configurations impact job visibility on the Dispatch Board, refer to the article [Understanding Job Visibility on the Dispatch Board](Dispatch/Understanding_Job_Visibility). This article will help you understand why specific jobs appear or do not appear on your Dispatch Board based on your selected Service Territories and organizational settings.
* **Maps:** The map will show jobs only from the selected Service Territories.  With this comprehensive overview, you can effectively manage resources, plan schedules, and monitor operations, ensuring seamless and efficient task execution.
# Find Live Nearest Technicians & Nearby Jobs
Source: https://docs.zuper.co/Dispatch/FInd_tech
In a fast-paced field service environment, time and precision are everything. As a dispatcher, you’re expected to make quick decisions that impact not only your team’s productivity but also customer satisfaction. That’s why Zuper's **Nearby** feature on the Dispatch Board is designed to take the guesswork out of technician assignment.
Instead of manually cross-referencing schedules, skills, and distances, you can now find the right technician, at the right time, closest to the job location, all in a few clicks. Whether it's a high-priority repair or an urgent maintenance task, this tool helps you optimize technician dispatching based on live location, skill compatibility, and shift availability.
### Why use the Nearby feature?
* **Faster Response Time**: You can quickly locate technicians who are physically closest to the job site, minimizing travel time.
* **Skill-Based Matching**: You can ensure only qualified technicians are considered for the job based on skill tags.
* **Conflict-Free Scheduling**: You can avoid overlaps and double bookings by checking real-time availability and shift status.
* **Smart Resource Allocation**: You can reallocate ground teams efficiently to handle high-impact jobs with minimal downtime.
## How to find live technicians nearest to a job
1. Click the **Scheduling and Dispatching** module from the left navigation menu and select “**Dispatch Board**”.

2. Right-click on a *job* card in the **Dispatcher Queue**.
3. Choose **“Find Live Technician”** from the context menu.

4. Zuper will now switch to the **Map & Nearby mode**, displaying a radius circle around the job location.
5. Use the **radius slider** at the bottom of the screen to define how far you'd like to search for available technicians.

6. The system will automatically:
* Filter live (punched-in) technicians.
* Check for skill match (you can toggle this filter off).
7. Hover over a technician’s avatar on the map to view:
* Distance and estimated travel time.
* Shift hours and availability.
* Any scheduling conflicts, like ongoing jobs or time-offs.

> [!TIP]
>
> **Tip**: If you’ve moved the map around and want to quickly return to the original job’s location, just click the “****Pin to Nearby****” button or the job locator icon.
>
> 
8. Once you’ve found the best-fit technician, click on the avatar and choose **“Assign Job”**.

9. Select “**Yes**” to confirm the job assignment to the technician.

> [!NOTE]
>
> **Note**: Assigning the job here does not schedule or reschedule; it only links the technician to the job.
The technician receives a notification (based on your organization’s settings), and the job appears in their schedule.
10. Click **“Switch off Nearby Mode”** to return to the standard Dispatch Board view, or click another job on the map to continue technician assignment.

## How to find nearby jobs within a geo radius
Sometimes, while searching for a technician, you might notice other jobs nearby. The **Nearby Jobs** view allows you to explore them without leaving the map.
1. While in **Nearby Mode**, switch to the **‘Jobs’ tab** on the top panel (next to ‘Users’).

2. This view shows all jobs **scheduled for today** within your selected radius.
3. Use filters to refine the list based on:
* Schedule Date
* Job category
* Due date
* Job Status
* Contact

4. Click on any job pin on the map to access its tooltip.
5. Choose **“Find Live Technician”** again to reset the radius with the newly selected job as the center point.

With the ability to factor in location, skill match, and schedule availability, all in one view, you’ll transform your dispatching process from reactive to proactive.
# Live View in Dispatch Board
Source: https://docs.zuper.co/Dispatch/Live_View
In fast-moving field service environments, dispatchers need to react quickly to what’s happening on the ground. Yet, urgent jobs often remain hidden due to filters or outdated views.
**Live View** in Zuper changes that.
Live View offers a **real-time, filter-free stream** of all unscheduled and unassigned jobs that are due *today* or *tomorrow*. It’s designed to help dispatchers stay focused on what needs attention *right now*, without the clutter of long-term scheduling or irrelevant filters.
### **Key Highlights**:
* Displays only jobs scheduled or due within the next 48 hours.
* Supports up to 500 jobs without compromising speed or responsiveness.
> [!TIP]
>
> **Prerequisite**: **Live View** is available only when the **Auto-Sync** feature is enabled for your account. If Auto-Sync is *active*, Live View is automatically ready to use.\
> If you don’t see this feature in your Dispatch Board, contact [support@zuper.co](mailto:support@zuper.co) to get it enabled.
## **Accessing Live View**
To open Live View:
1. Click the **Scheduling and Dispatching** module from the left navigation menu and select **Dispatch Board**.

2. Select the **Jobs** stream.
3. Click the Job Type dropdown and choose **Live View**.

4. You’ll see two tabs- **Today** and **Tomorrow.**
* The Today tab lists all jobs due/scheduled to be dispatched today.

* The Tomorrow tab shows jobs that need attention for the next day.

> [!NOTE]
>
> **Note**: Jobs are sequenced in the following order:
>
> * Scheduled Jobs are displayed first and sorted by start time.
> * Unscheduled Jobs are listed next, sorted by due date.
As soon as a job is scheduled or assigned, it will disappear from the Live View Dispatch queue, keeping your focus sharp and up-to-date. Similarly, as new jobs are created, you see them only if they’re scheduled/due for today or tomorrow in the live view.
## **Using Live View**
Live View is designed for simplicity and speed. Once you're in Live view, you can:
* **Search for Jobs**: Type a keyword or job number in the search bar to quickly locate specific jobs.
* **Assign Jobs Instantly**: Drag a job card and drop it into a technician’s available slot in the Scheduler. Set the start and end times in the pop-up, then click **Update**.
* **Find Nearby Technicians**: Right-click a job card and select **Find Live Technicians**. Zuper highlights nearby technicians along with their distance from the job site, helping you assign the right person faster.
### FAQs
**Q: Can I apply filters or sorting in Live View Dispatcher Queue?**\
**A**: No. Live View intentionally disables filters and custom sorts to ensure a pure, priority-driven real-time stream.
**Q: What job types are shown?**\
**A**: Only unscheduled and/or unassigned jobs that are due or scheduled within the next 48 hours.
**Will Live View affect my existing Dispatch Board view?**\
**A**: No, it runs as a separate dropdown view within the Jobs stream.
# Accessing the Maps
Source: https://docs.zuper.co/Dispatch/Maps/Maps
The maps module in Zuper provides a panoramic view that helps you track the exact location of users, jobs, routes, assets, properties, customers, and organizations on the map. Additionally, you can perform various actions such as creating routes, adding jobs, assigning users, optimizing routes, and more directly from within this module.
## Users
To track the exact location of users on the map, follow these steps:
1. Click the "**Maps**" icon at the left navigation menu. You will land on the maps page.

2. On the maps page, click "**Users**" at the top, which lists all the users in the team (the team will be set by default).

3. Click any user to view their exact location on the map. You can also search for and view specific users on a team. Click the filter icon to search for a user based on the chosen team and user type (online and offline).

5. To view any user details and location history, click the "**Kebab**" icon next to the user and select "**Show Details**." You can view the user details such as their role, email ID, phone number, skill set, team, work hours, and so on data on the right.


However, if you select "**History**," you can view the user's location history on the map for the selected date.


6. You can also pin/unpin users. Click the "**Pin**" icon next to the filters.

> [!NOTE]
>
> **Note:** When a user module is pinned, the user location will appear in all other selected modules on the map. When unpinned, it will not appear in other modules.
## Jobs
To track the exact location of the jobs on the map, follow these steps:
1. Click "**Jobs**" at the top of the maps page. This will list all the jobs with information such as user assigned, job status, priority, and so on.

2. Click any of the jobs to view the exact job location on the map. You can use the zoom-in and zoom-out icons to adjust the map view.

3. You can also search and view job locations on the map. To do so, click the "**Filter**" icon to search for a job based on the team and user.

4. To view any job details, click the "**Kebab**" icon next to the job and select "**Show Details**." This displays the job's primary information and notes associated with it.

5. You can also pin/unpin the job module. Click the "**Pin**" icon next to the filters

> [!NOTE]
>
> **Note:** When a job module is pinned, its location will appear on the map for all other
> selected modules. When unpinned, it will not appear in other modules.
## Routes
1. On the maps page, click "**Routes**" at the top, which lists all the routes created. Click any of the routes to view the exact location on the map. You can use the zoom-in and zoom-out icons to adjust the map view.

2. You can also search and view specific routes on the map. Click the "**Filter**" icon to search for a route based on the date the picker selects.

> [!NOTE]
>
> The blue dot represents the route present for the day.
3. You can also pin/unpin a route. Click the "**Pin**" icon next to the filters.
> [!NOTE]
>
> **Note:** When a route is pinned, its location will appear in all other selected modules on the map. When unpinned, it will not appear in other modules.

### Create New Route
In addition to viewing the route on the map, you can create a new route from here.
1. Click the "+" icon next to Routes.
2. A sidebar appears on the right to create a route. Enter the following details on the page and click the "**Next**" button.
* Route Name- Provide a name for the route.
* Route Color - Choose the route color from the drop-down menu to be marked on the map.
* Mode of Transport- Choose the transport mode (Car/semi-truck, truck, pedestrian) used on the route.
* Route type - Choose the route type (Fastest travel time or shortest distance) that the technician needs to follow.
Start Location- Pick the location from where the route would start.
End Location- Pick the location where the route ends.
* Departure- Select the date and Time of departure.
* Duration- Enter the estimated time (in hours) that will be taken for the route to complete.

3. Once the route has been created, you can add a job on the following page. To do so, click "**+ Add Job**."

4. Select the Jobs to be added and click the "**Choose Job**" button to add them to the route.

> [!NOTE]
>
> **Note:** The jobs with an exclamation mark cannot be selected as they do not have any geo-coordinates in their route.
5. After adding, click the "**Create**" button. The route will be created successfully.

6. Once the route has been created, you can view details and edit or clone the route by clicking the "**Kebab**" icon.
When you click "**Edit Route**," you can make necessary changes to the previously created route. Once done, click the "**Update**" button to save the changes.
When you click "**Clone Route**," The same route with the same details will be cloned and added as a new route. You can also make changes if needed.

**Show Details**
Using the actions icons at the top left, you can lock the route, assign a user, optimize the route, and edit route/reorder jobs/clone route/delete the route by clicking the "**Kebab**" menu.
> [!NOTE]
>
> **Note:** When you lock the route, you won't be able to update it. This means you can't change the route location, reschedule, add more jobs to the route, or reorder them.

## Assets
To track the exact location of the assets on the map, follow these steps:
1. On the maps page, click "**Assets**" at the top, which lists all the assets created.

2. Click any asset to view its location on the map. You can use the zoom-in and zoom-out icons to adjust the map view.

3. You can also search and view specific assets. To do so, click the "**Filter**" icon to search for an asset based on the selected category.

4. To view asset details, click the "**Kebab**" icon next to the asset and select "**Show Details**." You can view details such as the asset code, ownership, parts, and so on.
5. You can also pin/unpin an asset. Click the "**Pin**" icon next to the filters.

> [!NOTE]
>
> **Note:** When an asset module is pinned, its location appears in all other selected modules on the map. When unpinned, it does not appear in different modules.
## Properties
To track the exact location of the property on the map, follow these steps:
1. On the maps page, click "**Properties**" at the top, which lists all the properties created.

2. Click any properties to view their location on the map. You can use the zoom-in and zoom-out icons to adjust the map view.

3. You can also search and view specific properties. To search for a property, click the "**Filter**" icon. To view the property's details, click the "**Kebab**" icon next to the property and select "**Show Details**." You can view the property details such as property location, the number of jobs associated with the property, and so on.

## Customers
To track the exact location of the customer on the map, follow these steps:
1. On the maps page, click "**Customers**" at the top, which lists all the customers created. Click any customers to view their exact location on the map. You can use the zoom-in and zoom-out icons to adjust the map view.

2. You can also search and view specific customer locations on the map. To search for a particular customer, click the "**Filter**" icon.

3. To view any customer details, click the "**Kebab**" icon next to the customer and select "**Show Details**." You can view the customer's primary information and notes associated with them.
## Organization
To track the exact location of the organization on the map, follow these steps:
1. On the maps page, click "**Organization**" at the top, which lists all created organizations. Click any organizations to view their exact location on the map. You can use the zoom-in and zoom-out icons to adjust the map view.

2. You can also search and view specific organization locations on the map. To search a particular organization, click the "**Filter**" icon.

3. To view any organization details, click the "**Kebab**" icon next to the organization and select "**Show Details**." The organization details, such as address, associated customers, jobs, and other data, are displayed on the right.

## Maps Settings
Two major settings can be applied to maps:
* **Overlay all routes on the map.**
* **Overlay service territories.**
1. Click the "**Settings**" icon at the top right corner of the map and select the following.
* **Overlay all routes on the map**- When selected, you can view all the routes on the map.
* Overlay service territories- When this is selected, you can view the territories where the routes and jobs are carried out efficiently on the map. Once selected, click the "**Save**" button to confirm.

* To create new service territories, navigate to Settings and select Service Territory. You can create a new service territory by choosing the "**New Service Territory**" option. Additionally, it is possible to edit or deactivate existing service territories by selecting "**Edit Service Territory**" and "**Deactivate Territory**," respectively.


> [!NOTE]
>
> **Note:** Once a service territory is created, new jobs will automatically be assigned to the technicians who belong there.
So, what's next? Now it's time to explore the Maps module in Zuper with these step-by-step instructions. With this guidance, you can track various modules on the map, including users, jobs, routes, assets, properties, customers, and organizational locations. You can also seamlessly perform additional tasks such as viewing, creating routes, adding jobs, and optimizing routes directly within the module, enhancing operational efficiency and management capabilities.
# Overview
Source: https://docs.zuper.co/Dispatch/Overview
In Zuper, the **Dispatch Board** module provides a centralized workspace where dispatchers can view and manage unassigned routes and all jobs (unscheduled, assigned, unassigned, or overdue) in one intuitive hub. With this unified view, you can efficiently monitor incomplete jobs and unassigned routes, and take immediate action with just a click.
You can schedule or reschedule jobs simply by dragging and dropping them according to technician availability at the team level. The Dispatch Board also combines a map view with real-time insights into technicians’ schedules, job locations, and route details, helping you optimize dispatching operations seamlessly.
The Dispatch Board is composed of four interconnected layouts:
* Dispatcher queue
* Users
* Scheduler
* Map

## Key Capabilities:
* **Real-Time Updates**: The **Auto-Sync** feature instantly syncs job status, schedule, or assignment changes made via the web or mobile app across all layouts for jobs due within seven days, eliminating the need for manual refreshes and ensuring seamless, unified visibility.
> [!NOTE]
>
> Auto-Sync is not enabled by default. To enable it for your account, contact your account administrator or email [support@zuper.co](mailto:support@zuper.co).
* **Collaboration Indicators**: Display a subtle overlay or label (e.g., “*Shawn Edward is assigning…*”) on Job cards in the Dispatch Board or on the Job Details page during actions like assigning, scheduling, or updating due dates. It helps avoid duplicate efforts or overwrites, and the indicator typically fades once the action is complete or the session ends.
> [!NOTE]
>
> Collaboration Indicators work only when **Auto-Sync** is enabled.
* **Live View**: Prioritizes unscheduled/unassigned jobs due today/tomorrow in the Jobs Stream.
> [!NOTE]
>
> Live View requires **Auto-Sync** to be active. Refer to [Live View](/Dispatch/Live_View) support documentation for details.
* **Drag-and-Drop Scheduling**: Easily assign or reschedule jobs within the Scheduler by dragging and dropping job cards.
* **Map Integration**: Visualize job and technician locations to make informed, location-based scheduling decisions.
* **Customizable Views**: Configure job card details, color codes, and filters to suit your preferences.
* **Nearby Feature**: Identify live technicians near a job site based on their skills and availability. See **Find Live Nearest Technicians** for details.
* **Service Territory Filtering**: View and filter jobs by owned territories to streamline dispatching. Learn more in [Understanding Job Visibility](/Dispatch/Understanding_Job_Visibility).
# Customize Dispatch Board
Source: https://docs.zuper.co/Dispatch/Settings
Set up the Dispatch Board to match how your team dispatches. You can choose what appears on job and user cards, how the scheduler opens and looks, and what the map shows. The board has four settings panels: **Dispatchers Queue**, **Users**, **Scheduler**, and **Map**.
**Navigation:** *Dispatch Board -> Settings*
## Open Dispatch Board settings
You can open settings in two ways:
* Click the **Settings** icon at the top right of the Dispatch Board, then select a panel from the left.
* Click the **Settings** icon inside the queue, users list, scheduler, or map. Settings opens directly on that panel.

After you make changes in any panel, click **Save**.
## Dispatchers queue settings
Choose how job cards look in the dispatchers queue.
| Setting | What it does |
| :- | :- |
| **Primary Color** | Colors the job card based on the attribute you choose. Select **None** for no highlight. |
| **Secondary Color** | Shows a second color marker on the job card based on the attribute you choose. |
| **Jobs per page** | Sets how many jobs appear on each page of the queue. |
| **List View** or **Table View** | Shows jobs as cards or as rows in a table. |
| **Job Card** | Sets the details shown on each job card. **Job #** and **Job Title** are always shown. |
**To customize the dispatchers queue:**
1. Open **Settings** and select **Dispatchers Queue**.
2. Under **Primary Color** and **Secondary Color**, select the attribute to highlight.
3. Under **Jobs per page**, select the number of jobs to show on each page.
4. Under **Details**, select **List View** or **Table View**.
5. Under **Job Card**, click **+ Add attribute** to add details to the job card. The preview on the right shows how the card looks.
6. Click **Save**.

> [!NOTE]
>
> **Note**: When you select **Table View**, you can also choose whether the table appears on the left or at the bottom of the board.
### Additional elements in the dispatchers queue
You can use the **Search**, **Filter**, **Sort**, and **Hide** options to manage jobs and routes in the dispatchers queue.
* **Search**: Search for unassigned routes and jobs by job type.
* **Filter**: Apply advanced filters to view the jobs or unassigned routes you need.
> [accordion] Apply and manage quick filters in the dispatchers queue
>
> 1. Click **Advanced Filter** and set the filter criteria.
> 2. Turn on **Save as Filter** to save the filter for future use.
>
> 
>
> 3. The saved filter is added to the **Quick Filter** box at the top right of the screen with the name **default filter**. Select it from the dropdown, or add more filters as needed.
>
> 
>
> 4. To manage saved filters, click **Manage Filter**. You can add, edit, or delete filters from here.
>
> 
* **Sort**: Sort jobs or routes by **Scheduled Date**, **Due Date**, **Job #**, or **Job Priority**.
* **Hide**: Collapse the dispatchers queue to give the scheduler and map more space.
> [!NOTE]
>
> **Note**: To show the queue again, click the expand icon at the left of the scheduler toolbar.
>
> 
## Users settings
Choose what appears on user cards and in the details that show when you hover over a user.
**To customize user cards:**
1. Open **Settings** and select **Users**.
2. Under **Card Details**, select **Plain** or **With Avatar**.
3. Click **+ Add attribute** to add details to the user card. **Technician Name** is always shown. You can add:
* Role
* Skillset
* Job/Route count
* Shift Hours
* Work Hours
* Designation
4. Under **More Information**, select the details to show when you hover over a user: **Skillset**, **Role**, **Capacity**, or **Work Hours**.
5. Click **Save**.

### Additional elements in users
Use the **Search** and **Filter** options to find specific users within a team.
* **Search**: Search users by name or skillset.
* **Filter**: Filter users by criteria such as skillset, and save filters for later.

## Scheduler settings
Scheduler settings have two tabs: **Controls** and **Colors**.
> [tab] Controls
>
> The **Controls** tab sets how job cards look on the scheduler, how the scheduler behaves, and what it displays.
>
> **Job card information**
>
> | Setting | What it does |
> | :- | :- |
> | **Primary Color** | Sets the background color of the job card. Choose **None**, **Job Category**, **Job Status**, **Team**, or **Custom Colors**. |
> | **Secondary Color** | Sets the color of the line on the left edge of the job card. |
> | **Details** | Sets the details shown on each job card. **Job #** and **Job Title** are always shown. |
>
> 
>
> > [accordion] Set custom colors and icons for map entities
> >
> > You can set custom colors and icons for jobs, customers, assets, and properties shown on the map.
> >
> > 1. Open the **Primary Color** dropdown and click **Custom**.
> > 2. In the sidebar, select colors and icons for each entity.
> > 3. Click **Save**.
> >
> > 
> >
> > For more details, see [Map settings](#map-settings).
>
> #### **Controls**
>
> * **Default View**: Choose whether the scheduler opens in the Day, Week, or Month view.
> * **Starting Day of the Week**: Choose the first day of the week.
> * **Auto Filter Dispatchers' Queue Jobs Based on Scheduler Date**: Show only jobs for the scheduler's selected date in the queue.
> * **Scheduler Locker**: Add a lock icon to the scheduler toolbar that turns drag-and-drop off and on.
>
> #### **Display**
>
> * **Display Distance and Travel Time Between Jobs**: Show the distance and travel time between a technician's jobs.
> * **Display Business Hours Only**: Show only your business hours.
> * **Summary**: Show the number of jobs for each day, week, or month.
> * **Display Weekends**: Show Saturday and Sunday.
> * **Display Week Numbers**: Show the week number of the year.
>
> **To customize the scheduler:**
>
> 1. Open **Settings** and select **Scheduler**.
> 2. On the **Controls** tab, set the job card colors and details.
> 3. Under **Controls** and **Display**, choose the options you need.
> 4. Click **Save**.
>
> 
> [tab] Colors
>
> The scheduler shades time when technicians aren't available. You can give each type of blocked time its own color so they're easy to tell apart on a busy schedule.
>
> 1. Open **Settings** and select **Scheduler**.
> 2. Click the **Colors** tab.
> 3. Click the edit icon next to a zone and pick a color:
> * **Non-business hours**: Time outside your business hours.
> * **Time-off**: Approved time off for each technician.
> * **Weekends**: Saturday and Sunday.
> * **Off-shift hours**: Time outside a technician's shift.
> 4. Click **Save**.
>
> To restore the original colors, click **Reset to default**.
>
> 
>
> > [!NOTE]
> >
> > **Note**: **Weekends** appears only when **Display Weekends** is turned on. **Off-shift hours** appears only when shifts are configured.
### Additional elements in the scheduler
Use the **Search** and **Filter** options to manage jobs and routes on the scheduler.
* **Search**: Search for specific jobs.
* **Filter**: Filter jobs by category, due date, customer, priority, skills, and tags. Save filters for later.

## Map settings
Choose what the map shows and how it filters.
| Setting | What it does |
| :- | :- |
| **Enable Map View** | Shows the map on the Dispatch Board. When turned off, the map is hidden. |
| **Display Nearby Jobs** | Shows jobs near the selected job or route on the map. |
| **Independent Map Filters** | Filters the map separately from the dispatchers queue and scheduler. The map shows all matching jobs for the day, not just those in the list. |
| **Default Layers** | Sets the layers shown when the map opens: **Jobs**, **Routes**, **Users**, **Customers**, **Properties**, **Assets**, and **Service Territories**. |
**To customize the map:**
1. Open **Settings** and select **Map**.
2. Select **Enable Map View**, and choose whether to turn on **Display Nearby Jobs** and **Independent Map Filters**.
3. Under **Default Layers**, select the layers to show.
4. To change the colors and icons of map entities, click **Customize colors and icons**. For details, see [Map](/Dispatch/Detailed_Overview#to-set-custom-colors%2Ficons).
5. Click **Save**.

> [!NOTE]
>
> **Note**: You can select default layers only when **Enable Map View** is turned on.
### Additional elements in the map
Use the **Filter** option to view route locations on the map. Select a route and click **Apply**.

# Understanding job visibility on the Dispatch Board
Source: https://docs.zuper.co/Dispatch/Understanding_Job_Visibility
Managing and overseeing jobs effectively is crucial, and understanding why certain jobs appear on your Dispatch Board can be challenging. This article clarifies how specific settings influence job visibility, helping you understand what you see and why.
### Key settings for job visibility
Job visibility on your Dispatch Board depends on the two important configurations in the **Organizations Settings** on the **Settings** page:
1. **Can Team Leader access all jobs of FEs across teams?**
* **True**: You can view all jobs assigned to Field Executives (FEs), regardless of their team.
* **False:** You can see only jobs assigned to FEs within your team.
2. **Can Team Leader access jobs based on service territory ownership?**
* **True:** You can view all jobs within your owned Service Territories, even if these jobs are assigned to different teams.
* **False:** You cannot view jobs based on Service Territories ownership. The visibility of jobs under the Dispatch Board will be primarily governed by the Team Leader’s job access set in the “**Can Team Leader Access All Jobs of FEs Across Teams?**” field.
### Job visibility on the Dispatch Board
Here's how the settings impact the jobs you can view:
| **Can Team leader access all jobs of FEs across teams?** | **Can Team Leader access jobs based on Service Territory ownership?** | **Jobs You Can View on the Dispatch Board** |
| - | - | - |
| **True** | **True** | - All jobs assigned to your team where you’re a team lead.
- Jobs assigned to technicians on your team.
- Jobs assigned to technicians from other teams.
- Jobs in your owned Service Territories, even if assigned to other teams.
|
| **True** | **False** | - All jobs assigned to your team where you’re a team lead.
- Jobs assigned to technicians on your team.
- Jobs assigned to technicians from other teams.
- Jobs are in your owned service territories, but only if they are within your team.
|
| **False** | **True** | - Jobs assigned to technicians on your team.
- Jobs are in your owned service territories, but only if they are within your team.
- Jobs in owned Service Territories from other teams are not visible.
|
| **False** | **False** | - Jobs assigned to technicians on your team.
- Jobs are in your owned service territories, but only if they are within your team.
- Jobs in owned Service Territories from other teams are not visible.
- Limited to view jobs based on direct team assignment only.
|
**Viewing jobs on the Dispatch Board**
The **Service Territory** filter on the Dispatch Board refines job visibility based on service territory ownership. This feature also allows Dispatchers (Team Leaders) to manage jobs and teams more effectively without needing to be part of a specific team. The real-world example below illustrates how service territory ownership influences the Team Leader to control job and team visibility.
It also shows how the "**Can Team Leader access jobs based on Service Territory ownership?**" setting interacts with the "**Can Team Leader access all jobs of FEs across teams?**" setting to determine if a Team Leader can view jobs across different teams.
**Teams and Jobs Overview:**
| **Team** | **Field Executives (FEs)** | **Jobs in North Zone-ST1** | **Jobs in West Zone-ST2** |
| - | - | - | - |
| Team Titans | FE1, FE2 | Job 1 (FE1), Job 2 (FE2) | |
| Team Alpha | FE3, FE4 | Job 21 (FE1), Job 22 (FE2) | Job 41 (FE3), Job 42 (FE4) |
| Team Beta | FE5, FE6 | Job 31 (FE5), Job 32 (FE6) | |
### ***Scenarios***
To further illustrate, here are some scenarios that show how these settings affect what you see on the Dispatch Board:
**Scenario 1**: *Both settings **True**, "**North Zone-ST1**" selected*
* **Visible Jobs:** Job 1, Job 2 (Team Titans), Job 21, Job 22 (Team Alpha), Job 31, Job 32 (Team Beta).
* **Not Visible:** Job 41, Job 42 (These are in West Zone-ST2, which you do not own).
**Reason:** All jobs in the selected Service Territory (North Zone-ST1) are displayed, including those from other teams.
**Scenario 2:** *Access All Jobs **True**, Service Territory Access **False**, "**North Zone-ST1**" selected*
* **Visible Jobs:** Job 1, Job 2 (Team Titans), Job 21, Job 22 (Team Alpha), Job 31, Job 32 (Team Beta), Job 41, Job 42 (Team Alpha).
* **Not Visible:** None.
**Reason:** You can view all jobs assigned to technicians from any team, including those in the Service Territories you own, but the filter consists of jobs from all territories.
**Scenario 3:** *Access All Jobs **False**, Service Territory Access **True**, "**North Zone-ST1**" selected*
* Visible Jobs: Job 1, Job 2 (Team Titans).
* Not Visible: Job 21, Job 22 (Team Alpha), Job 31, Job 32 (Team Beta), Job 41, Job 42 (Team Alpha).
**Reason:** You can only view jobs in the Service Territories you own and only those within your own team.
**Scenario 4:** *Both settings **False**, "**North Zone-ST1**" selected*
* **Visible Jobs:** Job 1, Job 2 (Team Titans).
* **Not Visible:** Job 21, Job 22 (Team Alpha), Job 31, Job 32 (Team Beta), Job 41, Job 42 (Team Alpha).
**Reason:** You can view jobs assigned to technicians in your team and those in the Service Territories you own, but only if they are within your own team.
We recommend using the Dispatch Board for a comprehensive view of all jobs based on your Organization settings and the selected Service Territory. However, please note that the jobs on the Dispatch Board may differ from those on the Jobs listing page. The Jobs listing page will display only the jobs that you and your team are directly associated with, providing a more focused view tailored to your team's specific assignments.
By understanding these settings and how to use the Service Territory filter, you can effectively manage and oversee jobs on your Dispatch Board.
# Get roof insights with Property Intelligence
Source: https://docs.zuper.co/Get-Roof-Property-Intelligence
Property intelligence helps your teams move faster from a new lead to a meaningful homeowner conversation.
Instead of waiting for a full roof measurement, click **Get Data** from the Zuper job to access available roof and property information in seconds, including roof area, squares, facets, imagery, roof material, roof shape, and visible condition details.
Use these insights to understand the property quickly, qualify the opportunity, ask better questions, and decide the right next step, whether that is continuing the conversation, scheduling an inspection, or ordering a full roof measurement.
Property Intelligence gives your team useful context earlier in the sales process so that they can engage homeowners with more confidence and less guesswork.
> [!NOTE]
>
> **Note**: Property Intelligence supports early-stage qualification and preparation. It does not replace a full roof measurement or an on-site inspection when either is required.

## Before you begin
* **Account configuration is required.** Contact the Support team to enable Property Intelligence for your account.
* The job must have a **complete and valid service address**. Zuper uses this address to identify the property.
* **Access**: Admins can access Property Intelligence by default. To grant access to other roles, enable the **Order Property Intelligence** permission under **Custom Roles**.

## When should I use Property Intelligence?
You can use Property Intelligence early in the roofing sales process when you need enough information to understand the property without ordering a comprehensive measurement report.
For example, you can use it to:
* Review a roof before contacting a new lead.
* Estimate the overall size and complexity of the roof.
* Identify the available roof material and shape.
* Review visible roof condition indicators.
* Prepare for an initial conversation with the homeowner.
* Decide whether a detailed roof measurement is necessary.
## What Property Intelligence provide
After your request, Zuper displays the available data in the **Property Intelligence** section of the job.
| **Data** | **What it tells you** |
| :- | :- |
| **Roof area** | Estimated roof area in square feet |
| **Squares** | Estimated number of roofing squares |
| **Facets** | Number of identified roof facets |
| **Roof Material** | Identified Roof Material |
| **Roof Shape** | Identified roof shape, when available |
| **Property imagery** | Oblique aerial imagery of the property |
| **Roof condition** | Visible roof condition information derived from available imagery |
The information available can vary by property and by the imagery available through EagleView.
Click **View Report** to see additional roof material and condition information.
## Choose between Property Intelligence and a full roof measurement
Use the comparison below to decide which option fits your needs.
| **Data** | **Property Intelligence** | **Full roof measurement** |
| :- | :- | :- |
| Roof area | Yes | Yes |
| Squares | Yes | Yes |
| Facets | Yes | Yes |
| Property imagery | Yes | Depends on the provider |
| Roof material | Yes | Depends on the provider |
| Roof shape | Yes | Depends on the provider |
| Roof condition information | Yes | Not provided |
| Comprehensive roof measurements | No | Yes |
## **Request Property Intelligence for a job**
Make sure the job has a complete and valid **service address** before you request property data. Property Intelligence uses the service address to identify the property.
1. Open the required **Job** record.
2. Select the **Details** tab.
3. Scroll to the **Property Intelligence** section.
4. Click **Get Data**.

Zuper requests the property data from EagleView and displays it in the **Property Intelligence** section. Results usually appear within a few seconds.
### **Review the Property Intelligence report**
After the property data is available:
1. Go to the **Property Intelligence** section.
2. Click **View Report.** \

The report opens in a panel on the right side of the job.
#### **Review the roof condition summary**
The **Summary Roof Condition** section can include:
* Overall condition: The overall condition rating available for the roof.
* Imagery date: The date associated with the imagery used for the property data.
Check the imagery date when reviewing roof condition information. Changes made after the imagery was captured may not appear in the report.
#### **Roof Material and Condition**
The **Roof Material & Condition** section provides available information about the roof's material, shape, and visible condition.
Depending on the property and available imagery, Zuper may display details such as **roof material**, **roof shape**, **material degradation**, **natural discoloration**, **streaking**, **patching**, **missing or peeling material**, **effluent runoff**, **sealing**, **structural damage**, **tarp**, **ponding**, and **rusting**. Not all properties include every condition attribute.
> [!TIP]
>
> **Important**: Property Intelligence is based on available aerial imagery. You can use the condition data as an early qualification signal rather than as a replacement for an on-site roof inspection.
## Frequently asked questions
> [accordion] Do I need to configure an EagleView integration?
>
> No. You do not need to configure or manage a separate measurement-provider integration to use Property Intelligence.
> [accordion] Is Property Intelligence a replacement for a full roof measurement?
>
> No. Property Intelligence provides key roof measurements, such as roof area, squares, and facets, along with property imagery, roof material, and roof condition information.
>
> A full roof measurement provides more comprehensive roof measurement data and should be used when detailed measurements are required.
> [accordion] How quickly is the property data available?
>
> Property data is typically available within a few seconds after you click **Get Data.**
>
> Response time can vary based on the property and data availability.
> [accordion] Why might Property Intelligence not return data?
>
> Property Intelligence may not return data in some cases.
>
> * **The service address is incomplete or invalid:** Verify that the job has a complete and valid **service address**, then click **Get Data** again.
> * **Property data is not available:** If the service address is valid but EagleView does not have data for the property, Property Intelligence cannot return the requested data.
> [accordion] Can I view Property Intelligence data from the Property module?
>
> Yes.
>
> After Property Intelligence is requested from a **Job**, Zuper makes the retrieved data available on the associated **Property** record.
# Concepts
Source: https://docs.zuper.co/Getting_Started/Concepts
Zuper includes various modules tailored to handle specific aspects of your field service business. These modules work together to provide a seamless and integrated experience, enabling you to manage projects, service requests, jobs, schedules, dispatching, customer information, and more.
Below, you will find a detailed explanation of each module and how they contribute to optimizing your field service management.
* **Dashboard**: The Dashboard module lets you view key metrics from every module in one place.
* **Work Order Management**
Zuper’s Work Order Management concept covers the creation, management, and tracking of modules such as requests, jobs, and projects. It ensures seamless execution of work orders, whether for individual customers or large-scale projects.
> [accordion] Jobs
>
> The Jobs allows you to create customized jobs for specific organizations or customers, ensuring that business-to-business and business-to-customer work orders are efficiently created with all necessary details and properties.
> [accordion] Requests
>
> The Request module enables administrators (back-office Admins) and customers to create and manage service requests.
> [accordion] Projects
>
> The Projects module allows you to plan and manage projects that span longer periods and involve multiple jobs, people, and materials, all in one place.
* **Scheduling & Dispatching**
The Scheduling & Dispatching concept discusses job scheduling, technician assignment, and route optimization. With modules like the Dispatch Board, Calendar, and Maps, you can efficiently allocate resources and minimize downtime.
> [accordion] Dispatch Board
>
> The Dispatch Board module provides a centralized overview of routes and all jobs, including those that are unscheduled, assigned, unassigned, and overdue, in one place, allowing dispatchers to act on them with a single click. Its unified view of unassigned routes/jobs, technicians’ schedules, and job locations through a map streamlines the entire dispatching process.
> [accordion] Calendar
>
> The Calendar module enables you to efficiently view unscheduled jobs, schedule and manage jobs assigned to field technicians, and create and review time-off requests submitted by users, helping you plan their work accordingly.
> [accordion] Maps
>
> The Maps module provides a panoramic view that helps you track the exact location of users, jobs, routes, assets, properties, customers, and organizations on an interactive map. This helps optimize routes, reduce travel time, and improve overall efficiency.
* **Customer Management**
Zuper’s Customer Management concept covers the creation and tracking of customers, organization, and property details in one place, using modules like Customers, Organizations, and Properties.
> [accordion] Customers
>
> The Customers module allows you to add new customers, update their details, and access their complete history and associated records in one centralized location.
> [accordion] Organizations
>
> The Organizations module helps you create, view, and update information about various organizations, ensuring all records are accurately maintained and easily accessible.
> [accordion] Properties
>
> The Properties module enables you to add new properties of customers or organizations, edit existing details and keep track of all the properties you service in one convenient place.
**User Management**
The User Management concept focuses on tracking work hours, managing time-off requests, and scheduling shifts for field technicians using modules like Timesheets, Timeoff, and Shifts for efficient real-time user management.
> [accordion] Timesheets
>
> The Timesheet module helps track and manage field technicians’ work hours accurately and efficiently.
> [accordion] Timeoff
>
> The Timeoff module allows you to view, create, and manage time-off requests submitted by field technicians.
> [accordion] Shifts
>
> The Shifts module allows you to view, plan, and schedule new shifts for field technicians and track existing shifts in real-time.
* **Inventory Management**
The inventory Management concept focuses on how to efficiently track, manage, and optimize inventory, ensuring the availability of parts, products, and services when needed.
> [accordion] Parts, Products, and Services
>
> The Parts, Products & Services module enables you to manage and maintain a comprehensive catalog of your organization’s parts and services. You can add, edit, and categorize parts and services, making tracking inventory and managing costs easier and ensuring that your team has the necessary resources to complete their jobs efficiently.
> [accordion] Pricelists
>
> The pricelists module in Zuper helps businesses implement flexible and efficient pricing strategies. With this feature, businesses can:
>
> * Create multiple pricelists tailored to different customer segments.
> * Apply margins, discounts, and custom rates to optimize pricing.
> * Reduce manual adjustments and ensure pricing consistency across jobs, invoices, and contracts.
>
> By automating pricing management, businesses can enhance customer satisfaction and improve revenue control.
> [accordion] Transfer Orders
>
> The Transfer Orders module in Zuper streamlines inventory movement between different locations. This feature allows businesses to:
>
> * Track the status of transfers in real-time.
> * Ensure accurate stock updates at both source and destination locations.
> * Transfer serialized inventory and record instant transfers.
> * Maintain a detailed activity log for audit and tracking purposes.
* **Accounting**
The Accounting concept includes modules for managing financial transactions, such as generating and managing quotes and invoices.
> [accordion] Quotes
>
> The Quotes module allows you to generate, manage, and send quotes to customers.
> [accordion] Invoices
>
> The Invoices module streamlines the invoicing process by allowing you to create, manage, and send invoices to customers.
* **Contracts & Assets Management**
The Contracts & Assets Management concept includes modules for creating and managing customer service contracts and service assets.
> [accordion] Contracts
>
> The Contracts module allows you to create, manage, and track customer service contracts. This includes setting contract terms, expiry dates, and compliance monitoring to ensure both parties meet their obligations.
> [accordion] Assets
>
> The Assets module helps you manage and maintain detailed records of all assets used in your service operations. This includes tracking asset locations, ensuring proper maintenance, and scheduling servicing to keep your inventory in optimal condition.
* **Reports**: The Reports module provides comprehensive reporting capabilities, allowing you to generate detailed reports on various modules.
# Install and Sign In to Zuper
Source: https://docs.zuper.co/Getting_Started/Installing_Zuper
Zuper is available as a web app and a mobile app for iOS and Android devices. You can access the web app directly in a supported browser or download the mobile app to manage your work on your mobile device.
This guide explains how to install the Zuper Field Service app on iOS and Android devices and sign in to the web.
> [accordion] **Before you begin**
>
> Make sure you have:
>
> * An existing Zuper user account.
> * Your **Company Name**, **Email ID**, and **Password** to sign in.
> * An active internet connection.
> * A compatible device if you're using the mobile app. See [Device requirements](/Zuper_Mobile_Apps/Device_Requirements).
>
> If you don't have your login credentials, contact your company's Zuper administrator.
## Access Zuper on the web
You can access the Zuper web portal directly from a supported browser. No installation is required.
To sign in:
1. Open a [supported web browser](#supported-browsers).
2. Go to [https://next.zuperpro.com](https://next.zuperpro.com).

3. Enter your **Company Name** and continue.
4. Enter your **Email ID** and **Password**.

5. Click **Login** to access your account.\
If your company uses single sign-on (SSO), click **Login with SSO** instead of signing in with your password.
## Install the Zuper Field Service app
The Zuper Field Service app is available for iOS and Android devices.
### On iOS (iPhone or iPad)
To install and sign in to Zuper on your iPhone or iPad:
1. Open the **App Store** and search for **Zuper - Field Service Your Way**. You can also open the [App Store listing](https://apps.apple.com/us/app/zuper-field-service-your-way/id1633081340) directly.
2. Tap **Get** or the download icon to install the app.

3. Open the app, enter your **Company Name**, and continue.
4. Enter your **Email ID** and **Password**, and then tap **Login**.
If your company uses single sign-on (SSO), select **Login with SSO** instead of signing in with your password.
### On Android
To install and sign in to Zuper on your Android device:
1. Open the **Google Play Store** and search for **Zuper - Field Service App**. You can also open the [Google Play listing](https://play.google.com/store/apps/details?id=co.zuper.android) directly.
2. Tap **Install**.

3. Open the app, enter your **Company Name**, and continue.
4. Enter your **Email ID** and **Password**, and then tap **Login**.
If your company uses single sign-on (SSO), select **Login with SSO** instead of signing in with your password.
### Sign in on your Mobile Browser
You can also open the Zuper web app on your mobile browser:
1. Open a browser on your mobile device.
2. Go to [https://next.zuperpro.com](https://next.zuperpro.com).
3. Enter your **Company Name**, **Email ID**, and **Password** to sign in.
> [!NOTE]
>
> **Note:** It won't be the easiest to navigate since the website is not optimized for mobile, but it should let you accomplish what you are trying to do!
#### Supported Browsers
The Zuper web app supports the following browsers:
* Google Chrome
* Mozilla Firefox
* Microsoft Edge
* Apple Safari
#### Troubleshoot sign-in issues
If you're having trouble signing in to Zuper, review the following common issues.
> [accordion] What should I do if I can't sign in?
>
> Make sure you've entered the correct **Company Name**, **Email ID**, and **Password**.
>
> Also, check your internet connection and try signing in again.
>
> If the issue continues, contact your company's Zuper administrator or [Zuper Support](mailto:support@zuper.co).
> [accordion] What do I do if I forget my password?
>
> On the sign-in screen, click or tap **Reset Password**. Zuper sends you an email with instructions to reset your password.
> [accordion] What happens if I enter an incorrect password multiple times?
>
> If you enter an incorrect password three times, Zuper temporarily blocks your network IP address for 30 minutes as a security measure.
>
> You can try signing in again after 30 minutes or from a different network.
>
> If you still can't sign in, contact [Zuper Support](mailto:support@zuper.co).
>
> For more information, see [Password policy](/Settings/Security/password_policy).
# Add Users and Set Up Teams
Source: https://docs.zuper.co/Getting_Started/Users_Teams
Set up your team in Zuper by adding users and organizing them into teams. This ensures your team members have the appropriate access to Zuper and makes it easier to manage job assignments.
> [!NOTE]
>
> **Alternative navigation**: For quick access to **Settings**, click your profile icon in the top-right corner and select **Settings**.
## Add your first user
Each person who needs access to Zuper must have a user account. When adding a user, you can assign a role based on their responsibilities.
Zuper supports roles such as **Admin**, **Team Leader**, and **Field Executive**, each with different access permissions.
**To add a user:**
1. From the left navigation menu, click **More** and select **Settings**.
2. Under **Users & Teams**.
3. Select **User Management**.
4. Click **+ Create New User** to begin adding a user.

For detailed instructions on creating users and assigning roles, see [Managing your users](/Settings/Users_Teams/Users_Creation).
## Create your first team
Teams help you organize users and simplify job assignments. You can group team members based on their service location, trade, or specialization.
For example, an HVAC business might create separate teams for installations, repairs, and maintenance.
**To create a team:**
1. From the left navigation menu, click **More** and select **Settings**.
2. Under **People & Access**, expand **Users & Teams**.
3. Select **Team Management**.
4. Click **+ Create New Team** to begin setting up a team.

For detailed instructions on configuring teams, see [User & Team Settings](/Settings/Users_Teams/General#team-management).
> [!TIP]
>
> **Tip:** Start with one or two teams based on your immediate business needs. You can add more teams and reorganize users as your business grows.
# Welcome to Zuper
Source: https://docs.zuper.co/Getting_Started/Welcome_to_Zuper
Zuper is a modern platform built to help operate field service businesses efficiently. Zuper’s powerful features help you manage & optimize field service operations, improve communication and empower your team to deliver a delightful customer service experience.
With Zuper, you can effortlessly handle everything from scheduling to dispatching to payments and reporting, all in one place. Zuper’s intuitive mobile app and desktop browser app offer a comprehensive experience to ensure your team is always connected, whether on desktop or on the go.
Sounds simple, right? Let’s dive into the fundamentals of Zuper and explore how to set up your account, create your first job, and configure the platform to your team’s needs.
* **Efficient Work Order Management**: Keep track of work orders and ensure smooth execution from start to finish.
* **Smart Scheduling and Dispatching**: Automatically optimize your team’s schedule and dispatch tasks with precision.
* **Streamlined Estimates and Proposals**: Quickly create and manage estimates and proposals to win more business.
* **Comprehensive Inventory and Asset Management**: Monitor your inventory and assets to stay organized and efficient.
* **Powerful Location Intelligence**: Use location data to make informed decisions and improve service delivery.
* **Simplified Timesheet Management**: Track time effortlessly to ensure accurate billing and payroll.
* **Easy Contract Management**: Handle contracts seamlessly and keep everything in one place.
* **Custom Workflows and Onsite Checklists**: Tailor workflows and checklists to match your business needs.
* **Efficient Invoice Management**: Streamline invoicing and ensure timely payments.
* **Insightful Reporting and Analytics**: Gain valuable insights with detailed reports and analytics to drive your business forward.
Zuper’s intuitive mobile app, robust desktop app, and easy-to-use customer portal ensure that communication and information sharing are a breeze for your field technicians, back-office teams, and customers.
Sounds pretty simple, right? Let’s [dive into Zuper](/Getting_Started/Concepts) and explore how to set up projects, manage jobs, and maximize our powerful features. Let’s make great things happen together!
# Zuper for Roofing Trial Walkthrough
Source: https://docs.zuper.co/Getting_Started/zuper-roofing-trial
This guide takes you through a typical roofing job — lead to payment — so you can see exactly how Zuper would fit into your current process. You need the Zuper web app and the Zuper mobile app. Expect about 15–30 minutes to complete the full flow.
If you have not logged in to the Web app yet, this short video will walk you through the process.
[Loom video player](https://www.loom.com/embed/972a414b8f8d42adb5e2dc3f915bf21c)
***
## Before you start
When setting up your test customer, use your own email address as the customer's email. This lets you receive the same notifications your customers would — inspection confirmations, proposals, invoices, and updates — so you can see the full customer experience alongside the back-office view.
> [!NOTE]
>
> **Mobile app — trial outside sales login**
>
> * **Email:** Your email ID.
> * **Password:** \@123
>
> In place of \, use the company login name shared in the welcome email. You can use this pre-built login or create your own outside sales user in the account.
>
> **John's role in this trial:** Outside sales — handles inspections and proposals on site. This persona can also be used to view the production lifecycle from the field.
***
## Step 1: Qualifying the lead
**Where:** Web app · **Time:** 2–5 min
Watch the video walkthrough or follow the step-by-step guide below:
[Loom video player](https://www.loom.com/embed/1f6500fb49c94de08ec4bdf0ddbea38f)
**Create the test customer**
**1. Go to Customers**
In the sidebar, go to **Customers** → **Add New Customer**.
**2. Enter customer details**
Enter the customer name and your email address — this is your test customer for the trial.
**3. Add an address**
Add any address using **Pick from a Map**. Choose something local to you.
**4. Save**
Select **Save**.
**Find the auto-created job**
A **Lead Qualification** job is created the moment you save a new customer. Watch for workflow activity at the bottom right — it might take up to 45 seconds.
> [!TIP]
>
> The fastest way to see updates is to refresh your browser, or swipe down to refresh on the mobile app.
**Find the job in the pipeline**
**1. Go to Jobs**
Go to **Jobs** in the sidebar.
**2. Select the Prospects pipeline**
Select the **Prospects** pipeline at the top left. This switches to Kanban view, filtered by leads only.
**3. Locate your job**
Your job appears in the **Prospects / Lead** pipeline, ready to advance.
**Run the qualification**
**1. Drag the pipeline card**
Drag the pipeline card for your lead and drop it into **Qualifying** on the Kanban board.
**2. Complete the intake form**
Work through the lead intake form — communication preferences, what the customer is looking for. These are all customizable fields you can configure in the back end.
**3. Confirm the lead**
When asked **"Is this a genuine lead?"**, select **Yes** and submit.
The lead advances into a qualified opportunity. Go to the **Opportunities / Inspections** pipeline — your job now appears in the **New-Inspection** stage. Open it by selecting the arrow at the top left of the pipeline card.
> [!TIP]
>
> **What just happened:** The job moved from Lead to Inspection automatically, with the status updated at each step. The job is now ready to be booked as an inspection appointment.
***
## Step 2: Running the inspection
**Where:** Web app + mobile app · **Time:** 5–10 min
Follow the step-by-step guide below, or watch the video walkthrough instead.
[Loom video player](https://www.loom.com/embed/1b92d414c0a84467879c0cf862761ec5)
**Schedule and assign a salesperson**
**1. Assign a user**
At the top right of the job, select **+** under **Users/Teams Assigned** to assign the pre-built **John Wayne** mobile app user.
**2. Schedule the inspection**
Select the **Schedule** calendar icon at the top left, under the job title. Schedule for right now.
**3. Enter measurements**
Go to the **Measurements** tab on the left side and manually enter measurements.
> [!NOTE]
>
> Measurements populate automatically once you integrate your measurement provider. You can also upload a measurement file instead of entering values manually. Intelligent quoting relies on measurements to calculate — if you do not enter them, the proposal will not populate.
**Switch to the mobile app**
**1. Log in**
Log in as your assigned salesperson.
**2. Open the job**
Open the job on the dashboard.
**3. Update status to On My Way**
Update the status to **On My Way** — this starts the travel timer and sends the customer a live-tracking notification.
> [!TIP]
>
> An automated email goes to the customer email you entered. Open it and select the link to see live tracking of John Wayne en route to the inspection appointment.
**Arrive on site**
Update the status to **Arrived On-Site**. Travel time stops. Update again to **Inspection Report** to begin the inspection.
***
**Insurance claim — two paths to explore**
This is a good point to try both flows. Each follows a different process in Zuper.
> [tab] No — Standard quote flow
>
> Select **No** to proceed with a standard proposal. The system moves into intelligent quoting and generates a **Good, Better, Best** proposal from your inspection findings. Follow the remaining steps in this phase.
> [tab] Yes — Insurance claim flow
>
> Select **Yes** to follow the claim process. The job category updates to **Claim** and a different process flow begins. You capture claim data in the claim inspection checklist, which automatically updates the job with those details.
> [!NOTE]
>
> We suggest selecting **No** first, then returning to explore the Claim flow later.
***
**Fill out the inspection checklist**
Work through all items and upload photos. Your responses directly drive what appears in the proposal — Zuper uses the checklist to build the quote automatically using intelligent quoting.
Two fields are pre-configured to demonstrate this in the trial:
* **Ventilation:** Select **Box Vents** — this is enough to include it in the proposal.
* **Roof penetrations:** Select **Pipe Boots** — mark the condition as **Failed** and enter the quantity to include them.
This shows how different checklist responses control what does and does not appear in the quote.
***
**Generate and send the proposal**
**1. Submit and update status**
Submit the checklist and update the status to **Create Proposal**.
**2. Choose a template**
Choose a proposal template and select **Create Proposal**.
**3. Find the quote on mobile**
In the mobile app, go to the **Associated** tab. Swipe down to refresh — the quote is built and waiting toward the bottom.
**4. Add a cover image**
Select the quote, then choose a proposal cover image from the job gallery or your device.
**5. Send to customer**
Select **Send** to email it to your customer.
**6. Review from email**
Go to your email, open the notification, review the quote, sign off on an option, and select color choices and any optional add-on products.
***
**Present on the mobile app (optional)**
Select **Present** to walk through the proposal on your device. The good/better/best options, color picker, add-ons, and the inspection items you flagged — pipe boots and vents — are all reflected here.
**Customer accepts and signs — deposit collected**
Sign off on the proposal from the email or on the mobile app. When **Zuper Pay** is enabled, a deposit is collected automatically at the point of signature.
**Approve the accepted quote — web app**
Back on the web app, the quote status updates to **Accepted** and the job updates to **Won** automatically. Update the status to **Approved**.
> [!NOTE]
>
> This is an intentional manual step — it gives your team a chance to review before anything goes into production.
> [!TIP]
>
> **What just happened:** The quote line items were added to the job automatically. The job has moved into the Production pipeline — schedule and assignment cleared, ready for the crew.
***
## Step 3: Managing production
**Where:** Web app + mobile app · **Time:** 5–10 min
Watch the video walkthrough or follow the written guide below:
[Loom video player](https://www.loom.com/embed/1e27026dabdc4d338fa1c261b1a0aa68)
***
**Manage production**
The inspection job automatically updates to **Production** with a status of **New-Production**. Update the status to **Pre-Production** from the web app.
**Purchase order created**
A purchase order (PO) is generated automatically from the accepted quote line items when the job enters **New-Production** status. The PO starts in draft.
**1. Open Purchase Orders**
In the right-hand sidebar, select **Purchase Orders**.
**2. Review the PO**
Review the PO, then select **Send to Vendor**.
**3. Choose a template and send**
Choose the standard PO template and send.
***
**Receive materials**
Once materials arrive, mark quantities received in the purchase order.
> [!NOTE]
>
> An "Accept All" one-click option is coming soon to streamline materials receipt.
**Assign crew and schedule**
**1. Assign the production team**
In the upper-right **Users/Teams Assigned** section, select **+** to assign the production team.
**2. Set the schedule**
Select the **Schedule** calendar icon at the top left of the job to set the date and time. The customer receives a notification to confirm the schedule.
> [!NOTE]
>
> Scheduling can also be done from the calendar or dispatch board. Follow these steps manually here to complete the flow.
***
**On site — update statuses via mobile app**
**1. Confirm the schedule**
Update the status to **Schedule Confirmed**.
**2. Update job statuses on mobile**
In the mobile app — make sure John Wayne is still assigned to the production job — update the job status through each stage:
* **On My Way**
* **Arrived**
* **Site Preparation** (complete checklist)
* **Roof Installation**
Each status change is timestamped and logged for reporting, event logs, and activity tracking.
***
**Complete tasks in order**
Tasks must be completed sequentially. Select each task on the mobile app to reveal its checklist, complete it, then mark it as completed.
> [!NOTE]
>
> Tasks can be configured for parallel execution if sequential completion is not required.
**Change order — if scope changes on site**
**1. Update status to Change Order**
Update the status to **Change Order** in the checklist.
**2. Select item and enter quantity**
Select the item needed, then enter the quantity in the respective field — for example, eight additional pieces of decking.
This triggers a change order proposal, pre-selected in intelligent quoting with the correct change order template. It is sent to the customer, signed electronically, and the new line items are added to the job automatically upon acceptance. No separate job or manual update is needed.
***
**Complete the job**
**1. Update status to Job Complete**
Update the job status to **Job Complete**.
**2. Add completion photos**
Add completion photos in the checklist.
**3. Log unused materials**
Log any unused materials — Zuper either returns them to inventory or generates a Return Material Authorization (RMA) for the supplier automatically.
***
**Multiple production phases — for example, gutters or siding**
If the job requires further production work after roofing, Zuper handles this within the same job — no new job needed. At the **Closed** status, a checklist prompts the team to select the next production category. The job cycles into that phase automatically, with the schedule and assignment cleared for the next crew. This continues until all production work is complete.
> [!NOTE]
>
> Multi-category production is not configured in this trial account.
***
**Customer signs off on site**
The customer signs the completion form and rates the job using the three-tier feedback system.
> [!TIP]
>
> **What just happened:** The production job is complete. Zuper moves it into the Revenue pipeline automatically and generates the invoice.
***
## Step 4: Invoicing and payment
**Where:** Web app · **Time:** 2–5 min
Follow the step-by-step guide below, or watch the video walkthrough instead:
[Loom video player](https://www.loom.com/embed/966b59b5e8c6490c968fb7020fb4ff95)
***
**Invoice generated from production**
The invoice includes everything from the original quote plus any approved change orders. It starts in draft.
**Review and send**
**1. Open the invoice**
In the right-hand sidebar, select the invoice under **Invoices**.
**2. Send to customer**
Review it, then select **Send**. The customer receives an email with the invoice and can pay directly from there.
***
**Record payment**
Once paid, Zuper automatically records the transaction based on the selected payment method. The job status updates to **Paid in Full** automatically. Partial payments and overdue invoice statuses are tracked and updated the same way.
***
## What Zuper handled automatically in this walkthrough
| Trigger | Automatic action |
| - | - |
| New customer saved | Job created |
| Lead qualified | Job moved to Inspection |
| Proposal accepted and signed | Deposit collected |
| Quote accepted in production | Purchase order built |
| Change order accepted | Items added to job |
| Job completed | Invoice generated and job moved to Revenue |
# Avalara
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/Avalara
## Overview
Avalara AvaTax is a cloud-based solution that automates transaction tax calculations and tax filing. It provides real-time tax calculations using tax content from over 12,000 U.S. taxing jurisdictions and 200+ countries, ensuring compliance with current tax rules. By integrating AvaTax with Zuper, businesses can eliminate manual tax calculations, automatically retrieve accurate tax rates, and apply exemption rules for transactions.
## Prerequisites
* **Active Account**: An active Avalara AvaTax account is required.
* **Geographic Restriction**: Avalara integration is available only for organizations in the U.S.
## Installing AvaTax in Zuper
To enable the AvaTax integration, contact Zuper’s support team at [**support@zuper.co**](mailto:support@zuper.co) for initial configuration. Once configured, follow these steps:
1. Go to **Settings** > **Configuration Settings** > **Quotes and Invoices** > **Taxes**.
2. Click **Use Avalara** on the Taxes configuration page.
3. **Enter AvaTax Credentials**:
* **Account Number**: Provided during AvaTax account activation.
* **License Key**: Provided during AvaTax account activation.
* **Company Code/ID**: Your company identifier in the AvaTax Admin Console.
* **Environment**: Select either "Sandbox" or "Production."
> [!NOTE]
>
> **Note**: Zuper’s sandbox environment can only connect to Avalara’s Sandbox account.
* **Commit Documents**: Enable to submit tax documents to AvaTax for record-keeping. If disabled, sales tax is retrieved but not recorded in AvaTax for compliance reporting.
4. Click **Continue** to proceed further.

5. In the **Avalara Connection** dialog box, select the exact address using the **Pick from Map** button.
> [!NOTE]
>
> **Note**: The address, country, and AvaTax credentials will be shared with Avalara during setup.
6. Click the “**Submit**” button to complete the settings.


## Configuring Organizations, Customers, and Properties
To ensure accurate tax calculations, configure the following modules with valid addresses and tax exemption details:
### Organizations
1. Navigate to **Organizations** > **+ New Organization**.
2. Enter customer details for the organization.
3. Add valid **service** and **billing addresses** using the address picker to ensure accurate geolocation data for Avalara.
4. For tax-exempt organizations:
* Mark as **Tax-Exempt**.
* Select the appropriate **Entity Code** (e.g., for religious or charitable organizations) or provide an **Exemption Number** issued by the government.
5. Click **Save**.

### Customers
1. Navigate to **Customers** > **+ New Customer**.
2. Enter customer details.
3. Add valid **service** and **billing addresses** using the address picker.
4. For tax-exempt customers:
* Mark as **Tax-Exempt**.
* Select the appropriate **Entity Code** or provide an **Exemption Number**.
5. Click **Save**.

### Properties
1. Navigate to **Properties** > **+ New Property**.
2. Enter property details.
3. Add valid **service** and **billing addresses** using the address picker.
4. For tax-exempt properties:
* Mark as **Tax-Exempt**.
* Select the appropriate **Entity Code** or provide an **Exemption Number**.
5. Click **Save**.

> [!NOTE]
>
> **Notes**:
>
> * Taxes are calculated based on the property’s address if the organization, customer, and property are taxable.
> * Accurate geolocation data from the address picker is critical for Avalara to fetch the correct tax details.
## Configuring Parts and Services
To apply the correct tax codes for items:
1. Navigate to **Parts and Services** from the left menu.
2. Select a product to open its details.
3. Click **More Actions** > **Edit Parts/Services**.
4. Enter the applicable **AvaTax System Tax Code** in the **Tax Code** field.
* **Note**: View available tax codes at [taxcode.avatax.avalara.com](https://taxcode.avatax.avalara.com/).
5. Click **Save**.
6. **Tax Calculation**: Avalara combines the tax code and the customer’s address to determine taxability (exempt, partially taxable, or fully taxable).the submission of
7. **Optional**: Add or edit tax codes for items directly in the **Tax Code** field when creating a transaction.

## Managing Transactions (Quotes and Invoices)
When creating quotes or invoices, AvaTax automates tax calculations:
1. Navigate to **Quotes** > **+ New Quote** or **Invoices** > **+ New Invoice**.
2. Fill in the required details.
3. Add discounts or fees via:
* **Settings** > **Configuration Settings** > **Parts and Services** > **Discounts and Fees**, or
* Directly on the parts and services in the transaction.
4. Save the transaction as a draft to trigger AvaTax to:
* Identify tax applicability for parts and services in the customer’s geographic area.
* Assess the customer’s taxability.
* Retrieve accurate tax rates based on local governing authorities.
5. **Note**: Taxes are applied based on the billing or service address configured in **Organization Settings** > **Misc Settings** > **Tax Settings**.

6. **Discounts**:
* Transaction-level discounts are applied proportionately to all items.
* Line-item discounts are applied only to specific items.
7. **Errors**: Any errors returned by Avalara will be displayed on the transaction details page.

## Disabling AvaTax Integration
To disable the AvaTax integration:
1. Navigate to **Settings** > **Configuration Settings** > **Quotes and Invoices** > **Taxes**.
2. Select the **Deactivate** option.
3. Confirm the deactivation to disable the integration.

Integrating Avalara AvaTax with Zuper enables automated, accurate, and compliant tax calculations, reducing manual effort and ensuring seamless tax management.
# Clyr
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/Clyr
The Zuper-Clyr integration automates expense management for field service businesses, combining Zuper’s job and customer management with Clyr’s AI-driven expense tracking. Key features include:
* **Expense Tracking**: Add credit card details in Clyr to automatically track expenses. Capture receipts via the Clyr mobile app, which sync as Parts & Services in Zuper jobs.
* **Job-to-Project Sync**: Zuper jobs sync as Clyr projects, enabling seamless expense association.
* **Customer-to-Client Sync**: Zuper customers sync as Clyr clients for consistent data.
* **User Sync**: Zuper users sync to Clyr, supporting role-based expense submission and approvals.
* **Cost Visibility**: Expenses mapped to Clyr projects appear in Zuper jobs, improving job costing and budget tracking.
This integration minimizes manual entry, ensures policy compliance, and boosts efficiency for mobile workforces (e.g., HVAC, plumbing).
## Integrate and Use Clyr with Zuper
To set up and use the integration, follow these steps.
1. On Zuper, select the “**Jobs**” module from the left navigation menu and create a new job by filling in the necessary details.

2. The new job is created successfully.

3. On Clyr, click Projects in the left navigation menu. Choose the Zuper Job that is captured as a project.


4. Select the Transactions module and choose the exact transaction for which the project needs to be assigned.

5. Choose the project and map this to the transaction.

6. The transaction is mapped to the project successfully.

7. Switch to Zuper. You can view the transactions under the parts and services section in the job.

> [!NOTE]
>
> **Note**: Users on Zuper are synced as users on Clyr. The customers on Zuper are synced as clients on Clyr.
# Debugging common errors
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/QBD_Error
The most common QuickBooks Desktop errors are listed here. We came up with the errors along with the resolution for each. If you do not find any errors listed, kindly reach out to [support@zuper.co](mailto:support@zuper.co)
## Input String Error
1. Name Character Error
**Alert description:**
The string "**name**" in the field "**Name**" is too long.
**Solution:**
As the name field exceeds the acceptable character limit,
Modify the field name; attached Quickbooks Desktop characters limit for different fields.
The character limits for different name fields are listed below.

2. Address Character Error
**Alert description:**
The string "**addr**" in the field "**Addr1**" is too long.
**Solution:**
As the address field characters exceed the limit, modify the characters in the address field. A maximum of 41 characters are allowed.
## Error Occurrence during QuickBooks Desktop Zuper Sync
### Customer is not found
**Alert description:**
When a customer is created in Zuper and pushed to QuickBooks Desktop, the QuickBooks ID and QuickBooks Sequence ID are synced back to the Zuper customer module and stored in a custom field.
If you encounter an error during this process, it may be because the customer has been marked as inactive or deleted in QuickBooks.
**Solution:**
If the customer is inactive, please reactivate them in QuickBooks and try again.
If the customer has been deleted, you must recreate the customer in QuickBooks and attempt the sync again.
### Estimate is not found
**Alert description:**
When a quote is created in Zuper and pushed to QuickBooks Desktop, the QuickBooks ID and QuickBooks Sequence ID are synced back to the Zuper Quote module and stored in a custom field. If an error occurs during this process, it may be due to the quote being deleted.
**Solution:**
Please create the Quote again and retry sync
### Duplicate record in Zuper
**Alert description:**
An error may occur if a user clones a record that has already been synced with QuickBooks Desktop and creates an invoice or quote without clearing the QuickBooks Sequence ID and QuickBooks ID.
**Solution:**
Please clear the sequence ID and QuickBooks Desktop ID and retry sync.
### Invoice is not found in Zuper
**Alert description:**
When an invoice is created in Zuper and pushed to QuickBooks Desktop, the QuickBooks ID and QuickBooks Sequence ID are synced back to Zuper's Invoice module and stored in a custom field. If an error occurs, it may be due to the deletion of the invoice in QuickBooks.
**Solution:**
Please create the invoice again in Zuper and retry sync.
### Product is not found in Zuper
**Alert description:**
When a product or service is used in an invoice and pushed to QuickBooks Desktop, the QuickBooks ID and QuickBooks Sequence ID are synced back to Zuper’s Parts and Service module and stored in a custom field. If an error occurs, it may be due to the deletion of the part, product, or service in Zuper.
**Solution:**
Please create the part/service/product again in Zuper and retry sync.
### Payment mode is not found in Zuper
**Alert description:**
When an invoice is pushed from Zuper to QuickBooks Desktop, a payment mode is either created in QuickBooks Desktop or mapped to an existing one. An error will occur if the payment mode has been deleted when receiving the response from QuickBooks Desktop.
**Solution:**
Please create the payment mode and retry sync.
### Rest of all other Errors
For all other errors not mentioned here:
Please contact Zuper support - [support@zuper.co](mailto:support@zuper.co) to resolve this issue.
# Pre-Requisites
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/QBD_Pre
Zuper is integrated with QuickBooks Desktop to make your accounting and inventory management go hand-in-hand with this seamless integration.
With this integration, you can:
* Sync all your customers & inventory from Zuper to QuickBooks Desktop.
* Upon creating a Quote/Invoice/Payment in Zuper, it will be synced with QuickBooks
Desktop.
## System Requirements
1. Zuper supports the integration of US versions of QuickBooks Desktop.
2. Zuper supports QuickBooks Desktop versions that are less than three years old based on
the current calendar year. This means that as of 2025, we support versions from 2021
onwards.
3. Zuper supports integration with QuickBooks Desktop Contractor, Pro, Premier and Enterprise editions.
4. Zuper - QuickBooks Desktop integration is exclusive to the Windows version of QuickBooks Desktop, and we do not offer support for QuickBooks Desktop on MAC or any
other operating system.
5. To integrate with Zuper, QuickBooks Desktop must be updated and operating on Windows 10 or above.
6. If you have hosted through a third-party cloud hosting provider for QuickBooks Desktop, please confirm with the third-party cloud hosting provider if they allow installation of QuickBooks Web Connector. If not, you may be unable to integrate with Zuper.
> [!NOTE]
>
> **Note:** The QuickBooks web connector should be installed for seamless integration.
## Before you get started
1. The setup process requires a user with admin permission in both Zuper and QuickBooks
Desktop. It must be carried out in single-user mode within QuickBooks Desktop.
2. The admin user is expected to complete the integration setup on the same computer with access to the QuickBooks desktop.
3. Ensure the setup is conducted on a computer with access to QuickBooks Desktop and maintain a stable internet connection.
4. Additionally, it is advised to turn off the computer's sleep mode settings to prevent interruptions during setup.
# Inventory sync
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/QBD_Reverse_Inventory
## Overview
Quickbooks Desktop Bi-Directional Inventory sync allows you to keep all your inventory items and their quantities in sync between Quickbooks Desktop and Zuper.
The records pushed from Zuper will be reflected in the web connector, and if you have enabled auto sync, the records will be synced automatically; if not, you should update the records manually.
## Before you get started
1. You need to install the QuickBooks integration.
2. Set the '**Sync Product Masters**' configuration to '**Yes**'.
3. Enable categories on QuickBooks Desktop for the bidirectional sync to function correctly.
4. Since QuickBooks Desktop allows negative quantities when consumption exceeds the available stock, turn on the '**Allow Negative Stock Balance**' setting in Zuper (**Organization Settings -> Parts and Service Settings**).
5. In Zuper, set the '**Choose Module to Track Consumption**' setting (**Organization Settings -> Parts and Service Settings**) to Invoice.
6. The sync will not function properly if this setting is set to '**Job**', '**Quotation**' or '**None**'.
## How to use
You must set the following configurations for the bidirectional sync to function correctly:
1. Choose Product Master (**Mandatory**): Selecting "**Zuper**" assigns it as the product master, while choosing "**QuickBooks Desktop**" assigns QuickBooks Desktop as the product master.
> [!NOTE]
>
> Note: To enable reverse inventory sync, ensure "**QuickBooks Desktop**" is selected as the product master.
2. Product Minimum Quantity (**Mandatory**)–The minimum product quantity, entered as a numeric value, will be transferred from the corresponding QuickBooks Desktop inventory item to Zuper whenever a part or product is moved from QuickBooks Desktop with this minimum quantity applied here.
3. Non-Inventory Product Quantity (**Mandatory**)– The non-inventory item from QuickBooks Desktop will be synced with the default product quantity in Zuper, which is the non-inventory product quantity mentioned here.
4. Default Zuper Product Category (**Mandatory**) – Enter the default product category UID of Zuper for which the category of the QuickBooks Desktop inventory item gets synced.
5. Default Zuper Product Location (**Mandatory**) – Enter the default product location UID of Zuper for which the location of the QuickBooks Desktop inventory item gets synced. Select the "Update" button to connect QuickBooks Desktop with Zuper.
> [!NOTE]
>
> Note: The integration will not work as expected if any "**Mandatory**" fields are not given properly.
## Bi-directional QuickBooks Desktop – Zuper Inventory Sync
* For advanced inventory customers, inventory site information from QuickBooks Desktop will be displayed in Zuper. If a location exists in Zuper, inventory items can be transferred from QuickBooks Desktop to Zuper.
* It is important to ensure that the location master is identical in both systems, as it is case-sensitive.
* Once you configure these settings, the bidirectional sync between QuickBooks Desktop and Zuper will be established.
* Creating a part, product, or service on Zuper syncs with QuickBooks Desktop if 'Zuper' is selected as the product master.
* Similarly, if 'QuickBooks Desktop' is chosen as the product master, the sync happens in the reverse direction
* When a part or product is consumed in Zuper, its quantity updates in QuickBooks Desktop, and vice versa. This happens regardless of which system is set as the product master, ensuring that item quantities stay in sync between both systems.
### Existing product modifications in QuickBooks Desktop and Zuper
If a product with the same name already exists in Zuper and a matching product is created in QuickBooks Desktop, the product quantity in Zuper will automatically update during the reverse sync.
If a product already exists in Zuper and a new product with a different name is created in QuickBooks Desktop, the new product will be added to Zuper during the reverse sync.
Before count changes:
**QuickBooks Desktop:**


**Zuper:**


### Quantity Update in QuickBooks Desktop
Whenever a purchase order is created or an inventory adjustment is made in QuickBooks Desktop, we sync the quantity update in Zuper.
Before count changes: **QuickBooks Desktop**

**Zuper:**

After count changes: **QuickBooks Desktop**

**Zuper:**

### Quantity adjustment in QuickBooks Desktop
You can adjust the quantity of the purchased items.
In QuickBooks Desktop, under the "**Inventory**," select "**Adjust Quantity / Value on Hand**." Select the adjustment type as "**Quantity**" and fill in other details.
* If you add the quantity in "**New Quantity**," QuickBooks Desktop will adjust the existing quantity of the inventory line item in Zuper.
* If you modify the quantity difference, QuickBooks Desktop will add the quantity to your existing inventory line item in Zuper.
* If you add the quantity in "**New Quantity**" and as "**New Line Item**," QuickBooks Desktop will create a new location, if available in Zuper, with the new quantity of the inventory line item in Zuper.
Before count changes:
**QuickBooks Desktop**

**Zuper**

* If the quantity is reduced in QuickBooks Desktop, it will get decreased in Zuper at the designated location.
* If the quantity increases in QuickBooks Desktop, it will get added to the same configured location in Zuper.
* If only a single location exists in Zuper, any quantity adjustments will automatically apply to that location.
After count changes: **QuickBooks Desktop**

**Zuper**

### Handling service in QuickBooks Desktop
The service can be charged for the purchase, professional fees, and service charges. You can create a service item type from QuickBooks Desktop that will sync with Zuper's service.
In QuickBooks Desktop:
* Navigate to Inventory and select Service as the type.
* Fill in the required fields as needed.

Syncing with Zuper:
* The connector can be set to run manually or automatically to sync data between QuickBooks Desktop and Zuper.
* The Service category in Zuper is determined based on the default settings configured.
### 
Handling Non-Inventory items in QuickBooks Desktop
The non-inventory item in QuickBooks Desktop is synced with Zuper's Part. The taxable and non-taxable options set in QuickBooks Desktop are also reflected in Zuper.
In QuickBooks Desktop, under "**Inventory**," under type, select "Non-Inventory Part." Add the "Serial Name/Number, Description, Manufacturer's Part Number, Price, Tax Code, and Account."
The minimum quantity and category of the part in Zuper is fetched from the configuration default settings.
**QuickBooks Desktop:**

**Zuper:**

> [!NOTE]
>
> Note: Settings -> Organization Settings -> Parts and Services Settings -> Choose module to track part consumptions -> Invoice (choose invoice only).
### Important points to note
1. During setup, a default product category will be entered, and all products synced from QuickBooks Desktop to Zuper will be categorized under this default product category in Zuper.
2. The quantity tracking only applies to Inventory items in QuickBooks Desktop and not to Non-Inventory or Service items. Transfer transactions do not affect the total product quantity across locations and do not require synchronization.
3. Transfer transactions do not affect the total product quantity across locations and do not require synchronization.
4. Syncing product locations from QuickBooks Desktop to Zuper is not supported. Instead for users without advanced inventory in QuickBooks Desktop, a default location will be configured in the settings to manage product locations in Zuper.
To conclude, the bidirectional inventory sync between QuickBooks Desktop and Zuper ensures seamless and efficient inventory management by keeping all inventory items and quantities updated in real time.
# Module & Field Level Mapping
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/QBD_Sync
## Zuper Customer – QuickBooks Desktop Customers
Prerequisites If you want to sync all customers between QuickBooks Desktop and Zuper, please select “**Yes**” under the “**Customer Master Sync**” field on the App Configuration page.
Selecting this as “**No**” will only sync the customer as a part of the Quote or Invoice sync between the systems.


> [!NOTE]
>
> **Note:** The tax-exempt information under the customer in Zuper will not be synced to Quick Books Desktop due to the limitation in the Quick Books Desktop API. Hence, you will need to update this information manually.
## Zuper Parts & Services – QuickBooks Desktop Items & Services
Prerequisites:
The parts and services master sync should be “**Yes**” on the configuration page. If “**No**” is selected, the parts/services will be pushed whenever a new quote or invoice is created.
In Zuper, if a part or product is set to track quantity as "**Yes**," it is pushed to QuickBooks as inventory. If set to "**No**," it is pushed as non-inventory, while services in Zuper are pushed as item service in QuickBooks Desktop.
The various sync details:


> [!NOTE]
>
> Note: You must create four custom fields (****QuickBooks Desktop Income Account, QuickBooks DesktopCOGS Account, QuickBooks Desktop Asset Account, and QuickBooks Desktop Expense Accoun**** t) in Zuper for every part, product, or service to map the QuickBooks Desktop Income Account, QuickBooks Desktop COGS Account, QuickBooks Desktop Asset Account, and QuickBooks Desktop Expense Account from QuickBooks Desktop. Ensure these fields match, as they are case-sensitive.
> [!NOTE]
>
> Note: QuickBook Desktop does not support a first-class field called Category, and hence, it will not be synced with Zuper.
## Zuper Quote – QuickBooks Desktop Estimate
The sync happens from Zuper Quote to QuickBooks Desktop Estimate.
Prerequisites: The Quote sync should be “**Yes**” on the configuration page; only Zuper Quote integration to Quick Books Desktop will happen. You can do three significant actions: *Quote Create Sync, Quote Update Sync, and Quote Deposit Payment Sync*.
The various sync details:


> [!NOTE]
>
> Note:
>
> * Quote sync happens from Zuper Quote to Quick Books Desktop only when the quote reaches the “**Sent**” status.
> * The fee entered in a Quote will not be pushed to QuickBooks Desktop.
> * If a quote includes a deposit amount, we will also push the deposit as a partial payment when creating the invoice from that quote to QuickBooks Desktop.
## Zuper Invoice – QuickBooks Desktop Invoice
The sync happens from Zuper Invoice to QuickBooks Desktop Invoice. The sync from Zuper to QuickBooks occurs based on the status selected in the configuration settings.
You can do three significant actions: Invoice Create Sync, Invoice Update Sync, and Invoice Payment.
The various sync details:


> [!NOTE]
>
> **Note:**
>
> * By default, we will create custom fields in Zuper named QuickBooks ID and QuickBooks Sequence ID. When cloning any invoice that has been pushed to QuickBooks Desktop, please remove both IDs; otherwise, the push will fail.
> * From Zuper’s side, we will create a payment mode if the payment mode between the system does not match.
> * The fee and tip entered in Zuper invoice will not be synced in Quickbooks desktop.
## Zuper Payments – QuickBooks Desktop Payments
The sync will happen from Zuper payments to Quickbooks payments.
The various sync details:
* When Zuper pushes payments, they can be viewed against their corresponding invoices in QuickBooks Desktop.
* We will mark a payment as void whenever it is voided in Zuper.
* For seamless sync, the payment mode must be configured in Zuper and Quick Books Desktop. If it is not present, we will create it on Quick Books Desktop.

### Points to note:
* QuickBooks Desktop does not retain the relationship between a quote and an invoice as Zuper does.
* You can sync customers or organizations from Zuper to QuickBooks Desktop. If you select organization syncing, we will push organization information only when creating transactions. A master sync of organizations is not possible.
* New features in Zuper's latest version, such as markup, Stock Transfer Order, etc., will not be pushed to QuickBooks Desktop.
* Multi-currency support is not available in Zuper.
* Classes handling is not managed.
* Credit memo and refund process scenarios are not handled.
* Custom field mapping capabilities are not handled for now.
* We recommend maintaining tax or discount in only one system. Either you can maintain tax or discount in QuickBooks Desktop or Zuper, not both.
* If the percentage or value of a discount changes in any transaction from the master value, a new discount item will be created in QuickBooks Desktop.
* If you add a custom line item to any quote or invoice in Zuper, the item will be created as a service item in QuickBooks Desktop.
# Debugging common errors
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/QBO_Errors
The most common QuickBooks Online errors are listed here. We identified the errors along with their corresponding resolutions. If you do not find any errors listed, kindly reach out to [support@zuper.co](mailto:support@zuper.co)
## Overview of Sync Issues
When data fails to sync between Zuper and QuickBooks Online, the issue can stem from various sources, including configuration errors, data validation issues, or QuickBooks Online API limitations. The absence of an error in sync history often indicates that the record was created or updated by the same user whose API key was used for the integration. Other scenarios include incorrect installation (e.g., incomplete OAuth) or specific errors logged in the sync history, which can be either Zuper-validated or QuickBooks Online API errors.
### Sources of Errors
* **Zuper Entities**:
* Primary Zuper Record: Missing line items or invoices not in a sync-ready status.
* Associated Zuper Object: Incorrect customer details for QuickBooks Online creation.
* Zuper App Configuration: Misconfigured settings.
* Zuper Settings: Duplicate object errors due to mismatched unique fields.
* **QuickBooks Online Entities** :
* Primary QuickBooks Online Record: Manual modifications in QuickBooks Online conflict with sync updates.
* Associated QuickBooks Online Record: Issues fetching tax or other linked data.
* QuickBooks Online Settings: Custom transaction numbers, class tracking, or multicurrency settings.
* QuickBooks Online Plan: Limitations, such as a lack of class tracking support.
* **Combined Issues**: Errors may arise from a combination of configuration and missing data, or unsupported QuickBooks Online settings.
## Error Categories and Solutions
Below is a consolidated breakdown of errors, their causes, and actionable solutions, organized by category.
## **1. Zuper-Side Errors**
### **• Customer not found or could not be created in QuickBooks Online**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Invalid customer information. Examples: incorrect email format, invalid phone number. | Verify and correct the customer's email to a valid format (e.g., [user@domain.com](mailto:user@domain.com)). Fix phone number format per QuickBooks Online requirements. Retry the sync. |
| **Code:** N/A | **Missing customer identification field.** The field your account uses to match customers is empty on the Zuper record, for example, an invoice whose customer has no Billing Email populated. | Check which fields your account uses under **App Store → QuickBooks Online → Identify Customers in Zuper-QuickBooks**. Populate the selected field(s) on the Zuper customer record. Retry the sync. See [Identifying customers](/Integrations/Accounting_and_payments/Zuper_QuickBooks_Online) for the full mapping table. |
***
### **• Unable to upload attachment - \$ in QuickBooks Online**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Attachment exceeds QuickBooks Online’s 20MB size limit. Unsupported format (e.g., PDF). | Ensure the attachment is under 20MB. Use a supported format (e.g., JPEG, PNG). Compress or convert the file. Retry the sync. |
***
### **• Unable to fetch tax from QuickBooks Online**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Tax sync issue between Zuper and QuickBooks Online. QuickBooks Online is the tax master, and the relevant tax is not created in Zuper. | Match Zuper’s tax configuration to QuickBooks Online’s tax settings. If QuickBooks Online is the tax master, create the corresponding tax in Zuper. Update tax mapping in integration settings. Retry the sync. |
***
### **• Line item not present**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Invoice/quote has no line items. QuickBooks Online requires at least one line item. | Add at least one valid line item. Fill all required fields (e.g., description, amount). Retry the sync. |
***
### **• Could not create or update product**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Failed to get Zuper product details. QuickBooks Online doesn’t support negative price for inventory items. Bundle-level pricing not supported in QuickBooks Online / Bundle not available in QuickBooks Online. QuickBooks Online doesn’t allow creating bundles via API. | Retry the sync after some time. Set a non-negative selling price for the inventory item. Use a roll-up bundle in the invoice/estimate. Create the bundle directly in QuickBooks Online, then sync the invoice/estimate. |
| | QuickBooks Online service items without a SKU value are skipped during sync. Zuper requires a SKU to match and import service-type items. Unlike parts, service items do not have a fallback identifier, so missing SKU causes a silent skip — no error is logged in Zuper's sync history. | |
| | 1. **Open Products and Services in QuickBooks Online.** In QuickBooks Online, go to **Sales → Products and Services**. 2. **Edit the affected service item.** Open each service item that is missing from Zuper and select **Edit**. 3. **Populate the SKU field.** Enter a unique value in the **SKU** field, then select **Save and close**. 4. **Retry the sync in Zuper.** In Zuper, go to **App Store → QuickBooks Online → Sync Now**. - **Verify the items in Zuper.**
Go to **Inventory Management → Parts & Services** and confirm the service items now appear. | |
***
### **• Excess Payment Detected**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Payment collected in Zuper failed to sync to QuickBooks Online. Payment then collected in QuickBooks Online; reverse sync shows payments exceed invoice total. | Usually safe to ignore as payments will match between Zuper and QuickBooks Online. Confirm payment totals align in both systems. |
***
### **• Payment method not found in Zuper/QuickBooks Online**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Payments collected in QuickBooks Online lack a payment method or use one not present in Zuper. | Add a fallback payment method in Zuper for reverse-sync from QuickBooks Online. Retry the sync. |
***
## **2. QuickBooks Online API Errors**
### **• Unsupported Operation**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** 500 | QuickBooks Online plan selected in Zuper doesn’t match the subscribed QuickBooks Online plan. Technical issues (e.g., encoding or special characters). | Contact Zuper support ([support@zuper.co](mailto:support@zuper.co)) to verify/update the plan mapping. Ensure plan selection matches QuickBooks Online subscription. Remove or correct special characters/encoding issues. Retry the sync. |
***
### **• Business Validation Error**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** 6000 | QuickBooks Online business rule failed. Examples: missing GST/HST rate (Canada), agency issues, currency mismatch, missing required fields. | Read the QuickBooks Online error message for the exact cause. Update fields in Zuper (e.g., add valid GST/HST, fix currency). Retry the sync. |
***
### **• Invalid Email Address Format Error**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** 2210 | Customer email in Zuper is not in a valid format. | Update the email to a valid format (e.g., [user@domain.com](mailto:user@domain.com)). Validate other customer details. Retry the sync. |
***
### **• Invalid Reference ID Error**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** 2500 | A line item name matches a master record (e.g., product category) in QuickBooks Online. | Rename the line item in Zuper to be unique (not matching any QuickBooks Online master). Retry the sync. |
***
### **• Stale Object Error**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** 5010 | Updating an outdated object version. Concurrent edits in QuickBooks Online by the OAuth user. | Contact Zuper support to refresh the integration connection. Avoid concurrent edits on the same record in QuickBooks Online. Retry the sync. |
***
### **• Object not found**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Referenced record (e.g., customer/product) is deleted or inactive in QuickBooks Online. | Check QuickBooks Online for the referenced record’s status. Reactivate or recreate the record. Retry the sync. |
***
### **• Incorrect account type or missing account reference**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Referenced account is invalid or missing in QuickBooks Online. | Verify the account exists and has the correct type (e.g., income, expense). Update account mapping in Zuper integration settings. Retry the sync. |
## **3. Duplicate Errors**
### **• Duplicate Object Error**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** 630 | Object in Zuper violates a unique constraint in QuickBooks Online (e.g., reference ID, name). | Update the object in Zuper to ensure uniqueness (e.g., change reference ID or name). Check QuickBooks Online for conflicting records. Retry the sync. |
***
### **• Duplicate Document Error / Duplicate Document Number Error**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** 6140 | Document number in Zuper already exists in QuickBooks Online. Often occurs when existing QuickBooks Online records predate integration and Zuper uses a similar series with ID preference set to Zuper. | Use a unique document number in Zuper or enable auto-numbering in QuickBooks Online. Set ID preference to “QuickBooks Online” and retry. **Note:** Document numbers will not match between Zuper and QuickBooks Online. |
***
### **• Duplicate Name Exists Error**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** 6240 | Customer name exists in QuickBooks Online but with a different QuickBooks Online ID. Often due to manual deletion and recreation in QuickBooks Online. | Change the customer’s display name in Zuper to be unique. Or merge or rename duplicates in QuickBooks Online to align with Zuper. Retry the sync. |
***
## **4. Other Errors**
### **• Unable to Fetch Customer from QuickBooks Online**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Unknown issues blocking customer retrieval. Possible connectivity or permission problems. | Verify OAuth connection and API permissions. Confirm the customer exists and is active in QuickBooks Online. Re-authenticate the integration if needed. Retry the sync. |
***
### **• Unable to Fetch the Estimate from QuickBooks Online**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Unknown issues fetching the estimate. Possible data mismatches or QuickBooks Online access issues. | Check the estimate’s status in QuickBooks Online and sync requirements. Re-authenticate integration and confirm connectivity. Retry the sync. |
***
### **• All Other Error Codes**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Unlisted or unknown issues (connectivity, permissions, data problems). | Contact Zuper support ([support@zuper.co](mailto:support@zuper.co)) with the specific error code and sync history details. Provide logs or screenshots to assist troubleshooting. |
***
### **• Customer not present in QuickBooks Online for the given ID: XXXX**
| **Error** | **Cause** | **Solution** |
| :- | :- | :- |
| **Code:** N/A | Customer synced from Zuper to QuickBooks Online but was made inactive. Sometimes due to temporary connection issues preventing retrieval. | Reactivate the customer in QuickBooks Online. Retry the sync. If connection-related, try again after some time. |
## Best Practices to Prevent Sync Errors
1. **Verify Integration Setup**:
* Ensure OAuth is completed correctly and the API key is valid.
* Confirm that the QuickBooks Online plan selected in the app configuration matches the user’s subscription.
2. **Data Validation**:
* Regularly check customer details, tax settings, and line items in Zuper for accuracy.
* Avoid manual changes in QuickBooks Online that could conflict with sync updates.
3. **QuickBooks Online Configuration**:
* Enable or disable features like custom transaction numbers, class tracking, or multicurrency as needed.
* Ensure tax settings in QuickBooks Online align with Zuper’s configuration.
4. **Monitor Sync Activity**:
* Regularly review sync history and activity logs to identify and address issues early.
* Compare QuickBooks Online’s transaction audit history with Zuper’s invoice activity for discrepancies.
5. **User Coordination**:
* Prevent the OAuth user from editing QuickBooks Online records during sync to avoid stale object errors.
6. **Unique Identifiers**:
* Ensure customer names, invoice numbers, and reference IDs are unique to avoid Duplicate Object (630), Duplicate Document (6140), and Duplicate Name Exists (6240) errors.
* Use distinct names for line items to prevent Invalid Reference ID Errors (Error Code: 2500).
7. Ensure all **service items** in QuickBooks Online have a **SKU / Item ID** populated. Items without a SKU will not sync into Zuper and will not appear in sync history error logs.
8. Use a **separate Zuper account** for the integration API key and for day-to-day invoice and payment work. Records created or updated by the API key's own account are skipped silently and do not appear in sync history error logs.
## Additional Notes
* **Multiple Causes**: Sync failures may result from combined issues (e.g., missing data and incorrect settings). Address each potential cause systematically.
* **Documentation**: Refer to the QuickBooks Online API error codes and Zuper’s error documentation for detailed troubleshooting.
* **Support**: If issues persist, contact Zuper or QuickBooks Online support with specific error details from the sync history.
### Diagnostic Tools
* **Sync Activity**: Review to identify created or associated records during sync.
* **QuickBooks Online** **Transaction Audit History**: Compare with Zuper’s invoice activity to distinguish user-initiated changes from integration-driven changes.
* **Error Codes**: Use the provided error codes to pinpoint the issue and apply the corresponding solution.
* **Combined Issues**: Some errors may result from multiple causes (e.g., incorrect plan selection and missing data). Address each issue systematically using the provided solutions.
* **Escalation**: For errors requiring Zuper support (e.g., Unsupported Operation, Stale Object, or unlisted error codes), provide detailed information, including the error code, sync history logs, and affected records.
* **Documentation**: For further details on specific error messages, refer to QuickBooks Online’s API documentation and Zuper’s error code reference.
***
# Overview
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/QBO_Overview
The Zuper and QuickBooks Online integration is an excellent solution for businesses managing field service operations and accounting.
Core Features of Zuper-QuickBooks Online Integration:
* **Automated Invoice Sync**: Invoices created in Zuper automatically sync with QuickBooks Online, ensuring up-to-date financial records.
* **Real-Time Data Synchronization**: Changes in QuickBooks Online, like payment updates, are instantly reflected in Zuper, and vice versa.
* **Unified Customer and Organization Management**: Keep customer and organization information consistent across both systems, eliminating duplicate entries and ensuring data reliability.
## **Key Benefits**
* **Time Efficiency**: Automated data transfer reduces manual tasks and saves time.
* **Enhanced Accuracy**: Seamlessly syncing data across platforms minimizes manual entry errors.
* **Improved Collaboration**: Operations and finance teams access up-to-date, consistent information, enabling better teamwork and insights.
With this integration, you can:
* Sync all your contacts, accounts, and inventory from Zuper to QuickBooks Online.
* Upon creating a Quote or Invoice in Zuper, it is synced with QuickBooks Online.
## Bi-directional sync
**Invoices**: Invoice status is synced bidirectionally. If a payment is collected against an invoice in QuickBooks Online, the invoice will be updated to a paid status in **QuickBooks Online**. This is synced back to Zuper. Similarly, the partially paid status is also synced back to Zuper.
**Payments**: Payments collected in QuickBooks Online are synced to Zuper and vice versa.

# Accessing Sync History
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/QBO_Sync_History
Customers who use the QuickBooks integration to send invoice and quote data from Zuper to QuickBooks sometimes encounter errors. The Sync history feature allows you to troubleshoot these issues.
To help troubleshoot Zuper-QuickBooks Online sync issues, Zuper provides a sync history log that tracks data transfers between the two systems. This allows you to determine the root cause of errors, resolve them, and resync for smooth integration.
## Sync History
1. Select the “**Settings**” module from the left navigation menu. Under the "**Other Settings**," select the "**Sync Activity**."

2. The "Sync History" list page appears.
2.1. Sync UID - The unique ID identifying the sync between Zuper and QuickBooks.
2.2. Module Name - The name of the module where the sync happened.
2.3. Record ID/Name - The exact module record ID or Name with the hyperlink.
2.4. Application Name - The name of the integrated application.
2.5. Type of Sync - The sync type of the integration which can be the actions such as Create, Update, and Delete.
2.6. Status - The sync current status is shown - Started, Success, or Error status is displayed.

3. Click a record id/name to view details.
You can view the current sync status of the QuickBooks integration along with the destination record ID.

4. Click the clock icon to view the Sync History.

5. A dialog box will appear to display the list of recent syncs for the record.

> [!NOTE]
>
> **Daily sync limits:** To keep the QuickBooks Online integration stable, Zuper limits the number of syncs that can happen each day.
>
> * The company-level limit counts all syncs across your account.
> * The record-level limit counts syncs for each individual record, in every module that syncs with QuickBooks Online. Both limits reset daily.
>
> Once a limit is reached, changes made later that day do not sync, and an error appears in **Sync History** and stays there. If your company reaches its limit, syncing stops for all records. If a single record reaches its limit, only that record stops syncing. If these limits affect your syncing, contact [Support](mailto:support@zuper.co).
## How to Retry Sync?
1. Whenever an error occurs during the sync, an alert will appear on the Invoice / Quote's details page.
Take corrective actions and click the "**Retry Sync**" to reysnc the record.

2. The sync will happen and it will be completed in few seconds.

3. The sync is successfully done.

4. If you wish to acknowledge and dismiss the error, click the "**Acknowledge**" button.

## How To Resolve Errors?
1. When the error alert appears, click the "**Learn How to Fix**" button. You will be redirected to the relevant section of this article, which contains information on resolving errors.
We created this feature to provide visibility into sync errors for our customer to identify issues, allowing for corrective actions and manual resync when necessary.

# Inventory sync
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/QBO_bid_inventory
QuickBooks Bi-Directional Inventory Sync lets you keep all your inventory items and their quantities in sync between QuickBooks Online and Zuper.
This allows you to use one system as the system of origin for products while consuming them in transactions on both systems. The quantities will be kept in sync on both systems.
## Pre-Requisites
1. You need to install the QuickBooks integration.
2. Set the '**Sync Product Masters**' configuration to '**Yes**.'
3. Enable categories on QuickBooks Online so the bidirectional sync functions correctly.
4. Since QuickBooks Online allows negative quantities when consumption exceeds the available stock, turn on the '**Allow Negative Stock Balance**' setting in Zuper (Organization Settings -> Parts and Service Settings).
5. In Zuper, set the '**Choose Module to Track Consumption**' setting (Organization Settings -> Parts and Service Settings) to Invoice.
6. The sync will not function properly if this setting is set to '**Job**,'' **Quotation**,' or '**None**.'
## How to use
You must set the following configurations for the bidirectional sync to function correctly:
1. **Choose Product Master** – Select the system where you will create new products, specifying whether products will be added initially in Zuper or QuickBooks Online. This setting determines how the sync operates, so ensure you create parts only in the selected system.
2. **Default Product Location** – Enter the default location for products created when synced from QuickBooks Online. This is necessary because QuickBooks Online does not support locations for inventory and non-inventory items.
3. **Product Minimum Quantity** – Set the minimum quantity for the product at the default location.
4. **Non-Inventory Product Quantity** – Set the default quantity for non-inventory items from QuickBooks Online to be created in Zuper. This is required since QuickBooks does not support quantities for non-inventory items.
Once you configure these settings, the bidirectional sync between QuickBooks Online and Zuper will be established.

Creating a part, product, or service on Zuper syncs with QuickBooks Online if 'Zuper' is selected as the product master. Similarly, if 'QuickBooks Online' is chosen as the product master, the sync happens in the reverse direction.
When a part or product is consumed in Zuper, its quantity updates in QuickBooks Online, and vice versa. This happens regardless of which system is set as the product master, ensuring that item quantities stay in sync between both systems.
> [!NOTE]
>
> Note: If the product categories in QuickBooks are enabled, the integration will consider both the category and the name when checking for duplicates.
## Limitations
1. When an inventory item syncs from QuickBooks Online, it is always synced as a product, and its location is set to a default location, which can be modified as needed.
2. When a non-inventory item syncs from QuickBooks Online, it is always synced as a part, with a default quantity assigned to the configured location, which can be adjusted as needed.
3. Quantity changes are always synced to the default configured location.
4. If Zuper is selected as the '**Product Master**,' the quantity sync for invoices created in QuickBooks Online will not work as expected.
# Payments sync
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/QDP_Payments
The sync will happen between QuickBooks Desktop payments and Zuper payments.
This allows you to use one system as the system of origin for payments while updates are synced on both systems.
## Before you get started
* The payment mode used for the payment in QuickBooks Desktop must be created/already existing in Zuper.
* The web connector must either be actively running in auto-sync mode
or manually initiated by the user.
## Set sync between QuickBooks Desktop Zuper
1. The QuickBooks Desktop payments can be viewed against their corresponding invoices in Zuper for the fully or partially paid invoice.


2\. Payments made through QuickBooks Desktop for partially paid invoices can be viewed in Zuper and linked to their respective invoices.


3\. When a user makes a partial or complete payment in QuickBooks Desktop using the "**Cash or Online**" payment method, Zuper updates it with the same payment method through reverse sync.
> [!NOTE]
>
> **Note**: Zuper will void the previous payment in QuickBooks Desktop for edited payments and update it with the new payment details.


4\. When a user voids a payment in QuickBooks Desktop, Zuper reflects this change, with the payment history in the invoice section indicating the voided payment synced from QuickBooks Desktop.

Zuper's reverse payment sync with QuickBooks Desktop simplifies managing payment errors by automatically reversing them and updating records in real time. This saves time, reduces mistakes, and keeps your financial data accurate and consistent.
# QuickBooks Online Data Import
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/QuickBooks_data_import
## **Overview**
Zuper's integration with QuickBooks Online enables seamless import of customer and product data from QuickBooks into Zuper.
The import feature supports Products and Customers Modules, with configurable options to tailor the sync to your needs.
This guide covers the setup and execution of bulk data imports. Note that imports are one-way (from QuickBooks to Zuper) and can be based on criteria such as creation date or update date.
## **Prerequisites**
* An active Zuper account with administrative access.
* A connected QuickBooks Online account via the Zuper app (go to Settings > Apps > QuickBooks Online to connect if not already done).
* Ensure your QuickBooks data is up to date, as the import pulls live data.
* For large datasets, imports may take time; monitor progress in the interface.
## **Accessing the Import Feature**
1. Log in to your Zuper account and navigate to Apps -> QuickBooks Online.

2. In the QuickBooks Online settings page, click **Bulk Import** to start the import wizard.

## **Step 1: Choose Modules to Import**
On the initial setup screen (Step 1 of 4: Choose Modules to Import), select the modules you want to sync:
* **Products**: Import your product master’s from QuickBooks to Zuper.
* **Customers**: Import customer records from QuickBooks to Zuper.
.png?fit=max\&auto=format\&n=JrmueORkXcAaN9vK\&q=85\&s=ecc13599cdc7a554dc6d507dcb5dd69c)
> [!NOTE]
>
> **Note**: You can select one module at a time, or you can select Products and Customers together; however, the import process occurs one module at a time.

## **Step 2.1: Configure and Import Products**
If you selected Products, you'll be directed to the Products Import - Setup screen.
Under **Sync Based on**, choose a filter based on which to import products:
* **All Products**: Imports every active product in the connected QuickBooks company.
* **Created Date**: Imports products created after a specified date.
* **Last Updated Date**: Imports products updated after a specified date.
If selecting Created Date or Last Updated Date, enter a **Sync from** date to define the starting point.
Click **Get Count** to preview the number of eligible products (e.g., "9 Products found in QuickBooks").

Review the count and click **'Sync products**' to begin the import.

* Monitor the progress bar on the next screen (Step 2: Import Products to Zuper), which shows real-time status (e.g., "Importing 0 of 9 Products (0%)").

## **Step 3: Check Results for Products**
After the import process completes, you'll see the Check Results screen (Step 3: Check Results).
* If successful, a green checkmark appears with a message like "**Successfully imported 1 out of 1 Products into Zuper**."
* If there are errors, a yellow exclamation or red X icon appears, indicating the number of failed imports (e.g., "Imported 0 out of 1 Products into Zuper" or "Imported 0 out of 2 Products into Zuper").
Errors are listed in a table with columns for **Product ID, Record name, and Reason**. Common errors include:
* "**Product already exists in Zuper**" (e.g., for PRODUCT ID 503, RECORD NAME "Black Shingles").
* "**Product Sku is required for Product Creation/Update**" (e.g., for PRODUCT ID 504, RECORD NAME "3' Eaves").
For errors, make necessary changes in QuickBooks (e.g., add missing SKUs or skip duplicates), then retry the import or create records manually.
Click **Skip** to proceed without resolving or **Continue** to move to the next module.
Once complete, proceed to the Customers module if selected, or to the finish step.

## **Step 2.2: Configure and Import Customers**
If you selected Customers, you'll be directed to the Customers Import - Setup screen (this follows a similar structure to Products).
Under **Name Format**, select how customer names should be formatted in Zuper:
* **First Name, Last Name** (default).
* **Last Name, First Name**.
This defines how the customers are created in Zuper. For example, If a customer is called John Nash in QuickBooks and the name format is set to Last Name, First Name. They will be imported in Zuper as Nash John.
Under **Sync Based on**, choose a filter for which customers to import:
* **All Customers**: Imports every active customer in the connected QuickBooks company.
* **Created Date**: Imports customers created after a specified date.
* **Last Updated Date**: Imports customers updated after a specified date.
If selecting Created Date or Last Updated Date, enter a **Sync from** date (e.g., September 18, 2025) to define the starting point.
Under **Customer Hierarchy**, decide how to handle parent-child relationships:
* **All as Customers** (default: Treats both parent and sub-customers as flat customers).
* **All Sub-Customers as Customers**. (Creates only the sub-customers as customers in Zuper. Parent customers are skipped.
* **Parents as Orgs, Sub-Customers as Customers**. (Creates parents as orgs in Zuper and Sub-customers as associated Customers)
Click **Get Count** to preview the number of eligible customers based on the filters (e.g., "1 Customer found in QuickBooks").
Review the count and click '**Sync customers**' to begin the import.


Monitor the progress bar, like the Products import.
## **Step 3.2: Check Results for Customers**
* Successful imports display a green checkmark with a message such as "**Successfully imported 1 out of 1 Customers into Zuper**."
* Errors, if any, are detailed in a table (although less common in customer examples).

* Click **Skip** or **Continue** as needed.


## **Step 4: Finish the Import**
After importing selected modules, review the **Import Summary** tab (Step 4 of 4: Import Summary) for an overview:
* **Products**: Shows the count imported (e.g., 1).
* **Customers**: Shows the count imported (e.g., 1).
Click **'Download Report' to obtain** to get a detailed Excel file of the import results. The report includes columns like:
* **Import Status** (e.g., Success).
* **QuickBooks Record Id** (e.g., 503).
* **QuickBooks Record Name** (e.g., Black Shingles).
* **Zuper Url**.
* **Import Information** (e.g., "Successfully created Black Shingles in Zuper").


If needed, you can return to previous steps to adjust configurations or re-import.
Click **Finish** or navigate back to the dashboard. Imported data will now be available in Zuper for use in quotes, invoices, and other features.

## **Important Notes**
* The records imported via this import functionality will be automatically connected with the respective records in QuickBooks Online.
* This feature is intended to be used for the initial setup of your Zuper account with your exisitng QuickBooks data. Therefore, record updates are not supported. If a record that already exists in Zuper is imported via this feature, it will be skipped in the import process.
* Only active records are imported into Zuper from QuickBooks for both Products and Customers.
* Only the first 2 levels in the hierarchy, i.e Parent\_customers -> Sub-customers\_level\_1, are supported in the import. QuickBooks supports further levels of Sub-customers (up to level 3), but these are not considered for the import.
* Fallbacks are used for particular fields, such as Category and Product Location (for Products Import), that are mandatory for creation in Zuper.
## **Limitations**
QuickBooks Online has character limitations on specific fields. Please ensure that each field you are about to upload follows this limit to prevent any data import errors. Learn more about this character's limitations [here](https://quickbooks.intuit.com/learn-support/en-us/help-article/printing-preferences/character-limitations-fields-quickbooks/L7eIy5gE3_US_en_US).
## Best Practices
* Ensure that the API key is entered properly and the configurations are saved before attempting the Import.
* Review the report for the Import to understand the reasons for failure. Ensure all the mandatory fields for record creation in Zuper are present in the QuickBooks Online records being imported.
* Ensure that the Name format setting in the Import matches the Display Name Format setting in the Zuper QuickBooks Online app Configuration.

* Enable **Sync Product Masters** to automatically keep products in sync post-import.
## **Troubleshooting**
* **No Data Found**: Ensure the Sync from date is set correctly and that data exists in QuickBooks matching your filters. Double-check your QuickBooks connection.
* **Import Stuck at 0%**: Refresh the page or check your internet connection. For large imports, it may take several minutes to start.
* **Hierarchy Issues**: If customer relationships aren't importing as expected, try different Customer Hierarchy options and re-import.
* **Product Already Exists in Zuper**: This error occurs when a product (e.g., "Black Shingles") is detected as a duplicate. Skip the import for that item or remove/update the existing record in Zuper before retrying.
* **Product Sku is Required**: Ensure all products in QuickBooks have a valid SKU. Update the product in QuickBooks and retry the import.
* **Multiple Errors in Batch**: If importing multiple items (e.g., 2 products), errors are listed individually. Address each reason (e.g., SKU missing or duplicate) and re-import selectively.
* **Errors During Sync**: Note any error messages and contact Zuper support with details (e.g., date filters used). Use the Download Report for a full log of successes and failures.
* **Inconsistent Results**: If an import shows success in the report but errors in the UI (or vice versa), verify data in both platforms and consider re-running with narrower filters.
For more advanced configurations or API-based imports, refer to Zuper's developer documentation.
# Sage Intacct
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/Sage
The bi-directional integration between **Zuper** and **Sage Intacct** allows seamless synchronization of data between the two systems.
You can transfer **invoices and customer information** from Zuper to Sage Intacct and import **inventory and payment details** from Sage Intacct to Zuper.
This integration enhances accuracy, reduces manual effort, and ensures your accounting and field operations stay in sync.
The following sections explain how to:\
A. Connect Sage Intacct with Zuper\
B. Understand how the integration works\
C. Uninstall Sage Intacct from Zuper
### **A. How to Connect Sage Intacct with Zuper**
1. **Open Zuper App Store**
* Log in to your Zuper account.
* Click your **Profile Picture** in the top-right corner and select **App Store**.

2. **Select the Sage Intacct App**
* Under **Browse by Category**, choose **Accounting and Payments**.
* Locate **Sage Intacct**.

* Click **Configure Settings**.

> [!NOTE]
>
> Note: Keep both the Zuper and Sage Intacct tabs open during setup for quick switching between
>
> systems.
3. **Update Zuper Settings**\
Configure the following fields under Sage Intacct settings:
| Field | Description |
| :-: | :-: |
| **Sage Sender ID** *(Mandatory)* | Enter the Sender ID from Sage Intacct. |
| **Sage Sender Password** *(Mandatory)* | Enter the corresponding sender password. |
| **Sage Company ID** *(Mandatory)* | Enter the Company ID from Sage’s login page. |
| **Sage User ID** | Enter the User ID from Sage’s login page. |
| **Sage User Password** *(Mandatory)* | Enter the user password. |
| **Sync Customers** | Select **Yes** or **No** to sync customers from Zuper. |
| **Sync Organizations** | Select **Yes** or **No** to sync organizations from Zuper. |
| **Sync Products** | Select **Yes** or **No** to sync products from Sage. |
| **Identify Customer By** | Choose **None**, **Name**, or **Email** to identify customers. |
| **Invoice Custom Field for Location** | Enter the Invoice Custom Field from Sage’s Accounts Receivable module. |
| **Default Payment Mode UID in Zuper** | Contact Zuper Support to obtain this UID. |
| **Default Product Category UID in Zuper** | Contact Zuper Support to obtain this UID. |
| **Zuper API Key** | Enter your Zuper API key. [Learn how to generate an API key.](#) |
| **Sync Failure Emails** | Enter email addresses to receive sync failure notifications. |
4. Click **Update** to complete the connection between Zuper and Sage Intacct.

### **B. How the Zuper – Sage Intacct Integration Works**
Once connected, data synchronization between Zuper and Sage Intacct works in both directions — based on the configured modules.
#### **i. Zuper as a Source**
Data flows from Zuper to Sage Intacct.
* **Organizations → Customers**\
Any new or updated organization in Zuper automatically syncs with the **Customers** module in Sage.\
The synced record includes a **Sage Customer ID** visible in the organization’s details in Zuper.
* **Customers → Contacts**\
Customer information from Zuper syncs with the **Contacts** module in Sage Intacct, keeping customer details consistent across both systems.
* **Invoices → Sales Invoices**\
Invoice creation or updates in Zuper automatically sync with the **Sage Invoices** module in Sage.\
You can view the **Sage Invoice ID** under the Zuper Invoice details.
#### **ii. Sage as a Source**
Data flows from Sage Intacct to Zuper.
* **Items → Products**\
Any new or updated item in Sage Intacct syncs automatically with the **Products** module in Zuper.
* **Payments → Payments**\
Payments recorded or updated in Sage Intacct sync seamlessly with the **Payments** module in Zuper.
> [!NOTE]
>
> Note: This two-way integration ensures that accounting and operational data remain synchronized, reducing manual entries and improving accuracy.
### **C. How to Uninstall Sage Intacct from Zuper**
1. **Open Zuper App Store**
* Log in to your Zuper account.
* Click your **Profile Picture** → **App Store**.
2. **Locate the App**
* Under **Browse by Category**, select **Accounting and Payments**.
* Choose **Sage Intacct** from the list.
3. **Uninstall the App**
* Click **Deactivate**.

The Sage Intacct integration will be deactivated from your account.
The **Zuper–Sage Intacct Integration** provides a unified workflow between your field operations and financial system.\
By syncing customers, invoices, payments, and inventory in real time, this integration eliminates duplicate data entry, enhances visibility, and enables your back-office team to manage all accounting processes directly from Zuper.
# Square
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/Square
**Square** is a popular point-of-sale (POS) system that enables merchants to accept credit and debit card payments through a mobile app or card reader. Known for its simple setup, quick deposits, and affordable transaction fees, Square is now integrated with **Zuper**, allowing you to collect full or partial payments for estimates and invoices directly from the app.
### A. Connecting Your Square Account
To connect your Square account, follow these steps:
1. **Log in** to your Square Developer Dashboard at [https://developer.squareup.com/apps](https://developer.squareup.com/apps).

2. **Create a new developer application.**
* Once created, you can find your **App ID** on the application details page.

3. **Generate an Access Token** from your **Sandbox** or **Production** environment.

4. **Locate your Location ID** from the **Locations** page.

You will need the following three values to configure the integration in Zuper:
* **App ID**
* **Access Token**
* **Location ID**
### B. Integrating and Using Square with Zuper
#### I. How to Connect Square with Zuper
1. Log in to your **Zuper account**.
2. Click your **Profile Picture** (top-right corner) and select **App Store**.

3. Under **Browse by Category**, choose **Accounting & payments** → select **Square**.

4. Click **Configure Settings**.

5. Fill in the configuration fields:
| **Field** | **Description** |
| :-: | :-: |
| **App ID (Mandatory)** | Enter the App ID from your Square Developer Application. |
| **Access Token (Mandatory)** | Enter the Access Token from the Credentials page. |
| **Location ID (Mandatory)** | Enter the Location ID from your Square Locations page. |
| **Zuper API Key (Mandatory)** | Enter your Zuper API key. [Learn how to generate it.](https://developers.zuper.co/reference/generate-api-key) |
6. Click **Update** to connect your Square app with Zuper.

> [!NOTE]
>
> Note: Ensure that the Zuper API key is linked to a dedicated account for smooth integration.
#### II. How the Zuper–Square Integration Works
Zuper integrates with Square to collect payments for **Jobs**, **Estimates**, and **Invoices**.
**Navigation**: Accounting → Quotations → Collect Deposit
Accounting → Invoices → Payment
**To collect a payment:**
1. Go to the **Quotes** module from the top-left menu.
2. Select the quote for which you want to collect a payment.
3. Click **Collect Deposit** → select **Credit/Debit Card**.

4. If the customer’s card is saved, you’ll see it listed. Otherwise, select **Add New Card**.

5. After entering new card details, the customer will be prompted to either:
* **Skip** (proceed to payment directly), or
* **Save and Pay** (save the card for future transactions).

> [!NOTE]
>
> Note: The same process applies when collecting payments for invoices.
With Square integrated, customers can securely pay and sign using the merchant’s mobile device, while merchants can process credit card payments effortlessly.
### C. Uninstalling the Integration
You can uninstall the integration from either **Zuper** or **Square**.
#### I. Uninstall Square from Zuper
1. Log in to your **Zuper account**.
2. Click your **Profile Picture** → select **App Store**.
3. Under **Accounting and Payments**, select **Square**.
4. Click **Deactivate**.

The Square integration will be deactivated successfully.
#### II. Uninstall Zuper from Square
1. Log in to your **Square account**.
2. Navigate to **Settings → App Integrations**.
3. Next to **Zuper**, click **Manage** to open the developer console: [https://developer.squareup.com/console/en/apps](https://developer.squareup.com/console/en/apps).
4. From the left menu, select **OAuth**.

5. Click **Replace Secret** to regenerate your **Application Secret**.

6. Return to **App Integrations**, click the **ellipsis (⋮)** icon next to Zuper, and select **Disconnect**.
Zuper will now be successfully disconnected from your Square account.
Once connected, the **Zuper–Square Integration** allows you to:
* Accept secure payments for estimates and invoices.
* Save customer cards for future use (with consent).
* Manage payments seamlessly from the Zuper mobile or web app.
# Xero
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/Xero
**Xero** is a cloud-based accounting software platform designed to help businesses manage invoicing, bank reconciliation, bookkeeping, and reporting.
The **Zuper–Xero Integration** is a **uni-directional** connection that pushes **estimates and invoices** from Zuper to Xero—streamlining financial operations between your service and accounting teams.
The following sections explain how to:
A. Connect Xero with Zuper\
B. Zuper–Xero Integration Works\
C. Uninstall Xero from Zuper
### **Pre-requisites**
Before you begin, ensure you have the following:
* **Zuper API Key**
* **Xero OAuth Access**
> When you click **Install** in the App Store, a permission screen will appear to authorize your Xero account. This process is known as **OAuth**.
### A. How to Connect Xero with Zuper
1. **Log in** to your Zuper account.
2. Click your **Profile Picture** (top-right corner) → select **App Store**.

3. Under **Browse by Category**, select **Accounting and Payments**, and choose **Xero**.

4. Click **Install Xero**.

> [!NOTE]
>
> Note: Keep both the Zuper and Xero tabs open for a smooth setup process.
5. A pop-up will appear. Review the data access permissions and click **Allow Access**.

6. Update **Xero Settings** by configuring the following fields:
| **Field** | **Description** |
| :-: | :-: |
| **Zuper API Key (Mandatory)** | Enter your Zuper API key. [Learn how to generate it.](#) |
| **Tenant Name (Mandatory)** | Enter the instance name of your Xero account (visible in the top-left corner). |
| **Estimate Sync (Mandatory)** | Select **Yes** or **No** to push quotations from Zuper to Xero. |
| **Invoice Sync (Mandatory)** | Select **Yes** or **No** to push invoices from Zuper to Xero. |
| **Use Zuper Estimate Number (Mandatory)** | Select **Yes** or **No** to use Zuper’s prefix quote number in Xero. |
| **Use Zuper Invoice Number (Mandatory)** | Select **Yes** or **No** to use Zuper’s prefix invoice number in Xero. |
| **Delete Cancelled Invoice/Estimate (Mandatory)** | Select **Yes** or **No** to automatically delete canceled invoices or quotes in Xero. |
| **Sync Tax Master (Mandatory)** | Select **Yes** or **No** to sync tax master data from Zuper to Xero. |
| **Line-Item Account Code (Mandatory)** | Enter the account code from Xero’s **Chart of Accounts** for product syncing. |
| **Payment Account Code (Mandatory)** | Enter the account code from Xero’s **Chart of Accounts** for payment syncing. |
> [!NOTE]
>
> Note: If the same account code is used for both product and payment, ensure the Enable Payments on this account checkbox is selected in Xero.

7. Click **Update** to complete the integration setup.
> [!NOTE]
>
> Important: Use a dedicated account with a valid Zuper API Key to ensure smooth synchronization between Zuper and Xero.
### B. How the Zuper–Xero Integration Works
Once connected, Zuper automatically pushes data from your **Estimates** and **Invoices** modules to Xero, based on your configuration.
#### 1. Estimate Sync
* When a **Quotation** is created in Zuper, it automatically syncs to Xero.
* Any changes or deletions in Zuper will be reflected in Xero based on integration settings.
**Example:**
* **Zuper:** New quotation created
* **Xero:** Quote reflected under the same customer account
#### 2. Invoice Sync (Partial Payment)
* A partially paid invoice in Zuper will appear in Xero as **Awaiting Payment**.
**Example:**
* **Zuper:** Invoice status = *Partially Paid*
* **Xero:** Invoice status = *Awaiting Payment*

#### 3. Invoice Sync (Full Payment)
* A fully paid invoice in Zuper will appear in Xero as **Paid**.
**Example:**
* **Zuper:** Invoice status = *Paid*
* **Xero:** Invoice status = *Paid*

#### 4. Cancelled Quotations
* When a quotation is cancelled in Zuper, it will automatically appear as **Deleted** in Xero.
**Example:**
* **Zuper:** Quote status = *Cancelled*
* **Xero:** Quote status = *Deleted*

#### 5. Declined Quotations
* Declined quotations in Zuper will reflect as **Declined** in Xero, maintaining consistency across both systems.

#### 6. Status Mapping Between Zuper and Xero
Field Equivalent Table- Quotation
| **Zuper Status** | **Xero Status** |
| :-: | :-: |
| Draft | Draft |
| Sent | Sent |
| Accepted | Approved |
| Declined | Declined |
| Converted | Converted |
Field Equivalent Table- Invoice
| **Zuper Status** | **Xero Status** |
| :-: | :-: |
| Draft | Draft |
| Sent | Awaiting Approval |
| Partially Paid | Awaiting Payment |
| Paid | Paid |
This mapping ensures real-time data consistency between both platforms.
### C. How to Uninstall Xero from Zuper
1. Log in to your **Zuper account**. Click your **Profile Picture** (top-right corner) → select **App Store**.

2. Under **Browse by Category**, select **Accounting and Payments**, then choose **Xero**. Click **Uninstall**.

3. The Xero integration will be successfully uninstalled from your account.

The **Zuper–Xero Integration** enables seamless data flow between your field service operations and accounting platform by:
* Automatically syncing estimates and invoices from Zuper to Xero.
* Maintaining real-time payment status updates.
* Reducing manual data entry and financial errors.
This integration simplifies your financial management workflow, allowing your back-office team to work more efficiently within Zuper.
## Frequently Asked Questions
> [accordion] Does the Xero integration automatically map product descriptions to product names or SKUs in Zuper's Quote/Invoice screen?
>
> No. Mapping product descriptions to product names or SKUs automatically via Xero is not supported. The integration does not perform this mapping, and descriptions will not auto-populate based on SKU changes made in the accounting system.
> [accordion] What does the integration sync, and in which direction?
>
> The Xero integration pushes Zuper records (such as invoices and customer data) to the accounting system. This is a **one-way sync** for most record types. Changes made in Xero do not automatically reflect back into Zuper's Parts & Services catalog or line item descriptions.
> [accordion] If I update a product SKU or name in Xero, will it update in Zuper automatically?
>
> No. SKU or product name changes made in Xero are not pushed back into Zuper. You will need to manually update the relevant items in Zuper's **Parts & Services** master list, or contact your onboarding team or support team for bulk update assistance.
> [accordion] Is the Description field on a Quote or Invoice line item editable in Zuper?
>
> Yes. The **Description field** on each line item in the Quote/Invoice screen remains fully editable within Zuper at the transaction level. The integration sync does not overwrite this field. You can manually update the description for each line item as needed directly on the quote or invoice.
> [accordion] What should I do if I need to update descriptions or SKUs across many products at once?
>
> For bulk updates to product names, SKUs, or descriptions in Zuper, contact [Zuper Support](mailto:support@zuper.co) or reach out to your onboarding team for assistance with a bulk import or catalog update.
> [accordion] Why did one invoice fail to sync to Xero while others synced successfully?
>
> When a single invoice does not reach Xero but others created at the same time do, the cause is usually the **linked customer record** rather than the invoice itself. Xero requires certain contact fields to be populated before it will accept the associated invoice.
>
> Check the customer record in Zuper under **Customers → \[Customer Name] → Edit** and confirm the following fields are populated:
>
> | Field | Requirement |
> | :- | :- |
> | \[FIELD LABEL — PENDING H3] | \[PENDING H1 CONFIRMATION] |
> | Email ID | \[PENDING H4 — precedence vs. above] |
>
> After updating the customer record, reinitiate the sync for the affected invoice. If the invoice still does not appear in Xero, reach out to [Zuper Support](mailto:support@zuper.co) with the invoice number and the customer record ID.
# Setup the integration
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/Zuper_QuickBooks_Desktop
QuickBooks Desktop integration helps us push data from Zuper, such as Customers, Parts and services, Quotes, Invoices, and Payments, to QuickBooks Desktop.
The records pushed from Zuper will be reflected in the web connector. and if you have enabled auto sync, the records will be synced automatically; if not, you should update them manually.
## Install QuickBooks Desktop
1. Once logged in to your Zuper account, open a new tab in your browser. Click on your Profile Picture at the top right corner of the screen and select the "**App Store**."

2. Under the "**Browse by Category**," select the "**Private Apps**" option and choose "**QuickBooks Desktop**."

3. Click on the "**Connect to QuickBooks**" button.

4. Update Zuper Settings by configuring the following fields:
a. Zuper API Key (**Mandatory**) – Refer to the steps below to create the Zuper API. To create the Zuper API, refer to the below steps:
> [accordion] API Key Creation
>
> If you are trying to integrate Zuper with any external systems, you will need an API key to access the Zuper APIs. To generate API (Application Programming Interface) Key, please follow the below steps.
>
> 1. Log in to Zuper with an admin account.
> 2. Scroll down the menu bar on the left and select the "**Settings**" icon key.
> 3. Under the "**General Settings**" category, select "**Account Settings.**"
>
> 
>
> 4. On the account settings page, select **"API Keys."**
>
> 
>
> 5. Click on "**New API Key**" and enter the name of the API key in the pop-up windows.
>
> 
>
> 6. Click on "**Create**" to generate the API key. (Once created, the API key can be viewed by clicking on the "**View API Key**" hyperlink.)
>
> 
>
> 5. To delete/deactivate an existing API, click on the "**Delete API Key**" (x) next to the respective API.
>
> 
>
> > [!NOTE]
> >
> > Note: The API key generated will provide full permission & access to the user who
> >
> > created this key. Please ensure to store this key securely.
> [!NOTE]
>
> **Note:** It is mandatory to enter the Zuper API Key for Integration to perform smoothly.
b. QuickBooks Desktop Data File Location (**Mandatory**) – Enter the exact QuickBooks Desktop Data file location. The data file should be taken from QuickBooks. In QuickBooks Desktop, Press **Fn+F2** to get the data file location.

c. QuickBooks Desktop Connector Username (**Mandatory**) - Enter the QuickBooks Desktop Connector Username.
d. QuickBooks Desktop Connector Password (**Mandatory**) - Enter the QuickBooks Desktop Connector Password.
e. Push Customers (**Mandatory**)- If you select the option "**Yes**," the customer will be pushed one way from Zuper to QuickBooks Desktop. If you choose "**Yes**," we will sync the creation from the master itself. If you choose "**No**," the customer will be created only while pushing an invoice, quote, or any other transaction.
f. Push Estimates (**Mandatory**)- If you select "**Yes**," estimates will be pushed one way from Zuper to QuickBooks Desktop. If you choose "**No**," Estimates items won't be pushed from Zuper to QuickBooks Desktop.
g. Push Services & Products (**Mandatory**)- If you select "**Yes**," services and products will be pushed one way from Zuper to QuickBooks Desktop. If you choose "**No**," services and products will be pushed when we push Invoice/Quote to the Quick Books Desktop.
h. Invoice Status to Trigger Push (**Mandatory**) - You must choose the invoice's status from the drop-down menu. Based on the invoice status selected here, the push will happen.
i. Estimate / Invoice ID (**Mandatory**) - If you select Zuper ID, Zuper Estimate / Invoice ID will appear on QuickBooks Desktop. If you select QuickBooks Desktop ID, whatever sequence you have in QuickBooks Desktop will be taken as an Invoice ID.
j. Identify the customer in Zuper-QuickBooks (**Mandatory**) - You must choose the applicable customer format displayed on QuickBooks Desktop.
k. Use QuickBooks as Tax Master (**Mandatory**) – Upon selecting "**Yes**," QuickBooks Desktop will be the primary source for tax-related information such as tax rates and codes. If "**No**" is selected, Zuper will be the primary source for tax.
l. Default QuickBooks Payment Account (**Mandatory**) - You must enter the default QuickBooks Payment chart of accounts for which the default account will be impacted.
m. Use Different Discount Accounts in QuickBooks (**Mandatory**)- If you select "**Yes**," the different discount accounts will be used in QuickBooks Desktop. The discount account is specified in the Discount Name. If you select "**No**," we will create a default discount account in QuickBooks Desktop. Select the "**Update**" button to connect QuickBooks Desktop with Zuper.

## Link QuickBooks Desktop with Zuper
1. Once you have completed the configuration settings in Zuper, as shown above, click the "**Install QuickBooks Desktop**" button. Once you have done the configuration settings in Zuper.
2. Zuper provides the option to Download the QWC authentication file. Click "**Download QWC File**."

3. Open QuickBooks web connector, click "**File**," and then "**Update Web Services**." You will see the following dialog box: Click "**Add an Application**."

4. You will then be asked to select whether you want to allow the application to read and modify this company file. Select "**Yes, always; allow access even if QuickBooks is not running**." Login as "**Admin** ." Click "**Continue**" to set up the web connector.

5. Open Web Connector and click the checkbox next to Zuper Pro at the far left of your screen. Click the "**Auto-Run**" checkbox.

6. Enter your Zuper Pro password and press "**Ok**." Then, it will ask if you want to save the password; select yes to save your web connector password.
When both progress bars reach 100%, we have successfully downloaded your data from QuickBooks Desktop. Next, we'll upload it to our servers and then put it into your account.
This process can take some time, depending on how much data you have. You must maintain a stable internet connection until this process is complete.

QuickBooks Desktop– Zuper integration is completed.
## Uninstall QuickBooks Desktop
1. Once logged in to your Zuper account, open a new tab in your browser. Click on your Profile Picture at the top right corner of the screen and select the "**App Store.**"

2. Under the "**Browse by Category**," select the "**Private Apps**" option and choose "**QuickBooks** **Desktop**."

3. Click the "**Disconnect from QuickBooks**" button.

3. QuickBooks Desktop App is uninstalled successfully.

Integrating QuickBooks Desktop with Zuper can enrich and enhance operations by ensuring seamless data transfer between your accounting software and field service management system.
## Frequently Asked Questions
> [accordion] Does the QuickBooks Desktop integration automatically map product descriptions to product names or SKUs in Zuper's Quote/Invoice screen?
>
> No. Mapping product descriptions to product names or SKUs automatically via QuickBooks Desktop is not supported. The integration does not perform this mapping, and descriptions will not auto-populate based on SKU changes made in the accounting system.
> [accordion] What does the integration sync, and in which direction?
>
> The QuickBooks Desktop integration pushes Zuper records (such as invoices and customer data) to the accounting system. This is a **one-way sync** for most record types. Changes made in QuickBooks Desktop do not automatically reflect back into Zuper's Parts & Services catalog or line item descriptions.
> [accordion] If I update a product SKU or name in QuickBooks Desktop, will it update in Zuper automatically?
>
> No. SKU or product name changes made in QuickBooks Desktop are not pushed back into Zuper. You will need to manually update the relevant items in Zuper's **Parts & Services** master list, or contact your onboarding team or support team for bulk update assistance.
> [accordion] Is the Description field on a Quote or Invoice line item editable in Zuper?
>
> Yes. The **Description field** on each line item in the Quote/Invoice screen remains fully editable within Zuper at the transaction level. The integration sync does not overwrite this field. You can manually update the description for each line item as needed directly on the quote or invoice.
> [accordion] What should I do if I need to update descriptions or SKUs across many products at once?
>
> For bulk updates to product names, SKUs, or descriptions in Zuper, contact [Zuper Support](mailto:support@zuper.co) or reach out to your onboarding team for assistance with a bulk import or catalog update.
> [accordion] What does the integration sync, and in which direction?
>
> The Zuper–QBO integration pushes records from Zuper (customers, products, estimates, invoices, and payments) to QuickBooks Online. This is a one-way sync for most record types. Invoice payment status syncs bidirectionally. Invoices or estimates created in QBO do not sync back into Zuper — all records must originate in Zuper to appear in both systems.
# Setup the integration
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/Zuper_QuickBooks_Online
Zuper is integrated with QuickBooks Online to make your accounting and inventory management go hand-in-hand with this seamless integration.
## Zuper - QuickBooks Online integration plans
* **Simple Start (US/Global) and Essentials (US) Plans**: Most integration features are available.
* **Features Requiring Higher Plans**:
* **Inventory Sync (bi-directional)**: Requires Plus or Advanced plan.
* **Class Tracking**: Requires Plus or Advanced plan.
* **Multicurrency Support**: Requires Essentials or higher (Essentials, Plus, or Advanced).
* **Custom Fields**:
* Depending on the plan, the number of custom fields that can be added to a transaction or synced from Zuper may vary.
## Before you get started
* You must have an active account with QuickBooks Online.
* You cannot connect multiple QuickBooks Online organizations to your Zuper account and vice versa.
* Ensure that the base currency of both these organizations is the same.
* Ensure that the Zuper account used for API key generation and the one used for syncing invoices with QuickBooks Online are separate.
> [!NOTE]
>
> **Note:** It is mandatory to enter the Zuper API Key for Integration to perform smoothly.
## Set up QuickBooks Online integration with Zuper
Integrating Zuper with QuickBooks Online is a simple and streamlined process.
* Log in to your Zuper account. Navigate to the App Store on the sidebar.

* Choose **Accounting & Payments** from the side menu. Select QuickBooks Online.

* Click "**Connect to QuickBooks Online**".

* You will be redirected to the QuickBooks Online sign-in page. Enter your credentials to proceed with the integration.

* Once you sign in to QuickBooks Online, select the organization you want to connect with inventory if you have multiple organizations. After choosing an organization, click **Next** to complete the integration.

## Zuper App Configuration
* Once you have connected with QuickBooks Online, you will be redirected to your Zuper account to configure the integration.
* You must configure the settings to sync the Zuper modules with QuickBooks Online.

* To create the Zuper API (**Mandatory**), refer to the section below:
> [accordion] API Key Creation
>
> If you are trying to integrate Zuper with any external systems, you will need an API key to access the Zuper APIs. To generate API (Application Programming Interface) Key, please follow the below steps.
>
> 1. Log in to Zuper with an admin account.
> 2. Scroll down the menu bar on the left and select the "**Settings**" icon key.
> 3. Under the "**General Settings**" category, select "**Account Settings.**"
>
> 
>
> 4. On the account settings page, select **"API Keys."**
>
> 
>
> 5. Click on "**New API Key**" and enter the name of the API key in the pop-up windows.
>
> 
>
> 6. Click on "**Create**" to generate the API key. (Once created, the API key can be viewed by clicking on the "**View API Key**" hyperlink.)
>
> 
>
> 5. To delete/deactivate an existing API, click on the "**Delete API Key**" (x) next to the respective API.
>
> 
>
> > [!NOTE]
> >
> > Note: The API key generated will provide full permission & access to the user who
> >
> > created this key. Please ensure to store this key securely.
> [!NOTE]
>
> **Note:** It is mandatory to enter the Zuper API Key for Integration to perform smoothly.
* Sync Customers (**Mandatory**) - If you select "**Yes**," whenever a new customer is created in Zuper, it will automatically synchronize with the QuickBooks Online customer module. If you choose "**No**," customer sync between Zuper and QuickBooks Online will not be executed.
* Sync Estimates (**Mandatory**) - If you select "**Yes**," whenever a new quote is created in Zuper, it will automatically synchronize with the QuickBooks Online estimate module. If you choose "**No**," a quote sync between Zuper and QuickBooks Online will not be executed.
* Sync Deposits to Customer - If you select "**Yes**," whenever a deposit is created in Zuper, it will automatically synchronize with the QuickBooks Online customer module. If you choose "**No**," the deposit will not be synced to the customer on QuickBooks Online.
* Sync Services and Products (**Mandatory**) - By selecting "**Yes**," inventory will synchronize two ways from Zuper to QuickBooks Online and vice versa. If "**No**" is selected, Zuper and QuickBooks Online do not synchronize inventory items.
> [!NOTE]
>
> **Note:** You need a QuickBooks Online "Essentials" plan and above
* Master Product System (**Mandatory**) - By selecting "**Zuper**," the master product system will be Zuper. If "**QuickBooks Online**" is selected, the master product is QuickBooks Online.
* Master Product Location- Enter the Master product location to which the inventory line is synced from Zuper to QuickBooks Online.
* Non-Inventory Product Quantity - Enter the non-inventory product quantity synced from Zuper to QuickBooks Online.
* Product Minimum Quantity - Enter the product minimum quantity of Zuper to which QuickBooks Online is synced.
* Invoice Status (**Mandatory**) - Upon selecting the status for the Invoice in Zuper, we trigger the sync to create a similar invoice in QuickBooks Online without any duplication. If the status is selected as "**All**" upon creating the Invoice in Zuper, sync will be triggered immediately, and the invoice will be made in QuickBooks Online.
* Default Tax Agency (In QuickBooks) - Copy and paste the "**Default tax Agency**" from QuickBooks Online, if available.
* Sync Failure Emails - A failed error message will be emailed to the given IDs upon sync.
* Default Payment Mode UID (**Mandatory**) - To sync with QuickBooks Online, enter the default Zuper payment mode UID.
* Auto Enable invoice payment methods - If you select "**Yes**," the invoice payment method created in Zuper will automatically sync with the QuickBooks Online invoice module. If you choose "**No**," the invoice sync between Zuper and QuickBooks Online will not be executed.
* Default Payment Mode UID (To get the "**Payment UID**," click "**CTRL+Shift+J**" and copy and paste the payment mode code).

* Estimate or Invoice ID (**Mandatory**)- After selecting the "**Zuper ID or QuickBooks Online ID**," This will be updated in QuickBooks online under the field name "**Estimate or Invoice No**."
* Identify Customers in Zuper-QuickBooks - When selecting the option below and syncing the invoice or estimate with QuickBooks Online, it checks and creates the invoice for the right customer.
| Zuper Fields | QuickBooks Online Fields |
| - | - |
| Customer Email | Customer Email |
| Customer Name | Customer Name |
| Billing Email | Customer Email |
| Billing Name | Customer Display Name |
| Organization Name | Customer Display Name |
* QuickBooks Plan (**Mandatory**) - The product type is allowed as "**Service**" only for the Essentials plan in QuickBooks Online. If not the Essentials plan, the product type can be "**Inventory or Non-Inventory**."
* Custom Field Mapping - The data flows from Zuper Custom fields to QuickBooks Online Custom fields from the invoice. The sync is limited to custom fields from the Invoice module.
The format of custom field mapping is:
**QuickBooksOnlineField1, ZuperField1; QuickBooksOnlineField2, ZuperField2.**
> [!NOTE]
>
> **Note:** QuickBooks Online supports only three custom fields; if we add more than three custom fields, the data sync will not occur.
* Display Name Format - From Zuper account for the invoices and estimates, the customer name sync to QuickBooks Online happens based on the dropdown options:
**First Name, Last Name (Default)**
**Last Name, First Name**
Based on the preference chosen, the name sync happens.
* Account Name to deposit Payments – Enter the account name to which the payment needs to be allocated. The payment amount will be recorded in the chosen account, ensuring accurate financial tracking and allocation.
* For example, if the deposit payment is for rent, you might enter "**Rent Expense account**" in this field to ensure the payment amount is recorded under the Rent Expense account in QuickBooks Online.
* Delete action in Zuper to Void in QuickBooks – Upon selecting "**Yes**," whenever any invoice is deleted in Zuper, it will also be voided in QuickBooks Online. If "**No**" is selected, deleting an invoice in Zuper will only remove it from Zuper, leaving the corresponding invoice unaffected in QuickBooks Online.
* Invoice Cancel in Zuper to Void in QuickBooks – If you select "**Yes**," the invoice voided in Zuper will be invalid in QuickBooks Online. If you select "**No**," the invoice voided in Zuper will not be invalid in QuickBooks Online.
* Use QuickBooks as Tax Master – Upon selecting "**Yes**," QuickBooks Online will be the primary source for tax-related information, such as tax rates and codes. If "**No**" is selected, Zuper will be the primary source for Tax.
If QuickBooks Online is chosen as the primary tax source, ensure that tax configurations in Zuper align with those specified in QuickBooks Online.
* Push Email Field for Customer in QuickBooks – Enter the Zuper customers' email to sync with them on QuickBooks Online.
* Use Different Discount Accounts in QuickBooks – If "**Yes**," the different discount accounts will be used in QuickBooks Online; the discount account is specified in the Discount Name. If "**No**" is selected, the default discount account will be used in QuickBooks Online.
* Class Tracking - Enabling Class Tracking for Invoices, Quotes, and Products in QuickBooks Online.
In our App Settings, we allow "**Item Level**" or "**Invoice Level**" class tracking
* If it is set as "**Invoice Level**", we look for the custom field '**QuickBooks Online Class**', if a value is found, we sync that to QuickBooks Online as part of the invoice sync
* If it is set as "**Item Level**", then we iterate through each line item in the invoice & each item's custom field "**QuickBooks Online Class**" and use that for itemitem-level level class sync with QuickBooks Online.
**QuickBooks Sync**
**Sync Line Items As** - Choose how line items from Zuper invoices or estimates are synced to QuickBooks Online:
* **Summarized Line Items**: : Syncs each product line item individually. With this option, bundles are not split into components and may fail to sync if not already present in QuickBooks Online.
* **Bundle as components**: Roll-up bundles sync to QuickBooks Online as their individual component Products/Services, preserving each component’s quantity, price, discount, and tax as defined by the bundle. Non-bundle items continue syncing using the standard/default behavior.
> [!NOTE]
>
> **Note**: This applies only to roll-up bundles. Because the QuickBooks Online API does not support creating bundles, bundles are exported by syncing their components instead.

**Zuper:**

**QuickBooks:**

**Payment Sync Direction** - Configure the direction of payment synchronization between Zuper and QuickBooks Online:
* **Both Ways**: Payments sync bidirectionally.
* **Zuper to QuickBooks Online**: Syncs payments only from Zuper to QuickBooks Online.
* **QuickBooks Online to Zuper**: Syncs payments only from QuickBooks Online to Zuper.
* **No Sync**: Disables payment synchronization.

**Estimate Status to Trigger Sync (Mandatory)** - Select the status of the Quote in Zuper that will trigger the sync to QuickBooks Online. Options include:
* **All**: : Sync is triggered for any new estimate created in Zuper in the "**Draft**" status.
* **Sent**: Sync is triggered only when the estimate status changes to "**Sent**."
* **Accepted**: Sync is triggered only when the estimate status changes to "**Accepted**".

Sync Deposits to Customer - If you select “**Yes**,” whenever a deposit is created in Zuper, it will automatically synchronize with the QuickBooks Online customer module. If you choose “**No**,” the deposit will not be synced to the customer on QuickBooks Online.
> [!NOTE]
>
> **Note**: This setting is independent of the Estimate Status to Trigger Sync setting and operates separately for deposit synchronization.
***
## QuickBooks Online **Field mapping**
**Module - Invoices**
| **Zuper Field** | **QuickBooks Online Field** | **Notes** |
| - | - | - |
| Prefix | Doc No. | Prefix and Invoice No. are joined to create Doc No. (when ID preference is Zuper) |
| Invoice No. | Doc No. | |
| Reference No. | Doc No. | When ID preference is set to QuickBooks Online. Doc No. syncs from QuickBooks Online to Zuper Reference No. |
| Invoice Date | Transaction Date | |
| Payment Term | Sales Term | |
| Invoice Due Date | Due Date | |
| Invoice Template | NA | |
| Invoice Tags | NA | |
| Invoice Description | NA | |
| Invoice Total | Total Amount | |
| Invoice Remarks | Customer Memo | “Note to Customer” in the UI |
| Invoice CC Email | Secondary Contacts Email (From Job) | The associated jobs' secondary contact emails are synced to the CC fields in the invoice. |
| Billing Address | Billing Address | |
| Service Address | Shipping Address | |
| Notes | Private Note | “Memo on Statement” in the UI |
**Module – Products**
*Inventory to Product*
| QuickBooks Online **Field** | **Zuper Field** | **Notes** |
| :- | :- | :- |
| Name | Product Name | |
| SKU | Product No. | |
| Product Image | Product Image | |
| Category | Product Category | |
| Initial Quantity on hand | Available Quantity | |
| As of date | NA | |
| Reorder Point | Min. Quantity | |
| Description | Description | |
| Sales Price/Rate | Unit Selling Price | |
| Income Account | Custom Field | |
| Sales Tax | NA | Info not directly available in API |
| Purchasing Information | | |
| Cost | | |
| Expense Account | Custom Field | |
| Asset Account | Custom Field | |
| Preferred vendor | | |
| NA | Minimum Quantity | Configured Value |
| NA | Location | Configured Location |
*Non-Inventory to Part*
| QuickBooks Online**Field** | **Zuper Field** | **Notes** |
| :- | :- | :- |
| Name | Part Name | |
| SKU | Part No. | |
| Category | Product Category | |
| Description | Description | |
| Sales Price/Rate | Unit Selling Price | |
| Income Account | Custom Field | |
| Sales Tax | NA | Info not directly available in API |
| Purchasing Information | | |
| NA | Available Quantity | Configured Value |
| NA | Minimum Quantity | Configured Value |
| NA | Location | Configured Location |
*Service to Service*: \
| QuickBooks Online **Field** | **Zuper Field** | **Notes** |
| :- | :- | :- |
| Name | Service Name | |
| SKU | Service No. | |
| Category | Category | |
| Description | Description | |
| Sales Price/Rate | Unit Selling price | |
| Income Account | Custom Field | |
| Sales Tax | NA | Info not directly available in API |
| Purchasing information | NA | |
**Module - Customer**
| **Zuper Field** | QuickBooks Online **Field** | **Notes** |
| - | - | - |
| First Name | First, Last, Display Name | Combined to create Display Name |
| Last Name | | |
| Organization | NA | Not synced to QuickBooks Online "**Company**" |
| Email | Email | |
| Category | NA | |
| Billing Street | Street Address 1 | |
| Billing City | City | |
| Billing State | State | Mapped using SubdivisionCode |
| Billing Country | Country | |
| Billing Zip Code | Zip Code | |
| Mobile Number | Mobile Number | If the Mobile Number is empty in Zuper, it will be empty in QBO. |
| Home / Work Number | Primary Phone Number | The priority order is Home > Work. |
| Description | Notes | |
| Service Address | Shipping Address | |
| Tags | NA | |
| SLA | NA | |
| Accessible to Everyone | NA | |
| Preferred Time Zone | NA | |
**Module - Vendor Management**
| **Zuper Field** | **QuickBooks Online Field** | **Notes** |
| - | - | - |
| NA | Vendor Currency | Mandatory for Vendor Creation when multicurrency is turned on |
| Vendor Name | Company Name | Changed from Company Name. Backend Key is changed |
| Vendor Display Name | Display Name | Auto Populated by QuickBooks. Mandatory field for Vendor Creation. |
| Vendor Contact Name | First Name, Last Name | |
| Name to print on checks | Auto-populated | |
| Vendor Description/Plaintext Description | NA | |
| Street Address | Street Address | |
| Landmark | NA | |
| City | City | |
| State/Province | State | |
| Country | Country | |
| Zip Code | Zip Code | |
| Latitude and Longitude | NA | |
| Contact First Name | NA | |
| Contact Last Name | NA | |
| Phone Number | Phone Number | |
| Email Address | Email | |
| Default Delivery Method | NA | |
| Additional Email Recipients | NA | |
| Default Tax Rate | | |
| Vendor Payment Terms | Payment - Terms | “Terms” field under payment section. |
| Bank Name | | |
| Bank A/C no. | Bank Account Number | |
| NA | Routing Number | |
| Opening Balance | | |
| Default Expense Category | | |
| Billing Rate (per hr) | | |
| Business ID no./SSN | NA | |
| Custom Fields | | |
## **Class-Tracking in QuickBooks Online(QuickBooks Online plus or advanced)**
In QuickBooks Online, classes can be used to track transactions and group them according to different classifications, such as business units within a company or by product lines.
Classes appear are tracked at the invoice level when the class assignment is chosen as “**one to each transaction**”. When the assignment is chosen as “**one to each row in transaction**,” the class is tracked at the line item level.

The choice made for the class assignment should also be selected in the Zuper QuickBooks Online app configuration.

To track classes when syncing from Zuper to QuickBooks Online, a custom field called “**QuickBooks Online Class**” must be created in the invoice or products records, depending on the configuration. The field must be configured with the values of available classes in QuickBooks Online.
When used in the transaction, the field's value must be set to the class for that record.
When synced to QuickBooks Online, these transactions will appear in the respective Class report.

\
**Account tracking:**
We work with two types of accounts in GL - Income Account & Expense Account
* Businesses can set an Account on the item level. By default, we map it to '**Sales of Product Income**' for the Income account and "**Cost of Goods Sold**" for the Expense Account
* But if they would like to override, we can set up a custom field called '**QuickBooks Online Income Account**' and '**QuickBooks Onlin**e **Expense Account** ' on the item level to override the above default account while syncing to QuickBooks Online.
When creating a new invoice or quote or product in QuickBooks Online, we can assign it a class while syncing it from Zuper to accurately track and categorize financial transactions.
1. In the QuickBooks Online configuration screen, based on what you've specified in QuickBooks Online, select whether class tracking is to be done and if it is to be done for the entire transaction or each line item in the transaction.
2. Go to Settings > Custom Fields & Checklist Settings > Invoice Fields, Product Fields, Part Fields, streamlined and straightforward or Quotation Fields.
3. Create a custom field with the label "**QuickBooks Online Class**."
4. While creating the invoice, ensure that the value for the custom field is present.
## QuickBooks Online Account Configure
* Sign in to the QuickBooks Online account and click the link below based on the signed-in account. Then click the "**Switch Now**" button.
* [QuickBooks Online Live Account ](https://app.qbo.intuit.com/app/categorymigration)
* [QuickBooks Online Staging Account](https://sandbox.qbo.intuit.com/app/categorymigration)

* Go to Accounting -> Chart of Accounts and make the following changes to the below 3 accounts:
| Name | Account Type | |
| - | - | - |
| Inventory Asset | Account Type: Other Current Details | Details Type: Inventory |
| Cost of Goods Sold | Account Type: Cost of Goods Sold | Details Type: Supplies and Materials - COGS |
| Sales of Product Name | Account Type: Income | Details Type: Sale of Product Income |
| | | |
### Pushing Customers to QuickBooks Online
With the Zuper-QuickBooks Online integration, you can sync Customer master data from Zuper to QuickBooks. You can control this through a setting that is available in the configuration.
The customer records can be created or updated in QuickBooks Online based on changes in Zuper. If the Zuper customer is present in QuickBooks Online, then they are identified using:
* Customer QuickBooks ID.
* Email ID.
* Customer Name. (First Name Last Name)
Similarly, if the organization is present in QuickBooks Online, then they are identified using:
* Org QuickBooks ID
* Org name
The billing contact of QuickBooks Online is identified using: For billing contact
* Billing name
* Billing email
If the customer, organization, or billing contact is absent in QuickBooks Online, it will be created during the sync. This can be configured using the below setting:

The various mapping details:
* The **Customer Description** mapped as **Customer Notes** in Zuper.
* The **Customer's** Address is mapped as a **Billing Address** in Zuper.
> [!NOTE]
>
> **Alert:** The Customer ID created in QuickBooks Online is stored as a Custom field in Zuper. To maintain the sync, it is important not to delete or override this field.
### Push Products and Services to QuickBooks Online
* Depending on the configuration for Products Master, products and services are synced from Zuper to QuickBooks Online and vice versa.
* If the QuickBooks Online product is present in Zuper, the validation is done based on the following criteria: a. Product QuickBooks ID. b. Product Name.
> [!NOTE]
>
> **Note:** Based on the validation – The system will return a specific product or service if a product ID is given; another wise list of products or services will be returned if we search using the product name.
Notes for Inventory sync
* Products and Parts of Zuper are captured as Inventory in QuickBooks Online. (Track Quantity means inventory).
* Service is captured as Service in QuickBooks Online (If the track quantity is not present, this is captured as non-Inventory).
* Before a product or part or service is created in Quickbooks Online, the category must be in QuickBooks Online. Once identified, the item will be created.
**Mapping Details**:
For all the products, a chart of account details is needed. a. Income account reference
b. Inventory Asset account reference
c. Expense account reference.
* Inventory Start Date – Company created date or Current day –1 (if company date is absent).
* Description – Product Description.
* Purchase Cost – Unit Selling Price.
* SKU – Unique ID identifying the product.
> [!NOTE]
>
> Note: The product type allowed in QuickBooks Online is "**Service**" only for the Essentials plan. Other than the Essentials plan, the product type can be "**Inventory or Non-Inventory**."
Based on Zuper's tax information, the tax masters should be created in QuickBooks Online, and then the tax mapping will happen with the tax ID and name. The created Product ID in QuickBooks Online is stored as Custom fields in Zuper. Refer to this article to enable bidirectional inventory sync.
### Push Quotes to QuickBooks Online:
With the Zuper-QuickBooks Online integration, you can sync quotes from Zuper to Quickbooks Online. You can control this through a setting in the configuration.
* The data push will happen from QuickBooks Online to Zuper.
* If the Estimate settings are enabled in the integration settings, we will fetch the Estimate UID.
* If the QuickBooks Online Estimate is present in Zuper, the validation is done based on the following criteria:
* List of matching criteria is listed
> [!NOTE]
>
> **Note:** Based on the validation, The QuickBooks Online Estimate ID is back verified in Zuper if the ID is not present, and a new Estimate ID is created in Zuper.
**Notes for Quotes Sync:**
* The billing address in Zuper is captured as a Customer Address in QuickBooks Online.
* Service and Billing customers of Zuper are considered Billing customers in QuickBooks Online only.
* If the customer already exists, then the customer will have a QuickBooks Online ID; if not, a new customer will be created in QuickBooks Online based on the billing address of the Zuper details.
**Line-Item Details:**
The service charge varies based on the estimate for installation or repair, so these situations are not captured as master line items. For custom line items, the amount is captured dynamically.
* Estimate's expiration date – QuickBooks Online's expiry date
* Notes - QuickBooks Online's Customer Memo
* Await Payment – Email sent (Payment collection pending)
* Customer, Customer ID – Verify that if a new customer is absent, the customer ID will be created in Zuper.
* The status names will be synchronized from Zuper to QuickBooks Online (This transaction status verification is to be done).
* US tax rule – The tax rule structure is to be followed; for the rest of the world, different taxes are calculated straightforwardly.
* The Quote number in Zuper is captured as a document number in QuickBooks Online.
The created estimate ID in QuickBooks Online is stored as a custom field in Zuper.
### Push Invoices to QuickBooks Online
Zuper-QuickBooks Online integration syncs invoices. You automatically synchronize Invoices according to the pre-defined settings and quote conversion. You can take three significant actions: Invoice Create Sync, Invoice Update Sync, Invoice Payment Sync, and Invoice Note Addition Sync.
* The data push will happen from QuickBooks Online to Zuper.
* We will fetch the invoice if the invoice settings are enabled in the integration settings.
* If the QuickBooks Online Estimate is present in Zuper, the validation is done based on the following criteria:
* List of matching criteria listed in Zuper.
> [!NOTE]
>
> **Note:** Based on the validation – The QuickBooks Online Invoice ID is back verified in Zuper if the ID is not present, and a new Invoice ID is created in Zuper.
The various preliminary details:
* Customer Address in QuickBooks Online is captured as a Billing address in Zuper.
* Service and Billing customers of Zuper are considered Billing customers in QuickBooks Online only.
* If the customer already exists, then the customer will have a QuickBooks Online ID; if not, a new customer will be created in QuickBooks Online based on the billing address of the Zuper details.
Line-Item Details:
The service charge varies based on the installation or repair invoice, so these situations are not captured as master line items. For dynamic custom line items – the amount is captured dynamically.
* Invoice's due date – QuickBooks Online's due date
* Remarks - QuickBooks Online's Customer Memo
* Customer, Customer ID – Verify that if not present, a new Customer customer ID is to be created in Zuper.
* Await Payment – Email sent (Payment collection pending)
* The status names will be synchronized from Zuper to QuickBooks Online (This transaction status verification is to be done).
* US tax rule – The tax rule structure is to be followed; for the rest of the world, different taxes are calculated straightforwardly.
* Item Description of Zuper is captured as a Sale Item Line Item in QuickBooks Online.
> [!NOTE]
>
> **Note:** If the contract includes an Invoice, the contract details will be synchronized as line items in QuickBooks Online.
The discount details and subtotal are captured as line items in QuickBooks Online.
* You can convert an estimate into an invoice or create an invoice directly in both Zuper and QuickBooks Online. The converted estimate is captured as a linked transaction.
* Private Note – This is visible to a few users based on the settings.
* Job – Invoice creation – This is done based on the Job's prefix.
* For the existing invoice sync – An update operation will happen if the new invoice creation means a new invoice is created.
* The full payment done in Zuper gets synchronized with QuickBooks Online as the total invoice payment, along with the mode of payment.
* The partial payment made in Zuper is recorded in QuickBooks Online. The invoice ID created in QuickBooks Online is stored as a Custom field in Zuper.
### **Push Vendors to QuickBooks Online**
Zuper–QuickBooks Online integration syncs Vendor master records and related Purchase Orders (POs). You automatically synchronize Vendors according to the pre-defined settings. You can take significant actions: Vendor Create Sync, Vendor Update Sync, Vendor Status Sync (Active/Inactive), Vendor Attachment Sync (active vendors only).
The data push will happen from Zuper to QuickBooks Online.
We will push the vendor if the vendor settings are enabled in the integration settings. The options available are Yes or No.
If the QuickBooks Online Vendor is present in Zuper, the validation is done based on the following criteria:
* Match the stored QuickBooks Online Vendor ID in Zuper.
* If no ID is present, match by the QuickBooks Online unique Display Name.
* If no match is found, a new Vendor will be created in QuickBooks Online.
> [!NOTE]
>
> **Note**: Based on the validation – The QuickBooks Online Vendor ID is back verified in Zuper; if the ID is not present, the new Vendor ID from QuickBooks Online is stored in Zuper for future updates.


The various preliminary details:
* Zuper is the master system; this is a one-way sync. Changes made directly in QuickBooks Online do not flow back to Zuper.
* When the configuration is set to Yes, new Vendors created in Zuper are pushed to QuickBooks Online immediately. When set to Yes during PO sync, the Vendor is created in QuickBooks Online at the time the first PO is synced.
* Editing a Vendor record in Zuper will sync the changes to QuickBooks Online.
* Handling Vendor Status:
* Marking a Vendor Inactive in Zuper marks the Vendor Inactive in QuickBooks Online (shown as deleted).  
* Marking a Vendor Active in Zuper reactivates the Vendor in QuickBooks Online.
* While a Vendor is Inactive in Zuper, edits and attachments are allowed in Zuper, but QuickBooks Online does not accept updates/attachments for inactive Vendors. Once the Vendor is marked Active again, the latest Vendor details are synced; attachments added while inactive are not synced.
* Attachments:
* Vendor attachments added while the Vendor is Active in Zuper are synced one-way to QuickBooks Online.
* The maximum file size for attachments in QuickBooks Online is 20 MB.


* Multicurrency:
* If multicurrency is enabled in QuickBooks Online, a Vendor Currency custom field must be added to the Vendor module in Zuper and populated for each Vendor. This currency is mandatory for creating vendors in QuickBooks Online.
* Vendor custom fields in Zuper are not synced to QuickBooks Online.
* QuickBooks Online requires a unique Display Name for each Vendor.
* Vendor email is pulled from the vendor record in Zuper and carried over to QBO.
### **Push purchase orders to QuickBooks Online**
Purchase order (PO) sync lets you send purchase orders created in Zuper directly to QuickBooks Online (QBO). When a PO is created or updated in Zuper, those changes flow to QBO automatically, so your procurement records stay consistent across both systems without manual re-entry.
Status updates that reach a terminal state in QBO such as Closed flow back to Zuper, keeping both systems aligned throughout the order lifecycle.
> [!NOTE]
>
> **Note:** Deleting a PO in Zuper does not delete or void it in QBO. Deletions are excluded from sync.
**Before you enable PO sync**
Complete these steps in QBO before turning on PO sync in Zuper.
1. Confirm your QBO account is on the Plus or Advanced plan. PO sync requires inventory tracking, which is available only on these plans.
2. In QBO, go to Settings, then select Account and Settings.
3. Select Expenses.
4. Under Purchase orders, turn on Show Items table on expense and purchase forms. This setting is required for line items from Zuper POs to appear on QBO POs.

5. If you plan to map custom fields, enable custom fields for purchase orders in QBO. A maximum of three custom fields can be mapped across invoices, estimates, and purchase orders combined.
### Enable PO sync in Zuper
Once your QBO account is ready, configure PO sync in Zuper.
1. Go to Settings, then select Integrations.
2. Select QuickBooks Online.
3. In the Zuper App Configuration panel, locate Sync Purchase Orders.
4. Select Yes to turn on PO sync.
5. Locate Purchase Order Status to Trigger Sync.
6. Select the PO status at which Zuper should send the PO to QBO. The available options are: • Submitted • Approved • Sent to Vendor • Vendor Accepted
7. Select Save to apply the configuration.

> [!NOTE]
>
> **Note**: Once you save, any PO that reaches the selected trigger status and statuses after it will sync to QBO automatically. POs created before you enabled sync will not sync retroactively.
### How vendors sync
When a PO syncs to QBO, Zuper checks whether the associated vendor already exists in QBO.
* If the vendor exists in QBO, Zuper links the vendor to the PO automatically.
* If the vendor does not exist in QBO, Zuper creates the vendor in QBO first, then links them to the PO.
### What syncs from Zuper to QBO
**PO fields**
The table below shows how PO fields in Zuper map to fields in QBO.
| **Zuper field** | **QBO field** |
| :- | :- |
| PO number | PO number |
| Vendor | Vendor |
| Vendor email | Email |
| Required by date | Due date |
| Order date | Purchase order date |
| Delivery address | Shipping address |
| Billing address | Mailing address |
| Remarks | Your message to vendor |
| Status | PO status |
> [!NOTE]
>
> **Note**: The PO title, payment term, and template fields in Zuper do not map to QBO fields. Job, project, asset, and material request associations are also not synced.
**Line items**
Line items added from a vendor's product catalog in Zuper sync to QBO as product line items.
| **Zuper field** | **QBO field** |
| :- | :- |
| Item name | Product/Service name |
| Part number | SKU |
| Unit purchase cost | Rate |
| Required quantity | Quantity |
| Total | Amount |
| Remarks | Description |
| Option or variant | Description |
| Vendor SKU | Description |
Custom line items added to a PO in Zuper are created in the QBO product master and then associated with the PO.
> [!NOTE]
>
> **Note**: Variant information is included in the QBO Description field. It does not sync to a dedicated line item field in QBO.
### Notes and attachments
Notes and files attached to a PO in Zuper sync to the corresponding PO in QBO — notes as internal memo content and files as attachments
> [!NOTE]
>
> **Note**: If you remove an attachment from a PO in Zuper after it has synced, that removal does not delete the attachment from QBO. Attachment deletions are excluded from sync.
### Custom fields
Custom field mapping follows the same configuration used for Zuper invoice and estimate sync to QBO. If you have already mapped custom fields for invoices or estimates, those mappings apply to POs as well — provided the custom fields are enabled for purchase forms in QBO.
A maximum of three custom fields can be mapped in total across invoices, estimates, and purchase orders.
After a successful sync, Zuper updates two custom fields on the PO record —QBO PO Number and QBO Purchase Order ID — with the corresponding values from QBO. You can use these fields to cross-reference the record in either system.
### Checking sync status
Once a PO syncs to QBO, you can verify the result under Sync History in Zuper. The page shows a success message for the PO sync. It also displays the sync status for each line item inside the PO, so you can confirm that all items transferred correctly.
### Purchase order status mapping
Zuper and QBO use different status labels for purchase orders. The table below shows how statuses correspond between the two systems.
| **Zuper status** | **QBO PO state** |
| :- | :- |
| Draft | Open |
| Submitted | Open |
| Approved | Open |
| Rejected | Closed |
| Sent to vendor | Open |
| Vendor accepted | Open |
| Vendor rejected | Closed |
| Partially fulfilled | Open |
| Fulfilled | Closed |
| Closed | Closed |
| Cancelled | Closed |
When a bill is created in QBO for a given PO, the PO status in Zuper automatically updates to Closed.
### What purchase order data does not sync
Not all purchase order data flows to QuickBooks Online. The following are excluded from the integration:
* **PO deletions** — Deleting a PO in Zuper does not remove it from QuickBooks Online.
* **Attachment removals** — Removing a file in Zuper does not remove it from QuickBooks Online.
* **Job, project, asset, and material request associations** — Links to these records are not included in the sync.
* **Variant details** — Variant information does not appear in a dedicated line item field in QuickBooks Online. It appears in the **Description** field only.
### Chart of Accounts in QuickBooks Online
In QuickBooks Online, the chart of accounts needs to be set up for Accounting and tracking financial transactions. The major type of accounts are:
* Balance Sheet Accounts
* Profit and Loss Accounts
Balance Sheet Account statements provide a snapshot of the company’s financial health at a given point in time.
Profit and Loss Account statements provide a view into the performance of a company over a period of time.
**AR and AP:**
AR (Accounts Receivable) and AP (Accounts Payable) are Accounting components that track money owed to and by the business respectively. They don’t hold actual cash but are balance accounts that track money that is owed.
*AR workflow:*
* Invoice a customer - increases AR account balance by the invoice amount.
* Receive Payment (partially or in full). - decreases AR account balance by the payment amount
* Deposit the payment to a bank account.
* AR accounts are Asset accounts.
*AP workflow:*
* Enter a Bill from a vendor - increases AP account balance by the Bill amount.
* Pay Bill (fully or partially). - decreases AP account balance by the payment amount.
* Payment is recorded from the chosen account (bank, credit card, etc.).
* AP accounts are Liability accounts.
| **QuickBooks Online Feature** | **AR (Accounts Receivable)** | **AP (Accounts Payable)** |
| :- | :- | :- |
| **Chart of Accounts** | Uses the Accounts Receivable (asset) account | Uses the Accounts Payable (liability) account |
| **Transactions** | Invoice, Receive Payment, Sales Receipt | Bill, Pay Bills, Expense |
## Updating newly created Income or Expense Accounts in Product Custom Fields
When creating new income or expense accounts in QuickBooks Online for accurate tracking and categorizing financial transactions, it's essential to ensure seamless integration and data consistency between Zuper and QuickBooks Online. Follow these steps to add the newly created account name in the Product Custom Fields.
1. Go to Settings -> Custom Fields & Checklist Settings -> Product or Part Fields. The Product Custom Fields page opens.
2. In the QuickBooks Online Income Account field, add the names of the newly created income accounts as values.
3. In the QuickBooks Online Expense Account field, add the names of the newly created expense accounts as values.
Adding the account names in the Product Custom Fields enables easy selection of specified accounts while creating products and services. This ensures that products or services are correctly linked to QuickBooks' online appropriate income or expense accounts, facilitating accurate financial tracking and categorization.
## Updating newly created invoice custom fields
When creating a new Invoice in QuickBooks Online, it's essential to ensure seamless integration and data consistency between Zuper and QuickBooks Online to track and categorize financial transactions accurately.
Follow these steps to add the newly created invoice to the Product Custom Fields.
1. Go to Settings -> Custom Fields & Checklist Settings -> Invoice Fields. The Product Custom Fields page opens.
2. In the QuickBooks Online Invoice field, add the newly created invoice date names as values.
3. In the QuickBooks Online Invoice field, add the names of the newly created due dates as values.
Adding the invoice date and due date in the Invoice Custom Fields enables easy selection of specified accounts while creating Invoices. This ensures that Invoices are correctly linked to QuickBooks online.
## Credits and Refunds
Zuper’s revamped credits and refunds feature allows you to manage customer credits, process refunds (full or partial), and void payments efficiently. These actions sync seamlessly with QuickBooks Online, ensuring accurate financial records. Credits can be applied to invoices, stored as credit memos, or refunded via the original payment method, depending on the transaction type (Zuper Pay or non-Zuper Pay, online or offline).
**Creating a Credit Memo**
Credit memos in the Zuper store credit against a customer, which can later be applied to invoices. These can be done either directly in the customer module or while refunding a payment in a transaction.
1. **Log in to Zuper**: Navigate to the Invoice or Payments module.
2. **Select Customer**: Choose the customer you want to create a credit with.
3. **Create Credit Memo**:
* Click **New Credit Memo** or equivalent.
* Enter the credit amount and add a memo/note (e.g., reason for credit, such as overpayment or service issue).
* A default line item of type "SubTotal" with the credit amount is automatically added (required for QuickBooks Online API).
* Save the credit memo. It will sync to QuickBooks Online as a credit memo linked to the customer.
4. Verify in QuickBooks Online:
* In QuickBooks Online, go to **Sales** > **Customers** to confirm the credit memo is listed under the customer’s account.
* Note: If a credit memo is deleted in Zuper, it will also be deleted in QuickBooks Online.
**Applying Credits to an Invoice**
When a customer has an active credit memo, you can apply it to a new or existing invoice.
1. **Create or Select an Invoice**:
* Navigate to the **Billing** module and create a new invoice or select an existing one for the customer.
2. **Apply Credit**:
* Choose **Record Payment** or **Apply Credit**.
* Select the credit memo and specify a custom amount (up to the total credit available).
* Save the action. The invoice status updates to **Partially Paid** or **Paid** in Zuper.
3. **Sync with QuickBooks Online**:
* The applied credit is recorded as a payment in Zuper and synced as a payment in QuickBooks Online against the invoice.
* The applied amount reduces the customer’s credit balance in QuickBooks Online.
4. **Verify in QuickBooks Online**:
* In QuickBooks Online, go to **Sales** > **Customers** or **Transactions** > **Payments** to confirm the payment and updated invoice status.
**Processing Refunds**
Refunds can be issued for full or partial payment amounts, depending on the transaction type (Zuper Pay or non-Zuper Pay, online or offline). Refunds are stored as credit memos or returned to the original payment method.
**Zuper Pay Transactions**
* **Offline Transactions**:
1. Navigate to the **Billing** or **Payments** section in Zuper.
2. Select the customer and the payment to refund.
3. Choose **Refund** and specify the amount (full or partial).
4. Select whether to store the refund as a credit memo or return it to the original payment method.
5. Save the refund. The payment in Zuper has been updated, and the invoice status has changed to **Partially Paid** or **Sent**.
6. **Sync with QuickBooks Online**:
* The payment in QuickBooks Online is cleared (set to 0) for full refunds or modified for partial refunds.
* If stored as a credit memo, the customer's corresponding credit is added in QuickBooks Online.
* **Online Transactions**:
1. Follow the same steps as offline transactions, but the refund must be manually added as a credit memo in Zuper.
2. The refund is processed and synced to QuickBooks Online as described above.
**Non-Zuper Pay Transactions**
* **Offline and Online Transactions**:
1. Navigate to the **Billing** or **Payments** section.
2. Select the payment to refund and choose **Refund**.
3. Specify the amount (full or partial) and store it as a credit memo.
4. Save the refund. The invoice status updates to **Partially Paid** or **Sent**.
5. **Sync with QuickBooks Online**:
* The payment in QuickBooks Online is cleared (full refund) or modified (partial refund).
* A credit memo is added to the customer’s account in QuickBooks Online.
**Notes**
* Refund receipts are not created in QuickBooks Online as part of this process.
* Deposits collected against quotes in Zuper cannot be refunded.
**Voiding Payments**
Voiding a payment cancels the entire payment amount and does not automatically create a credit memo.
1. **Void a Payment in Zuper**:
* Navigate to the **Billing** or **Payments** section.
* Select the payment and choose **Void**.
* Confirm the action. The payment is voided, and the invoice status changes to **Partially Paid** or **Sent**.
2. **Sync with QuickBooks Online**:
* The corresponding payment in QuickBooks Online is voided.
* Note: Voiding does not automatically add credits to the customer in Zuper or QuickBooks Online. Credits must be manually added if needed.
3. **Verify in** **QuickBooks Online:**
* In QuickBooks Online, go to **Transactions** > **Payments** to confirm the payment is voided.
* For non-Zuper Pay transactions, voiding a payment acts as a refund but does not offer a "**refund**" option.
**Notes**
* Zuper does not allow voiding or canceling invoices with active payments, unlike QuickBooks Online. Ensure payments are cleared in Zuper before voiding an invoice in QuickBooks Online to avoid discrepancies.
* In QuickBooks Online, voiding an invoice may push payments to customer credits. Since Zuper clears payments before voiding, this should not occur during sync.
**Troubleshooting Common Issues**
* **Sync Errors**: If credits, refunds, or voids do not reflect in QuickBooks Online, check the integration settings in Zuper. Ensure the QuickBooks Online connection is active and retry the sync.
* **Incorrect Invoice Status**: Verify that the invoice status in Zuber (**Partially Paid** or **Sent**) matches QuickBooks Online after refunds or voids. Correct any discrepancies in Zuper.
* **Credit Application Issues**: Ensure QuickBooks Online’s "**Automatically apply credits**" setting is turned off to prevent unintended credit application.
* **Credit Memo Line-Item Errors**: If a credit memo fails to sync to QuickBooks Online, confirm that a default "**SubTotal**" line item is included, as the QuickBooks Online API requires.
**Best Practices**
* **Disable QuickBooks Online Auto-Apply Credits**: Turn off QuickBooks Online’s "Automatically apply credits" setting to ensure manual control over credit application.
* **Regular Syncing**: Sync Zuper with QuickBooks Online daily to maintain accurate financial records.
* **Clear Memo Notes**: Add detailed notes to credit memos and refunds for audit purposes (e.g., "Refund for overpayment on Invoice #123").
* **Review Reports**: Use Zuper and QuickBooks Online reports (e.g., Customer Balance Summary, Payment Reports) to track credits and refunds.
This enhancement covers:
* Customer **Invoices**
* **Payments**
* **Credits**
* **Refunds**
* **Voids** (offline and online transactions)
## **Credits Sync**
### **Creating Credits**
1. Credits can be generated manually against a customer in Zuper.

2. Credits are automatically refunded when a refund is processed on a paid invoice (partial or full).

3. All such credits are synced to **Credit Memos** in **QuickBooks Online** against the same customer in **Unapplied** Status.


### **Applying Credits**
When credits are applied to an **outstanding invoice** in Zuper, the corresponding **Credit Memo in QuickBooks Online** is now **applied**.

The invoice is also reflected as paid/partially paid in the regular flow.
Available credits can also be used to **collect deposits against Quotes**. These transactions are also adjusted against the customer's credit balance in QuickBooks Online. The behaviour differs based on the ‘**Sync Deposit to Customers**’ Configuration.
**Scenario 1** – Sync Deposits to customers is turned off

The Estimate is created in QuickBooks Online. The credit is still unapplied in QuickBooks Online.

Convert the Quote to Invoice

The credit memo has been adjusted (reduced), and the payment is reflected against the invoice.

**Scenario 2**: Sync Deposits to customers is turned on
The deposit is collected using credits against the quote.

### **Payment Modes**
Refunds and credits may be handled via:
* **Zuper Pay (online/offline)** or
* **Standard payment methods** (cash, bank transfers, etc.).\
Zuper ensures proper reflection of the refund source and amount in QuickBooks Online, irrespective of the payment mode.
**Voiding Payments**
When a payment is voided in Zuper:

The **corresponding payment in QuickBooks Online** is automatically voided.

Similarly, if a payment is voided in QuickBooks Online:

The associated payment record in **Zuper** is also voided to maintain synchronization.

## Surcharge sync with QuickBooks Online
When you process a Zuper Pay payment that includes a [surcharge](https://docs.zuper.co/Zuper-pay/Surcharge), Zuper automatically pushes two separate records to QuickBooks Online. The invoice payment syncs as usual, carrying only the base payment amount. The surcharge portion syncs separately as a journal entry. This keeps your invoice totals and payment status in sync across both platforms without any manual reconciliation on your part.
> [!NOTE]
>
> Surcharge sync applies to Zuper Pay transactions only. Payments processed through other payment methods do not generate journal entries in QuickBooks Online.
## How the journal entry is structured
For each invoice that includes a surcharged payment, Zuper creates one journal entry in QuickBooks Online. Each surcharged payment adds two lines to that entry.
| Line | Account | Side |
| - | - | - |
| Expense line | Expense Account for Surcharge (defaults to Uncategorized Expense if not set) | Debit |
| Cash line | Undeposited Funds | Credit |
Debit and credit values are equal and match the surcharge amount from the payment.

## Setting up the expense account for surcharge
Before surcharge amounts sync, configure the expense account you want Zuper to use for the debit entry in QuickBooks Online.
1. Select your **Profile Picture** in the top-right corner of Zuper.
2. Select **App Store**.
3. Open the **QuickBooks Online** app.
4. Locate the **Expense Account for Surcharge** field.
5. Enter the exact name of the expense account as it appears in QuickBooks Online.
6. Select **Update**.

> [!NOTE]
>
> If you leave this field blank, Zuper defaults to Uncategorized Expense as the debit account. To avoid misclassified entries, enter the correct account name before processing surcharged payments.
## How surcharge refunds sync
When you issue a refund on a surcharged payment in Zuper, the surcharge reversal syncs to QuickBooks Online automatically. Zuper pushes a journal entry that reverses the original lines.
| Line | Account | Side |
| - | - | - |
| Cash line | Undeposited Funds | Debit |
| Expense line | Expense Account for Surcharge | Credit |
The refund amount follows the same proportional logic as the refund in Zuper. A full refund reverses the full surcharge amount. A partial refund reverses the surcharge amount proportional to the refund percentage. To learn more about how refunds are calculated in Zuper, see [Surcharge Fee — Processing Refunds](https://docs.zuper.co/Zuper-pay/Surcharge).
> [!WARNING]
>
> Voiding a Zuper Pay payment is not supported. To reverse a surcharged transaction, issue a refund in Zuper. The surcharge reversal syncs to QuickBooks Online automatically.

## Uninstall QuickBooks Online
1. Log in to your Zuper account. Click your Profile Picture at the top right corner of the screen and select “**App Store**.”

2. Under “**Browse by Category**,” select the “**Accounting**” option and choose “**QuickBooks Online**.”

2. Click “**Configure Settings.**

3. Click the “**Deactivate**” button and confirm deactivation to temporarily pause the integration.

* **Saving configuration with paused sync**: Your integration settings (e.g., field mappings, API connections, and preferences) will be preserved for future use. However, any new or updated data flowing *from Zuper to QuickBooks Online* (such as new invoices, customer updates, or inventory changes) will be temporarily halted. This lets you pause outgoing syncs without losing your setup, which is useful for troubleshooting, maintenance, or temporary holds.
* **Impact on existing synced invoices and payments**: For invoices that were already successfully synced from Zuper to QuickBooks Online *before* the pause, any payments collected directly in QuickBooks Online (e.g., via customer payments or bank feeds) will continue to sync *back to Zuper*. This reverse sync occurs only if your app configuration explicitly enables it (e.g., via payment reconciliation or bi-directional update settings). It prevents discrepancies in your records for completed transactions, ensuring payments are reflected in both systems. Recommendation for Payments - Zuper recommends setting the payment sync direction to “**No Sync**” to ensure payments collected in QuickBooks Online are not synced back to Zuper when the integration is inactive.
* Disables all payment synchronization between Zuper and QBO. No data is exchanged in either direction, which helps maintain data isolation—especially when the integration is temporarily inactive. Zuper recommends this setting in such cases to prevent unintended back-sync of QBO payments into Zuper.

**Impact on Inventory Sync**\
Inventory items created in QuickBooks Online will continue to sync to Zuper when QuickBooks is configured as the product master. Product consumption and replenishment updates will also continue to sync from QuickBooks to Zuper.
**Recommendation**\
To avoid inventory-related impacts, turn off product master synchronization.
* After pausing sync or deactivating the integration, navigate to **Zuper → QuickBooks Online configuration** and disable **Sync Product Masters**.\
This prevents QuickBooks from creating or updating Products and Services in Zuper when QuickBooks is set as the product master. As a result:
* No new products will be synced from QuickBooks Online to Zuper during the paused or deactivated period.
* Product quantity consumption and replenishment will not sync from QuickBooks Online to Zuper.
* Existing product master’s that were synced before this setting was turned off will remain unchanged in both systems.
You can safely re-enable **Sync Product Masters** when the integration is reactivated. This ensures product quantities can stay in sync and, if needed, be manually adjusted in both systems.
4. Click the “**Disconnect from QuickBooks Online**” button (it will appear in red text below the "**Activate**" button if the app is inactive).

5. In the confirmation dialog box, review the warning ("Are you sure you want to disconnect from QuickBooks Online? App settings will be lost.") and click "**Disconnect from QuickBooks Online**" to confirm. Your app is now successfully uninstalled.

## Limitations
* QuickBooks Online limits a customer's First Name or Last Name to 25 characters and a Company Name to 50 characters. If a customer is created in Zuper with a name that is over 25 characters long, there will be an error when creating the Customer in QuickBooks Online.
* If a customer is deleted in Zuper, the record will still be available in QuickBooks Online.
* Customers should subscribe to QuickBooks Online Plus or Advanced for inventory tracking.
* The Zuper account holder should have a dedicated account to generate the API Key, and the user should be in the administrator role. This account should be different from the one connecting to QuickBooks Online.
* For the B2B scenario cases, to push the Organization to QuickBooks Online, the value for the fields "**Identify Customers in Zuper – QuickBooks Online**" should be specified as:
* Billing Name – Customer Display Name.
* QuickBooks Online allows a maximum of three custom fields for Quotes and Invoices. Irrespective of the status of the custom field in QuickBooks Online, more than three custom fields will replace the current custom field values. Regardless of the custom field's status
> [!NOTE]
>
> Note: Adding the account names in the Product Custom Fields enables easy selection of specified accounts while creating products and services. This ensures that products or services are correctly linked to QuickBooks Online's appropriate income or expense accounts.
* Because Zuper does not send line-item service dates, QuickBooks rejects invoices that include products or services with a QBO revenue recognition template assigned, so you cannot use the revenue recognition feature with invoices synced from Zuper.
## FAQs
> [accordion] What QBO plan do I need to sync purchase orders?
>
> You need the Plus or Advanced plan in QBO. These plans include inventory tracking, which is required for PO sync to work. The Simple Start and Essentials plans do not support this feature.
> [accordion] What happens if the vendor on my Zuper PO does not exist in QBO?
>
> Zuper creates the vendor in QBO automatically before syncing the PO. The vendor record is created using the details from the Zuper vendor profile, including their email address.
> [accordion] Can I sync POs that were created before I turned on the setting?
>
> No. Only POs that reach the selected trigger status after you enable PO sync are sent to QBO. POs created before you enabled the setting do not sync retroactively.
> [accordion] I updated a PO in Zuper after it synced. Will the changes appear in QBO?
>
> Yes. Field value updates, line item changes, and status updates made in Zuper after the initial sync continue to flow to QBO.
> [accordion] A PO was closed in QBO. Why did the status not update in Zuper?
>
> Only terminal status updates from QBO — Closed, Rejected, Fulfilled, and Cancelled — sync back to Zuper. If the status change in QBO does not match one of these values, it will not reflect in Zuper.
> [accordion] Does the QuickBooks Online integration automatically map product descriptions to product names or SKUs in Zuper?
>
> No. The QuickBooks Online integration does not map product descriptions to product names or SKUs automatically. Descriptions do not auto-populate based on SKU changes made in QuickBooks Online.
> [accordion] What does the integration sync, and in which direction?
>
> The QuickBooks Online integration pushes Zuper records — such as invoices and customer data — to QuickBooks Online. For most record types, this is a one-way sync. Changes made in QuickBooks Online do not automatically reflect in Zuper's **Parts & Services** catalog or line item descriptions.
> [accordion] If I update a product SKU or name in QuickBooks Online, will it update in Zuper automatically?
>
> No. SKU or product name changes made in QuickBooks Online are not pushed back into Zuper. Update the relevant items manually in Zuper's **Parts & Services** master list. For bulk updates, contact your onboarding or support team.
> [accordion] Is the Description field on a quote or invoice line item editable in Zuper?
>
> Yes. The **Description** field on each line item in the quote or invoice screen remains fully editable within Zuper at the transaction level. The integration sync does not overwrite this field, so you can update the description for any line item directly on the quote or invoice.
> [accordion] What should I do if I need to update descriptions or SKUs across many products at once?
>
> Bulk updates to descriptions or SKUs are not supported through the integration. To update multiple items at once, contact your onboarding team or [Support](mailto:support@zuper.co) for bulk update assistance.
> [accordion] What happens if I do not set an expense account for surcharge?
>
> Zuper uses Uncategorized Expense as the default debit account for all surcharge journal entries. To keep your books organized, enter the correct account name in the **Expense Account for Surcharge** field in the QuickBooks Online app settings before processing payments.
> [accordion] Does the surcharge affect my invoice total in QuickBooks Online?
>
> No. Only the base payment amount syncs to the invoice payment in QuickBooks Online. The surcharge is recorded separately as a journal entry, so your invoice totals and payment status remain accurate.
> [accordion] Can I void a Zuper Pay payment in QuickBooks Online?
>
> No. Voiding is not supported for Zuper Pay transactions. If you need to reverse a payment, issue a refund in Zuper. The surcharge reversal syncs to QuickBooks Online automatically.
> [accordion] What happens in QuickBooks Online when I refund a surcharged payment?
>
> Zuper automatically pushes a reversal journal entry to QuickBooks Online. The entry debits Undeposited Funds and credits the expense account used in the original surcharge entry. No manual action is required in QuickBooks Online.
## Related articles
• [Sync history – QuickBooks Online](https://docs.zuper.co/Integrations/Accounting_and_payments/QBO_Sync_History)
• [Debugging common errors – QuickBooks Online](https://docs.zuper.co/Integrations/Accounting_and_payments/QBO_Errors)
• [Inventory sync – QuickBooks Online](https://docs.zuper.co/Integrations/Accounting_and_payments/QBO_bid_inventory)
• [Purchase orders in Zuper](https://docs.zuper.co/Purchasing/Purchase-Orders/Creating-purchase-order)
• [Vendors in Zuper](https://docs.zuper.co/Purchasing/Vendors/Vendors)
# Wisetack
Source: https://docs.zuper.co/Integrations/Accounting_and_payments/Zuper_Wisetack
Customers can now get financing from Wisetack to pay for field services. With the Wisetack – Zuper Integration, businesses can offer Wisetack financing to their customers for high quotes. while the customer can pay the invoice amount to Wisetack in installments.
The financing option helps businesses offer their customers finance, as set by Wisetack.
**Getting started with Wisetack**
1. To onboard new merchants
2. Configuring Wisetack
3. Pre-Qualification Check
4. Applying for a Finance and Payment Release
5. Finance Cancellation Scenario
6. Accessing Finance History
## 1. To onboard new merchants
To enable Consumer financing via Wisetack for our account, kindly reach out to your account manager or customer support team at [support@zuper.co](mailto:support@zuper.co)
Once submitted, the information provided takes up to 5 business days to review.
## 2. Settings – Configuration
The configurations are the pre-defined settings that enable the admin to modify the essential details.
1. Select the “**Settings**” icon from the left panel and choose the “**Organization Settings**” section.

2\. Under the “**Configurations**,” select the “**Quotation and Invoice Settings**.”
a. Enable the “Financing” module by setting the following details: a. Enable Financing – Select this as Yes to enable consumer financing.
b. Payment Mode Facilitating the Payment (**Mandator**y) – Choose the payment mode as “**Wisetack**.”
c. Amount Range to facilitate financing option (in USD) (**Mandatory**) – Wisetack sets the default range.

## 3. Pre-Qualification Check
The eligibility check is a significant part of the Pre-Qualification phase. Using the maximum qualifying criteria Wisetack sets, the business and customer can learn about the eligible amount.
* The pre-qualification occurs in the Quotes module. The business and customers can choose another payment mode based on the qualifying
amount.
* Select the “**Quotations**” module from the left panel and choose the “**+ New Quote**” option. Fill in the necessary “**Customer & Job Details**,” “**Billing Contact**,” and “**Billing Address**” information.
* Enter the necessary “**Parts and Services**.”

> [!NOTE]
>
> **Note:** Based on the final amount, the finance section specifies the approximate finance details, tenure, and interest will be visible to the customer at the bottom of the screen.
Select the “**Send Pre-Qualification**” button to the customer to check their eligibility amount. Alternatively, the customer can fill out the application form directly on the form during the field service.

Please fill in the “**Mobile Number**” and “**Purpose**" fields (Mandatory Fields) and click the “**Send Prequalification Link**” button.

Following the above steps, businesses and customers can learn the eligible amount and the maximum qualifying criteria Wisetack sets.
## 4. Applying for a Finance and Payment Release
* The pre-qualification link is optional. The business can directly create an invoice, and customers can opt-in for finance if needed.
* After following the steps above to convert the quote to an invoice, you can verify the details using the following steps.
> [!NOTE]
>
> **Note**:The finance section, which specifies the approximate details of the Finance, tenure, and interest, will be visible to the customer at the bottom of the screen.
* Verify the pre-filled “**Customer & Job Details**,” “**Billing Contact**,” and “**Billing Address**” information as the invoice is converted from the quotation.
* Verify the necessary “**Item Details**.” The final amount will be displayed and saved as a draft in the invoice.
Next, you can view the “**Financing Options Available**” section. First, select the “**Send Financing Application**” button on the Web App.


**Enter the Mandatory fields** – USD Amount and Purpose. Next, **fill in the optional fields:** Completion Date, Mobile Number, First Name, Last Name, and the email.

* Customers can review and accept Wisetack's terms. After the customer agrees with the terms, the status will be updated as “**Terms Accepted**.”
* The Financing section in the middle of the screen shows the Financing Application status.
* Once the job is complete and the customer approves the job completion, Wisetack will release the finance amount to the business.
* The status in the Zuper App will change to “**Amount Settled**.”
* The details will be sent to the customer’s registered email and SMS, indicating that Wisetack has settled the finances.

## 5. Financing Cancellation Scenario
An initiated finance can be canceled during one of the following scenarios.
* **Edit Invoice: (Mandatory)**
Financing will be canceled if the due amount is less than the requested finance amount or if the customer is changed.
This is a Mandatory scenario.
* Invoice Detail (Cancellation)
The finance will be canceled if the invoice is canceled from the invoice detail page.
Archived Invoices (Back-office cancellation message will be displayed)
Only the Manager can cancel the finance if the invoice is archived from the mobile apps.
* **Mark as paid**
(**Invoice Detail | Back-office cancellation Message will be displayed**). If the amount due is equal to the requested finance amount, the Manager or the back office can only cancel the finance.
* **Collect Payment (Stripe) Invoice Detail**
Back-office cancellation Message will be displayed) In the case of stripe payments, if the amount due is equal to the requested finance amount, the Manager or the back office can only cancel the finance.
* **Delete Invoice (Only Manager App or Back office)**
The Manager will cancel the finance.
With this significant Zuper-Wisetack integration, the customers now do not need to worry about the amount, and based on the customer's eligibility, the amount of finance applied will be approved.
## 6. Accessing Finance History
All Finance history can be viewed on a single page:
Navigation: *Accounting -->Financing*
Financing has two primary tabs:
1. **Pre-qualifications**: All customer finance pre-qualification histories can be tracked under this tab.
2. **Finance Applications**: The customer's finance application history can be tracked under this tab.
> [!NOTE]
>
> **Note:** You can view each line item using the Action a View icon and filter the required details using the filter icon.

With the Wisetack – Zuper integration, businesses can seamlessly offer financing options to their customers, making it easier for them to afford high-value services. By enabling Wisetack financing, businesses can improve their cash flow, increase conversion rates for high quotes, and provide a more convenient experience for their customers.
# FreshDesk
Source: https://docs.zuper.co/Integrations/CRM/FreshDesk/FreshDesk
With Zuper’s first-class integration with Freshdesk, it seamlessly helps push Freshdesk tickets to Zuper, delivering an exceptional customer experience. You can create a Job from a Freshdesk ticket with a bi-directional sync.
The three major sections we are going to discuss here are:
A. How to connect Zuper with Freshdesk?
B. How to connect Freshdesk with Zuper?
C. How does Zuper –Freshdesk Integration work?
D. How to uninstall Freshdesk from Zuper?
**A. How to connect your Zuper with Freshdesk?**
1. Open a new tab in your browser once you are logged in to your Freshdesk, and select the Freshdesk **App Store**.
a. **Zuper Region** (Mandatory) – Enter the region of Zuper for which Freshdesk integration is applicable.
b. **Zuper API Key** (Mandatory) - To create the Zuper API key, Click [**here**](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys) to know how to create and use API keys
c. **Freshdesk Domain** (Mandatory) - Enter Freshdesk’s URL.
d. **Freshdesk API Key** (Mandatory) – Copy-paste the Freshdesk API key from your Freshdesk account (How to find your API key).
e. **Sync Notes Automatically** – You can choose either “**Yes**” or “**No**” to sync or unsync Zuper Job Notes with Freshdesk.
f. Choose Notes to Sync – You can choose the type of notes for which the sync should happen from Freshdesk to Zuper. Options available are **Private Note**, **Public Note**, and **Reply**.
g. Enable Full Page to Support Agent – You can choose either “**Yes**” or “**No**” to set permissions for the Support Agents to the Full Page app access within Freshdesk.

## B. How to connect your Freshdesk with Zuper?
1. Open a new tab in your browser once you are logged in to your Zuper Account. Click on your Profile Picture in the top right corner of the screen and select the “**App Store**.”

2. Under the “**Browse by Category**,” select the “**CRM**” option and choose “**Freshdesk**.”

3. Click on the “**Install Freshdesk**” button.

4. Update Zuper Settings by configuring the following fields:
a. Zuper API Key (Mandatory) – To create the Zuper API key, Click [**here**](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys) to know how to create and use API keys.
b. Freshdesk API Key (Mandatory) – Copy paste the Freshdesk API key from Freshdesk account ([How to find your API key](https://support.freshdesk.com/en/support/solutions/articles/215517-how-to-find-your-api-key)).
c. Freshdesk Subdomain (Mandatory) - Enter the Freshdesk Subdomain details here.
d. Sync Zuper Status Updates - You can choose either “**Yes**” or “**No**” to sync or unsync Zuper Status updates with Freshdesk.
e. Sync Zuper Custom Fields - You can choose either “**Yes**” or “**No**” to sync or unsync Zuper Custom Fields with Freshdesk.
f. Sync Zuper Job Notes - You can choose either “**Yes**” or “**No**” to sync or unsync Zuper Job Notes with Freshdesk.
g. Freshdesk Status Field Name - You need to enter the Freshdesk Field Name for which Zuper gets synced.
h. Freshdesk Assignees Field Name - You need to enter the Freshdesk Assignees Field Name for which Zuper gets synced.
i. Freshdesk Start Date Field Name - You need to enter the Freshdesk Start Date Field Name for which Zuper gets synced.
j. Freshdesk End Date Field Name - You need to enter the Freshdesk End Date Field Name for which Zuper gets synced.
k. Freshdesk Customer Signature Field Name - You need to enter the Customer Signature for which Zuper gets synced.
l. Freshdesk Ticket Close Statuses - You need to enter the list of Freshdesk Ticket Close Statuses for which Zuper status get synced (Use a comma separator to add multiple statuses).
m. Mark Freshdesk ticket as? - You need to choose the status of the Freshdesk ticket from the dropdown list - **None**, **Closed**, or **Resolved**.

Select the “**Update**” button to connect Freshdesk with Zuper.
## C. How does Zuper – Freshdesk work?
**Create a Job from Zuper**:
1. Log in to your Freshdesk account, and in the right sidebar widget, you can view the ticket for which a Job has not been created in Zuper.

Click the "**Create Job**" button to create a new job for the pending Freshdesk ticket.
2. The Job Title, Job Category, and Job Priority are automatically picked. The agent has added the Job description and chosen the time slot.

3. Use the "**Assisted Scheduling**" feature to choose the slots and click the "**Confirm**" button.

4.The Freshdesk ticket contact will be created as a Customer in Zuper.

5. Use the "**Pick From Map**" option to capture the exact customer address with proper geo-coordinates.

6. The new job is successfully created from the Freshdesk sidebar.

7. You can view the list of Jobs created using Zuper-Freshdesk integration, and you can also view all jobs in the associated Zuper account.

8. Click any one of the line items to view the Job details.

### Custom fields
If custom field values you saved in Zuper are not appearing in Freshdesk, check the following:
1. Confirm **Sync Zuper Custom Fields** is set to **Yes** in your Freshdesk integration settings.
2. Check whether the Freshdesk ticket was already closed before you saved the custom fields in Zuper. If so, reopen the ticket in Freshdesk, then re-save the custom fields in Zuper to trigger the sync.
3. Confirm the field names match exactly in both systems. Only fields with identical names sync automatically.
If the issue continues, contact [Support](mailto:support@zuper.co).
### Workflow execution history
Check workflow execution history for errors
If a workflow linked to this integration is not running as expected, you can check its execution history to find where it failed.
1. Go to the **Jobs** module and open the relevant job.
2. In the right panel, locate **Workflow Activity** and select **View History**.
3. Review the **Status** column. Select any failed run to see the error message and the node where the failure occurred.
4. To retry a failed run, select the **Retry** icon next to the execution.
5. If you have resolved the issue manually, select **Acknowledge** to mark the run as reviewed.
### Zuper inside Freshdesk App:
You can use the major Zuper capabilities in the Freshdesk App.
1. The Assets Picker helps you to add the Assets needed for the Job. Choose the Asset and click the "**Confirm**" button.
> [!NOTE]
>
> **Note**: You can include the required unassociated assets to Job based on your need and click the "Confirm" button.

2. The Contract Picker helps you add the contracts needed for the job. Choose the Contract and click the "**Confirm**" button.

3. The Part Picker helps you add the parts needed for the job.

Choose the parts and click the "**Confirm**" button.
4. The Custom fields are auto-populated only if they match the custom fields that are available in the Freshdesk ticket. Also, the user can fill in manually.

5. You can track the technician by viewing the live location of the User.

## D. How to Uninstall Freshdesk from Zuper?
1. Open a new tab in your browser once you are logged in to your Zuper Account. Click on your Profile Picture in the top right corner of the screen and select the “**App Store**.”

2. Under the “**Browse by Category**,” select the “**CRM**” option and choose “**Freshdesk**.”

3. Click on the “**Uninstall App**” button.

4. The Freshdesk app is uninstalled successfully.

Using Zuper integration with Freshdesk, you can easily create & dispatch field visit jobs, pick the right slot & technician using Assisted Scheduling directly, and access Zuper Job-status updates within Freshdesk with the Freshdesk tickets.
# Zendesk Support
Source: https://docs.zuper.co/Integrations/CRM/Zendesk/Zendesk
The Zendesk-Zuper integration helps the user connect the Zendesk support tickets with Zuper. The bi-directional data flow based on the settings allows the user to update the ticket details on both Zendesk and Zuper.
We are going to see two different setups:
**Zendesk – Zuper Integration**
**Zuper – Zendesk Integration**
## Pre-Requisites:
API Keys. Click [here](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys) to know how to create and use API keys
## A. Zendesk-Zuper Integration:
You need to land on the Zendesk support page and integrate the Zuper with Zendesk by following the steps:
1. Select the “**Settings**” module from the left panel.

2. Select the “**Go to Admin Centre**” option.

3. Choose the “**Apps and Integrations**” subsection under the “**Admin Center**” section.

4. Select the “**Market Place**” option present at the top of the page.

5. Search for the "**Zuper**" app under the filters option.

6. Select the “**Zuper**” app from the list.

7. Select the “**Install**” option to set up the Zuper integration.

8. Enter the Mandatory fields: “**Title**” and “**API Key**” (Zuper’s API key), and if required, fill in the Optional fields: “**Zendesk Ticket Type**,” “**Zuper Default Job Category**,” “**Push Comments to Zuper Automatically**,” “**Enable Role Restrictions**,” “**Enable Group Restrictions**.”

9. Select the “**Update**” button to save the preferences.

By following the steps above, you can easily integrate Zuper with Zendesk.
## B. Zuper – Zendesk Integration:
To get the API keys for Zuper-Zendesk Integration, follow the steps below:
1. Click on “**Go to Admin Center**” under “**Settings**” from the left panel.

2. Now select “**Apps and Integrations**” and click on “**Zendesk API**.”

3. Select “**Add API Token**” to create the new API key.

4. Type the API Token Description name as “**Zuper**” and copy the “**API Key**.”

> [!NOTE]
>
> **Note**: Make sure to copy and store this API token. Zendesk will not display it again after clicking Save or leaving this page.
## How to Install?
You need to land on the Zuper web app and integrate Zendesk with Zuper by following the steps:
1. Click on your profile picture on the top right corner of the page, which will open the list of options. Next, click on the “**App Store**” link.

2. You will be redirected to the “**App Store**.” Click on “**CRM**” under “**Browse by Category**” on your left and click “**Zendesk**.”

3. In the dialog box, enter the **Zendesk subdomain** of the account you want to connect to Zuper.

4. Zendesk displays a dialog box **“Allow Zuper to access your Zendesk account?”**

5. Enter the Email and Password.

6. Enter the Mandatory Fields: Zuper API Key, Zendesk API Token, Zendesk Agent Email, Sync Zuper Status Updates, Sync Zuper Job Status, Zendesk Status Field Name.

7. Enter the Optional Fields on the Zuper from the field details taken from the
Zendesk support page: **Zendesk Assignees Field Name, Zendesk Start Date**
Field Name. Zendesk End Date Field Name, Zendesk Customer Signature Field Name, Zendesk Ticket Closure Statuses.

Select the “**Update**” button to save the preferences.
**What Happens After Authorization**
After successful authorization:
* Map Zuper jobs to Zendesk tickets.
* Automatically update ticket custom fields with job status, assigned technician, scheduled date, and customer signatures.
* Job notes sync as Zendesk ticket comments, including any attachments.
* Tickets can automatically resolve or close based on mapped job statuses.
**Best Practices**
* Authorize the integration using a Zendesk admin account to avoid permission issues.
* Configure the required Zendesk custom fields for job mapping before connecting.
* Do not disconnect the OAuth authorization unless you need to reset the integration.
## C. Zuper - Zendesk Sell/ Support Field Equivalents:
Deal ID / Zendesk ID - The deal ID / Zendesk ID is a unique ID of Zendesk Sell / Support that is getting pushed to the Custom Field of Zuper for identification purposes.

## D. How does Job creation work in Zendesk?
1. From the right panel of Zendesk, Choose “**Create Job**” to create a new job. You need to fill the following tabs :
**Customer Details Tab** - Enter the client’s details.
\*\*Job Details Tab \*\*- Enter the work order details.
**Assign Employees** - Assign the field technicians using assisted scheduling option.
2. Asset Picker helps you to select the resources from Zuper’s Jobs module of Zendesk.

3. Parts Picker helps you select the parts from the Zuper’s Jobs module of Zendesk.

4. Contract Picker helps you select the agreements from Zuper’s Jobs module of Zendesk.

5. By default, the timezone is displayed according to the organization’s or customer’s preferences set in Zuper. Now, users can create a new job based on their preferred time zone or switch to a different one.

> [!NOTE]
>
> **Note**: If both the organization and customer have preferred time zones, the customer's preferred time zone would be pre-filled.
### Assisted Scheduling:
Assisted Scheduling helps you choose the time slots based on the Slot View or Resource View.
**Slot View** - Based on the chosen category, time slots are displayed.
**Resource View** - Based on the users availability.

6. Live Tracking: Live tracking of field executives can be performed from the Jobs module in Zendesk.
You can use the assisted scheduling feature from Zuper while creating a Job in Zendesk.

## E. Overall Flow

## How to Uninstall?
1. Open a new tab in your browser and once you are logged in to your Zuper Account, click on your Profile Picture on the top right corner of the screen and click on “**App Store**.”

2. You will be redirected to the “**App Store**.” Click on “**CRM**” under “**Browse by Category**” on your left and click “**Zendesk**.”

3. Click “**Uninstall App**” button.

4. The uninstall is successful.

By following the above steps, you can now easily integrate Zendesk with Zuper.
# Zoho CRM
Source: https://docs.zuper.co/Integrations/CRM/ZohoCRM/Zoho_CRM
With Zuper’s first-class integration with Zoho CRM, Zuper seamlessly helps across your sales, services, and support teams to deliver an exceptional customer experience.
The three major sections we are going to discuss here are:
A. How to connect Zoho CRM with Zuper?
B. How does Zuper –Zoho CRM Integration work?
C. How to uninstall Zoho CRM from Zuper?
## A. How to connect your Zoho CRM with Zuper?
1. Open a new tab in your browser after logging in to your Zuper Account. Click on your Profile Picture in the top right corner of the screen and select the “**App Store**.”

4. Under the “**Browse by Category**,” select the “**CRM**” option and choose “**Zoho CRM**.”

3. Click the “**Install Zoho CRM**” button.

Switch to the Zuper tab on your browser and log in to your Zuper account.
4. Provide the necessary permission details for the Zoho CRM.

5. Update Zuper Settings by configuring the following fields:
a. Reverse Integration User ID (**Mandatory**) – From the Employees module in Zuper, select the “User,” copy the ID, and paste it into the “**Reverse Integration User ID**.”
b. Zoho Region (**Mandatory**) – Europe, India, and Australia; this will be automatically based on the Zoho regions. You can choose from the drop-down list if the region is not listed automatically.
c. To create the Zuper API key, Click [**here**](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys) to know how to create and use API keys
> [!NOTE]
>
> **Note**: The update should be auto-synced from Zoho to Zuper properly.
We create separate users, with whom we create app keys and use them.

Select the “**Update**” button to connect the Zoho app with Zuper.
## B. How does Zuper–Zoho Integration work?
1. Log in to your Zoho account and create a workflow from Zoho.
The Sync happens from Zoho deal to Zuper Job | Zoho Account as Zuper Organization | Zoho Contact as Zuper Customer.
| Zoho Entity | Zuper Entity |
| :- | :- |
| Deal | Job |
| Account | Organization |
| Contact | Customer |

## C. How to Uninstall Zoho CRM from Zuper?
3. Click on your Profile Picture in the top right corner of the screen and select the “**App Store**.”

2. Under the “**Browse by Category**,” select the “**CRM**” option and choose “**Zoho CRM**.”

3. Click on the “**Uninstall App**” button.

4. The Zoho CRM app is uninstalled successfully.

Using Zuper integration with Zoho CRM, you can easily create & dispatch field visit jobs, pick the right slot & technician using Assisted Scheduling directly, and access Zuper Job-status updates within Zoho CRM.
# HubSpot SalesHub & Service Hub
Source: https://docs.zuper.co/Integrations/CRM/Zuper_HubSpot_Integration
With Zuper's first-class integration with HubSpot ServiceHub and HubSpot Sales Hub, you can work seamlessly across your sales, services, and support teams to deliver an exceptional customer experience. Using Zuper integration with HubSpot, you can easily create and dispatch field visit jobs, pick the right slot and technician using Assisted Scheduling directly, and access Zuper Job Status updates within HubSpot tickets and deals.
## Before you get started
The initial setup is critical for the integration to function smoothly. Once the integration is successfully set up, the Zuper widget will appear in the right-side pane within the HubSpot Deal and Ticket details page.
Please follow the steps below to connect your Zuper Account with your HubSpot ServiceHub and HubSpot Sales account.
### A. Integrate Zuper and HubSpot (Setup):
1. Once logged in to your Zuper account, click your Profile Picture in the top right corner of the screen and select "**App Store.**"

2. You will be redirected to the Zuper App Marketplace, where you must choose the "**CRM**" category and select “**HubSpot.**"

3. Click the " **Install HubSpot"** button to be redirected to HubSpot.

4. Choose the **HubSpot account** to which you would like to link the Zuper account.

5. The scope approval access request from HubSpot account screen appears. Check the mark on the terms and conditions and click the "**Connect App**" button.

8. Now, you can enable “**Update HubSpot Settings**” by entering the following details.
* **Zuper API Key (Mandatory Field):** - Enter the Zuper API key
* To create the Zuper API, refer to the below steps:
> [accordion] API Key
>
> If you are trying to integrate Zuper with any external systems, you will need an API key to access the Zuper APIs. To generate API (Application Programming Interface) Key, please follow the below steps.
>
> 1. Log in to Zuper with an admin account.
> 2. Scroll down the menu bar on the left and select the "**Settings**" icon key.
> 3. Under the "**General Settings**" category, select "**Account Settings.**"
>
> 
>
> 4. On the account settings page, select **"API Keys."**
>
> 
>
> 5. Click on "**New API Key**" and enter the name of the API key in the pop-up windows.
>
> 
>
> 6. Click on "**Create**" to generate the API key. (Once created, the API key can be viewed by clicking on the "**View API Key**" hyperlink.)
>
> 
>
> 5. To delete/deactivate an existing API, click on the "**Delete API Key**" (x) next to the respective API.
>
> 
> [!NOTE]
>
> **Note:** The API key generated will provide full permission & access to the user who
>
> created this key. Please ensure to store this key securely.
> [!NOTE]
>
> **Note:** It is mandatory to enter the Zuper API Key for Integration to perform smoothly.
* **Sync Zuper Status Updates (Mandatory Field): -** Choose “**Yes**” to enable the sync of Zuper's current job status updates with HubSpot.
* **Sync Zuper Job Notes (Mandatory Field): -** Choose “**Yes**” to enable the sync of Zuper Job Notes' current job status updates with HubSpot.
* **HubSpot Status Field Name (Mandatory Field)**: Enter the "**Status**" field API name of Zuper from where the current status is fetched and reflected in HubSpot.
To get the Status Field Name, Log in to your HubSpot account, and under **settings**, choose **Tickets** → **Manage ticket Properties** → All Properties --> choose **Field Visit Status** property → Select the "**Backslash**" link under field type.

You must copy the API label from the "**Internal Name**" option and paste it under "**HubSpot Status Field Name**."
* **HubSpot Assignees Field Name:** Enter the "**Assignees**" field API name of Zuper, from which where the current status is fetched and reflected in HubSpot.
* To get the Assignees field name: Login to your HubSpot account, and under **settings**, choose **Tickets** → **Manage ticket Properties** → **All Properties** → choose **Assigned Technician** property → Select the "**Backslash**" link under field type.

* You must copy the API label from the "**Internal Name**" option and paste it under "**HubSpot Assignees Field Name**."

* **HubSpot Completed Date Field Name -** Enter the internal name of the completed date field in HubSpot to which the Zuper status-completed or closed date will be synced.
* **HubSpot Customer Feedback Field Name -** Enter the internal name of the customer feedback field in HubSpot, to which the Customer Signature will be synced from Zuper.
* **Sync HubSpot Job Notes (Mandatory Field) -** Choose "**Yes**" to enable the sync of HubSpot Job Notes updates with Zuper.
* **HubSpot to Custom Fields Mapping -** Enter the custom fields API field name of HubSpot followed by Zuper's custom API field name separated by commas, from which the current status is fetched and reflected from Zuper.

* Once you have filled in all the information, click the “**Update**” button. Your preference will be updated successfully.

These are the prerequisites for HubSpot and Zuper integration. Once the above setup is ready, a custom workflow action is configured in HubSpot to ensure smooth data flow between the apps.
## Add Job widget to HubSpot views
HubSpot has introduced App Cards — a newer, more reliable way for external apps to display data inside HubSpot records. Zuper now supports an App Cards-based Jobs widget that replaces the older CRM Cards-based widget.
App Cards load faster, receive direct support from HubSpot, and are less prone to performance issues. The older CRM Cards have been deprecated by HubSpot and will receive limited support going forward. Zuper recommends that all new customers use the App Cards widget and that existing customers plan a transition at a time that works for them.
> [!NOTE]
>
> **Notes**: This migration applies only to Deals, Tickets, Contacts, and Company records.
**How to migrate to App Cards**
This is a one-time process. You repeat it for each record type that syncs with Zuper: Deals, Tickets, Contacts, and Companies.
**Edit the layout**
1. In HubSpot, go to the record type you want to update.
2. Select **Customize record** or **Edit layout** from the record view.
3. The layout editor opens with a right-side pane.
**Add Zuper Jobs App Card**
1. In the right-side pane, select **Add Cards**.

2. Select **Card Library**.
3. In the search field, enter Zuper.
4. Under **Apps**, locate the Zuper Jobs Card.
5. Select the card to add to the layout.
.png?fit=max\&auto=format\&n=bMcfoPsnX4A_4PNI\&q=85\&s=bd239c370b457a5124e9df87d803235c)
**Save and exit**
1. Close the sidebar modal.
2. Select **Save and exit** to apply the updated layout.
**Repeat for all synced record types**
Repeat Steps 1–3 for each of the following record types:
* Deals
* Tickets
* Contacts
* Companies
> [!NOTE]
>
> **Note**: Once you complete this process for all four record types, the new App Cards widget is active.
>
> Jobs created with the old CRM Cards widget will also appear in the new widget — no data is lost during the transition.
**What to know before you migrate**
**Your existing jobs are safe**
Jobs created through the old CRM Cards widget remain visible in the new App Cards widget. Removing the old CRM card from a record layout does not delete or hide any jobs.
**User-specific layouts in HubSpot**
HubSpot supports user-specific record layouts. If your team uses personalized layouts, each relevant layout must be updated individually to include the new App Cards widget. Check with your HubSpot administrator to confirm whether user-specific layouts are in use.
**The create and view experience stays the same**
The process for creating a job and viewing job details inside HubSpot remains unchanged. Only the underlying widget technology is different.
**Removing the old CRM Cards widget**
After you add the new App Cards widget, you can remove the old CRM Cards widget from your record layouts. This step is optional.
**Existing customers —** Removing the old CRM card does not affect your data or the display of jobs in the new App Cards widget. Remove it at a time that suits your team.
**New customers —** Zuper recommends adding only the new App Cards widget. Remove the old CRM card from all record layouts as part of your initial setup.
> [!WARNING]
>
> **Alert: Deleting a job in Zuper will also delete the associated record in HubSpot.** If you want to remove a job from the Zuper schedule without affecting HubSpot, do not use the Delete option. Use the unschedule method described below instead.
> [accordion] Removing a Job from the Schedule Without Deleting the HubSpot Record
>
> If you need to remove a booking from the Job Calendar or Dispatch Board while keeping the job record intact in both Zuper and HubSpot, clear the scheduled dates instead of deleting the job.
>
> **This action must be performed in the webapp.**
>
> **1. Open the Job**
>
> Navigate to the job in the webapp from Jobs or from the Job Calendar / Dispatch Board.
>
> **2. Clear the Scheduled Dates**
>
> In the job details, remove the **Scheduled Start Date** and **Scheduled End Date** fields. Leave the **Due Date** unchanged.
>
> **3. Save the Job**
>
> Click **Update** to save. The job will no longer appear on the Job Calendar or Dispatch Board but will remain in Zuper and HubSpot.
>
> **4. Open the Job**
>
> Navigate to the job in the webapp from Jobs or from the Job Calendar / Dispatch Board.
>
> **5. Clear the Scheduled Dates**
>
> In the job details, remove the **Scheduled Start Date** and **Scheduled End Date** fields. Leave the **Due Date** unchanged.
>
> **6. Save the Job**
>
> Click **Update** to save. The job will no longer appear on the Job Calendar or Dispatch Board but will remain in Zuper and HubSpot.
>
> > [!NOTE]
> >
> > Clearing the scheduled dates only removes the booking from the Zuper schedule view. The job record, its status, and its HubSpot association are fully preserved.
### B. Create Zuper Jobs within HubSpot
You can create jobs in Zuper through the widget in HubSpot's right-hand panel of the Deal or Ticket Object.
The HubSpot Deal & Ticket sidebar will display the Zuper Jobs widget which will list the associated Zuper’s jobs. Zuper lets you have one or multiple jobs for a single deal or ticket.

To create a new job, Click the "**Create Job**" button.

The above dialog box opens. Fill in the relevant job details, including all mandatory fields such as Job Category, Scheduled Date, Due Date, etc.
When you try to create a new job from the Zuper widget in HubSpot, some fields, such as Job Title, priority, and Service Address, will be prefilled in the form. The contacts associated with the Deal or Ticket will get pushed. This allows you to create the job quickly.
| Zuper Fields | HubSpot's Equivalent Fields for Zuper |
| - | - |
| Customer | Contacts |
| Organization | Company |
| Assets | Same (Display as per Zuper master) |
| Parts | Same (Display as per Zuper master) |

The customer doesn't need to be present in Zuper while creating a new Job in Zuper, and the customer fetch from the system happens with the email ID match.
The service address is the customer's (**Contact**), and the billing address is the Organization's (**Company** ).
1. While creating a job from the HubSpot widget, an existing Zuper customer can be chosen from HubSpot, or a new customer can be created ad hoc in the widget and linked to Zuper.
2. To associate an existing customer, you can choose them from a dialog box based on the available list by searching for their name in the widget's search bar.
3. To add and associate a new customer with this job, click the "**New Customer**" option in the widget and provide the necessary details to create a customer. The customer will be associated with the job.

## **Notes for Job Creation**
* A **Customer** (**Contact**) or an **Organization** (**Company**) is mandatory when creating a new Job.
* The HubSpot widget allows you to create recurring jobs with the following recurrence schedules: .
* Assets, parts, and services related to the job can be picked for the service.
* If custom fields are present in a Job based on the Job category, they will be available to fill in HubSpot. All custom field types are supported except lookup and File Upload.
* Notes added to HubSpot Deal/Ticket will sync to Zuper Job as soon as they are created.
* Attachments were added to the HubSpot Deal/Ticket. Also, create a note in HubSpot, which will be synced to the Zuper Job.
* Notes added to Zuper job will sync directly to the associated Hubspot Deal/Ticket's notes instead of to a section on the widget.
[https://drive.google.com/file/d/1kdZEnUd\_XnCwTZlEyccz8EAXYXFWOjM-/preview](https://drive.google.com/file/d/1kdZEnUd_XnCwTZlEyccz8EAXYXFWOjM-/preview)
[https://drive.google.com/file/d/1kdZEnUd\_XnCwTZlEyccz8EAXYXFWOjM-/preview](https://drive.google.com/file/d/1kdZEnUd_XnCwTZlEyccz8EAXYXFWOjM-/preview)

Whenever the field technician marks the status as " **On my way** " on Zuper, the HubSpot Agent can track their location and ETA through the " **Track Technician** " option under the job's actions in the widget.
## HubSpot App Cards
The new Job Gallery feature brings all your job-related media into one seamless, unified view on Zuper.
For Staff using HubSpot to create jobs, the Gallery feature in HubSpot’s Details page brings all your job-related photos and videos into a single view within HubSpot - no more digging through Checklists, Notes, or Attachments! This provides crucial context and information that agents may need to respond to customers or take action on the Deal/Ticket.
How do you set up the Gallery Feature in HubSpot Deal?
1. Under the “**Deals**” page, click the “**Customize Card**” to add the gallery.

2. Select the view you regularly use in the record (deal/ticket) you wish to enable for App Card.

3. Click “**+**” to add the new tab. (applicable only for enterprise plans).

4. A dialog box will appear. Enter the tab name. Click the “**Done**” button.

5. Click the “**Add Cards**” button.

6. An “**Add middle column cards**” side panel appears. Under “Apps,” check the “Zuper Gallery” check box.

7. Click the “**Save and Exit**" button to save the card.

8. The App gallery is loaded successfully.

9. Click the “**Overview**” tab to view the app gallery for CRM Tickets. Click the “Edit Layout” to modify the gallery view.

10. Click any one of the images from the “**Job Gallery**.” Click the “**View Image**” button to see the gallery picture. Click the "View Video" button to see the video.

With powerful filtering and grouping, viewing your media has never been easier in the App gallery view. You can view all the media associated with jobs created from the Deal/Ticket in a single place.

> [!NOTE]
>
> Note: Once you "**Uninstall**" Zuper from HubSpot, the previous data synced between HubSpot and Zuper is retained in Zuper, and the ongoing data sync is disconnected between Zuper and HubSpot.
The business can easily ensure the deal's conversion to a successful job. In addition, with the bidirectional data flow, job details get updated on both apps (HubSpot CRM and Zuper).
## HubSpot Zuper Workflow Automation
With the HubSpot – Zuper Integration, you can currently create a job in Zuper from HubSpot using the Zuper widget on the right-side pane. This provides flexibility in creating a job to suit your different needs. You can specify the job details in the form and create a job. But this will involve some manual effort.
HubSpot Workflow Automation allows you to set up the automatic creation of jobs from deals and tickets from HubSpot to Zuper. You will have greater control over when data from HubSpot is pushed using triggers and how the data is pushed to Zuper with the mapping table. You can push a deal or a ticket to a job and sync customers' and organizations' data.
## Pre-requisites
* It would be best if you were in the HubSpot Professional or Enterprise plans.
* Ensure HubSpot Zuper Integration is set up (Use this link to set up).
### How to install and use Zuper - HubSpot integration
### Install HubSpot
1. Log in to your "**HubSpot**” account and go to the app marketplace.
2. From the app marketplace, navigate to Customer Service, then Field Service Management, and select "**Zuper.**"
### Data Flow
With workflow automation, we can define how data flows between Hubspot and Zuper. Currently, Data flows from the following Hubspot to Zuper modules are supported:
### HubSpot Zuper
| HubSpot's Equivalent Fields for Zuper | Zuper Fields |
| - | - |
| Deal | Job |
| Ticket | Job |
| Deal | Project |
| Contact | Customer |
| Company | Organization |
Module-level data flow is predefined and cannot be changed, i.e., data from deals will always flow into Job and vice versa.
The fields are mapped within each module, which you can control in the mapping table, as explained in the following section. Flows can be unidirectional or bidirectional.
### Field Pairing
In the integration between Zuper and HubSpot, field pairing is used to specify how the fields in Hubspot are connected to those in Zuper. This process guarantees that data is accurately moved and interpreted between the two systems.
1. Map the "**Deal to Job**" fields. HubSpot's fields get synced with Zuper field. a. The **Deals field** in HubSpot will be synced with the **Job** fields in Zuper. b. The **Contacts field** in HubSpot will sync with the Customer fields in Zuper **Company** fields in HubSpot get synced with **Organization** fields in Zuper.
You can use any of the arrows to define how the sync should happen.
i) A single forward and backward arrow represents one-way sync.
ii) Two parallel arrows represent two-way sync.
> [!NOTE]
>
> **Note:** Click the "**Add Field**" button to add the additional fields for mapping.
> [!NOTE]
>
> **Note:** The default value column lets you define the default value to be used if it is empty in Zuper or HubSpot.

2. Map the "**Ticket to Job**" fields. HubSpot's fields get synced with the Zuper field. Click the "**Save Changes**" button to save and configure the workflow.

2. Map the "**Deal to Project**" fields. HubSpot's fields get synced with the Zuper field. Click the "**Save Changes**" button to save and configure the workflow.

2. Map the "**Contact to Customer**" fields. HubSpot's fields get synced with the Zuper field. Click the "**Save Changes**" button to save and configure the workflow. Here, the Zuper Field – “**Customer Link**” is available by default and can be mapped to any field in the HubSpot Contact record where you wish to populate the URL of the connected Zuper Customer.

> [!WARNING]
>
> **All mandatory Zuper Job fields must have forward or bidirectional mapping configured for workflow-based job creation to succeed.**
>
> The following fields are mandatory in Zuper and must be mapped from HubSpot with a forward (HubSpot → Zuper) or bidirectional sync direction:
>
> * **Job Category** (most commonly missed — has no default HubSpot equivalent)
> * **Job Title**
> * **Due Date**
>
> If any mandatory field is unmapped or set to reverse-only sync, the workflow will execute and return a 200 response in HubSpot, but no job will be created in Zuper. No error will appear in the HubSpot workflow log.
5. Map the "**Company to Organization**" fields. HubSpot's fields get synced with the Zuper field. Click the "**Save Changes**" button to save and configure the workflow. Org Link is available to be mapped to a HubSpot field in the Company record. This will push the URL of the connected Zuper Organization to that field.

> [!NOTE]
>
> Note: The sync type in the field mapping must always be set to bi-directional when mapping the Customer/Organization Link to any field in HubSpot.
Within a deal-to-job, ticket-to-job, or deal-to-project flow, we can specify the mapping for the customer or organization that gets synced with the transaction record. This mapping /may differ from the mapping for imcustomer or organization master records, which are available separately.
To successfully push a Deal/Ticket from HubSpot to Zuper as a Job/Project, data must flow into Zuper from HubSpot. Therefore, the mandatory fields for creating a job/project in Zuper must have forward or bidirectional mapping. Only having reverse mapping from Zuper to HubSpot will not successfully push a deal/ticket to Zuper.
Field Pairing should be specified for all modules that need syncing between Hubspot and Zuper. Each HubSpot field can be mapped to one Zuper field.
## Setup automated workflow
After field mapping is done, you can set up the workflow to act in an automated process. Trigger workflow in HubSpot, and you can see the action in Zuper.
1. Go to Settings -> Automation and click the “**+New Workflow.**” Select Deal-based or Ticket-based workflow.

2. The initial step is enrollment.

3. You can set up the conditions for the trigger to happen.

4. The event is successfully selected.

5. Here, the relevant Zuper action will be available and can be set.

6. The deal from HubSpot will be pushed as a Job in Zuper. Click the "**Review and publish**" button.

7. You can review the configurations set and turn on the workflow.

> [!NOTE]
>
> Note: Once the workflow is set up, a new Deal or Ticket that satisfies the corresponding job will be created on Zuper with the specified field mapping. When a field value is updated in Zuper, it will correspondingly update in HubSpot when the direction of sync is Zuper to HubSpot and vice versa.
>
> The fields set to sync bidirectionally will update their values whenever the update happens on either system.
* The automation has now been set up and is live. Once a Deal or Ticket meets the configured trigger criteria, the object data will be pushed to a Zuper job according to the field mapping specified. The fields will also be kept in sync according to the sync direction specified.
* Relevant workflows need to be set up for data flow between other modules. For example, a ticket-based workflow with the relevant Zuper action needs to be set up for data to flow between Ticket and Job.
### Important Points:
* It is recommended that only one workflow be set up for each Zuper module sync. For example, only one deal-based workflow using a Zuper action should be created when moving data from a deal to a job.
* For Certain Fields, e.g., calculated fields, the sync direction can only be unidirectional; here, the source field is HubSpot.
* When transferring a large number of deals or tickets from HubSpot to Zuper, expect a 30-minute delay for all records to fully sync. Please wait until the sync is complete before proceeding.
* By default, HubSpot enrolls a record in a workflow only once. To make it trigger every time "**Push to Zuper**" is set to Yes, enable re-enrollment: open the workflow → Enrollment trigger → Re-enrollment tab → select "**Push to Zuper** = **Yes**."
* Avoid changing "**Push to Zuper**" and the pipeline stage at the same time. HubSpot may miss the trigger if both fields are saved together. Instead, use "**Push to Zuper** = **Yes**" as the enrollment trigger and add the pipeline stage as a filter condition inside the workflow.
* If a job wasn't created, check Settings → Sync Activity in Zuper before reaching out to support.
* When a job has multiple appointments, workflow automation cannot sync the schedule start and end dates to that job. No error message appears. This is expected behavior, Zuper calculates the job's schedule start and end dates automatically from the appointments linked to it.
* For non-dispatchable job categories, the job widget in HubSpot does not display the scheduled start and end dates. Only the due date appears.
## Deactivate / Uninstall HubSpot
1. Once logged in to your Zuper account, click your Profile Picture in the top right corner of the screen and select "**App Store.**"

2. Under “**Browse by Category**,” select the “**CRM**” option and choose “**HubSpot**.” Click “**Configure Settings**.”

3. Deactivate (pause) the integration (recommended before uninstalling)
On the HubSpot configuration page, click **Deactivate**.

4. In the confirmation dialog (Deactivate App), click **Deactivate** again to confirm.

### **What happens when the HubSpot App is Inactive?**
**1. Your Configuration Is Retained**\
Your existing HubSpot configuration — including API key, field mappings, and sync preferences — remains saved. You don’t need to reconfigure anything when you reactivate the app.
**2. Data Sync from Zuper Is Paused**\
Any sync configured from Zuper to HubSpot will stop while the app is inactive.
For example:
* Automatic creation or updates of records in HubSpot based on your sync settings (such as **“Push Zuper Job as HubSpot Deal”**) will not occur.
**3. Data Flow from HubSpot Continues**\
Actions initiated from HubSpot will still work:
* Job creation from the HubSpot widget will continue to function.
* Jobs, customers, projects, and other records can still be created in Zuper through HubSpot Workflows, if triggered.
**4. Impact on Zuper Connect**
* Call and SMS activities from Zuper Connect will **not** be pushed to HubSpot.
* However, the **Zuper Connect Dialer within HubSpot** will remain active and fully operational.
Uninstall the HubSpot app
Once the app is inactive, click Uninstall App (the red link below the Activate button).

In the confirmation dialog, review the warning and click **Uninstall App** again to confirm.
## HubSpot Sync History
Customers who use the HubSpot integration to create jobs from Zuper to HubSpot sometimes encounter errors. The Sync history feature allows you to troubleshoot these issues.
To help troubleshoot Zuper-HubSpot sync issues, Zuper provides a sync history log of the Jobs and Projects module that tracks data transfers between the two systems Jobs and Projects. This allows you to determine the root cause of errors, resolve them, and resync for smooth integration.
## Sync History
1. Select the “Settings” module from the left navigation menu. Under the "**Other Settings**," select the "**Sync Activity**."

2. The "**Sync History**" list page appears.
2.1. Sync UID - The unique ID identifying the sync between Zuper and HubSpot
2.2. Module Name - The module's name where the sync happened.
2.3. Record ID/Name - The exact module record ID or Name with the hyperlink.
2.4. Application Name - The name of the integrated application.
2.5. Type of Sync—The sync type of the integration can be actions such as Create, Update, and Delete.
2.6. Status - The sync status is shown - Started, Success, or Error status is displayed.
Click a record ID/name to view details. The current sync status of the HubSpot integration and the destination record ID are displayed.

3. The sync will happen and be completed in a few seconds. The sync has been successfully completed. To acknowledge and dismiss the error, click the "**Acknowledge**" button.

We developed the HubSpot Sync History feature to give our customers clear visibility into their integration processes. By tracking sync activities and highlighting any errors, this tool helps you quickly identify issues
## Troubleshooting
Use this section when something does not work as expected in your Zuper–HubSpot integration. Each subsection covers a specific area where issues commonly occur.
### Sync history errors
The **Sync History** log is your first stop when data does not move correctly between Zuper and HubSpot. It records every sync attempt — successful or failed — so you can find and fix problems quickly.
**Navigation**: *Settings* → *App Store* → *HubSpot* → *Sync History*
#### How to read sync history
1. Go to **Settings** and select **App Store**.
2. Select **HubSpot** from the list of installed integrations.
3. Select the **Sync History** tab.
4. Review the list of sync events. Each row shows:
* **Date and time** of the sync attempt
* **Record type** — for example, Job, Contact, or Note
* **Direction** — Zuper to HubSpot, or HubSpot to Zuper
* **Status** — Success or Failed
* **Error message** (visible for failed records)
5. Select a failed row to expand it and view the full error detail.
> [!NOTE]
>
> Sync History retains records for the last 30 days. If you need older records, export the data before they expire.
#### Common sync errors and fixes
**Error: "Invalid API key"**
The Zuper API key entered during setup has expired or was deleted.
1. Go to **Settings** → **Account Settings** → **API Keys**.
2. Generate a new API key.
3. Go to **Settings** → **App Store** → **HubSpot** → **Update HubSpot Settings**.
4. Enter the new key in the **Zuper API Key** field.
5. Select **Update**.
**Error: "Contact not found"**
The contact in HubSpot does not have an email address that matches any customer in Zuper.
1. Open the HubSpot contact record.
2. Confirm that an email address is present.
3. Open the matching customer record in Zuper.
4. Confirm that the same email address is entered.
5. Trigger a new sync by updating the job status in Zuper.
**Error: "Field mapping failed"**
A custom field name in HubSpot does not match what is entered in the **HubSpot to Custom Fields Mapping** setting in Zuper.
1. Log in to HubSpot and go to **Settings** → **Tickets** → **Manage Ticket Properties**.
2. Locate the property with the error.
3. Select the property and copy the value from the **Internal Name** field.
4. In Zuper, go to **Settings** → **App Store** → **HubSpot** → **Update HubSpot Settings**.
5. Paste the correct internal name into the **HubSpot to Custom Fields Mapping** field.
6. Select **Update**.
> [!WARNING]
>
> Field names are case-sensitive. "fieldVisitStatus" and "fieldvisitstatus" are treated as different values. Always copy the internal name directly from HubSpot to avoid mismatches.
**Error: "Sync disabled"**
The **Sync Zuper Status Updates** or **Sync Zuper Job Notes** toggle is set to **No** in your integration settings.
1. Go to **Settings** → **App Store** → **HubSpot** → **Update HubSpot Settings**.
2. Set **Sync Zuper Status Updates** to **Yes**.
3. Set **Sync Zuper Job Notes** to **Yes** if you also want notes to sync.
4. Select **Update**.
If the issue continues, contact [Support](mailto:support@zuper.co).
### HubSpot action logs vs. the notification panel
Zuper and HubSpot each provide a way to track activity. Understanding the difference helps you know where to look when something goes wrong.
| | HubSpot action logs | Zuper notification panel |
| - | - | - |
| **What it shows** | Actions triggered by HubSpot workflows — for example, "Create Zuper Job" or "Update Job Status" | Real-time alerts about job updates, status changes, and sync events inside Zuper |
| **Where to find it** | HubSpot → **Automation** → **Workflows** → select a workflow → **History** tab | Zuper → bell icon (top right of any page) |
| **Best used for** | Diagnosing why a HubSpot workflow did not fire or sent incorrect data to Zuper | Checking whether a Zuper event — such as a status change — was received and processed |
| **Level of detail** | Shows each enrolled record, the action taken, and success or error status | Shows a summary notification per event — no step-by-step breakdown |
#### When to use HubSpot action logs
Use HubSpot action logs when:
* A job was not created in Zuper after a HubSpot ticket or deal was updated
* A workflow action ran but sent incorrect field values to Zuper
* You need to check whether a specific contact or deal was enrolled in a workflow
**To access HubSpot action logs:**
1. Log in to HubSpot.
2. Go to **Automation** → **Workflows**.
3. Select the workflow you want to review.
4. Select the **History** tab.
5. Filter by **Status** — select **Failed** to focus on errors.
6. Select a record row to view the step-by-step action log and error details.
#### When to use the Zuper notification panel
Use the Zuper notification panel when:
* You want to confirm that a job status update was sent from Zuper to HubSpot
* You are checking whether a note or attachment sync was triggered
* You need a quick summary of recent activity without going into the Sync History log
**To access the Zuper notification panel:**
1. Log in to Zuper.
2. Select the bell icon in the top-right corner of any page.
3. Review the list of recent notifications.
4. Select a notification to go directly to the related job or record.
> [!NOTE]
>
> The notification panel shows activity for the logged-in user only. To investigate activity for another team member, ask them to check their own panel. For a full cross-user view, use the **Sync History** log instead.
If the issue continues, contact [Support](mailto:support@zuper.co).
### App Cards configuration for job display
HubSpot App Cards let you view Zuper job details — including the Job Gallery — directly inside a HubSpot Deal or Ticket. If jobs are not displaying correctly in the App Card, use the steps below to diagnose and fix the issue.
#### Jobs do not appear in the Zuper widget
**Symptom:** The Zuper widget is visible in the HubSpot sidebar, but no jobs are listed.
**Possible causes and fixes:**
* **The integration is inactive.** Go to **Settings** → **App Store** → **HubSpot** in Zuper and confirm the integration status shows **Active**.
* **No jobs are linked to this Deal or Ticket.** Select **Create Job** in the Zuper widget to create the first job for this record.
* **The contact email does not match.** Zuper matches contacts by email address. Confirm the email on the HubSpot contact record matches the customer email in Zuper.
#### The Job Gallery card is missing from the Deal or Ticket page
**Symptom:** The Zuper Job Gallery App Card does not appear on the HubSpot Deal or Ticket details page.
**Fix:**
1. Open the HubSpot **Deals** or **Tickets** page.
2. Select **Customize** **Cards** (found in the page header or layout settings).
3. Select the view you use for that record type.
4. Select **Add Cards**.
5. In the **Add middle column cards** panel, go to **Apps** and select the **Zuper Gallery** checkbox.
6. Select **Save and Exit**.
> [!NOTE]
>
> The **+** button to add a new tab is only available on HubSpot Enterprise plans. On other plans, add the Zuper Gallery card to an existing tab.
#### The Job Gallery loads but shows no images or videos
**Symptom:** The Zuper Gallery card appears in HubSpot, but it is empty even though photos or videos exist on the job in Zuper.
**Possible causes and fixes:**
* **Media was not attached to the job in Zuper.** Open the job in Zuper and confirm that photos or videos are present in the **Checklists**, **Notes**, or **Attachments** sections.
* **The job is not linked to the HubSpot Deal or Ticket.** In the Zuper widget inside HubSpot, confirm the job appears in the job list. If it does not, create a new job or link the existing job to the Deal or Ticket.
* **The App Card layout was not saved correctly.** Repeat the steps under "The Job Gallery card is missing" above to re-add and save the card.
#### Job status updates are not showing in HubSpot after the job changes in Zuper
**Symptom:** The job status changes in Zuper — for example, from **Scheduled** to **In Progress** — but the HubSpot ticket or deal property does not update.
1. Confirm that **Sync Zuper Status Updates** is set to **Yes** in your integration settings (see [Sync history errors](#sync-history-errors) above).
2. Confirm that the **HubSpot Status Field Name** in your integration settings matches the **Internal Name** of the status property in HubSpot.
3. Check the **Sync History** log for any failed events related to this job.
4. If the field name is incorrect, update it and select **Update** to save.
If the issue continues, contact [Support](mailto:support@zuper.co).
***
## Troubleshooting
### Workflow executes successfully but no Zuper record is created
A sample scenario: A 200 response from a HubSpot workflow action confirms that Zuper received the request — it does not confirm that the record was created. If your workflow returns success but no job, project, or customer appears in Zuper, work through the following checks.
> [accordion] Check that all mandatory fields are forward-mapped
>
> Every mandatory field in the target Zuper module must have a **Forward** or **Bidirectional** sync direction in the field mapping configuration. A field set to **Reverse only** (Zuper → HubSpot) will silently block record creation even when the workflow executes without error.
>
> Common mandatory fields for job creation:
>
> * **Job Category** — no default HubSpot equivalent; must be explicitly mapped
> * **Job Title**
> * **Due Date**
>
> To review your mapping: go to **App Store → HubSpot → Configure Settings → Field Mapping** and confirm sync direction for each mandatory field.
>
> > [!WARNING]
> >
> > If any mandatory field is unmapped or reverse-only, Zuper will return a 200 response to HubSpot but will not create the record. No error appears in the HubSpot workflow log.
> [accordion] Verify custom field names are exact matches
>
> Custom fields synced via the **HubSpot to Custom Fields Mapping** section must use the exact API field name from both HubSpot and Zuper. Names are case-sensitive. A mismatch will result in the field being silently skipped — the job will be created but the custom field will not be populated.
>
> To find the correct API name in HubSpot: go to **Settings → Properties → \[Object]** → locate the field → copy the value shown under **Internal name**.
> [accordion] Re-test with a controlled deal or ticket
>
> After updating any mapping, re-enroll a single test deal or ticket in the workflow. Confirm in Zuper that:
>
> * The record was created
> * All mapped standard fields are populated correctly
> * All mapped custom fields are populated correctly
>
> Do not bulk re-enroll until the single-record test passes.
> [accordion] Check that only one workflow is active per Zuper module
>
> Running more than one active HubSpot workflow that pushes to the same Zuper module (for example, two deal-based workflows both pushing to Jobs) can cause conflicts and unpredictable sync behavior. Ensure only one workflow is active per Zuper module at any time.
## FAQs
> [accordion] How long does it take for a Zuper job update to appear in HubSpot?
>
> Updates sync in near real time — typically within a few seconds of the change in Zuper. If an update does not appear after a few minutes, check the **Sync History** log for errors.
> [accordion] Can I sync custom fields from HubSpot to Zuper?
>
> Yes. Enter the HubSpot internal field name and the corresponding Zuper custom field name in the **HubSpot to Custom Fields Mapping** setting, separated by a comma. Both fields must exist before you set up the mapping.
> [accordion] Why does my HubSpot workflow say the "Create Zuper Job" action failed?
>
> This usually means a mandatory field — such as **Job Category** or **Scheduled Date** — was not included in the workflow action. Open the workflow in HubSpot, review the **History** tab for the failed record, and check which field caused the error. Update the workflow action to include all required fields.
> [accordion] What happens to my synced data if I uninstall the HubSpot integration?
>
> All data already synced between Zuper and HubSpot is retained in both systems. New changes made after uninstalling will no longer sync. You can reinstall the integration at any time to resume syncing.
> [accordion] The Zuper widget shows a job, but the HubSpot Deal status has not changed. What should I check?
>
> Start with three checks. First, confirm **Sync Zuper Status Updates** is set to **Yes** in your integration settings. Second, confirm the **HubSpot Status Field Name** matches the property internal name in HubSpot. Third, review the **Sync History** log for a failed event tied to that job.
>
> If the issue continues, contact [Support](mailto:support@zuper.co).
# Google Calendar
Source: https://docs.zuper.co/Integrations/Calendar/Google_Calendar
With our Zuper-Google Calendar integration, the user can install the Google Calendar from our Zuper store. Then, after installation, whenever jobs are created and scheduled for a particular date, this vital job information will be created and synced as an event from Zuper on the Google calendar for customers and field executives.
## **Pre-Requisites:**
API Keys: Click [here](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys) to know how to create and use API keys.
## Installation & How to use
1. Open a new tab in your browser and once you are logged in to your Zuper Account, click your Profile Picture on the top right corner of the screen and click “**App Store**.”

2. You will be redirected to the “**App Store**.” Click on “**Calendar**” under “**Browse by Category**” on your left and click “**Google Calendar**.”

3. Click on the “**Install Google Calendar**” button. Enter the “**Email ID**” and click on “**Next**.”

4. Enter the email ID and click "**Next**."


4. Mark the check box to proceed with the access and click on the “**Continue**” button.

4. Fill in the mandatory field details below to “**Update Google Calendar Settings**.”
i. Zuper API Key – The copied Zuper API Key.
ii. Calendar Name – Enter the Calendar Name for sync.
> [!NOTE]
>
> **Note**: The Calendar ID should be used to integrate the Primary calendar. The calendar name should be used to integrate the Secondary calendar. You can use either the primary calendar or the secondary calendar based on the scenario.
iii. Use Default Calendar Reminders – Choose the option “**Yes**.”
iv. Send Invite to all Assigned Users – Choose the option “**Yes**.”
v. Send Invite to Customers – Choose the option “**Yes**.”
Select the “**Update**” button to start the synchronization between Zuper and Google Calendar, and if you need any assistance, tap on the “**Need Support**” option.

7. Based on the settings saved, the Job details get synced on the Google Calendar as an event.

Follow these steps to get your Google Calendar ID:
* Go to your Google Calendar.
* In the Google Calendar interface, locate the "**My calendars**" area on the left.
* Hover over the calendar you need and click the downward arrow.
* A menu will appear. Click "**Settings & Sharing**".

8. Scroll down to the next page and under the “**Integrate calendar**” section, find the "**Calendar ID**."

> [!NOTE]
>
> **Note**: Please ensure the Google Account you have to connect during the installation is the same as the calendar to which you are connecting.
## Uninstall
1. Open a new tab in your browser and once you are logged in to your Zuper Account, click your Profile Picture on the top right corner of the screen and click “**App Store**.”

2. You will be redirected to the “**App Store**.” Click “**Calendar**” under “**Browse by Category**” on your left and click “**Google Calendar**.”

3. Click the “**Uninstall App**” button.

4. The uninstall is successful.

The job data flow happens from Zuper to Google Calendar in a one-directional flow. Thus, with the Zuper – Google Calendar integration, users can easily schedule job updates as events.
# Slack
Source: https://docs.zuper.co/Integrations/Collaboration/Slack
With our new Slack Integration, we have made it easy to connect your Slack workspace to Zuper and enable your team to receive all updates, from timesheets to jobs, in your preferred channel. You can also access the Zuper dashboard, schedule jobs, and add notes without needing to switch tabs.
## How to connect your Slack Workspace to Zuper?
1. Once you are logged in to your Zuper Account, click on your Profile Picture on the top right corner of the screen & click on “**App Store**.”

2. Under the “**Browse by Category**,” select the “**Collaboration**” option and choose “**Slack**.”

3. Click on the “**Install Slack**” button.

4. You will be redirected to Slack, where you can authorize Zuper to connect to your Slack workspace. Choose the channel to which you would like Zuper to send notification updates under “**Where should Zuper post**?” and click on the “**Allow**” button.

5. Update Slack Settings by configuring the following fields:
a. Send Timesheet Notifications For (Mandatory Field) – Select the timesheet event for which notification will be sent on the Slack channel.
b. Send Job Status Update Notifications (Mandatory Field) – Select “**Yes**” to enable the job status update notifications and “**No**” to disable job status update notifications.
c. Send Job Status Notes Notifications (Mandatory Field) – Select “**Yes**” to enable the job status notes notifications and “**No**” to disable the job status notes notifications. The Job notes notification will also include the attachments that the user adds to the notes
d. Send Job Reschedule Notifications (Mandatory Field) – Select “**Yes**” to enable the Job reschedule notifications and “**No**” to disable Job reschedule notifications.
e. Zuper API Key (Mandatory Field) – Enter the Zuper API key (Click [here](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys): How to generate Zuper API Key).

Select the “**Update**” button to complete the integration of Zuper with Slack.
## How does Zuper – Slack Integration work?
1. Open the Zuper-linked Slack channel. You can view the notification updates in the selected channel based on the configuration settings.

2. The Job-related statistics are shown, and you can select the “**Add Job Note**” button to create job notes on the Slack channel, which will be reflected in the Zuper job notes section under the jobs module.

3. Enter the required notes on the “**Add Notes to Zuper**” pop-up and select the“**Add Note**” option.

> [!NOTE]
>
> **Note**: Similarly, users can receive notifications for timesheet updates and job status changes.
## How to create a new job within Slack?
The back-office team does not need to switch between apps; they can create a new job directly within Slack, and it will be visible in the Zuper Jobs module.
You can select the “**Create New Job**” button to create a new job from the Slack channel, which will be reflected in Zuper.

2. The Job created from Slack gets reflected in the Zuper Jobs module. Zuper-Slack integration is bi-directional, and data gets updated on both apps whenever a new addition/modification happens.

In most cases, the back-office team needs information on the job status and relevant statistics. With this significant Zuper-Slack integration, users can get timely notifications and take swift action.
# Dear
Source: https://docs.zuper.co/Integrations/Commerce/Dear
With the help of our Zuper-DEAR Integration, the sales order created by DEAR will be produced as a new job in Zuper, and the stock gets made/updated from the DEAR e-commerce platform to Zuper. Majorly, Customers, Jobs, and Products get synced in Zuper-DEAR integration.
## How to connect your DEAR with Zuper?
1. Open a new tab in your browser and once you are logged in to your Zuper Account, click on your Profile Picture on the top right corner of the screen & click on “**App Store**.”

2. Under the “**Browse by Category**,” select the “**Commerce**” option and choose “**DEAR**.”

3. Click the “**Install DEAR**” button.

4. Update DEAR Settings by configuring the following details:\
a. **Zuper API Key (Mandatory Field)** – Enter the Zuper API key [(Click here: How to generate Zuper API Key)](https://docs.zuper.co/Settings/Developer_Hub/API_Keys).
b. **DEAR Account ID (Mandatory Field)** – Enter the account ID of the DEAR. (You can get it from the DEAR account).
c. **DEAR API Key (Mandatory Field)** – Enter the API Key of the DEAR. (You can get it from the DEAR account).
d. \*\*Default Job Category in Zuper (Mandatory Field) \*\* – Enter the default job category in Zuper (In case of any assistance, contact Zuper’s support team: [email: support@zuper.co](mailto:support@zuper.co)).
e. **Default Due Date in Zuper (Mandatory Field)** – Enter the default due date in Zuper (A numerical number represents the days).
f. \*\*DEAR Field for Due Date (Mandatory Field) \*\*- Enter the field name of the DEAR for which the Due Date is synced.
g. **DEAR Product Categories to Consider for Sync (Mandatory Field)** – Enter the default Product Categories for Sync in Zuper based upon the product created on the DEAR. (In case of assistance, contact Zuper’s support team: [email: support@zuper.co](mailto:support@zuper.co)).
> [!NOTE]
>
> **Note:** For the Sale order, conversion from DEAR should have at least one product categorized and defined under the above field to be converted as a Zuper job.
h. **Sync Product Location During (Mandatory Field)** – Specify the Product location sync point. This can be either **Pick, Pack, or Ship.**
i. ******DEAR Category Field Name – AdditionalAttribute 1 up to 10, Custom fields from the DEAR are captured here as AdditionalAttribute, ranging from 1 to 10.******
j. **DEAR Sale Order** – Zuper Job Category Mapping – Based on the Attribute set above, the DEAR Sale Order and Zuper Job Category Mapping happen. For instance, "**Repair onsite**" in DEAR is known as "**Maintenance**" in Zuper.
Select the “**Update**” button to complete the integration of Zuper with DEAR.

## **How does Zuper – DEAR Integration work?**
Zuper-DEAR integration is bi-directional; whenever the sale order is created and authorized by DEAR, a new job will be triggered in Zuper. The **new quantity** of the stocks updated in the DEAR integration will get updated as an **Available Quantity** in Zuper.
For the products in **DEAR**, they are captured as “**Parts and Services**” in Zuper.
1. Select the “**Sales**” module from the left panel of DEAR and create a fresh sales order by entering the Customer details, accounting details, and shipping details, and save the draft.

2. Now add the necessary products and required details to the Quote. Once the quote is authorized and moves to the Order stage, select the “**Authorize**” button on “**DEAR**” to trigger the Job in Zuper.

**Zuper:**
The new Job is created from a **DEAR sale**, and you can see the **DEAR Sale ID** on Zuper.

3. You can modify the quantity on **DEAR**, which will be updated on Zuper.

Zuper:

A new set of enhancements has been added to Zuper-DEAR Integration.
1. Select the “**Sales**” module from the left panel of **DEAR**. With the new update, you can now edit the product's location as part of Pick, Pack, or Ship actions, which will trigger a predefined webhook (installed during setup), and the location will be updated on the Zuper Job.

2. Now, add the “**Manual Sync**” option available in Zuper whenever a sales order gets updated in DEAR. This helps to sync the **Parts and Services, Service Address, and Due date in Zuper.**
With the new update, the “**Undo**” option in the DEAR integration sale order helps delete the associated work orders for Zuper.

DEAR is an inventory master system that serves the users to manage the inventory and stocks. With Zuper integration, DEAR’s customers can automatically manage their field technicians to fulfill orders.
# Mailchimp
Source: https://docs.zuper.co/Integrations/Marketing/Mailchimp
The Mailchimp integration with Zuper enables users to automatically build and update a customer mailing list in Mailchimp using customer information from the Zuper platform. This integration streamlines marketing campaign execution by syncing customer data uni-directionally from Zuper to Mailchimp.
## **Prerequisites**
* Ensure you have API keys from Stripe App and Zuper app.
## Installing Mailchimp in Zuper
Follow these steps to connect your Mailchimp account with Zuper:
1. Log in to your Zuper account. Click your profile picture in the top-right corner and select **App Store**.

2. Under the “**Browse by Category**,” select the “**Marketing & Survey**” option and choose “**Mailchimp**.”

3. Click the “**Install Mailchimp**” button.

4. Open a new browser tab and log in to your Mailchimp account.
Collect the following information:
* **Mailchimp API Key**:
* Navigate to **Account & Billing** > **Extras** > **API Keys**.
* Copy your API key. If none exists, click **Create A Key** to generate one.

* **Audience ID**:
* Navigate to **Audience** > **Settings**.
* Copy the **Audience ID** from the settings page.

* **Server Prefix**:
* From your Mailchimp browser URL (e.g., [https://us87.admin.mailchimp.com/](https://us87.admin.mailchimp.com/)), copy the server prefix (Here us87 is the prefix).

**Note**: Keep both Zuper and Mailchimp tabs open to switch between them during setup.
5. In Zuper’s Mailchimp integration settings, enter the following:
* **Mailchimp API Key** (Mandatory): Paste the API key from step 4.
* **Audience List** (Mandatory): Paste the Audience ID from step 4.
* **Server Prefix** (Mandatory): Paste the server prefix from step 4.
* **Zuper API Key** (Mandatory): Enter your Zuper API key. Refer to [How to Generate a Zuper API Key](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys) for guidance.

Click **Update** to complete the integration.
## How the Zuper-Mailchimp Integration Works
The integration automatically syncs customer data from Zuper to Mailchimp, creating or updating audience records for marketing campaigns.
1. **Customer Data Sync**:
* When a new customer is created or an existing customer is edited in Zuper, their information is synced to Mailchimp as an audience member.
- **Navigation in Zuper**: *Customers > New Customer or Edit Customer.*
> [!WARNING]
>
> **Important**: The customer’s email address is mandatory in Zuper for syncing to Mailchimp. If the email is missing during customer creation, it must be added later. Editing an email in Zuper creates a new audience member in Mailchimp, rather than updating the existing one.
2. **Viewing Synced Data in Mailchimp**:
* In Mailchimp, navigate to **Audience** > **Manage Contacts**.
* View the synced customer data (from Zuper) listed as an audience member in Mailchimp.

* Click an email address to view detailed profile information under **Profile Information**.

## Uninstalling Mailchimp for Zuper
1. Log in to your Zuper account. Click your profile picture in the top-right corner and select **App Store**.

2. Under the “**Browse by Category**,” select the “**Marketing & Survey**” option and choose “**Mailchimp**.”

3. Click "**Uninstall App**."

4. The Mailchimp app will be uninstalled successfully.

For marketing campaigns, email IDs and customer details are essential. With the unidirectional Zuper to Mailchimp data flow, you can add your audience list to Mailchimp. The database will sync and get automatically updated every time new customers are created on Zuper.
# EagleView
Source: https://docs.zuper.co/Integrations/Measurements_and_estimations/EagleView
## Overview
The Zuper-EagleView integration lets roofing teams handle property measurements easily—all in Zuper.
Key features:
✅ Initiate new measurements seamlessly from within a Zuper job.
✅ Integrate pre-existing EagleView projects with Zuper jobs effortlessly.
✅ Easily access, modify, and export measurement information.
✅ Monitor all measurements centrally in Zuper’s Measurements Tab.
This seamless integration boosts precision, transparency, and productivity throughout your roofing operations—from initial assessments to project completion.
## Plan availability
* **Zuper**: The EagleView integration is available only on **Core** and **Premium** plans.
## **Zuper Prerequisites**
* You must have admin access or permissions to edit custom roles and job settings.
* Ensure your settings workspace is set up with the Jobs module enabled.
* For integrations, you'll need credentials from the external provider.
* The customers with Core and Premium plans on Zuper will have access to EagleView.
## **Custom roles**
You need to enable the relevant permission in a custom role to allow users to order measurements from external providers.
1. Navigate to **Users & Teams > Custom Roles**.
2. Click **New Role** or edit an existing one.
3. Enter a **Role Name** (e.g., "Roofing Technician") and **Description**.
4. Select the Jobs module from the List of Modules under Permissions.
5. Search for Order Measurements from External Provider in the Jobs Permissions section.
6. Toggle the switch to **On** (it will turn blue).
7. Review and enable other related permissions: Click **Save Role** to apply changes.
8. Assign this role to relevant users or teams.

Once set, users with this role can initiate measurement orders from job details.
## **Managing measurement tokens**
Measurement tokens define the specific data points (e.g., lengths, areas) that Zuper pulls from external providers. You can enable or disable these to tailor what appears in your Measurement object in the job details page.
Read more from [**here**](https://docs.zuper.co/Settings/Modules/Jobs/Configuring_Measurements)

## **Connecting to measurement providers**
Zuper supports integrations with leading roof measurement services to fetch data, including aerial-derived roof specs, and high-precision reports.
Read more from [**here**](https://docs.zuper.co/Settings/Modules/Jobs/Configuring_Measurements#connecting-to-measurement-providers)
## How to install the EagleView integration?
1. Log in to your Zuper app, click the “**User**” icon, and tap on the “**App Store**”.

2. Under the “**Browse by Category**,” select the “**Measurements & Estimations**” option and choose “**EagleView**.”

3. Authenticate to login to EagleView. Enter the User ID and Password. Click “**Sign in**”

4. On the EagleView app page, click “**Install EagleView**.”

4. You will be redirected to EagleView for authentication. Click “Allow” to authenticate.
⚠️ Note: Only EagleView Administrators can complete the authentication.
### **How to generate a Zuper API Key**
You need a Zuper API Key to complete EagleView setup:
Zuper API Keys are essential for securely authenticating and authorizing access to the Zuper API. These keys enable seamless integration with Zuper’s services, allowing developers to build robust applications that leverage real-time data and functionality. Click [here](https://docs.zuper.co/Settings/Developer_Hub/API_Keys) to know more.
**Navigation**: *Settings -> Developer Hub -> API Keys*
Enter your Zuper API Key.
Click “**Update**.”

Your EagleView integration is now active and ready to use!
## How to Order a new EagleView measurement?
* From any job in Zuper, you can request a new measurement:
* Open the Job Details page. Go to the Measurement tab.
* Click + New Measurement (top-right) and select “**EagleView**” from the context menu.

> [!WARNING]
>
> **Alert: A credit card is required before placing an order**
>
> A valid credit card must be on file in your EagleView account to submit a measurement order. To add a card, log in to EagleView and navigate to **Billing → Payment Methods**.
After reviewing all fields, click **Place Order**. The new measurement request will appear in the Measurement tab as **In Progress**.
### **Order new measurement**
Fill in the following details:
* **Property Type (Mandatory) –** The user must select whether the property is **Residential** or **Commercial**.
* **Measurement Type (Mandatory)** - The user must choose the type of measurement they want to order.
* **Deliverable Type (Mandatory)** – The user must select a delivery option. The delivery types displayed are dependent on the **Measurement Type** selected.
* **Measurement Instruction (Mandatory)** – The user must select a measurement instruction. The available instructions shown will depend on the **Measurement Type** selected.
* **Special Instructions** – Enter the key instructions for EagleView and click **Next**.

**Additional Information**
* Send a copy of the report to – Users can choose to receive a**copy of the report** at additional email addresses.
* Promo Code –**If the user has a valid promo code** , it can be entered in the **Promo Code** field.
* If the job involves an insurance claim, the user can enable the **“This job involves an insurance claim”** toggle.\
Enabling this will display additional fields where the user can enter **Claim Number, Claim Information, PO Number, Date of Loss, and CAT ID**.

* After reviewing all fields, click **Place Order**. The new measurement request will appear in the Measurement tab as **In Progress**.

## Select an existing project
If you’ve already created an EagleView project for the property, you can link it instead of starting fresh:
* The service address auto-fills in the search bar.
* EagleView displays all matching measurements for that address.
* Select the desired measurement.
* It instantly syncs with the Zuper job.


### Viewing synced measurements
* When EagleView measurements are available, it automatically syncs to Zuper:
* Once measurements are synced back from EagleView, you can view and manage them in Zuper.
**Viewing synced measurements**
* Go to the **Measurement** tab.
* Click the **Completed Measurement Card**.
* Review synced values mapped to Zuper’s standard measurement tokens.

## Manually sync measurement data
When you place a measurement order, EagleView processes the request and automatically sends the data back to Zuper. However, if your order status shows **Completed** in EagleView but the measurement data has not yet synced in Zuper, you can trigger a manual sync to pull the measurement data.
1. Locate the EagleView measurement card you want to sync.
2. Select the context menu icon (three-dot icon) on the right side of the measurement card.
3. Select **Sync from EagleView** from the menu.


## **Removing measurements**
* Click the **⋮ Menu** → **Remove**.
* Confirm removal.

* Measurement is unlinked from the job, and the action is logged in **Job Activity**.

* Click the “**Gallery**” tab to view all the measurement pictures.

## How to uninstall EagleView from Zuper?
1. Click on your Profile Picture in the top right corner of the screen and select the “**App Store**.”

2. Under the “**Browse by Category**,” select the “**Measurements and Estimations**” option and choose “**EagleView**.”

3. Click the “**Uninstall**” button.

4. EagleView is uninstalled successfully.

## FAQs
> [accordion] Who can install and configure the EagleView integration in Zuper?
>
> Only Zuper users with **Admin** privileges can install apps from the App Store. Additionally, the user must be an **Administrator** in EagleView to authenticate during setup.
> [accordion] What happens if I enter the wrong API key or email during configuration?
>
> The integration will fail to sync data. Go back to **Settings → App Store → EagleView → Configure Settings** to correct the details and click **Save**. You will receive an error to recapture the measurements.
> [accordion] Can I link multiple EagleView orders to a single Zuper job?
>
> Yes, you can link multiple EagleView measurement projects to a single Zuper job.
> [accordion] Why don't I see my existing EagleView project when searching?
>
> Ensure the following:
>
> * The service address in Zuper matches the address in EagleView (including unit/apt #).
> * You are logged into EagleView with an account that has access to that project.
> [accordion] Are edits made in Zuper synced back to EagleView?
>
> No. Edits in Zuper are local only and do not update the original EagleView project.
> [accordion] What if a measurement stays 'In Progress' for too long?
>
> Reach out to **EagleView Support** directly to follow up on the order status.
> [accordion] Can Field Executives order measurements, or only admins?
>
> Admins and users with **custom role access** can order measurements. See [Custom Roles](#custom-roles) for steps to enable the required permission.
> [accordion] Will removing a measurement in Zuper remove it in EagleView?
>
> No. Removing a measurement in Zuper only unlinks it from the job. The project remains intact in EagleView and can be re-linked later if needed.
> [accordion] Why is a credit card required, and how do I add one?
>
> EagleView requires a valid credit card on file before a measurement order can be submitted.
>
> To add a card, log in to your EagleView account and navigate to **Billing → Payment Methods**.
# GAF Quick Measure
Source: https://docs.zuper.co/Integrations/Measurements_and_estimations/GAF
## Overview
The Zuper-GAF QuickMeasure integration allows roofing teams to order and manage roof measurement reports directly within Zuper. Key features include:
* Ordering new measurements from a Zuper job.
* Searching and integrating existing GAF QuickMeasure reports with Zuper jobs.
* Viewing, editing, and exporting measurement data.
* Central monitoring of measurements in Zuper's Measurements Tab.
This integration improves accuracy, efficiency, and workflow for roofing professionals.
## **Plan Availability**
* Available on **Zuper Core** and **Premium** plans.
## **Zuper Prerequisites**
* Jobs module activated in the settings.
* Applicable to Zuper Core and Premium plan users.
* The email ID used in Zuper should match the one used for the GAF quick measure to authenticate the account successfully.
## **Managing Measurement Tokens**
Measurement tokens represent specific data points (e.g., roof areas, pitches) imported from providers. Customize by enabling/disabling tokens in the Measurement object within job details. See [Configuring Measurements](https://docs.zuper.co/Settings/Modules/Jobs/Configuring_Measurements) for details.
## **How to Install the GAF QuickMeasure Integration?**
1. Log in to Zuper, click the **User** icon, and select **App Store**.

2. In **Browse by Category**, navigate to **Measurements & Estimations** > **GAF QuickMeasure**.

3. On the app page, click **Install GAF QuickMeasure**.

**How to Generate a Zuper API Key**
You need a Zuper API Key to complete GAF QuickMeasure setup:
Zuper API Keys are essential for securely authenticating and authorizing access to the Zuper API. These keys enable seamless integration with Zuper's services, allowing developers to build robust applications that leverage real-time data and functionality. Click [here](https://docs.zuper.co/Settings/Developer_Hub/API_Keys) to know more.
* Navigation: **Settings -> Developer Hub -> API Keys**
* Enter your Zuper API Key.
* Click "**Update**" to activate GAF QuickMeasure.
4. Enter the Zuper API Key.
> [!NOTE]
>
> Note: The email ID used in Zuper should match the one used for the GAF QuickMeasure to authenticate the account successfully.

## **Order a New GAF QuickMeasure Measurement**
1. Access the **Job Details** page. Select the **Measurements** tab. Click **+ New Measurement** and choose GAF **QuickMeasure**.

## **Order New Measurement Fields**
* **Property Type (Mandatory)**: Select from options: Single Family, Multiple Family, and Commercial.
* **What structures would you like included in your report? (Mandatory)**: Choose from Primary Structure Only, All Structures on Parcel, or All Structures except Primary Structure – **Applicable only for Single Family option.**
* **Include applicable codes and weather details in your order** – Add relevant compliance and historical data based on your project type:
* For **Single** and **Multiple** projects: Building Codes and Weather History.
* For **Commercial** projects: Design Criteria and Weather History. This ensures your order includes the appropriate regulatory and weather-related information required for your project type.
* **Provide any additional information**: Enter notes or special instructions for the measurement.
* **Email(s) to receive this report**: Add email addresses (separate with commas) to send the report to.
* Click **Place Order** to submit.

## **Select an Existing Project**
* The service address pre-fills in the search bar under the **Search Existing** tab.
* Results show matching GAF QuickMeasure reports for the address.

* Select the desired report to sync it with the Zuper job.
* After creating the measurements, click **+ New Measurement** → **Choose Existing** to manually complete the sync.

## **Viewing Synced Measurements**
* Measurements automatically sync from GAF QuickMeasure.
* Appear in the **Measurements** tab as a **Completed Measurement Card**.

* Inspect values aligned with Zuper's standard measurement tokens.
**View PDF**
* Click "**View In**" to view the measurements in PDFs or as a 3D view.



## **Edit Measurements**
* Click the "**Kebab**" menu to edit the measurements.

* Modify the measurements and click "**Save**."

**Download PDF**
* Click the "**Kebab**" menu to download the PDF.

## Manually sync measurement data
When you place a measurement order, GAF processes the request and automatically sends the data back to Zuper. However, if your order status shows **Completed** in GAF but the measurement data has not yet synced in Zuper, you can trigger a manual sync to pull the measurement data.
1. Locate the GAF measurement card you want to sync.
2. Select the context menu icon (three-dot icon) on the right side of the measurement card.
3. Select **Sync from GAF** from the menu.

**Removing Measurements**
* From the measurement card, click the **⋮ Menu** > **Remove**.
* Confirm the action.

* The measurement is unlinked from the job, with the activity logged in **Job Activity**.

* Images from the measurement can be viewed in the **Gallery** tab
## **Uninstall GAF QuickMeasure from Zuper**
1. Click **Profile Picture** > **App Store**.

2. Go to **Measurements and Estimations** > **GAF QuickMeasure**.

3. Click **Uninstall** **App**.

4. The integration is uninstalled.

## GAF Mobile
Field executives rarely get to plan measurement orders from a desk, most of the need comes up mid-visit. A few situations where that matters:\
* A storm damage inspection turns into an on-the-spot scope conversation, and the report needs to be started before the field executive leaves the property.
* The homeowner points out a detached garage or shed that wasn't part of the original job, changing which structures the order should include.
* A same-day follow-up reveals the original order was never placed, and routing it through the front office would mean a second trip just to submit it.
GAF QuickMeasure is now available directly in the Zuper mobile app, so none of these have to wait. Field executives can place a new measurement order with the same Building Codes and Weather History add-ons available on the web. They can also search for and link an existing GAF QuickMeasure report, or edit synced measurement values, all without routing anything through the front office.
> [!NOTE]
>
> **Note**: Field executives need the appropriate custom role and permission enabled to place or edit orders from mobile.

## **FAQs**
> [accordion] What if the API key or credentials are incorrect?
>
> Syncing will fail. Update your credentials by navigating to **Settings → App Store → GAF QuickMeasure → Configure Settings** and click **Save**.
> [accordion] Can multiple GAF QuickMeasure reports be linked to one Zuper job?
>
> Yes, you can link multiple GAF QuickMeasure reports to a single Zuper job. This is particularly useful for complex roofing projects involving multiple structures.
> [accordion] Why isn't my existing GAF QuickMeasure report appearing in search?
>
> Once a GAF QuickMeasure report has been completed and added to a job, it will no longer appear in search results.
> [accordion] Do changes in Zuper update back to GAF QuickMeasure?
>
> No. Changes made in Zuper do not sync back to GAF QuickMeasure. The integration is one-way — measurement reports and data are imported from GAF QuickMeasure into Zuper only.
> [accordion] How do I add a weather code to a job?
>
> When add-ons are selected, the related criteria and weather code details sync automatically.
>
> If the sync does not trigger automatically, complete it manually:
>
> 1. After creating the measurement, click **+ New Measurement**.
> 2. Select **Choose Existing**.
> 3. The weather code details will sync to the job.
> [accordion] Can field technicians order measurements?
>
> Yes. Field technicians can order GAF QuickMeasure measurements directly within Zuper, provided they have the appropriate **custom roles and permissions** assigned. See [Custom Roles](#custom-roles) for steps to enable the required permission.
> [accordion] I added the API key but I'm still seeing an error — what should I check?
>
> Verify that the **email address** used in Zuper matches the one registered with your GAF QuickMeasure account exactly. A mismatch between the two will cause authentication to fail even when the API key is correct.
# Hover Mobile
Source: https://docs.zuper.co/Integrations/Measurements_and_estimations/Hover_mobile
## **Overview**
The Zuper Hover integration enables field technicians and users to order professional roof measurements seamlessly, directly from the Zuper mobile app. This enables quick capture of accurate measurements for roofing inspections, estimates, and job planning without manual entry. Once ordered, Hover processes the request, syncs the data back to Zuper, and provides a summary report with key metrics like roof area, ridge lengths, and more.
This mobile integration builds on the web-based setup, allowing on-the-go ordering and real-time viewing of synced measurements. Benefits include:
* Reduced errors in manual data entry.
* Instant access to Hover's 3D models and PDFs.
* Support for both new orders and linking existing Hover projects.
* Visual indicators for manual edits.
> [!NOTE]
>
> **Note:** The integration must be enabled via the Zuper web portal first (see [Zuper Hover Integration (Web)](https://docs.zuper.co/Integrations/Measurements_and_estimations/Zuper_Hover) for setup details).
## **Plan Requirements for Hover Integration**
To use Hover on mobile, ensure your Zuper and Hover subscriptions meet these requirements:
The minimum subscription requirement for Zuper is a **Professional** or **Enterprise** plan. For Hover, the minimum requirement is **Scale** or **Transform**.
## **How to Order a New Hover Measurement on Mobile**
From a job in the Zuper mobile app, add measurements using Hover's professional service.
### **Prerequisites**
* Active job with a service address.
* Hover integration is enabled via the web.
* Sufficient measurement tokens.
**Steps**
1. Open the job in the Zuper Mobile.
2. Tap **+ New Measurement** in the Measurements section.

In the App, you can create a new measurement or search for an existing measurement.
**Create New**: Order a new Hover project.
**Search Existing**: Search by project name, ID, or street address, then select the project
### **Create New Measurement**
1. Select **Create New**.
2. Fill **Primary Information**:
* **Project Name** – Prefilled from the measurement.
* **Deliverable Type**
* **User Assigned** – Users from Hover.
3. Fill **Capturer Information**:
* **Captured By** – The person who captures the property image.
* **Name** – The name of the image capturer.
* **Email** – The Email ID of the capturer.
* **Phone Number** – The Phone number of the capturer.
4. Tap **Place Order**.
5. Once the order is placed, the field technician will receive the success message.


### **Select an Existing Project**
1. Select **Search Existing.**
2. Search by project name, ID, or street address in the search bar.
3. Select the project from the results.
Tap 'Add' to sync measurements and results automatically.

### **Viewing Synced Measurements**
Once synced, view summaries directly on your mobile device, with options to search and filter tokens.
**Steps**
1. In the job, go to the **Measurements** section.
2. Tap the synced measurement.
3. In **Measurement Summary**:
* Use the search bar to filter tokens.
* View **Measurement Categories**.
* Check for manual update indicators: An orange indicator shows the manually updated values.

### **Editing Synced Measurements**
Edit for accuracy post-sync; changes are flagged as manual updates.
**Steps**
1. In **Measurement Summary**, tap the pencil icon next to the **Measurement Category**.
2. In **Edit Measurements**, update fields.
3. Tap **Save**.

> [!NOTE]
>
> **Note**: Manual edits are flagged with orange dots (•) in the summary and contribute to the manual update count. They don't affect the original Hover data.

**Downloading Files**
1. In **Measurement Summary**, click the Ellipsis icon (three vertical dots).
2. Select View PDF and save to files.

**Removing Measurements**
Remove synced measurements from the job without affecting the original Hover project.
**Steps**
1. In the **Measurements** section, click the Ellipsis icon (three vertical dots) and select Remove.
2. On the confirmation dialog box, click **Yes** to remove the measurement from the job only.


## **FAQs**
> [accordion] How long does Hover syncing take on mobile?
>
> Sync duration varies depending on the size and complexity of the measurement. Check the **status badge** on the measurement card for real-time progress.
> [accordion] Why are some values shown in orange in the summary?
>
> Orange indicators — dots (•) and banners — flag values that have been manually edited after the initial sync. For example, you may see a banner stating **"3 value(s) have been manually updated"** to indicate the number of overridden fields.
> [accordion] How does token search work?
>
> Type a keyword in the search bar to filter the measurement summary and display only relevant metrics. For example, searching **"Total Valleys Length"** will surface that token and hide unrelated values.
> [accordion] Does mobile support manual entry alongside Hover?
>
> Yes. In the **New Measurement** modal, select **Manual Entry** to input measurement values directly without placing a Hover order. Both methods can be used on the same job.
> [accordion] How do I troubleshoot a failed order?
>
> 1. Verify the **service address** in Zuper is complete and accurate — partial or mismatched addresses are the most common cause of failed orders.
> 2. If the order status does not update after correcting the address, contact **Zuper Support** at [support@zuper.co](mailto:support@zuper.co).
>
> For web setup or advanced configuration, refer to the [Zuper Hover Integration (Web)](https://docs.zuper.co/Integrations/Measurements_and_estimations/Zuper_Hover) article.
# RoofScope
Source: https://docs.zuper.co/Integrations/Measurements_and_estimations/RoofScope
## Overview
The Zuper and RoofScope integration enables roofing service teams to manage property measurements seamlessly, all within the Zuper platform. With this integration, you can:
* Order a new measurement directly from a Zuper job.
* Sync existing RoofScope projects to Zuper jobs.
* View, edit, and download measurement data.
* Track all measurements in Zuper’s Measurements Tab.
This integration enhances accuracy, visibility, and efficiency across your roofing workflow from measurement to execution.
## **Plans Applicable**
* You need to have a valid **Growth**, **Advantage**, or **Scale** plan in RoofScope to enable measurements in Zuper.
* The customers with **Core** or **Premium** plans on Zuper will have access to the RoofScope integration.
## **Zuper Prerequisites**
* Users must have the “**Order Measurements from External Provider**” role permission enabled to place measurement orders with RoofScope.
* Ensure your settings workspace is set up with the Jobs module enabled.
* For integrations, you will need an API Key and a Scope Token from RoofScope.

Once set, users with this role can initiate measurement orders from job details.
### **Managing Measurement Tokens**
Measurement tokens define the specific data points (e.g., lengths, areas) that Zuper pulls from external providers. You can enable or disable these to tailor what appears in your Measurement object in the job details page.
Read more [**here**](https://docs.zuper.co/Settings/Modules/Jobs/Configuring_Measurements)
## How to connect the RoofScope Integration?
1. Log in to your Zuper app, click the **User** icon, and tap on the **App Store**.

2. Under the **Browse by Category**, select the **Measurements & Estimations** option and choose **RoofScope**.

3. On the RoofScope app page, click “**Configure Settings**.”

4. Fill in the following details: a. **RoofScope API Key** - To obtain an API key from RoofScope, email your request to [support@myscopetech.com](mailto:support@myscopetech.com). b. **RoofScope Scope Token** – Login to RoofScope. From the top right corner, under “**My Details**,” copy the “**Scope API Token**.”
> [!NOTE]
>
> Note: The RoofScope token is valid for only one year.
c. **How to Generate a Zuper API Key** You need a Zuper API Key to complete RoofScope setup: Zuper API Keys are essential for securely authenticating and authorizing access to the Zuper API. These keys enable seamless integration with Zuper’s services, allowing developers to build robust applications that leverage real-time data and functionality. Click [**here**](https://docs.zuper.co/Settings/Developer_Hub/API_Keys) to know more.
4. **Navigation**: Settings -> Developer Hub -> API Keys
Enter your Zuper API Key.
Click “**Update**” to activate RoofScope.

Your RoofScope integration is now active and ready to use!
## How to Order a New RoofScope Measurement?
* From any job in Zuper, you can request a new measurement:
* Open the Job Details page. Go to the Measurement tab.
* Click + New Measurement and select “**RoofScope**” from the context menu.


### **Order New Measurement**
Fill in the following details:
* **Property Type (Mandatory) –** Choose the applicable property type from the dropdown - Residential or Commercial.
* **Measurement Type (Mandatory)** – Choose the type of measurement from the dropdown – **RoofscopeX**, **RoofScope**,**RoofScope +** , **GutterScope**, and **SidingScope**.
* **Deliverable Options (Mandatory)** – Select the delivery options from the dropdown: **Standard** and **Rush**.
* **Auxiliary Building (Mandatory)** – Enter the number of auxiliary buildings covered by this measurement.
* Additional Note for Technicians – Enter the additional information.
Click “**Next.**”

## Insurance Claim Details
* Claim / Reference Number – Enter the insurance claim number.
* Date of loss – Enter the date of damage.
After reviewing all fields, click **Place Order**.\
The new measurement request will appear in the Measurement tab as '**In Progress**' and will be moved to the '**Completed**' status.


## **Select an Existing Project**
If you’ve already created a RoofScope project for the property, you can link it instead of starting fresh:
* The service address auto-fills in the search bar.
* RoofScope displays all matching measurements for that address.
* Select the desired measurement.
* It instantly syncs with the Zuper job.


## Viewing Synced Measurements
When RoofScope measurements are available, they automatically sync to Zuper.
Once measurements are synced back from RoofScope, you can view and manage them in Zuper.
**Viewing Synced Measurements**
* Go to the **Measurement** tab.
* Click the **Completed Measurement Card**.
* Review synced values mapped to Zuper’s standard measurement tokens.
* Click "**View In**" and choose "**PDF**."

Click the “**Kebab**” menu to “**Edit**” or “**Remove**” the measurement tokens.
### **Edit the synced measurements.**
* Click the **✏️ Edit** icon or open the **⋮ menu → Edit**.
* Make your changes and save.
* Edited fields display an “Edited” label.
* All edits are logged in **Job Activity**.


### **Manually sync measurement data**
When you place a measurement order, RoofScope processes the request and automatically sends the data back to Zuper. However, if your order status shows **Completed** in RoofScope but the measurement data has not yet synced in Zuper, you can trigger a manual sync to pull the measurement data.
1. Locate the RoofScope measurement card you want to sync.
2. Select the context menu icon (three-dot icon) on the right side of the measurement card.
3. Select **Sync from RoofScope** from the menu.

### **Removing Measurements**
* Open the **⋮ Menu** → **Remove**.
* Confirm removal.
* Measurement is unlinked from the job, and the action is logged in **Job Activity**.

* Click the “**Activity**” tab to view all the measurement-related activities.

## How to Uninstall RoofScope from Zuper?
1. Click on your Profile Picture in the top right corner of the screen and select the “**App Store."**

2. Under the “**Browse by Category**,” select the “**Measurements and Estimations**” option and choose “**RoofScope**.”

3. Click the “**Uninstall**” button. The uninstallation is successfully done.

### FAQs
> [accordion] Who can install and configure the RoofScope integration in Zuper?
>
> Only Zuper users with **Admin** privileges can install apps from the App Store. The user must also have a valid **RoofScope API Key** and **RoofScope Scope Token** to authenticate during setup.
> [accordion] How do I get the RoofScope API key?
>
> Email your request to [support@myscopetech.com](mailto:support@myscopetech.com). Once RoofScope provisions the key, add it in Zuper:
>
> **Navigation:** App Store → RoofScope → Configure Settings → RoofScope API Key
> [accordion] How do I get the RoofScope Scope Token?
>
> 1. Log in to your RoofScope account.
> 2. Open **My Details** from the top-right menu.
> 3. Copy the **Scope API Token**.
> 4. Paste it in Zuper under **App Store → RoofScope → Configure Settings → RoofScope Scope Token**.
> [accordion] What is the validity of the RoofScope Scope Token?
>
> The RoofScope Scope Token is valid for **one year**. After it expires, syncing and ordering measurements will fail until you update the token in Zuper.
>
> **Navigation:** App Store → RoofScope → Configure Settings → Update
> [accordion] Do I need a Zuper API key for this integration? How do I generate one?
>
> Yes. A Zuper API key is required to complete the RoofScope integration setup.
>
> 1. Navigate to **Settings → Developer Hub → API Keys**.
> 2. Generate or copy your API key.
> 3. Paste it into the RoofScope configuration screen in the Zuper App Store.
>
> For more details, see [API Keys](https://docs.zuper.co/Settings/Developer_Hub/API_Keys).
> [accordion] Which Zuper plans support the RoofScope integration?
>
> The RoofScope integration is available on **Core** and **Premium** Zuper plans.
> [accordion] Which RoofScope plans are required to use RoofScope measurements inside Zuper?
>
> You need an active **Growth**, **Advantage**, or **Scale** plan in RoofScope to enable measurements in Zuper.
> [accordion] Can I link multiple RoofScope orders to a single Zuper job?
>
> Yes, you can link multiple RoofScope measurement projects to a single Zuper job.
> [accordion] Why don't I see my existing RoofScope project when searching?
>
> Ensure the following:
>
> * The service address in Zuper matches the address in RoofScope exactly, including unit or apt number.
> * You are logged into RoofScope with an account that has access to that project.
> [accordion] Are edits made in Zuper synced back to RoofScope?
>
> No. Edits made in Zuper are local only and do not update the original RoofScope project.
> [accordion] What if a measurement stays 'In Progress' for too long?
>
> Reach out to **RoofScope Support** directly to follow up on the order status.
> [accordion] Can Field Executives order measurements, or only admins?
>
> Admins and users with **custom role access** can order measurements. See [Custom Roles](#custom-roles) for steps to enable the required permission.
> [accordion] Will removing a measurement in Zuper remove it in RoofScope?
>
> No. Removing a measurement in Zuper only unlinks it from the job. The project remains intact in RoofScope and can be re-linked later if needed.
# Upload Measurements
Source: https://docs.zuper.co/Integrations/Measurements_and_estimations/Upload_measurements
The **Measurement Upload** feature allows you to upload CSV measurement files from supported providers and automatically populate measurement values within a job.
Instead of manually entering measurements, Zuper reads the uploaded CSV file and maps the data to predefined measurement tokens using built-in system templates. This helps reduce manual data entry, minimize errors, and accelerate job setup.
## **Access & permissions**
* Measurement upload is available to all users who have access to the **Job Details** page.
* No additional permission or configuration is required.
## **Prerequisites**
Before uploading measurements, ensure that:
* You have a valid **CSV file** from Roofr, RoofSnap, or Bid Engine, or a valid **XML file** from Pitch Gauge or FirstMate.
## **Access Measurement Upload**
Measurement upload is available within the **Measurements** section of a job.
1. Go to the Job details page and open the **Measurements** section. Click **+ New Measurement**, then select **Upload Measurement**.

2. When the upload panel opens, you must select a **provider** before uploading the file. These templates contain predefined mappings between the provider’s measurement tokens and Zuper measurement tokens. After selecting a template, proceed to upload the CSV or XML file.


3. Upload or drag and drop your CSV or XML file. It will be validated automatically. Then click **Next**.

4. Use the attachments tab to upload the measurement PDF.
> [!NOTE]
>
> **Note:** Only PDF files are supported.

5. After reviewing the values, click **Create**.

Zuper generates measurement records within the Job using the values from the uploaded file.
The first measurement card is active by default.


## **Edit Measurement Values**
1. If you modify a value during the preview step, the system displays an **Edited** label on the measurement after creation.

2. Upload measurement files by clicking the **Attachments** tab, then **Upload**.

## **Activity Tracking**
* Every measurement upload automatically generates an **activity log** entry within the Job.

## **Disabled Measurement Tokens**
In some cases, the customer configuration may turn off certain measurement tokens.
If the uploaded file contains values for those tokens:
* The tokens will still appear within the Job
* Their values remain visible
This ensures that measurement data from the uploaded file is not lost.
## **Best Practices**
* Always choose the template that matches the file's source to ensure accurate data mapping.
* Verify all measurement values in the preview screen before creating measurements.
## FAQs
> [accordion] Do I need to manually set up system templates or field mappings?
>
> No. Zuper automatically manages system templates and field mappings. No setup is required.
> [accordion] What happens if some measurement tokens are disabled in the configuration?
>
> If the uploaded file contains values for disabled tokens, those tokens still appear in the job, and their values remain visible. This ensures that no imported data is lost.
> [accordion] Why do I see a "No measurement data found in the uploaded CSV" error?
>
> Each provider (Roofr, RoofSnap, Bid Engine, Pitch Gauge, and FirstMate) uses a different file format. If the file does not match the structure Zuper expects for the selected provider, the system cannot read it, and the upload fails. \
> To resolve this, confirm that the CSV file is from the provider you selected and that it has not been modified.
> [accordion] Why do I see a "No measurement data found in the uploaded XML file" error?
>
> The **Pitch Gauge** or **FirstMate** XML file either does not match the structure Zuper expects or is not a valid XML file. \
> To resolve this, confirm that the file was exported directly from the provider you selected (Pitch Gauge or FirstMate) and has not been modified or renamed. \
> If the issue continues, contact [Support](mailto:support@zuper.co).
# Hover Web
Source: https://docs.zuper.co/Integrations/Measurements_and_estimations/Zuper_Hover
## Overview
The Zuper and Hover integration enables roofing service teams to manage property measurements seamlessly, all within the Zuper platform. With this integration, you can:
✅ Order a new measurement directly from a Zuper job.
✅ Sync existing Hover projects to Zuper jobs.
✅ View, edit, and download measurement data.
✅ Access 3D model via Hover.
✅ Track all measurements in Zuper’s job activity.
This integration enhances accuracy, visibility, and efficiency across your roofing workflow — from measurement to execution.
## Plan Requirements for Hover Integration
To use the Hover integration with Zuper, ensure that your subscriptions on both platforms support integrations.
| **Section** | **Details** |
| :- | :- |
| **Zuper** | The Hover integration is available only on **Core** and **Premium** plans. If you are on the **Starter** plan, you must upgrade to Core or Premium to access Hover. |
| **Hover** | The **“Pay as You Go”** plan does not support software integrations. You must be on a Hover plan that includes marketplace integration to connect with Zuper. |
| **Next Steps** | If you are unsure about your plan: - Contact **Zuper Support** at [*support@zuper.co*](mailto:support@zuper.co) to confirm or upgrade your Zuper plan. - Contact your **Hover representative** to verify your Hover subscription. |
## **Custom Roles**
You need to enable the permission in a custom role to allow users to order measurements from Hover.
> [!NOTE]
>
> **Note**: By default, only admins or users with the “**Order Measurement from External Provider**” custom role permission can place orders for measurements.
1. Navigate to **Users & Teams > Custom Roles**.
2. Click **New Role** or edit an existing one.
3. Enter a **Role Name** (e.g., "Roofing Technician") and **Description**.
4. Select the Jobs module from the List of Modules under Permissions.
5. Search for **Order Measurements from External Provider** in the Jobs Permissions section.
6. Toggle the switch to **On**.
7. Review and enable other related permissions: Click **Save Role** to apply changes.
8. Assign this role to relevant users or teams.

Once set, users with this role can initiate measurement orders from job details.
## **Managing Measurement Tokens**
Measurement tokens define the specific data points (e.g., lengths, areas) that Zuper pulls from external providers. You can enable or disable these to tailor what appears in your job details page.
Read more from [here](https://docs.zuper.co/Settings/Modules/Jobs/Configuring_Measurements)
## **Connecting to Measurement Providers**
Zuper supports integrations with leading roof measurement services to fetch data like aerial-derived roof specs, 3D visualisations, and high-precision reports.
Read more from [here](https://docs.zuper.co/Settings/Modules/Jobs/Configuring_Measurements#connecting-to-measurement-providers)
## How to Enable the Hover Integration?
1. Log in to your Zuper app, click the “**User**” icon, and tap on the “**App Store**”.

2. Under the “**Browse by Category**,” select the “**Measurements & Estimations**” option and choose “**Hover**.”

3. On the Hover app page, click “**Install Hover**.”

4. You will be redirected to Hover for authentication. Click “**Allow**” to authenticate.
> [!NOTE]
>
> Note: Only Hover Administrators can complete the authentication.

## **How to Generate a Zuper API Key**
You need a Zuper API Key to complete Hover setup:
Zuper API Keys are essential for securely authenticating and authorising access to the Zuper API. These keys enable seamless integration with Zuper’s services, allowing developers to build robust applications that leverage real-time data and functionality.
**Navigation**: *Settings -> Developer Hub -> API Keys*
1. From the settings, select “**Developer Hub**,” choose “**API Keys**,” and click “**+New API Key**.”

2. A “**New API Key**” dialog box appears. Enter the “**API Key Name**.” Click the “**Create**” button to generate the API key.

3. The API key is successfully created. Click the copy icon to copy the API key. Paste it into the Hover configuration settings in Zuper

4. Under “**Actions**,” you can view or delete the API key.

5. Click Configure Settings in the left panel of the Hover app page. Enter your Zuper API Key. Click “**Update**.”

✅ Your Hover integration is now active and ready to use!
## How to Order a New Hover Measurement?
* From any job in Zuper, you can request a new measurement:
* Open the Job Details page. Go to the **Measurement** tab.
* Click **+ New Measurement**.

### **Option 1: Create New Measurement**
Fill in the following details:
**Project Name -** By default, this field is automatically populated with the **Zuper Job Title** (the name you assigned when creating the job, e.g., *“Smith Residence – Roof Replacement”*).
**Capture By** – Choose who will capture the property images in Hover:
* **Field Rep**
* Auto-fills with the assigned field rep’s name, email, and phone number.
* Use this if your on-site crew will capture images through the Hover app.
* **Homeowner**
* Auto-fills with the customer’s contact information stored in Zuper.
* Helpful when you want the homeowner to take their own property photos through Hover.
* **Professional**
* Manually enter the contact information of another professional (e.g., subcontractor or estimator).
* Use this if someone outside your team will handle the image capture.
> [!NOTE]
>
> **Note**: The homeowner will receive an email/text invitation to capture images directly from their device.
* **Deliverable Type** – Defaults to “**Roof** Only.” 
* **Service Address** - Pulled from the Zuper job. To make changes, the service address must be updated directly in the job.
✅ After reviewing all fields, click **Submit**.\
The new measurement request will appear in the Measurement tab as **Pending**.

### Option 2: Select an Existing Project
If you’ve already created a Hover project for the property, you can link it instead of starting fresh:
1. The service address auto-fills in the search bar.
2. Hover displays all matching projects for that address.
3. Select the desired project.
4. It instantly syncs with the Zuper job.

## Viewing Synced Measurements
When Hover measurements are available, it automatically syncs to Zuper:
Once measurements are synced back from Hover, you can view and manage them in Zuper.
**Viewing Synced Measurements**
* Go to the **Measurement** tab.
* Click the **Completed Measurement Card**.
* Review synced values mapped to Zuper’s standard measurement tokens.
**Viewing Visual Assets**
* **PDF Reports**: View inline within Zuper.
* **3D Models**: Click **View** → opens in Hover (login required).


**Edit the synced measurements.**
* Click the **✏️ Edit** icon or open the **⋮ menu → Edit**.
* Make your changes and save.
* Edited fields display an “**Edited**” label.
* All edits are logged in **Job Activity**.

### **Viewing and Managing Measurements**
**Downloading Files**
* Open the **⋮ menu** on the Measurement Card and **Download**.
* Save the complete Hover measurement package locally.

## Manually sync measurement data
When you place a measurement order, Hover processes the request and automatically sends the data back to Zuper. However, if your order status shows **Completed** in Hover but the measurement data has not yet synced in Zuper, you can trigger a manual sync to pull the measurement data.
1. Locate the Hover measurement card you want to sync.
2. Select the context menu icon (three-dot icon) on the right side of the measurement card.
3. Select **Sync from Hover** from the menu.

### **Removing Measurements**
* Open the **⋮ Menu** → **Remove**.
* Confirm removal.
* Measurement is unlinked from the job, and the action is logged in **Job Activity**.

* Click the “**Gallery**” tab to view all the measurement pictures.

* Click the “**Activity**” tab to view all the measurement-related activities.

## How to Uninstall Hover from Zuper?
1. Click on your Profile Picture in the top right corner of the screen and select the “**App Store**.”

2. Under the “**Browse by Category**,” select the “**Measurements and Estimations**” option and choose “**Hover**.” Click the “**Uninstall App**” button.

3. Hover is uninstalled successfully.

## FAQs
> [accordion] Who can install and configure the Hover integration in Zuper?
>
> Only Zuper users with **Admin** privileges can install apps from the App Store. Additionally, the user must be an **Administrator** in Hover to authenticate during setup.
> [accordion] What happens if I enter the wrong API key or email during configuration?
>
> The integration will fail to sync data. Correct your credentials by navigating to **Settings → App Store → Hover → Configure Settings**, updating the details, and clicking **Save**. You will receive an error prompting you to recapture the measurements.
> [accordion] Can I link multiple Hover projects to a single Zuper job?
>
> Yes, you can link multiple Hover measurement projects to a single Zuper job.
> [accordion] Why don't I see my existing Hover project when searching?
>
> Ensure the following:
>
> * The service address in Zuper matches the address in Hover exactly, including unit or apt number.
> * You are logged into Hover with an account that has access to that project.
> [accordion] Are edits made in Zuper synced back to Hover?
>
> No. Edits made in Zuper are local only and do not update the original Hover project.
> [accordion] What if a measurement stays 'In Progress' for too long?
>
> Reach out to **Hover Support** directly to follow up on the order status.
> [accordion] Can Field Executives order measurements, or only admins?
>
> Admins and users with **custom role access** can order measurements. See [Custom Roles](#custom-roles) for steps to enable the required permission.
> [accordion] Will removing a measurement in Zuper remove it in Hover?
>
> No. Removing a measurement in Zuper only unlinks it from the job. The project remains intact in Hover and can be re-linked later if needed.
> [accordion] Where can I view the 3D model of the roof?
>
> Click **View** on the Measurement Card to open the full 3D model in your browser via the Hover platform.
>
> > [!NOTE]
> >
> > You must be logged into your Hover account to view the 3D model.
# Geo Code
Source: https://docs.zuper.co/Integrations/Power_Apps/Geo_Code_App
Bring pinpoint accuracy to your customers' addresses with our Geo-Code Power app! When you integrate third-party apps, you may end up fetching the customer’s address without geo-coordinates.
With this new Geo-Code power app, the exact location of your customers can be instantly and accurately captured. Get ready for reliable results every time - say goodbye to complex location tracking forever!
> [!TIP]
>
> **Pre-Requisites:**\
> [Google API Key](https://developers.google.com/maps/documentation/javascript/get-api-key) and [Zuper API Key](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys)
## **Connect Geo-Code with Zuper**
Listed below are the steps to enable the Geo Code app on Zuper.
1. Open a new tab in your browser after logging in to your Zuper Account. Click on your Profile Picture in the top right corner of the screen and click on “**App Store**.”

2. Under the “**Browse by Category**,” select the “**Power Apps**” option and choose “**Geo Code**.”

3. Click on the “**Install Geo Code**” button.

4. Now, you can enable “**Update Geo Codes Settings**” by entering the following details.
* **Google Maps API Key** (Mandatory Field) – Enter the Application Programming Interface key. (This is fetched from the [Google Maps API ](https://developers.google.com/maps/documentation/javascript/get-api-key)obtained from the Customer).
* **Zuper API Key** (Mandatory Field) - Enter the Zuper API key [(Click here: How to generate Zuper API Key).](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys)
* **Apply geo-coding for Assets?** – Choose “**Yes**” to enable geo-coding for the assets.
* **Apply geo-coding for Organization?** – Choose “**Yes**” to enable geo-coding for your organization.
* Select the “**Update**” button to connect the **Geo Code** app with **Zuper**.

4.
> [!NOTE]
>
> **Note**: If you choose “**Yes**” for the above settings, only the exact location of the assets or organization will be captured.
We need to set the significant geo code “**Settings**” up first, and then Next, and we must proceed to create a Job with Geo-codes.
### View Geo Codes on the Zuper
Based on your Zuper settings, whenever Customers, Jobs, Organizations, or Assets are created without specific geo-coordinates, the Google API will fire up and automatically fetch geo-coordinates for the address entered.
1. Select the “**Jobs**” icon from the left panel and choose the “**Job**” for which you want to view the Geo Coordinates of your Customer.
2. Under the “**Job Details**” tab, scroll down so you can view the Geo-Codes fetched by our Power Apps.
> [!NOTE]
>
> **Note:** You need to enable the settings for an organization or asset to capture the Geo-coordinates, whereas Job and Customer addresses are automatically fetched as a part of the in-built settings.
>
> If you want to enable the Geo-coordinates later in time, the update is possible. For this to happen, a user should visit the customer or job module and perform an edit action.
## Uninstall Geo-Code
Listed below are the steps to disable the Geo Code app on Zuper.
1. Open a new tab in your browser after logging in to your Zuper Account. Click on your Profile Picture in the top right corner of the screen and click on “**App Store**.”

2. Under the “**Browse by Category**,” select the “**Power Apps**” option and choose “**Geo Code**.”

3. Click "**Uninstall App**." The Geo-code app will be uninstalled successfully.

No more worries about finding customer locations: Zuper Geo-Code App's accuracy ensures field technicians can provide speedy service to your customers, keeping up with SLAs, and increasing customer satisfaction.
# Invoice Auto Generator
Source: https://docs.zuper.co/Integrations/Power_Apps/Invoice_Auto_Generator
The business can set criteria for generating invoices automatically based on the billing frequency. Whenever the criteria are met based on the specified settings and status, auto-generating invoicing is possible. This integration automates invoice generation based on a customer or an organization's billing frequency.
## Connect your Auto Invoice Generator with Zuper
1. Open a new tab in your browser once logged in to your Zuper Account. Click on your Profile Picture in the top right corner of the screen and select the “**App Store**.”

2. Under the “**Browse by Category**”, select the “**Power Apps**” option and choose “**Invoice Auto Generator**.”

3. Click on the “**Install Invoice Auto Generator**” button.

4. Update Auto Invoice Generator Settings by configuring the following fields:
* **Job Status**(Mandatory Field) – Enter the job status for which you want to configure the auto-generation of the invoice.
> [!NOTE]
>
> **Note**: You can enter multiple statuses using the comma (,) separator.
* **Billing Module** (Mandatory Field) – Select the module from the drop-down box to confirm the module from which the billing should be considered.
* **Default Billing Period** (Mandatory Field) – Select the default billing period for the auto invoice generation.
* **Billing Frequency Custom Field** (Optional Field) – Enter the custom field name for the billing frequency. (This is applicable when you choose “**Organization**” as the option in step (b).)
* **Default Payment Term** (Mandatory Field) – Enter the invoice payment term.
* **Invoice Template Name** (Optional Field) – Enter the template name of the invoice.
* **Zuper API Key** (Mandatory Field) – Enter the Zuper API key.[(Click here: How to generate Zuper API Key).](https://docs.zuper.co/Settings/Developer_Hub/API_Keys)
* Select the “**Update**” button to connect the Auto Invoice Generator app with Zuper.

## Zuper – Auto Invoice Generator Integration work
### **Customer Module:**
1. Log in to your Zuper account and open the **customer’s** module from the left panel. You view the customer’s account details from the right section.

### **Organization Module**
1. Log in to your Zuper account and open the **organization’s** module from the left panel. You view the organization’s account details from the right section.

### Jobs Module
2. Open the **Jobs** module and select the Job Details page. You can view the “**Completed**” status of the Job.


### Invoice Module
2. You can view the auto-generated invoice based on your configured settings.

## Uninstall Invoice Auto Generator from Zuper
1. Open a new tab in your browser once logged in to your Zuper Account. Click your Profile Picture in the top right corner of the screen and select the “**App Store**.”

2. Under the “**Browse by Category**,” select the “**Power Apps**” option and choose “**Invoice Auto Generator.**”

3. Click on the “**Uninstall App**” button.

4. The Auto Invoice Generator app will be uninstalled successfully.

The invoice auto-generator helps automate the generation of invoices based on pre-defined settings. With this process, manual intervention in the invoice process is prevented, and customers receive their invoices on time.
# Job Mileage Calculation
Source: https://docs.zuper.co/Integrations/Power_Apps/Job_Mileage_Calculation
Zuper Power Apps are created with the intention to satisfy unique user requirements, and each app plays a unique role in fulfilling business needs.
Mileage calculation is a significant part of the field service management process, and this specific Zuper Power App helps extract the number of miles driven by field technicians in a specific interval. By retrieving accurate mileage calculations, field service businesses can process payroll and reimbursement requests effortlessly.
## A. Connect Job Mileage Calculation with Zuper
Listed below are the steps to enable the mileage calculation app on Zuper.
1. Open a new tab in your browser once you are logged in to your Zuper Account. Click your Profile Picture in the top right corner of the screen and select “**App Store**.”

2. Under the “**Browse by Category**,” select the “**Power Apps**” option and choose “**Job Mileage Calculation**.”

3. Click on the “**Install Job Mileage Calculation**” button.

2. Now, you can enable “**Update Job Mileage Calculation Settings**” by entering the following details.
**a. Start Location Type** (Mandatory Field) – The start point of the field executive’s location. The options can be either **Job Status** or **Employee Start Location**.
* **Job Status** – Choose if the starting point mileage calculation is based on Job status.
* **Employee Start Location** – Choose if the starting point mileage calculation is based on the Employee Start Location.
**b. Start Location Status** – Enter the status to be considered for the start location.
**c. End Location Type** (Mandatory Field) - The endpoint of the field executive’s location. The options can be either **Job Status** or **Job Service Address**.
* **Job Status** – Choose if the ending point mileage calculation is based on the Job Status.
* **Job Service Address** – Choose if the ending point mileage calculation is based on the Job Service Address.
**d. End Location Status** – Enter the status to be considered for the end location.
**e. Store mileage in** (Mandatory Field) – The mileage can be stored in the **Custom Field** defined or in the **Job Line Item.**
**f. Custom Field Name** – Enter the Custom Field Name where mileage values are stored. (Enter here if you choose “**Custom Field**” as an option in **Step (e**)).
**g. Line Item Name** - Enter the Line Item Name where mileage values are stored.(Enter here if you choose “**Job Line Item**” as an option in **Step (e**)).
**h. Cost per Mile** (Mandatory Field) - Enter the rate per mile. The rate defined here will be calculated per mile for the distance covered by the field executive.
**i. Mileage Type** (Mandatory Field) - Choose the preferred mileage type. This can be either **KMS (Kilometers) or Miles**.
**j. Zuper API Key** (Mandatory Field) - Enter the Zuper API key [(Click here: How to generate Zuper API Key).](https://docs.zuper.co/Settings/Developer_Hub/API_Keys)
Select the “**Update**” button to connect the **Job Mileage Calculation** app with **Zuper**.

The first mileage calculation setup in the “**Settings**” is complete. Next, we must proceed to the Zuper Mobile App for status updates.
## Update Job Status on the Zuper Mobile App:
As a part of the mileage calculation for the field executives, based on the status updates (as per your current settings), select an appropriate Job Status.
1. Select the "**Jobs**" module from the top-left hamburger icon.
Update the “**Job Status**.” Based on this status, the mileage calculation will be automatically done on the Zuper Web App.

Based on the different status updates on the Zuper Mobile App, the mileage calculations will be reflected on the Zuper Web App.
## View Mileage Calculation on the Zuper Web App:
By taking your Zuper App Store settings and status updates on the Zuper Mobile App into account, you can now view the mileage calculation for your field executive.
1. Select the “**Jobs**” icon from the left panel and choose the “**Job**” for which you want to view the mileage calculation for your field executive.
2. If you chose the **custom field** option during the initial setup, scroll down the job details page to view the mileage calculations under the “**Other Details**” section (*This is taken from* A. How to Connect Job Mileage Calculation with Zuper? 4) f) point in the initial Settings setup).

3. If you chose the **line item** option during the initial setup, scroll down the job details page to view the mileage calculations under the “**Parts / Services**” section (This is taken from A. How to Connect Job Mileage Calculation with Zuper? 4) g) point in the initial Settings setup).

The users require accurate mileage calculations to provide the exact amount for the field executives. With this Zuper Mileage Calculator, you need not worry about manual intervention for the field executive’s mileage calculation.
# Job Rescheduler
Source: https://docs.zuper.co/Integrations/Power_Apps/Job_Rescheduler
The **Job Rescheduler** Power App in Zuper is designed to streamline job scheduling within routes by ensuring that when performing key features, such as manual reordering, route optimization, and so on, the corresponding job dates/times are automatically rescheduled within the route. This capability enhances operational efficiency and accuracy for field service businesses.
## Connect Job Reschedule with Zuper
Follow these steps to enable the Job Rescheduler app on Zuper:
1. Log in to your Zuper Account. Click your **Profile picture** in the top right corner and select “**App Store**”.

2. Under “**Browser By Category**”, choose “**Power App**” and then select “**Job Rescheduler**”.

3. Click the “**Install Job Rescheduler**” button.

4. On the “**Update Job Rescheduler Settings**”, enter the following details to enable the Job Rescheduler in Zuper.
* **Zuper API Key**(Mandatory)– Enter the Zuper API key. To learn more, see [how I create an API key for my Zuper account](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys).
* **Round-Off Key** - Specify the number of minutes to which the job start date/time must be rounded off, considering travel duration. This field ensures that job start times are adjusted to the nearest specified interval. The available options are:
1. **NA**: Schedules the job to start precisely at the calculated arrival time (e.g., 10:02 hours).
2. **10-minute Round-off**: This rounds off the job start time to the next 10-minute interval (e.g., arrival at 10:02 will round off to 10:10 hours).
3. **15-minute Round-off**: This rounds off the job start time to the next 15-minute interval (e.g., arrival at 10:02 will round off to 10:15 hours).
4. **30-minute Round-off**: This rounds off the job start time to the next 30-minute interval (e.g., arrival at 10:02 will round off to 10:30 hours).
> [!NOTE]
>
> When jobs are rescheduled within a route, subsequent jobs will be adjusted based on the value specified in the **Round-Off Key** setting.
* Click the "**Update**" button to connect the Job Re-Scheduler app with Zuper.

Once the app is connected, go to the Zuper “**Dispatch Board—Routes**” module to use its features.
## Using the Job Rescheduler
### Manual Reordering of Jobs
When you adjust job sequences within routes, the **Job Rescheduler** Zuper Power App automatically updates the scheduled date/times of each job within the route based on the new sequence, and subsequent job times are adjusted based on the value configured in the **Round-Off** field.
Here’s how to reorder the jobs within the route:
1. Select the route containing the jobs you wish to reorder in the “**Route**” section.
2. Click the “**Reorder Jobs**” under the “**Kebab**” menu.
3. Drag-and-drop jobs to adjust the job sequence within the route.
4. Click the “**Reorder Jobs**” button to save.
5. After re-ordering the jobs, ensure that the system is refreshed.
Now, the job date and times are updated to reflect the new sequence of job orders.
### Rescheduling Route Departure
When you adjust the departure time of a route to accommodate scheduling or operational needs, the **Job Rescheduler** Zuper Power App automatically adjusts the scheduled dates/times of each job within the route based on the new departure time and any round-off settings configured.
Here’s how to reschedule a route departure:
1. Open the details of the route where departure adjustments are needed.
2. Update the departure date and time as required.
3. Save the changes and refresh the system to update job times within the route. For more information, see [Routes](https://care.zuper.co/portal/en/kb/articles/how-to-explore-the-maps-module-in-the-v3-zuper-web-app#Routes) (Edit Route).
Now, the job date and times are updated to reflect the new sequence of jobs.
### Moving Jobs Between Routes
When jobs are transferred from one route to another, the **Job Rescheduler** Zuper Power App automatically adjusts each job's scheduled dates/times within the source and target routes based on the new sequence and any round-off settings configured.
Here’s how to move jobs between routes:
1. Choose the jobs you want to transfer from their current route.
2. Click the “**Assign to another Route**” under the "**Ellipsis**" menu.
3. Specify the target route and assign the job by clicking the “**Re-assign**” button.
4. Confirm the job transfer in both the source and target routes.
5. Refresh the system to update the job times in both routes.
Now, the job date and time in both routes are updated to reflect the new sequence of jobs.
### Cloning a Route
Duplicate an existing route to replicate job schedules and operational plans efficiently. When routes are cloned, the **Job Rescheduler** Zuper Power App automatically replicates job schedules from the original route, adjusting job times based on any round-off settings configured.
Here’s how to clone a route:
1. Choose the route you want to duplicate.
2. Click the “**Clone Route**” button under the “**Kebab**” menu in the "**Route**" section.
3. Provide a new name for the cloned route and adjust any necessary details.
4. Click the “**Clone**” button to save the cloned route.
5. Optionally, you can customize job sequences within the cloned route. For more information, see [Routes](https://care.zuper.co/portal/en/kb/articles/how-to-explore-the-maps-module-in-the-v3-zuper-web-app#Routes).
Now, the job date and time are updated to reflect the new sequence of jobs.
### Creating a New Route
When you create a new route and add jobs to it, the Job Rescheduler Zuper Power App automatically adjusts the scheduled times of each job within the route based on any round-off settings configured.
Here’s how to create a new route:
1. Click the “**+**” icon next to Routes.
2. Fill in the required details.
3. Click “**+ Add Job**” to add jobs to the new route by selecting them from the job list.
4. Arrange job sequences within the new route to optimize operational efficiency and refresh the system. For more information, see [Create New Route](https://care.zuper.co/portal/en/kb/articles/how-to-explore-the-maps-module-in-the-v3-zuper-web-app#Create_New_Route).
Now, the job date and time are updated to reflect the new sequence of jobs in the newly created route.
### Best Practices
1. **Avoid Terminal Status Jobs**: Do not include/reorder jobs in terminal statuses (Closed, Completed, Cancelled) when managing routes.
2. **Manage Unscheduled Jobs**: Consider unscheduled jobs as zero-duration events. Adding an unscheduled job to a route does not affect the route's overall duration; only the travel durations "To" and "From" the job location are factored into scheduling.
## Uninstall Job Rescheduler from Zuper
1. Log in to your Zuper Account. Click your Profile picture in the top right corner and select “**App Store**”.

2. Under “**Browser By Category**”, choose “**Power App**” and then select “**Job Rescheduler**”.

3. Click the “**Uninstall App**” button.

4. The **Job Rescheduler** app is uninstalled successfully.

This guide provides a comprehensive overview of effectively using the Job Re-Scheduler Power App in Zuper, highlighting its automated job scheduling capabilities.
# Job Time Calculation
Source: https://docs.zuper.co/Integrations/Power_Apps/Job_Time_Calculation
Job Time Calculation helps field service businesses price their services accurately. This specific Zuper Power App helps calculate the working hours of field technicians by tracking their punch-in, break, and punch-out times.
## **Connect Job Time Calculation with Zuper**
Listed below are the steps to enable the Job Time calculation app on Zuper.
1. Log in to your Zuper Account. Click on your Profile Picture in the top right corner of the screen and click on “**App Store**.”

2. Under the “**Browse by Category**,” select the “**Power Apps**” option and choose “**Job Time Calculation**.”

3. Click the “**Install Job Time Calculation**” button.

4. Now, you can enable “**Update Job Time Calculation Settings**” by entering the following details.
* **Start Status** (Mandatory Field) – Enter the start status of the field executive.
* **End Status** (Mandatory Field) – Enter the end status of the field executive.
> [!NOTE]
>
> **Note:** Enter different status options that you use to track the progress of your jobs (such as Started, Resumed) and use a comma to differentiate each status. Make sure that the status options that you enter in the settings match your job status list.
If there is a status mismatch, the time calculation process will be impacted.
* **Choose Time Metric** (Mandatory Field) - The time measurement of the Job (excluding break/waiting time). The options can be either **Minutes** or **Hours.**
* **Store Time in** (Mandatory Field) – The time calculation can be stored in the **Custom Field** defined or in the **Job Line Item.**
* **Custom Field Name** – Enter the Custom Field Name where time values are stored. (Enter here if you choose “**Custom Field**” as an option in **Step (d**)).
* **Line-Item Name** - Enter the Line-Item Name where time values are stored.
(Enter here if you choose “**Job Line Item**” as an option in **Step (d**)).
* **Cost per Metric** (Mandatory Field) - Enter rate metrics. The rate defined here will be calculated per hour or minute for the Job done by the field executive.
* **Zuper API Key** (Mandatory Field) - Enter the Zuper API key [(Click here: How to generate Zuper API Key).](https://docs.zuper.co/Settings/Developer_Hub/API_Keys)
6. Select the “**Update**” button to connect the **Job Time Calculation** app with Zuper.

We need to set up the significant time calculation in the “**Settings**”. Next, we must proceed to the Zuper Mobile App for status updates.
### Update Job Status on the Zuper Pro Mobile App:
As a part of the job time calculation process, you need to select an appropriate Job Status.
1. Select the "**Jobs**" module from the top-left hamburger icon.
2. Update the “**Job Status**.” Based on this status, the time calculation will be automatically done on the Zuper Web App.

Based on the different status updates your field technicians make on the Zuper Mobile App, their working hours will be captured on the Zuper Web App.
## View Time Calculation on the Zuper Web App:
Job Time Calculations will depend on your Zuper App Store settings and the status updates made by your field executives on the Zuper Mobile App.
1. Select the “**Jobs**” icon from the left panel and choose the “**Job**” for which you want to view the mileage calculation for your field executive.
2. The status changes made on the mobile app are reflected in the Web App. Note: You can track the time spent on each status (such as **New, Started, Paused, Resumed**).

* If you chose the line item option during *A. How to Connect Job Time Calculation*: Scroll down the Job Details Page to view the time calculation under the “**Parts / Service Details**” section.

* If you chose the custom field option during *A. How to Connect Job Time Calculation*\_” scroll down the Job Details Page to view the time calculation under the “**Other Details**” section.

## Uninstall Job Time Calculation
Listed below are the steps to disable the Geo Code app on Zuper.
1. Open a new tab in your browser after logging in to your Zuper Account. Click on your Profile Picture in the top right corner of the screen and click on “**App Store**.”

2. Under the “**Browse by Category**,” select the “**Power Apps**” option and choose “**Job Time Calculation**.”

3. Click "**Uninstall App**."

3. The app will be uninstalled successfully.

Field service businesses need to capture accurate working hours of their field workforce to price their services properly. With Zuper’s Job Time Calculator, you can stop worrying about inaccurate timesheets and estimates.
# Using SRS Pricing on Your Proposals
Source: https://docs.zuper.co/Integrations/Purchasing/Creating a CPQ proposal with SRS pricing
**Navigation**: *Jobs → Job record → More Actions → Create CPQ Proposal*
## Overview
A CPQ (Configure, Price, Quote) proposal lets you present multiple pricing options in a single document — for example, a Basic package and an Intermediate package side by side. The customer reviews both, selects the one that suits them, and Zuper converts the accepted option into a quote, so the job moves forward with agreed costs already in place.
When your Parts and Services catalog is linked to SRS Distribution, Zuper takes this a step further by populating every line item with live branch pricing automatically. The numbers your customer sees reflect what your branch charges today, without any manual price entry.
This article covers how to create, review, and send a CPQ proposal with SRS pricing from a job record.
***
## Before you begin
Two things must be in place before you create a CPQ proposal with SRS pricing:
* Your SRS Distribution integration must be installed and at least one branch must be active. See [SRS Distribution integration — setup and branch management](/integrations/purchasing/srs-distribution-setup).
* The parts and products you plan to include must be linked to your SRS Distribution catalog. See [Linking SRS products to your Parts and Services catalog](/integrations/purchasing/srs-catalog-linking).
The job record must also exist in Zuper before you can create a proposal from it.
***
[CPQ with Supplier Pricing](https://player.vimeo.com/video/1201735014?badge=0\&autopause=0\&player_id=0\&app_id=58479)
## Create a CPQ proposal from a job
1. Go to **Jobs** from the left navigation menu.
2. Open the job record you want to create a proposal for.
3. Select **More Actions** at the top right of the job record.
4. Select **Create CPQ Proposal**.
A dialog appears confirming that Zuper is generating your proposal in the background using the SRS branch pricing linked to your catalog.
> [!NOTE]
>
> Select **View Proposal** in the dialog to open the proposal while it is still generating, or wait for the **New CPQ Proposal Created** notification to appear at the top right of the screen before you open it.
***
## Review and edit the proposal
The proposal opens on the **Edit Proposal** screen. Before you add line items, review the following fields to confirm the proposal is set up correctly.
### Confirm proposal details
The top of the screen shows three areas to review before adding line items:
* **Association(s)** — confirms the job and customer linked to this proposal. Verify these are correct before proceeding.
* **Address** — the service address pulled automatically from the job record.
* **Proposal Details** — expiry date, proposal template, and other fields. Update the expiry date if the default does not match your quoting window.
### Confirm the branch and pricelist
At the top right of the **Options** section, confirm the connected SRS branch shown. This is the branch whose pricing Zuper will use for all line items in this proposal. If you need to use a different branch, update your preferred branch in **Supplier Settings** before adding line items.
## SRS pricing on mobile
If you are working from the Zuper mobile app, you can access SRS branch pricing for your quotes and proposals. However, the way Zuper determines the branch price differs depending on where the quote was created.
> [!NOTE]
>
> For quotes created in the Zuper mobile app, you cannot select an SRS branch directly. Zuper uses the preferred branch set in your supplier settings to derive branch pricing. For quotes created on the web, pricing is derived from the supplier assigned to the quote.
## Add line items to each option
A CPQ proposal contains one or more option cards — for example, **Basic** and **Intermediate**. Each option is a separate pricing package. You add line items to each option independently.
1. Scroll to an option card in the **Options** section.
2. Select **+ Add** inside the option card to add a part or service from your catalog.
3. Search for and select the item. Zuper pulls the unit cost from the SRS branch pricing linked to that product.
4. If the product has multiple SRS options — for example, different colors or sizes — select the correct option from the dropdown next to the line item.
5. Enter a markup amount if applicable.
6. Repeat steps 2–5 for each line item in that option.
7. Repeat the process for every other option in the proposal.
> [!NOTE]
>
> For items linked to your SRS catalog, the unit cost reflects SRS branch pricing at the time the proposal is created. If no SRS catalog mapping exists for an item, Zuper uses the master cost set in your Parts and Services catalog instead.
***
## Save and send the proposal
Once you have finished adding line items to all options, you have two choices:
* Select **Save and Send** at the top right to save the proposal and send it to the customer immediately.
* Select **Save as Draft** to save without sending. You can open the proposal later from **Accounting → Quotes** and send it from the proposal detail page.
***
## What happens after the customer responds
When the customer accepts the proposal, Zuper converts the accepted option into a quote. The unit cost for each line item is determined by whether the item has an SRS catalog mapping:
* Items linked to your SRS catalog use the unit cost from your SRS branch catalog at the time the proposal was created.
* Items without a catalog in the selected SRS branch will use the Master Cost from Product Catalog.
This means the two types of items can coexist in the same quote without any manual adjustment.
> [!NOTE]
>
> Unit costs on the converted quote reflect SRS branch pricing at proposal creation time, not at quote conversion time. If branch prices have changed since you created the proposal, the converted quote will show the original proposal prices.
## How pricing stays current
Zuper updates pricing for all SRS-connected parts and products automatically, so you do not need to maintain prices manually.
* **Daily update:** Every day at midnight Central Standard Time, Zuper refreshes the unit cost for each product option and UOM across all your active SRS supplier branches.
* **On-use update:** When you add an SRS-connected part to an estimate or material order, Zuper fetches the latest price from the associated branch at that moment.
## FAQs
> [accordion] Can I create a CPQ proposal without SRS Distribution set up?
>
> Yes, but line items will not automatically populate with branch pricing. You will need to enter unit costs manually. To use live SRS pricing, install the SRS Distribution integration and link your products to the catalog before creating the proposal.
> [accordion] What happens if I add a product that is not linked to my SRS catalog?
>
> Zuper uses the master cost from your Parts and Services catalog instead. Both linked and unlinked items can coexist in the same proposal without any manual adjustment.
> [accordion] Can I change the SRS branch after I start adding line items?
>
> Yes, the purchase cost will update to the branch's pricing for those products linked to the newly selected branch. For others, the pricing will be pulled from the product master.
> [accordion] Can I save a proposal without sending it to the customer?
>
> Yes. Select **Save as Draft** to save without sending. You can open the proposal later from **Accounting → Quotes** and send it from the proposal detail page.
> [accordion] How does SRS pricing work when I create a proposal from the mobile app?
>
> On mobile, you cannot select an SRS branch directly. Zuper uses the preferred branch set in your supplier settings to derive branch pricing. On the web, pricing is derived from the vendor assigned to the proposal.
>
> If the issue continues, contact [Support](mailto:support@zuper.co).
***
## Related articles
* [Connect your SRS account](/Integrations/Purchasing/SRS-setup)
* [Setup your catalog with SRS products](/Integrations/Purchasing/Link%20Catalog%20Products%20to%20SRS)
* [Placing a material order with SRS](/Integrations/Purchasing/Creating%20a%20Purchase%20Order%20from%20a%20Quote%20with%20SRS%20Items)
* [Difference between proposals and quotes](/Accounting/Difference_Between_Proposals_and_Quotes)
# Placing Material Order to SRS
Source: https://docs.zuper.co/Integrations/Purchasing/Creating a Purchase Order from a Quote with SRS Items
**Navigation**: *Accounting → Quotes → Quote → New → Material Order*
## Overview
When a customer accepts a quote that includes SRS Distribution products, you can place the material order at your SRS branch without leaving Zuper. Zuper reads the line items on the quote, pre-fills your SRS supplier details, and sends the material order (MO) directly to SRS. Once SRS accepts the order, the SRS Order ID, delivery status updates, and supplier invoice sync back to the MO automatically — so your procurement and billing records stay in step.
Because the MO is built from the quote, you do not need to re-enter any line items manually. You can also create a MO from a quote in Draft or Accepted status, so you do not need to wait for customer acceptance before ordering materials.
***
## Before you begin
Three things must be in place before you create a MO from an SRS quote:
* Your SRS Distribution integration must be installed and at least one branch must be active. See [SRS Distribution integration — setup and branch management](/integrations/purchasing/srs-distribution-setup).
* Your parts catalog must be linked to SRS. See [Linking SRS products to your Parts and Services catalog](/integrations/purchasing/srs-catalog-linking).
* The line items on your quote must be mapped to SRS catalog products. Only mapped items appear in the item-selection step. You can still add items to a quote that you do not plan to procure from SRS.
### Configure purchasing settings
Before you create your first SRS material order, confirm the following settings are in place.
1. Go to **Settings**.
2. Select **Purchasing**, then select **General Settings**.
3. Select the **Material Orders** tab.
4. Under **General Settings**, confirm the following values:
| Setting | Required value |
| - | - |
| **Require Supplier Approval** | Yes |
| **Automatically Send MO to Supplier after Approval** | Yes (recommended) |
5. Select **Save**.
> [!NOTE]
>
> **Require Supplier Approval** must be set to **Yes** when placing orders to SRS Distribution. If this setting is off, MOs bypass the supplier acceptance step. The SRS Order ID will still appear on the MO once SRS processes the order.
***
## Create a material order from a quote
[MO Creation from Quote](https://player.vimeo.com/video/1201741636?badge=0\&autopause=0\&player_id=0\&app_id=58479)
### Open the quote and start a material order
1. Go to **Accounting** from the left navigation menu and select **Quotes**.
2. Open the quote that contains the line items you want to procure from SRS.
3. Select **New** at the top right of the quote, then select **Material Order** from the dropdown.
> [!NOTE]
>
> The **Supplier** panel on the right side of the quote shows the SRS supplier pre-filled when your line items are linked to the SRS catalog. If you updated the supplier assignment on the quote directly, the MO inherits that change automatically.
### Select the items to purchase
The **Select the items you want to purchase** dialog opens, listing all eligible line items from the quote.
1. Select the checkbox next to each item you want to include in the MO. All items are selected by default.
2. Use the **Search Item** field to find a specific item by name.
3. Review the **Required Qty** column. This value is pulled from the quote line item.
4. In the **Select Supplier** column, confirm that the correct SRS branch is assigned to each item.
> [!NOTE]
>
> The SRS Supplier branch is pre-filled based on your catalog settings. You can change the branch for an individual item by selecting a different option from the **Select Supplier** dropdown.
5. Select **Next**.
### Complete the material order details
The **Create Material Order** screen opens. For each product group, you will see the available SKU variants from SRS.
**Select SKU options**
1. Review the items listed under each product heading.
2. Select the checkbox next to the specific SKU variant — for example, a color or size option, you want to order.
3. Confirm the **Unit Purchase Cost** for each selected variant. Prices are pulled from the SRS catalog and updated based on the unit of measure.
4. Adjust the **Required Qty** field if needed.
5. Select the appropriate unit of measure from the dropdown next to the quantity field.
6. Add any line-level notes in the **Remarks** field.
> [!NOTE]
>
> The unit purchase cost updates based on the unit of measure you select, but the quantity does not. Verify the quantity and unit of measure together before proceeding — both values determine the total order amount sent to SRS.
**Complete the primary details**
1. Enter a **MO Title**. This is pre-filled as "MO for Quote" followed by the quote number and can be edited.
2. Select a **Delivery Method**. Select **Direct Shipment to Job's site** to send materials to the job address on the quote.
3. Select a **Delivery Time** — for example, **Anytime**.
4. Select a **Template** for the MO document.
5. Select a **Payment Term** — for example, **Immediate**.
6. Enter a **Required By** date. This field is mandatory.
7. Add any order-level notes in the **Remarks** field.
8. Select **Create Material Order**.
> [!NOTE]
>
> If your quote includes items from multiple suppliers, Zuper creates a separate MO for each supplier in a single step. Each MO appears individually under the **Material Orders** panel on the quote.
***
## What happens after you create the MO
### Draft status and submission
The MO is created in **Draft** status and linked to the quote under the **Material Orders** panel in the right sidebar. The **SRS Order ID** field on the MO is empty at this stage.
To move the MO forward, open it and select **Mark as Submitted**.
> [!NOTE]
>
> If **Automatically Send MO to Supplier after Approval** is enabled in your purchasing settings, Zuper sends the MO to SRS as soon as it clears the approval step — no manual send is needed.
### Supplier accepted status and SRS Order ID
Once SRS accepts the order, Zuper automatically updates the MO status to **Supplier Accepted**, populates the **SRS Order ID** field with the order reference number from SRS, and records the **MO Sent Date**.
The SRS Order ID appearing on the MO confirms that SRS has accepted and is processing your order.
### Delivery status updates
SRS pushes delivery status updates back to the MO in Zuper. The **Delivery Status** field reflects the current state of the shipment:
| Status | What it means |
| - | - |
| **In Transit** | Materials have left the SRS warehouse |
| **Arrived** | Materials have arrived at the delivery address |
| **Delivered** | Materials have been delivered to the delivery recipient |
### Receive items after delivery
After the materials are delivered, verify receipt in Zuper.
1. Open the MO from the **Purchasing** module or from the **Material Orders** panel on the quote.
2. Select **Receive Items**.
3. Enter the quantity received for each line item.
4. Select a delivery location if applicable.
5. Select **Confirm**.
Zuper records the inward transaction and updates the MO status to **Fulfilled** or **Partially Fulfilled** depending on whether all items were received.
### Invoice sync from SRS
When SRS issues an invoice for the delivered materials, it syncs automatically to the MO in Zuper. The MO status updates to **Invoiced**.
> [!NOTE]
>
> You do not need to manually enter the SRS invoice. Zuper fetches it automatically once SRS marks the order as invoiced on their end.
***
## Add an SRS product to a material order
> [!NOTE]
>
> The **Add product from SRS** option appears only when the supplier on the material order is an SRS Distribution branch. If you do not see this option, confirm that the correct suppliers are selected on the material order.
1. Go to the **Purchasing** module and select **Material Orders**.
2. Open an existing draft material order, or select **+ New Material Order** to create a new one.
3. In the **MO Items** section, select **+ Add**.
4. From the dropdown, select **Add product from SRS**. The **Add Product from SRS \[Branch Name] catalog** dialog opens.
5. In the **Supplier Product** field, select the product you want to order from the SRS catalog.
6. In the **Option** field, select the variant you need — for example, a color such as Brown or Gray.
7. In the **Required Qty** field, enter the quantity. Then select the unit of measure from the adjacent dropdown — for example, PC or RL.
8. Review the **Unit Purchase Cost** field. Zuper populates this automatically from the SRS catalog. Update it if needed.
9. In the **Remarks** field, enter any notes or special instructions for this line item. This step is optional.
10. Select **Add Product**. The product appears as a new line item in the **MO Items** section, with the supplier SKU, option, and cost pre-filled.
Repeat these steps for each additional SRS product you want to add to the material order.
> [!TIP]
>
> To view all products available in an SRS branch catalog, go to **Suppliers**, open the branch supplier record, and select the **Product Catalog** tab. Each product lists its supplier SKU, unit purchase cost, and available options.



## Limitations
Before you submit a MO, confirm all item selections, quantities, and delivery details. Once a MO is submitted, the following restrictions apply:
> [!WARNING]
>
> **Cancel** and **Delete** are only available while the MO is in **Draft** status. Once a MO is submitted, you cannot cancel or delete it from Zuper. Contact SRS directly to coordinate any changes, then update the **Remarks** field on the MO in Zuper for your records.
> [!WARNING]
>
> Editing a line item on a submitted MO pulls the price from your Zuper catalog, not from the current SRS supplier price. If the catalog price has not been updated, the line item cost may be set to \$0. Review your catalog pricing before editing line items on a submitted MO.
***
## FAQs
> [accordion] Can I create a MO from a quote that is still in Draft status?
>
> Yes. You can create a MO from a quote in either Draft or Accepted status. The quote does not need to be accepted by the customer before you order materials.
> [accordion] The SRS supplieis not pre-filled on one of my items. What should I do?
>
> This means the line item is not linked to an SRS catalog product. Go to your Parts and Services settings and confirm the item is mapped to the correct SRS SKU. See [Linking SRS products to your Parts and Services catalog](/integrations/purchasing/srs-catalog-linking) for guidance.
> [accordion] The SRS Order ID is not appearing on my MO. What does that mean?
>
> The SRS Order ID populates only after SRS accepts the order. If the field remains empty after submission, verify that **Require Vendor Approval** is set to **Yes** in your purchasing settings and that the MO has been sent to SRS. If the issue continues, contact [support@zuper.co](mailto:support@zuper.co).
> [accordion] The unit purchase cost changed when I selected a different unit of measure. Is that expected?
>
> Yes. The unit purchase cost from SRS is tied to the unit of measure. Selecting a different unit of measure — for example, switching from each to pallet — updates the cost accordingly. Always confirm the unit of measure and cost together before creating the MO.
> [accordion] I need to cancel a MO I already submitted. What can I do?
>
> Cancel and Delete are not available once a MO is submitted. Contact SRS directly to arrange a cancellation, then add a note in the **Remarks** field of the MO in Zuper to record the outcome. If the issue continues, contact [support@zuper.co](mailto:support@zuper.co).
***
## Related articles
* [Connect your SRS account](/Integrations/Purchasing/SRS-setup)
* [Setup your catalog with SRS products](/Integrations/Purchasing/Link%20Catalog%20Products%20to%20SRS)
* [Using SRS pricing on your proposals](/Integrations/Purchasing/Creating%20a%20CPQ%20proposal%20with%20SRS%20pricing)
* [Understanding purchase order status](/Purchasing/Purchase-Orders/Purchase-order-status)
# Setup Your Catalog
Source: https://docs.zuper.co/Integrations/Purchasing/Link Catalog Products to SRS
**Navigation**: *Parts and Services → Product record → Suppliers*
## Overview
Linking your Parts and Services catalog to SRS Distribution tells Zuper which SRS product to use when pulling live pricing, placing orders, and generating material orders for each item. Once a product is linked, Zuper fetches the current branch price automatically — so your estimates and material orders always reflect what your branch charges, without any manual price updates.
You can link products one at a time from the product record, or connect multiple products at once from the listing page. Either way, Zuper automatically suggests the closest matches from the SRS catalog, and you review and confirm them before saving.
***
## Before you begin
The SRS Distribution integration must be installed, and at least one branch must be connected before you can link catalog items. If you have not completed setup, see [SRS Distribution integration — setup and branch management](/integrations/purchasing/srs-distribution-setup).
***
## Link a single product to SRS
[Single Product Connection](https://player.vimeo.com/video/1201363531?h=4fbbc82006\&title=0\&byline=0\&portrait=0)
Use this method when you want to connect one product and review the mapping in detail.
1. Go to **Parts and Services** from the left navigation menu.
2. Select the product you want to link.
3. In the left panel of the product record, select **Suppliers**. If no suppliers are linked yet, the panel shows a prompt to start adding suppliers.
4. Select **+ Add** at the top right of the **Suppliers** panel.
5. In the **Add Suppliers** dialog, select the **Connected Suppliers** tab.
6. Select **SRS Distribution** from the list. The status shows **Connected** with the number of branches linked to your account.
7. Select **Next**. The **Connect to SRS** dialog opens. Zuper shows your product name at the top and a row of **Recommended Match** suggestions below it. These are the closest items Zuper found in the SRS catalog based on your product name.
8. Select a recommended match if one is correct. If none fit, use the **Search SRS Catalog** field to search by product name and select the correct item from the results.
> [!NOTE]
>
> If you cannot find an exact match, select the closest available SRS product. You can refine the mapping later from the **Suppliers** tab.
9. Select **Next**. The **Map SRS Catalog** screen opens. It shows the selected SRS product on the left and your Zuper product on the right.
10. Under **Select UOM**, choose the unit of measurement that matches your product.
> [!WARNING]
>
> The unit of measurement you select must match the supplier UOM exactly. A mismatch will cause incorrect pricing to appear on material orders.
11. In the **SRS Product Option** column, review each option listed. For each one, open the **Zuper Product Option** dropdown and select the matching option in your catalog. If no option applies, select **N/A**.
12. Select **Add**.
Zuper saves the mapping and returns to the **Suppliers** tab. The branch name appears as the supplier, with each mapped option showing the **Supplier SKU**, **SRS Product Option**, **Zuper Product Option**, and **Unit Purchase Cost**.
> [!NOTE]
>
> Catalog creation runs in the background for all branches. A banner at the top of the screen confirms this. Pricing data for some branches might take a few minutes to appear. Wait for the catalog to fully populate before selecting **Manage Catalog** — opening it before population is complete might show incomplete or missing product options.
***
## Link multiple products to SRS at once
[Bulk Product Connection](https://player.vimeo.com/video/1201717491?badge=0\&autopause=0\&player_id=0\&app_id=58479)
Use this method to connect multiple products in a single step from the Parts and Services listing page.
1. Go to **Parts and Services** from the left navigation menu.
2. Select the checkboxes next to the products you want to connect.
3. In the action bar that appears at the bottom of the page, select **Connect to Supplier**.
4. In the **Select supplier** step, select **SRS Distribution** (shown as **Connected**).
5. Select **Next**.
The **Connect items to SRS Distribution catalog** screen opens. Zuper pre-selects the best match from the SRS catalog for each product and shows a mapping table.
6. For each product, review the pre-selected SRS product in the left dropdown. Change it if the match is not correct.
7. For each SRS product option listed, open the **Zuper Product Option** dropdown and select the matching option. Leave unmapped options blank if they do not apply.
8. Select **Confirm and Save**.
Zuper saves the mappings for all selected products.
***
## Manage an existing SRS supplier mapping
Use this method when you want to connect one product and review the mapping in detail.
### Access supplier actions
1. Go to the product record and select **Suppliers** in the left panel.
2. Locate the SRS branch row.
3. Select the three-dot menu on the right of the branch row.
The following actions are available:
* **Add Option** — add a new product option mapping for this branch.
* **Manage Catalog** — reopen the **Map SRS Catalog** screen to update the UOM or option mappings.
* **Remove** — remove the SRS supplier link for this product from this branch.
### Remove a product option mapping
1. Select the delete icon (red trash icon) next to the option row you want to remove.
2. In the **Delete Supplier Catalog** dialog, choose one of the following:
* **Delete \[option name] from all SRS branches** — removes this option mapping across every branch linked to this product.
* **Delete only this particular option** — removes the mapping from this branch only.
3. Select **Delete**.
> [!NOTE]
>
> Deleting a supplier catalog mapping removes the pricing link for that option. The product itself remains in your Parts and Services catalog.
***
## Understanding the supplier record
After saving, the **Suppliers** tab displays a table with the following columns:
| Column | What it shows |
| - | - |
| **Supplier SKU** | The SRS identifier for this product option |
| **SRS Product Option** | The option name as it appears in the SRS catalog |
| **Zuper Product Option** | The matching option in your Zuper catalog |
| **Unit Purchase Cost** | The current branch price for this option |
If the **Unit Purchase Cost** shows **Cost not available**, the pricing for that option has not yet loaded from the branch. Check back after a few minutes or verify that the option is stocked at that branch.
***
## How pricing stays current
Once a product is linked, Zuper keeps prices up to date automatically in two ways, so you never need to update them manually:
* **Daily update** — every day at midnight Central Standard Time, Zuper refreshes the unit cost for each product option and unit of measurement across all your active SRS supplier branches.
* **On-use update** — when you add an SRS-connected part to an estimate or material order, Zuper fetches the latest price from the associated branch at that moment.
***
## FAQs
> [accordion] Can I link one Zuper product to more than one SRS branch?
>
> Yes. When you link a product, Zuper creates a separate supplier mapping for each of your connected branches. Each branch mapping has its own pricing and SKU.
> [accordion] What happens if I cannot find an exact SRS match for my product?
>
> Select **Manage Catalog** from the three-dot menu, then select **Unlink**. You can link the product to a different supplier catalog at any time. Unlinking a product removes all connected supplier catalogs for that product.
> [accordion] Why does my Unit Purchase Cost show 'Please contact branch for pricing'?
>
> Pricing loads in the background after a mapping is saved. If the cost is still unavailable after a few minutes, verify that the product option is stocked at that branch in your SRS RoofHub account.
> [accordion] What does the UOM selection affect?
>
> The unit of measurement controls how pricing is calculated on material orders. If the UOM in Zuper does not match the supplier UOM, the unit cost will be incorrect.
> [accordion] Can I remove an SRS supplier link without deleting the product?
>
> Yes. Go to the product record, select **Suppliers**, open the three-dot menu on the SRS branch row, and select **Remove**. The product remains in your Parts and Services catalog. Only the SRS pricing link is removed.
> [accordion] Why were some products excluded from a bulk link?
>
> Products are excluded from bulk linking if they are already linked to a supplier or are not eligible for supplier connection. The yellow banner at the top of the bulk mapping screen tells you how many products were excluded. If the issue continues, contact [support@zuper.co](mailto:support@zuper.co).
> [accordion] Why was no catalog created for a product after linking?
>
> This happens when the SRS catalog does not exist for the branches selected in your supplier settings. Zuper can only build a catalog for a product if the matching SRS item is carried by the branch. Check your branch selection in **Settings → Parts and Services Settings → Supplier Integrations → SRS Distribution** and confirm that the product is available at those branches in your RoofHub account.
***
## Related articles
* [Connect your SRS account](/Integrations/Purchasing/SRS-setup)
* [Using SRS pricing on your proposals](/Integrations/Purchasing/Creating%20a%20CPQ%20proposal%20with%20SRS%20pricing)
* [Placing a material order with SRS](/Integrations/Purchasing/Creating%20a%20Purchase%20Order%20from%20a%20Quote%20with%20SRS%20Items)
* [Parts and Services overview](/Inventory_Management/Overview)
# Connect Your SRS Account
Source: https://docs.zuper.co/Integrations/Purchasing/SRS-setup
> [!NOTE]
>
> This feature is currently in beta. To enable it for your account, contact your Account Manager or reach out to [support@zuper.co](mailto:support@zuper.co).
**Navigation**: *Settings → Parts and Services → Supplier Integrations → SRS Distribution*
The SRS Distribution integration connects Zuper directly to your SRS RoofHub account, so your team can order roofing materials without switching between systems. Once connected, Zuper pulls live branch pricing into every estimate and material order you create, refreshing prices automatically every day. When an order ships, delivery updates, proof of delivery, and the supplier invoice appear directly on the material order in Zuper — giving everyone on your team a single place to track materials from quote to delivery.
To get started, you install the app, verify your SRS account, and choose the branches you order from. Each branch connects to a job account, and you set one branch as your preferred branch for daily pricing updates. The sections below walk you through each step in order.
***
## Before you begin
Have the following ready before you install the integration. Gathering these in advance prevents interruptions during the setup steps:
* Your **SRS Customer Code** (also called your account number). You will find it in the account details section of any SRS invoice.
* A recent SRS invoice issued more than two days ago. You will need the **Invoice Number** and **Invoice Date** to verify your account.
* Alternatively, your **SRS Integration Key**. Go to **Integrations → Integration Key** in your RoofHub account to find it.
* Your **Zuper API Key**. Your Zuper administrator can provide this.
***
## Install the SRS Distribution app
1. From the **Settings**, under the **Parts and Services**, navigate to **Supplier Integrations**.

2. On **SRS Distribution,** Click **Connect.**

3. On the app detail page, select **Install App**.

The **Account Validation** screen opens. Continue to the next section to verify your account.
***
## Validate your SRS account
Zuper offers two ways to verify your account. Use whichever method you have credentials for.
### Method 1: Verify with invoice details
Use this method if you have a recent SRS invoice that is more than two days old.
1. In the **Customer Code** field, enter your SRS account number.
2. In the **Invoice Number** field, enter the invoice number from your SRS invoice.
3. In the **Invoice Date** field, enter the invoice date.
4. In the **Zuper API Key** field, enter your Zuper API key.
5. Select **Update**.

Zuper verifies your credentials with SRS. When the connection succeeds, the status badge changes to **Connected**.
> [!NOTE]
>
> The invoice date must be more than two days in the past. A same-day or next-day invoice will cause validation to fail.
### Method 2: Verify with an integration key
Use this method if you do not have a recent invoice available.
1. Select **Try Another Way** on the **Account Validation** screen.
2. In the **Customer Code** field, enter your SRS account number.
3. In the **Integration Key** field, enter the key from your RoofHub account. To find it, go to **Integrations → Integration Key** in RoofHub.
4. In the **Zuper API Key** field, enter your Zuper API key.
5. Select **Update**.

When the connection succeeds, the status badge changes to **Connected**.
> [!NOTE]
>
> If validation fails, confirm that your **Customer Code** is correct and that your invoice details match your SRS account exactly. Select **Update** again after correcting your details. If the issue continues, contact [support@zuper.co](mailto:support@zuper.co).
***
## Choose your branches
After your account is validated, Zuper loads the SRS branches linked to your account. You select the branches you order from and assign a job account to each one.
1. From the app detail page, select **Supplier Settings**. The branch setup screen opens.
2. On the **Choose Branches** step, review the list of SRS branches near your location. A map shows their positions alongside the list.
3. Select the checkbox next to each branch you want to use in Zuper.
4. For each selected branch, open the **Select Job Account** dropdown and select the job account to use for orders at that branch.
5. To set one branch as your preferred branch, select the star icon next to it. Zuper uses the preferred branch for daily pricing updates across your catalog.
> [!NOTE]
>
> You must assign a job account to every branch you select. Zuper uses this account when placing orders at that branch. You can change job accounts and update your preferred branch at any time from **Supplier Settings**.
***
## Import product templates from SRS
Zuper imports your product catalog from the order templates you have already built in SRS RoofHub. Each template groups products you order regularly — for example, by manufacturer or shingle type. Importing from templates rather than the full SRS catalog keeps your Zuper product list focused on what you actually use.
1. On the **Import Template** step, review the list of templates available in your RoofHub account. Each row shows the **Template ID**, **Template Name**, **Description**, and number of products.
2. Select the checkbox next to each template you want to import.
3. Select **Finish Setup** to begin the import. Zuper imports the selected templates in the background. Each product becomes a part in your **Parts and Services** catalog. Pricing updates automatically every day at 6:30 AM UTC.
> [!NOTE]
>
> Each template can only be imported once. If you add new products to a template in RoofHub after importing, those additions will not sync automatically. To bring in new templates created in RoofHub after the initial setup, use the **Import Templates** tab in **Supplier Settings** at any time.
> [!NOTE]
>
> If no templates appear, your RoofHub account does not have any order templates set up. Create templates of your frequently ordered products in RoofHub first, then return to Zuper to import them.

.png?fit=max\&auto=format\&n=F0kOJn5OlyUbOjIs\&q=85\&s=97dcc353f20435402adde6886ce2ea34)
# Manage your branches
After setup, you can view and manage all connected SRS branches from the Branches listing page.
[Supplier Branch Selection SRS](https://player.vimeo.com/video/1201369764?title=0\&byline=0\&portrait=0)
**Navigation**: *Settings → Parts and Services Settings → Supplier Integrations → SRS Distribution*
The **Branches** listing page shows each branch name, address, assigned SRS job account, and status.
### Add a branch
1. Go to **Settings → Parts and Services Settings → Supplier Integrations → SRS Distribution**.
2. Select **+ Add Branch** at the top right.
3. Select the new branch from the list and assign a job account to it.
4. Select **Save**.
Branches you have already added appear pre-selected and cannot be removed from this screen.
### Edit a branch
1. On the **Branches** listing page, hover over the branch you want to update.
2. Select the pencil icon that appears on the right.
3. Update the job account details.
4. Select **Save**.
### Set a preferred branch
1. On the **Branches** listing page, locate the branch you want to set as your preferred branch.
2. Select the star icon next to it. A filled star indicates the preferred branch.
Zuper uses the preferred branch for daily catalog pricing updates.
> [!NOTE]
>
> Only one branch can be set as preferred at a time. Selecting a new preferred branch removes the designation from the previous one.
### Deactivate a branch
1. On the **Branches** listing page, hover over the branch you want to deactivate.
2. Select the deactivate icon that appears on the right.
3. In the confirmation dialog, select **Deactivate** to confirm.
> [!WARNING]
>
> Deactivated branches remain in your account and continue to receive pricing updates. However, they are not available for selection when creating estimates or material orders.
***
## Disconnect the SRS Distribution integration
If you need to remove the SRS integration from your Zuper account, you can uninstall it from the App Store.
1. Go to your profile icon → **App Store → Purchasing → SRS Distribution**.
2. Select **Uninstall App** on the left panel.
3. In the confirmation dialog, select **Uninstall App** to confirm.
> [!WARNING]
>
> Uninstalling removes your account connection and branch configuration. Your existing parts and supplier records in Zuper are not deleted, but they may no longer receive SRS pricing updates.
***
## FAQs
> [accordion] What credentials do I need to connect SRS Distribution?
>
> You need your SRS Customer Code and either a recent invoice (more than two days old) or your SRS RoofHub Integration Key. You also need your Zuper API key, which your Zuper administrator can provide.
> [accordion] Can I connect more than one SRS branch?
>
> Yes. You can connect as many branches as your SRS account supports. Each branch requires a job account assignment before it can be used for orders.
> [accordion] What does the preferred branch do?
>
> Zuper uses the preferred branch as a fallback when no branch is selected during pricing. The preferred vendor is also pre-filled in Quotes and Proposals.
> [accordion] What happens to a deactivated branch?
>
> A deactivated branch remains in your account and continues to receive daily pricing updates. It is not available for selection when creating estimates or material orders. You can reactivate it at any time.
> [accordion] Will uninstalling the app delete my parts catalog?
>
> No. Your existing parts and vendor records in Zuper are not deleted when you uninstall the app. However, those records will no longer receive SRS pricing updates.
> [accordion] My validation keeps failing. What should I check?
>
> Confirm that your Customer Code matches your SRS account exactly and that the invoice you are using is more than two days old. If you are using an Integration Key, verify that you copied the key correctly from your RoofHub account. If the issue continues, contact [support@zuper.co](mailto:support@zuper.co).
***
## Related articles
* [Setup your catalog with SRS products](/Integrations/Purchasing/Link%20Catalog%20Products%20to%20SRS)
* [Using SRS pricing on your proposals](/Integrations/Purchasing/Creating%20a%20CPQ%20proposal%20with%20SRS%20pricing)
* [Placing a material order with SRS](/Integrations/Purchasing/Creating%20a%20Purchase%20Order%20from%20a%20Quote%20with%20SRS%20Items)
* [Configuring purchasing settings](/Settings/Modules/Purchasing/Configure-PO)
# Connecting ABC Supply
Source: https://docs.zuper.co/Integrations/Purchasing/abc-supply/Integrations/Purchasing/abc-supply/connecting-abc-supply
> [!NOTE]
>
> This feature is currently in beta. To enable it for your account, contact your Account Manager or reach out to [support@zuper.co](mailto:support@zuper.co).
**Navigation**: *Settings → Parts and Services → Supplier Integrations → ABC Supply*
## Overview
The ABC Supply integration connects Zuper to your myABCsupply account, so your team can order roofing materials without switching between systems. Once connected, Zuper pulls live, branch-specific pricing into every estimate and material order you create.
When an order ships, delivery updates appear directly on the material order in Zuper, giving everyone on your team a single place to track materials from quote to delivery.
To get started, you install the app and sign in with your myABCsupply credentials. ABC Supply uses a secure OAuth sign-in to verify your account, and the sections below walk you through each step in order.
## Before you begin
Have the following ready before you install the integration, since gathering this in advance prevents interruptions during setup.
* Your myABCsupply username and password. If you do not have a myABCsupply account, contact your ABC Supply branch representative to set one up before you continue.
## Install the ABC Supply app
1. From the **Settings**, under the **Parts and Services**, navigate to **Supplier Integrations**.

2. On **ABC Supply,** Click **Connect.**

2. Select **Install ABC Supply** on the app detail page. The ABC Supply sign-in screen opens, and you continue to the next section to connect your account.

## Sign in to your ABC Supply account
Zuper uses OAuth to connect to your ABC Supply account, so you sign in directly through ABC Supply's secure portal.
1. Enter your myABCsupply username in the **Username** field.
2. Enter your password in the **Password** field.
3) Select **Sign in**. Zuper verifies your credentials with ABC Supply, and when the connection succeeds, your account is linked and Zuper loads your branch information.
> [!NOTE]
>
> Select **Keep me signed in** on the sign-in screen if you want to stay connected without signing in again each session.
> [!NOTE]
>
> If the sign-in screen does not open, or it returns an error, confirm that your myABCsupply account is active and that your credentials are correct. If the issue continues, contact [Support](mailto:support@zuper.co).

## Choose your branches
After you sign in, Zuper loads the ABC Supply branches linked to your account, and you select the branches you order from and assign a **Ship-To Account** to each one.
1. Review the list of ABC Supply branches linked to your account.
2. Select the checkbox next to each branch you want to use in Zuper.
3. Open the **Ship-To Account** dropdown for each selected branch, and select the account to use for orders at that branch.
4. Select the **star icon** next to a branch to set it as your preferred branch. Zuper uses the preferred branch for daily pricing updates across your catalog.
5. Select **Save** to confirm your branch selections.
> [!NOTE]
>
> You must assign a **Ship-To Account** to every branch you select, and you can update your branch selections and preferred branch at any time from **Supplier Settings**.
## Import your parts catalog
Zuper imports your product catalog from the order templates linked to your ABC Supply account, so importing from templates keeps your **Parts and Services** catalog focused on what you actually use.
1. Review the list of templates available in your ABC Supply account on the **Select Template** step. Each row shows the **Template ID**, **Template Name**, and number of products.
2. Select the checkbox next to each template you want to import.
3. Select **Import from ABC Supply** to begin the import. Zuper imports the selected templates in the background, and each product becomes a part in your **Parts and Services** catalog. Pricing updates automatically each day at 6:30 AM UTC, or midnight CST.
> [!NOTE]
>
> Each template can only be imported once, and if you add new products to a template in ABC Supply after importing, those additions do not sync automatically. You can select the **Import Templates** tab in **Supplier Settings** at any time to bring in new templates.
> [!NOTE]
>
> If no templates appear, your ABC Supply account does not have any order templates set up yet. Create templates of your frequently ordered products in your ABC Supply account, and then return to Zuper to complete the import.
.png?fit=max\&auto=format\&n=B3b21fius4AwJij4\&q=85\&s=885592a60608aab2dc13028d375dbdb3)

## Manage your branches
After setup, you can view and manage all connected ABC Supply branches from the **Branches** listing page. To get there, go to **Settings**, select **Parts and Services Settings**, select **Supplier Integrations**, and select **ABC Supply**.
[Supplier Branch Selection ABC Supply](https://player.vimeo.com/video/1217577378?title=0\&byline=0\&portrait=0)
The **Branches** listing page shows each branch name, address, assigned **Ship-To Account**, and status.
### Add a branch
1. Go to **Settings**, select **Parts and Services Settings**, select **Supplier Integrations**, and select **ABC Supply**.
2. Select **+ Add Branch** at the top right.
3. Select the new branch from the list, and assign a **Ship-To Account** to it.
4. Select **Save**.
### Edit a branch
1. Hover over the branch you want to update on the **Branches** listing page.
2. Select the **pencil icon** that appears on the right.
3. Update the **Ship-To Account** details.
4. Select **Save**.
### Set a preferred branch
1. Locate the branch you want to set as your preferred branch on the **Branches** listing page.
2. Select the **star icon** next to it. A filled star indicates the preferred branch.
> [!NOTE]
>
> Zuper uses the preferred branch for daily catalog pricing updates, and only one branch can be set as preferred at a time. Selecting a new preferred branch removes the designation from the previous one.
### Deactivate a branch
1. Hover over the branch you want to deactivate on the **Branches** listing page.
2. Select the **deactivate icon** that appears on the right.
3. Select **Deactivate** in the confirmation dialog to confirm.
> [!NOTE]
>
> Deactivated branches remain in your account and continue to receive pricing updates, but they are not available for selection when you create estimates or material orders.
## Disconnect the ABC Supply integration
If you need to remove the ABC Supply integration from your Zuper account, you can uninstall it from the **App Store**.
1. Select your **profile icon**, select **App Store**, select **Purchasing**, and select **ABC Supply**.
2. Select **Uninstall App** on the left panel.
3. Select **Uninstall App** in the confirmation dialog to confirm.
> [!WARNING]
>
> Uninstalling removes your account connection and branch configuration. Your existing parts and supplier records in Zuper are not deleted, but they might no longer receive ABC Supply pricing updates.
## FAQs
> [accordion] What credentials do I need to connect ABC Supply?
>
> You need your myABCsupply username and password, and Zuper uses a secure OAuth sign-in. If you do not have a myABCsupply account, contact your ABC Supply branch representative to set one up before you continue.
> [accordion] What is OAuth, and is my password stored in Zuper?
>
> OAuth is a secure, industry-standard method that lets two applications share access without sharing your password, so when you sign in through the ABC Supply portal, your credentials go directly to ABC Supply. Zuper receives only a secure token to identify your account, and your password is never stored in Zuper.
> [accordion] Can I connect more than one ABC Supply branch?
>
> Yes, you can connect as many branches as your ABC Supply account supports, and each branch requires a **Ship-To Account** assignment before you can use it for orders.
> [accordion] What does the preferred branch do?
>
> Zuper uses the preferred branch as a fallback when no branch is selected during pricing, and the preferred branch is also pre-filled in quotes and proposals.
> [accordion] What happens to a deactivated branch?
>
> A deactivated branch remains in your account and continues to receive daily pricing updates, but it is not available for selection when you create estimates or material orders. You can reactivate it at any time.
> [accordion] Will uninstalling the app delete my parts catalog?
>
> No, your existing parts and supplier records in Zuper are not deleted when you uninstall the app, though those records no longer receive ABC Supply pricing updates.
## Related articles
* [Connecting SRS Distribution](https://docs.zuper.co/Integrations/Purchasing/SRS-setup)
* [Linking ABC Supply products to your Parts and Services catalog](https://docs.zuper.co/Integrations/Purchasing/abc-supply/setup-your-abc-catalog)
* [Creating a material order with ABC Supply pricing](https://docs.zuper.co/Integrations/Purchasing/abc-supply/placing-material-order-to-abc)
# Placing Material Order to ABC
Source: https://docs.zuper.co/Integrations/Purchasing/abc-supply/placing-material-order-to-abc
## Overview
When a customer accepts a quote that includes ABC Supply products, you can place the material order at your ABC Supply branch without leaving Zuper. Zuper reads the line items on the quote, pre-fills your ABC Supply supplier details, and submits the order directly to ABC Supply.
The **ABC Order ID** that appears on your Zuper document is ABC Supply's material order number, and it is your reference for tracking or modifying the order directly with ABC Supply.
Once ABC Supply accepts the material order, delivery status updates sync back to the material order in Zuper automatically. Because the material order is built from the quote, you do not need to re-enter any line items manually, and you can also create a material order from a quote in **Draft** or **Accepted** status.
## Before you begin
* Your ABC Supply integration must be installed, and at least one branch must be active. See [Connecting ABC Supply](#).
* Your parts catalog must be linked to ABC Supply. See [Linking catalog products to ABC Supply](#).
* The line items on your quote must be mapped to ABC Supply catalog products. Only mapped items appear in the item-selection step.
## Configure purchasing settings
1. Go to **Settings**.
2. Select **Purchasing**, then select **General Settings**.
3. Select the **Material Orders** tab.
4. Confirm the following values under **General Settings**.
| Setting | Required value |
| - | - |
| **Require Supplier Approval** | Yes |
| **Automatically Send MO to Supplier after Approval** | Yes (recommended) |
5. Select **Save**.
> [!NOTE]
>
> **Require Supplier Approval** must be set to **Yes** when you place material orders through ABC Supply. The setting label uses Zuper's current UI terminology, and it applies to all suppliers, including ABC Supply. If this setting is off, material orders bypass the supplier acceptance step, though the **ABC Order ID** still appears on the material order once ABC Supply processes it.
## Create a material order from a quote
### Open the quote and start a material order
1. Go to **Accounting** and select **Quotes**.
2. Open the quote that contains the line items you want to procure from ABC Supply.
3. Select **New** at the top right, then select **Material Order** from the dropdown. Zuper creates this as a Material Order document internally and submits it to ABC Supply as a material order.
The **Supplier** panel on the right side of the quote shows the ABC Supply supplier pre-filled when your line items are linked to the ABC Supply catalog. If you updated the supplier assignment on the quote directly, the material order inherits that change automatically.
### Select the items to purchase
1. Select the checkbox next to each item you want to include. All items are selected by default.
2. Use the **Search Item** field to find a specific item by name.
3. Review the **Required Qty** column. This value is pulled from the quote line item.
4. Confirm the correct ABC Supply branch is assigned to each item in the **Select Supplier** column.
> [!NOTE]
>
> The ABC Supply supplier branch is pre-filled based on your catalog settings. Each branch uses the **Ship-To Account** you assigned during setup, so changing the branch also changes the Ship-To Account and might affect the unit price.
5. Select **Next**.
### Select SKU options
1. Review the items listed under each product heading.
2. Select the checkbox next to the specific SKU variant you want to order.
3. Confirm the **Unit Purchase Cost** for each selected variant. Prices are pulled from the ABC Supply catalog and reflect the Ship-To Account assigned to the selected branch.
4. Adjust the **Required Qty** field if needed.
5. Select the appropriate unit of measure from the dropdown next to the quantity field.
6. Add any line-level notes in the **Remarks** field.
> [!NOTE]
>
> The unit purchase cost updates based on the unit of measure you select, but the quantity does not. Verify the quantity and unit of measure together before you proceed, since both values determine the total material order amount sent to ABC Supply.
### Complete the primary details
1. Enter a **MO Title**. Zuper pre-fills this as "MO for Quote" followed by the quote number, and you can edit it.
2. Select a **Delivery Method**. Select **Direct Shipment to Job's Site** to send materials to the job address on the quote.
3. Select a **Delivery Time**, for example, Anytime.
4. Select a **Template** for the material order document.
5. Select a **Payment Term**, for example, Immediate.
6. Enter a **Required By** date. This field is mandatory.
7. Add any order-level notes in the **Remarks** field.
8. Select **Create Material Order**.
> [!NOTE]
>
> If your quote includes items from multiple suppliers, Zuper creates a separate material order for each supplier in a single step. Each material order appears individually under the **Material Orders** panel on the quote.
[Create a material order from a quote with ABC Supply items](https://player.vimeo.com/video/1217578363?title=0\&byline=0\&portrait=0)
## What happens after you create the material order
### Draft status and submission
Zuper creates the material order document in **Draft** status and links it to the quote under the **Material Orders** panel in the right sidebar. The **ABC Order ID** field is empty at this stage, since ABC Supply has not yet created the material order on their end.
To move the material order forward, open it and select **Mark as Submitted**.
> [!NOTE]
>
> If **Automatically Send MO to Supplier after Approval** is enabled, Zuper sends the material order to ABC Supply as soon as it clears the approval step, and no manual send is needed.
### Supplier accepted status and ABC Order ID
Once ABC Supply accepts the material order, Zuper updates the material order status to **Supplier Accepted**, populates the **ABC Order ID** field with ABC Supply's material order number, and records the **MO Sent Date**.
The **ABC Order ID** is your material order reference in ABC Supply's system. Use this number when contacting your branch, requesting changes, or tracking fulfillment outside Zuper.
### Delivery status updates
ABC Supply pushes delivery status updates back to the material order in Zuper.
| Status | What it means |
| - | - |
| **In Transit** | Materials have left the ABC Supply warehouse |
| **Arrived** | Materials have arrived at the delivery address |
| **Delivered** | Materials have been delivered to the delivery recipient |
### Receive items after delivery
1. Open the material order from the **Purchasing** module or from the **Material Orders** panel on the quote.
2. Select **Receive Items**.
3. Enter the quantity received for each line item.
4. Select a delivery location if applicable.
5. Select **Confirm**.
Zuper records the inward transaction and updates the material order status to **Fulfilled** or **Partially Fulfilled**.
## Add an ABC Supply product to a material order
> [!NOTE]
>
> The **Add product from ABC Supply** option appears only when the supplier on the material order is an ABC Supply branch. If you do not see this option, confirm the correct supplier is selected.
1. Go to the **Purchasing** module and select **Material Orders**.
2. Open an existing draft material order, or select **+ New Material Order** to create a new one.
3. Select **+ Add** in the **MO Items** section.
4. Select **Add product from ABC Supply** from the dropdown.
5. Select the product you want to order in the **Supplier Product** field.
6. Select the variant, for example, Brown or Gray, in the **Option** field.
7. Enter the quantity and select the unit of measure, for example, PC or SQ, in the **Required Qty** field.
8. Review the **Unit Purchase Cost**. Zuper populates this from the ABC Supply catalog, priced against the Ship-To Account on the selected branch, and you can update it if needed.
9. Add any notes in the **Remarks** field. This step is optional.
10. Select **Add Product**. The product appears in **MO Items** with the supplier SKU, option, and cost pre-filled.
Repeat these steps for each additional ABC Supply product you want to add.
## Limitations
Once a material order is submitted and ABC Supply has created the material order on their end, the following restrictions apply.
> [!NOTE]
>
> **Cancel** and **Delete** are only available while the material order is in **Draft** status. Once submitted, you cannot cancel or delete it from Zuper. Contact ABC Supply directly with your **ABC Order ID** to coordinate any changes, and then update the **Remarks** field on the material order in Zuper for your records.
> [!NOTE]
>
> Editing a line item on a submitted material order pulls the price from your Zuper catalog, not the current ABC Supply supplier price. If the catalog price has not been updated, the line item cost might be set to \$0.
## FAQs
> [accordion] Can I create a material order from a quote that is still in Draft status?
>
> Yes, you can create a material order from a quote in either **Draft** or **Accepted** status. The quote does not need to be accepted by the customer before you order materials.
> [accordion] The ABC Supply supplier is not pre-filled on one of my items. What should I do?
>
> This means the line item is not linked to an ABC Supply catalog product. Confirm the item is mapped to the correct ABC Supply SKU in **Parts and Services**. See [Linking catalog products to ABC Supply](#) for guidance.
> [accordion] The ABC Order ID is not appearing on my material order. What does that mean?
>
> The **ABC Order ID** is ABC Supply's material order number, and it populates only after ABC Supply accepts the material order and creates it in their system. If the field remains empty after submission, verify that **Require Supplier Approval** is set to **Yes** and that the material order has been sent to ABC Supply. If the issue continues, contact [Support](mailto:support@zuper.co).
> [accordion] The unit purchase cost changed when I selected a different unit of measure. Is that expected?
>
> Yes, the unit purchase cost from ABC Supply is tied to both the unit of measure and the **Ship-To Account** assigned to your branch, so selecting a different unit of measure updates the cost accordingly. Always confirm the unit of measure and cost together before you create the material order.
> [accordion] I need to cancel a material order I already submitted. What can I do?
>
> Contact ABC Supply directly with your **ABC Order ID** to arrange a cancellation, and then add a note in the **Remarks** field of the material order in Zuper to record the outcome. If the issue continues, contact [Support](mailto:support@zuper.co).
## Related articles
* [Connecting ABC Supply](https://docs.zuper.co/Integrations/Purchasing/abc-supply/connecting-abc-supply)
* [Linking catalog products to ABC Supply](https://docs.zuper.co/Integrations/Purchasing/abc-supply/setup-your-abc-catalog)
* [Creating a material order from a quote with SRS items](https://docs.zuper.co/Integrations/Purchasing/Creating%20a%20Purchase%20Order%20from%20a%20Quote%20with%20SRS%20Items)
# Setup Your ABC Catalog
Source: https://docs.zuper.co/Integrations/Purchasing/abc-supply/setup-your-abc-catalog
## Overview
Linking your **Parts and Services** catalog to ABC Supply tells Zuper which ABC Supply product to use when pulling live pricing, placing orders, and generating material orders for each item. Once a product is linked, Zuper fetches the current branch price automatically, priced against the **Ship-To Account** assigned to your preferred branch, so your estimates and material orders always reflect what your branch charges without manual price updates.
ABC Supply maintains a live, nationally curated product catalog, and Zuper searches the full catalog directly when you link a product. Because the catalog covers thousands of SKUs across hundreds of branch locations, searching by manufacturer part number or ABC Supply SKU returns the most precise results. You can link products one at a time from the product records, or connect multiple products at once from the listing page.
## Before you begin
The ABC Supply integration must be installed, and at least one branch must be connected, before you can link catalog items. If you have not completed setup, see [Connecting ABC Supply](#).
## Link a single product
Use this method when you want to connect one product and review the mapping in detail.
### Select the ABC Supply match
1. Go to **Parts and Services** from the left navigation menu.
2. Select the product you want to link.
3. Select **Suppliers** in the left panel of the product record. If no suppliers are linked yet, the panel shows a prompt to start adding suppliers.
4. Select **+ Add** at the top right of the **Suppliers** panel.
5. Select the **Connected Suppliers** tab in the **Add Suppliers** dialog.
6. Select **ABC Supply** from the list. The status shows **Connected**, with the number of branches linked to your account.
7. Select **Next**. The **Connect to ABC Supply** dialog opens, showing your product name at the top with a row of **Recommended Match** suggestions below it, based on product name matching. If none of the suggestions are accurate, you can search by manufacturer part number or ABC Supply SKU in the next step for more precise results from the full catalog.
> [!TIP]
>
> If you cannot find an exact match, select the closest available ABC Supply product. You can refine the mapping later from the **Suppliers** tab.
### Map units and options
8. Select **Next**. The **Map ABC Catalog** screen opens, showing the selected ABC Supply product on the left and your Zuper product on the right.
9. Choose the unit of measurement that matches your product under **Select UOM**.
> [!NOTE]
>
> The unit of measurement you select must match the Master Product UOM exactly. A mismatch causes incorrect pricing to appear on material orders.
10. Review each option listed in the **ABC Product Option** column, and for each one, open the **Zuper Product Option** dropdown and select the matching option, or select **N/A** if no option applies.
11. Select **Add**.
Zuper saves the mapping and returns to the **Suppliers** tab. The branch name appears as the supplier, and each mapped option shows the **Supplier SKU**, **ABC Product Option**, **Zuper Product Option**, and **Unit Purchase Cost**.
> [!NOTE]
>
> Catalog creation runs in the background for all branches, and a banner at the top of the screen confirms this. Pricing data for some branches might take a few minutes to appear, so wait for the catalog to fully populate before you select **Manage Catalog**.
[Link a single product to ABC Supply](https://player.vimeo.com/video/1217577630?title=0\&byline=0\&portrait=0)
## Link multiple products at once
Use this method to connect multiple products in a single step from the **Parts and Services** listing page.
1. Go to **Parts and Services** from the left navigation menu.
2. Select the checkboxes next to the products you want to connect.
3. Select **Connect to Supplier** in the action bar at the bottom of the page.
4. Select **ABC Supply**, shown as **Connected**, in the **Select Supplier** step.
5. Select **Next**. The **Connect items to ABC Supply catalog** screen opens, and Zuper pre-selects the best match for each product in a mapping table.
6. Review the pre-selected ABC Supply product in the left dropdown for each product, and change it if the match is not correct.
7. Open the **Zuper Product Option** dropdown for each ABC Supply product option listed, and select the matching option. Leave unmapped options blank if they do not apply.
8. Select **Confirm and Save**. Zuper saves the mappings for all selected products.
[Link multiple products to ABC Supply](https://player.vimeo.com/video/1217578362?title=0\&byline=0\&portrait=0)
## Manage an existing ABC Supply supplier mapping
Use this method when you want to update or remove a mapping you have already saved.
### Access supplier actions
1. Go to the product record, and select **Suppliers** in the left panel.
2. Locate the ABC Supply branch row.
3. Select the **three-dot menu** on the right of the branch row.
The following actions are available:
* **Add Option** — add a new product option mapping for this branch.
* **Manage Catalog** — reopen the **Map ABC Catalog** screen to update the UOM or option mappings.
* **Remove** — remove the ABC Supply supplier link for this product from this branch.
### Remove a product option mapping
1. Select the **delete icon** next to the option row you want to remove.
2. In the **Delete Supplier Catalog** dialog, choose one of the following:
* **Delete \[option name] from all ABC Supply branches** — removes this option mapping across every branch linked to this product.
* **Delete only this particular option** — removes the mapping from this branch only.
3. Select **Delete**.
> [!NOTE]
>
> Deleting a supplier catalog mapping removes the pricing link for that option, but the product itself remains in your Parts and Services catalog.
## Understanding the supplier record
After you link a product to ABC Supply, the **Suppliers** tab on the product record shows one row per branch. Each row displays the following information:
* **Supplier SKU** — the ABC Supply product identifier for this item at the linked branch.
* **ABC Product Option** — the option from the ABC Supply catalog mapped to this product, for example, shingle color or size.
* **Zuper Product Option** — the corresponding option from your catalog.
* **Unit Purchase Cost** — the current price from your linked ABC Supply branch, refreshed daily.
Pricing in ABC Supply is tied to both the branch and the **Ship-To Account** assigned to it, so if your account has multiple Ship-To Accounts at the same branch, each account might have different pricing for the same product. Zuper uses the Ship-To Account you selected when you set up the branch. To change the Ship-To Account, go to **Supplier Settings** and update the branch configuration, and pricing reflects the new account on the next scheduled daily refresh.
## FAQs
> [accordion] What happens if Zuper cannot find a match in the ABC Supply catalog?
>
> Zuper shows the closest results it can find based on your product name, and if none are correct, you can select the **Search ABC Catalog** field to search by manufacturer part number or ABC Supply SKU instead, since these return more precise results than product name alone. If the item does not exist in the ABC Supply catalog, you cannot link it.
> [accordion] Can I link one Zuper product to more than one ABC Supply branch?
>
> Yes, when you link a product, Zuper creates the mapping across all connected branches automatically, and each branch appears as a separate row in the **Suppliers** tab with its own pricing, reflecting the **Ship-To Account** assigned to that branch.
> [accordion] Why is pricing not showing after I link a product?
>
> Catalog creation runs in the background and might take a few minutes to complete, and a banner at the top of the screen appears while the catalog populates. Wait until the banner disappears before you select **Manage Catalog** to review pricing.
> [accordion] Can I update the UOM or option mapping after saving?
>
> Yes, go to the product record, select **Suppliers**, open the **three-dot menu** next to the ABC Supply branch row, and select **Manage Catalog** to update the UOM or option mappings and save. If the unit cost looks incorrect after saving, confirm the **Ship-To Account** on the branch is set correctly in **Supplier Settings**.
> [accordion] What does deleting a supplier catalog mapping do?
>
> Deleting a mapping removes the pricing link for that option, and the product remains in your **Parts and Services** catalog, though it no longer pulls ABC Supply pricing for the deleted option. Other mapped options on the same product stay unaffected.
> [accordion] The ABC Supply option is not appearing in the Connected Suppliers tab. What should I check?
>
> Confirm that the ABC Supply integration is installed and that at least one branch is connected. If the integration was recently uninstalled, you must reinstall it and sign in again before you link products. If the issue continues, contact [Support](mailto:support@zuper.co).
## Related articles
* [Connecting ABC Supply](https://docs.zuper.co/Integrations/Purchasing/abc-supply/connecting-abc-supply)
* [Creating a material order with ABC Supply pricing](https://docs.zuper.co/Integrations/Purchasing/abc-supply/placing-material-order-to-abc)
* [Linking catalog products to SRS Distribution](https://docs.zuper.co/Integrations/Purchasing/Link%20Catalog%20Products%20to%20SRS)
# Using ABC Pricing on Your Proposals
Source: https://docs.zuper.co/Integrations/Purchasing/abc-supply/using-abc-pricing-on-your-proposals
## Overview
A CPQ (Configure, Price, Quote) proposal lets you present multiple pricing options in a single document, for example, a **Basic** package and an **Intermediate** package side by side. The customer reviews both, selects the one that suits them, and Zuper converts the accepted option into a quote.
When your **Parts and Services** catalog is linked to ABC Supply, Zuper takes this a step further by populating every line item with live branch pricing automatically. The numbers your customer sees reflect what your branch charges today, without any manual price entry.
The following sections show you how to create, review, and send a CPQ proposal with ABC Supply pricing from a job record.
## Before you begin
Two things must be in place before you create a CPQ proposal with ABC Supply pricing.
* Your ABC Supply integration must be installed, and at least one branch must be active. See [Connecting ABC Supply](#).
* The parts and products you plan to include must be linked to your ABC Supply catalog. See [Linking catalog products to ABC Supply](#).
The job record must also exist in Zuper before you can create a proposal from it.
## Create a CPQ proposal from a job
CPQ proposals in Zuper are generated in one of two ways: automatically when a job reaches a configured status, or manually from the job record.
When a job reaches the category and status configured in your CPQ template, Zuper automatically generates the proposal, and it appears in the **Proposals** panel on the job record, ready to review. Your admin sets the trigger in **Quote Settings**. See Setting up a CPQ proposal template for details. Open the proposal from the **Proposals** panel, and continue to **Review and edit the proposal** below.
### Create a proposal manually
If you need to create a proposal before the status trigger is reached, or if automatic generation is not configured, you can create one manually.
1. Go to **Jobs** from the left navigation menu.
2. Open the job record you want to create a proposal for.
3. Select **+** in the left panel of the job record.
4. Select **New Proposal** from the menu.
5. Choose the CPQ template for this job type in the template selector, and select **Choose Template**. The proposal opens on the **Edit Proposal** screen. Continue to **Review and edit the proposal** to complete it.
## Review and edit the proposal
The proposal opens on the **Edit Proposal** screen. Before you add line items, review the following fields to confirm the proposal is set up correctly.
### Confirm proposal details
The top of the screen shows three areas to review before you add line items.
* **Association(s)** — confirms the job and customer linked to this proposal. Verify these are correct before you proceed.
* **Address** — the service address pulled automatically from the job record.
* **Proposal Details** — expiry date, proposal template, and other fields. Update the expiry date if the default does not match your quoting window.
### Confirm the branch and pricelist
Confirm the connected ABC Supply branch shown at the top right of the **Options** section. This is the branch whose pricing Zuper uses for all line items in this proposal.
If you need to use a different branch, update your preferred branch in **Supplier Settings** before you add line items.
## ABC Supply pricing on mobile
If you are working from the Zuper mobile app, you can access ABC Supply branch pricing for your quotes and proposals, though the way Zuper determines the branch price differs depending on where you created the quote.
For quotes created in the Zuper mobile app, you cannot select an ABC Supply branch directly, so Zuper uses the preferred branch set in your **Supplier Settings** to derive branch pricing. For quotes created on the web, pricing is derived from the supplier assigned to the quote.
## Add line items to each option
A CPQ proposal contains one or more option cards, for example, **Basic** and **Intermediate**. Each option is a separate pricing package, and you add line items to each option independently.
1. Scroll to an option card in the **Options** section.
2. Select **+ Add** within the option card to add a part or service from your catalog.
3. Search for and select the item. Zuper pulls the unit cost from the ABC Supply branch pricing linked to that product.
4. If the product has multiple ABC Supply options, for example, different colors or sizes, select the correct option from the dropdown next to the line item.
5. Enter a markup amount if applicable.
6. Repeat steps 2–5 for each line item in that option.
7. Repeat the process for every other option in the proposal.
> [!NOTE]
>
> For items linked to your ABC Supply catalog, the unit cost reflects ABC Supply branch pricing at the time you create the proposal. If no ABC Supply catalog mapping exists for an item, Zuper uses the **Master Cost** set in your Parts and Services catalog instead.
## Save and send the proposal
Once you have finished adding line items to all options, you have two choices.
* Select **Save and Send** at the top right to save the proposal and send it to the customer immediately.
* Select **Save as Draft** to save without sending. You can open the proposal later by going to **Accounting** and selecting **Quotes**, and send it from the proposal detail page.
## What happens after the customer responds
When the customer accepts the proposal, Zuper converts the accepted option into a quote. The unit cost for each line item is determined by whether the item has an ABC Supply catalog mapping.
* Items linked to your ABC Supply catalog use the unit cost from your ABC Supply branch catalog at the time you created the proposal.
* Items without a catalog in the selected ABC Supply branch use the **Master Cost** from the product catalog.
This means the two types of items can coexist in the same quote without any manual adjustment.
> [!WARNING]
>
> Unit costs on the converted quote reflect ABC Supply branch pricing at proposal creation time, not at quote conversion time. If branch prices have changed since you created the proposal, the converted quote shows the original proposal prices.
[Create a CPQ proposal with ABC Supply pricing](https://player.vimeo.com/video/1217578364?title=0\&byline=0\&portrait=0)
## How pricing stays current
Zuper updates pricing for all ABC Supply-connected parts and products automatically, so you do not need to maintain prices manually.
* **Daily update** — every day, Zuper refreshes the unit cost for each product option and UOM across all your active ABC Supply supplier branches.
* **On-use update** — when you add an ABC Supply-connected part to an estimate or purchase order, Zuper fetches the latest price from the associated branch at that moment.
## FAQs
> [accordion] Can I create a CPQ proposal without ABC Supply set up?
>
> Yes, but line items do not automatically populate with branch pricing, so you need to enter unit costs manually. To use live ABC Supply pricing, install the ABC Supply integration and link your products to the catalog before you create the proposal.
> [accordion] What happens if I add a product that is not linked to my ABC Supply catalog?
>
> Zuper uses the **Master Cost** from your Parts and Services catalog instead, and both linked and unlinked items can coexist in the same proposal without any manual adjustment.
> [accordion] Can I change the ABC Supply branch after I start adding line items?
>
> Yes, the purchase cost updates to the new branch pricing for products linked to that branch. For products without a catalog in the newly selected branch, pricing is pulled from the product master.
> [accordion] Can I save a proposal without sending it to the customer?
>
> Yes, select **Save as Draft** to save without sending. You can open the proposal later by going to **Accounting** and selecting **Quotes**, and send it from the proposal detail page.
> [accordion] How does ABC Supply pricing work when I create a proposal from the mobile app?
>
> When you create a proposal from the Zuper mobile app, you cannot select an ABC Supply branch directly, so Zuper uses the preferred branch set in your **Supplier Settings** to derive branch pricing. For proposals created on the web, pricing is derived from the supplier assigned to the quote.
## Related articles
* [Connecting ABC Supply](https://docs.zuper.co/Integrations/Purchasing/abc-supply/connecting-abc-supply)
* [Linking catalog products to ABC Supply](https://docs.zuper.co/Integrations/Purchasing/abc-supply/setup-your-abc-catalog)
* [Creating a CPQ proposal with SRS Distribution pricing](https://docs.zuper.co/Integrations/Purchasing/Creating%20a%20CPQ%20proposal%20with%20SRS%20pricing)
* [Creating a purchase order from a quote with ABC Supply items](https://docs.zuper.co/Integrations/Purchasing/abc-supply/placing-material-order-to-abc)
# Aircall
Source: https://docs.zuper.co/Integrations/SMS_and_Telephony/Aircall
**Aircall** is a leading cloud-based phone system designed for businesses, especially sales and customer support teams. Based in Europe, it provides VoIP (Voice over Internet Protocol) services and supports communication across more than **160 countries**, including the USA, Canada, New Zealand, and Singapore.
The **Zuper–Aircall integration** enables your back-office teams to connect their Aircall account with Zuper, allowing them to make and receive calls, as well and send outbound text messages, directly from the Zuper web app. This integration enhances communication efficiency by bringing calling and messaging functions into a single platform.
## Field Mapping
When you integrate Aircall with Zuper, the following data sync occurs automatically:
| **Zuper Field** | **Aircall Field** |
| :- | :- |
| **Users** | **Users** |
| First Name | First Name |
| Last Name | Last Name |
| Email | Email |
| **Teams** | **Teams** |
| Team Name | Team Name |
| **Customers** | **Customers** |
| First Name | First Name |
| Last Name | Last Name |
| Email | Email |
| Mobile Number, Home Number, Work Number | Phone Numbers |
| Organization | Company Name |
***
## A. Setting up your Aircall account
1. Log in to your **Aircall** account using your registered **Email ID** and **Password**.

2. Click **"Create" or "Port a Number"** to add a new number to your Aircall account.

## B. Connecting Aircall with Zuper
The **Zuper–Aircall integration** lets you connect your Aircall account with Zuper to make and receive calls, as well as send outbound text messages through your Aircall number.
#### **Step 1: Access the App Store**
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store** from the dropdown menu.

2. Under **Browse by Category**, select **Telephony, Video & SMS**, and choose **Aircall**.

> [!NOTE]
>
> Note: Ensure that the Phone Call option is enabled for your contacts.
>
> Navigation: Contacts → Edit Contact → Notification Preferences
#### **Step 2: Authorize and Configure Integration Settings**
1. Click "**Install Aircall**" to allow Zuper to access information from your Aircall account.

2. Configure the following fields:
| **Field** | **Description** | **Where to Find** |
| :-: | :-: | :-: |
| **Zuper API Key (Mandatory)** | Enter your Zuper API Key to authenticate the integration. | \[Refer: [How to generate a Zuper API Key](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys)] |
| **Sync Customers (Mandatory)** | Choose **Yes** to sync customer data from Zuper to Aircall; choose **No** to disable syncing. | Available in Aircall Integration Settings in Zuper |
| **Sync Teams (Mandatory)** | Choose **Yes** to sync team data from Zuper to Aircall; choose **No** to disable syncing. | Available in Aircall Integration Settings in Zuper |
| **Sync Users (Mandatory)** | Choose **Yes** to sync user details from Zuper to Aircall; choose **No** to disable syncing. | Available in Aircall Integration Settings in Zuper |
| **Aircall From Number (Mandatory)** | Enter your registered 10-digit Aircall number. This number must be SMS-enabled and compliant with regional regulations (e.g., A2P10DLC in the USA). | Aircall → Numbers → Active Numbers |

Click **Update** to complete the integration setup.
## C. Using the Zuper–Aircall Integration
#### **1. Making and Receiving Calls**
1. Click the **Sign In** button on the **Aircall widget** (displayed at the bottom-right of the Zuper web app).
2. Select the preferred number from your available Aircall numbers.
3. Use the **Aircall Dial Pad** to make outgoing calls or receive incoming calls directly within Zuper.

> [!NOTE]
>
> Note: The Aircall widget remains active while navigating across Zuper pages. To enable the Aircall integration on your account, contact our Support Team at [support@zuper.co](mailto:support@zuper.co).
#### **2. Sending Text Messages via Aircall**
1. Navigate to **Contacts** from the left navigation panel. Select the contact you want to notify from the listing page to open its details.

2. On the **Contact Details** page, click **More Actions → Email/Text Message**.

3. Configure the following fields:
| **Field** | **Description** |
| :-: | :-: |
| **Contact Via (Mandatory)** | Select **SMS** to send the notification. |
| **Contact Number (Mandatory)** | Choose the contact number for which the message should be sent. |
| **Message Body (Mandatory)** | Enter the text message content. |

Click **Send** to deliver the text message via Aircall.
## D. Uninstalling Aircall from Zuper
1. If you no longer need the integration, follow the steps below to uninstall the Aircall app.
Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store**.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **Aircall**. Click **Uninstall**.

3. The Aircall is uninstalled successfully.

The **Zuper–Aircall integration** streamlines communication for customer-facing teams by enabling call management and SMS directly within Zuper.
\
With this cloud-based, one-way integration, data flows from Zuper to Aircall, allowing users to efficiently handle calls, respond to inquiries, and send real-time text notifications.
\
This integration ensures better customer engagement, faster service resolution, and an enhanced support experience.
# CloudTalk
Source: https://docs.zuper.co/Integrations/SMS_and_Telephony/CloudTalk
CloudTalk is a leading cloud-based phone system based in the European region, trusted by global businesses for efficient communication across more than 160 countries.
The **Zuper–CloudTalk integration** enables seamless outbound communication by connecting your CloudTalk account with Zuper. Once integrated, you can automatically send outbound **Text Messages** directly through your CloudTalk number to keep your contacts informed about job updates, pending items, or service notifications in real time.
> [!NOTE]
>
> Note:
>
> * You must have an active CloudTalk Essentials plan or above to use this integration.
> * Ensure that Text Message/Text Notifications are enabled for your contacts.
>
> Navigation: Contacts → Contacts Listing page → Edit (via three-dot icon) → Edit Contact page → Notification Preferences
## A. Connecting CloudTalk with Zuper
Follow the steps below to integrate your CloudTalk account with Zuper.
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store** from the dropdown menu.

1. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **CloudTalk** from the list of available integrations. Click **Install CloudTalk**.


3. Update the following fields with details from your CloudTalk account:
| **Field** | **Description** | **Where to Find** |
| :-: | :-: | :-: |
| **Zuper API Key (Mandatory)** | Enter your Zuper API Key. | \[Refer: [How to generate a Zuper API Key](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys)] |
| **CloudTalk Access Key ID (Mandatory)** | Enter your CloudTalk Access Key ID. | Go to *CloudTalk → Settings → API Keys → Access Key ID* |
| **CloudTalk Access Key Secret (Mandatory)** | Enter your CloudTalk Access Key Secret. | Go to *CloudTalk → Settings → API Keys → Access Key Secret → Show* |
| **Sender Number (Mandatory)** | Enter the CloudTalk phone number from which text messages will be sent. | Go to *CloudTalk → Settings → Numbers → Active Numbers* |
| **Sync Contacts (Yes/No)** | Choose **Yes** to sync contacts between Zuper and CloudTalk, or **No** to disable synchronization. | Configure within the **CloudTalk Integration Settings** panel in Zuper. |



Click **Update** to complete the integration setup.
## B. Using the Zuper–CloudTalk Integration
Once the integration is configured, you can send **Text Messages** directly from Zuper using your CloudTalk number.
1. Navigate to the **Contacts** module from the left panel.

2. Select a contact on the listing page to open its details. On the **Contact Details** page, click **More Actions** (top-right corner) and select **Email/Text Message** from the dropdown menu.

3. Fill in the following fields:
| **Field** | **Description** |
| :-: | :-: |
| **Contact Via (Mandatory)** | Select SMS to send a notification. |
| **Contact Number (Mandatory)** | Choose the contact’s phone number. |
| **Message Body (Mandatory)** | Enter the message content. |

Click **Send** to deliver the text message via CloudTalk.
> [!NOTE]
>
> Note: You can trigger messages via the Contacts module, Bulk Text Message action, or Workflow automation.
## C. Uninstalling CloudTalk from Zuper
If you no longer need the integration, follow the steps below to uninstall the CloudTalk app.
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store**.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **CloudTalk**.

3. The **CloudTalk** is uninstalled successfully..

With the **Zuper–CloudTalk integration**, businesses can streamline communication and ensure instant notifications for their customers. This one-way integration enables data to flow from Zuper to CloudTalk, automatically sending Text Messages for updates, reminders, and notifications, enhancing efficiency and customer engagement.
# Gupshup
Source: https://docs.zuper.co/Integrations/SMS_and_Telephony/Gupshup
The Gupshup – Zuper Integration helps users build a bot platform and set up a conversational bot service that enhances customer communication when using the WhatsApp chatbot.
The customer purchases a Gupshup subscription, and our Zuper team builds a conversational bot for optimal customer-user communication on WhatsApp.
To ensure a seamless experience, Gupshup verifies that messages created for WhatsApp by Zuper are valid before they are used on WhatsApp. Without predefined and approved templates on Gupshup, the developer will not be able to send messages on WhatsApp.
1. Log in to “**Gupshup**” and enter the valid credentials to log in and set the conversational bot.

2. Select the “**Message Templates**” option from the left panel. The user can view the message template, create a new one, or clone an existing one. To start a new template, select the “**Create**” option.
3. Enter the “**Your Account**” password and “**Name**,” then select the “**Alert Update**” option under the category.

5. Select the “**Type**” of the template as “**Text**.” Next, choose the “**Language**” as “**English**.” Finally, enter the Header (Optional) and Body details.

6. Enter the “**Footer**” Details (Optional), Button (Optional), and button text (Mandatory) details. The button text can be viewed under the preview pane. Then select the “**Add Sample**” option.

7. Enter the “**Body**” details under the "**Add Sample**" content option to preview the details and select “**Done**.”

8. Select the “**Create**” option to generate the message template. Once the message template gets approved, the details will be used for the user–bot conversations without any flaws.

Whenever Zuper creates message templates on Gupshup for user-bot interaction, Gupshup ensures that the approved pre-registered messages and conversational messages built by the developer remain unchanged.
# Infobip
Source: https://docs.zuper.co/Integrations/SMS_and_Telephony/Infobip
With the help of our Zuper-Infobip Integration, business owners can send SMS notifications to their customers with regular updates and reminders for their requested work orders.
## A. How to connect your Infobip with Zuper?
1. Open a new tab in your browser and log in to your Zuper Account. Click on your Profile Picture on the top right corner of the screen & select the “**App Store**.”

2. Under the “\*\*Browse by Category,” \*\*select the “**Telephony, Video & SMS**” option and choose “**Infobip**.”

3. Click on the “**Install Infobip**” button.

> [!NOTE]
>
> **Note**: Please keep *Zuper and Infobip* tabs open; you can switch between the tabs for integration.
4. Switch to the Infobip tab on your browser and log in to your Infobip account.
Using the copy icon, copy the API key and API Base URL from the Infobip home page.

## B. Using the Zuper–Infobip Integration
Once the integration is configured, you can send **Text Messages** directly from Zuper using your SimpleTexting number.
1. Navigate to the **Contacts** module from the left panel. Select a contact on the listing page to open its details.

2. On the **Contact Details** page, click **More Actions** (top-right corner) and select **Email/Text Message** from the dropdown menu.
Fill in the following fields:
| **Field** | **Description** |
| :-: | :-: |
| **Contact Via (Mandatory)** | Select **SMS** to send a notification. |
| **Contact Number (Mandatory)** | Choose the contact’s phone number. |
| **Message Body (Mandatory)** | Enter the message content. |

Click **Send** to deliver the text message via SimpleTexting.
> [!NOTE]
>
> Note: You can trigger messages via the Contacts module, Bulk Text Message action, or Workflow automation.
## C. Uninstalling Infobip from Zuper
If you no longer need the integration, follow the steps below to uninstall the Infobip app.
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store**

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **Infobip.** you have the option to Uninstall **Infobip**.

3. The Infobip is uninstalled successfully.

With this one-way integration, data flows from **Zuper to Infobip**, ensuring that customers.
# Invisible Link
Source: https://docs.zuper.co/Integrations/SMS_and_Telephony/Invisible_Link
Invisible Link is a widely used SMS application based in the European region, trusted for reliable message delivery and easy integration with business workflows.
The Zuper–Invisible Link SMS integration enables seamless communication by connecting your Invisible Link account with Zuper. Once integrated, you can automatically send outbound Email/Text Messages directly through your Invisible Link number, keeping your contacts informed about pending items, job updates, or service notifications in real time.
> [!NOTE]
>
> Note:
>
> * This integration is available to all users with an active Invisible Link plan, regardless of your location.
> * Ensure that **Text Message/Text Notifications** are enabled for your contacts.\
> \
> **Navigation:** Contacts → Contacts Listing page → Edit (via three-dot icon) → Edit Contact page → Notification Preferences
## A. Connecting Invisible Link SMS with Zuper
Follow the steps below to integrate your Invisible Link account with Zuper.
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store** from the dropdown menu.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **Invisible Link** from the list of available integrations.

3. Click **Install Invisible Link**.

> [!TIP]
>
> Tip: Keep both Zuper and Invisible Link tabs open during setup to switch between accounts easily.
4. Update the following fields with details from your Invisible Link account:
| Field | Description | Where to Find |
| :- | :- | :- |
| **Invisible API Key (Mandatory)** | Enter the Invisible Link API key. | Go to **Settings → Developer Section → API Key → Generate API Key** on Invisible Link. |
| **Invisible Link User Name (Mandatory)** | Enter the login name used for Invisible Link. | Use your login username from the Invisible Link login page. |
| **Invisible Link Sender Name/Number (Mandatory)** | Enter the sender name/number from which messages will be sent. | Go to **Send → Single SMS → Alphanumeric Sender** on Invisible Link. |

Click **Update** to complete the integration.
## B. Using the Zuper–Invisible Link SMS Integration
Once integrated, you can send **Email/Text Messages** directly from Zuper.
1. Navigate to the **Contacts** module from the left panel.

2. Select a **contact** from the listing page to open its details.
On the **Contact Details** page, click ****More Actions (at the top right corner) and selectEmail/Text Message**** from the dropdown menu.

3. Fill in the following fields:
| Field | Description |
| :- | :- |
| **Contact Via (Mandatory)** | Select **Text Message** to send a notification. |
| **Contact Number (Mandatory)** | Choose the contact’s phone number. |
| **Message Body (Mandatory)** | Enter the message content. |

Click **Send** to deliver the text message via Invisible Link.
> [!NOTE]
>
> Note: You can trigger messages via the Contacts module, Bulk Text Message action, or Workflow automation.
## C. Uninstalling Invisible Link from Zuper
If you no longer need the integration, follow the steps below to uninstall the Invisible Link app.
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store**.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **Invisible Link**. You have the option to Uninstall **Invisible Link**.

3. The Invisible Link is uninstalled successfully.

A confirmation message will appear once **Invisible Link** has been successfully uninstalled.
# Message Media
Source: https://docs.zuper.co/Integrations/SMS_and_Telephony/Message_Media
The **Zuper–Message Media integration** enables you to send outbound **Text Message/Text Notifications** to your contacts directly from Zuper using your Message Media account. This ensures customers receive instant updates on pending items, job progress, or service alerts.
> [!NOTE]
>
> Note:
>
> 1. To enable the Message Media integration on your account, contact our Support Team at [support@zuper.co](mailto:support@zuper.co).
> 2. Ensure that Text Message/Text Notifications are enabled for your contacts.
>
> Navigation: Contacts → Contacts Listing page → Edit (via three-dot icon) → Edit Contact page → Notification Preferences
> 3. The Zuper–Message Media integration currently supports the following countries: Australia, Canada, New Zealand, the UK, and the US.
## A. Connecting Message Media with Zuper
Follow the steps below to integrate your Message Media account with Zuper.
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store** from the dropdown menu.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **Message Media** from the list of available integrations. Click **Install Message Media**.

> [!TIP]
>
> Tip: Keep both the Zuper and Message Media tabs open during setup to switch between them easily.
>
> ###
In the configuration window, fill in the following details:
| Field | Description |
| :- | :- |
| **Authentication Method (Mandatory)** | Select the authentication method – either **Basic Auth** or **HMAC**. |
| **Auth Username (Mandatory)** | Enter your Message Media authentication username. |
| **Auth Password (Mandatory)** | Enter your Message Media authentication password. |
| **Enable SMS Notification** | Select **Yes** to enable Text Message notifications. |

Click **Update** to complete the integration setup.
## B. Using the Zuper–Message Media Integration
Once integrated, you can send Text Messages directly from Zuper through Message Media.
1. Navigate to the **Contacts** module from the left navigation menu. Select a contact on the listing page to open its details.

3. On the **Contact Details** page, click **More Actions** on the top right corner and select Email/Text Message from the dropdown menu.
Fill in the following fields:
| Field | Description |
| :- | :- |
| **Contact Via (Mandatory)** | Select **Text Message** to send a notification. |
| **Contact Number (Mandatory)** | Choose the contact’s phone number. |
| **Message Body (Mandatory)** | Enter the text message content. |

Click **Send** to deliver the text message via Message Media.
> [!NOTE]
>
> Note: You can trigger Text Messages via the Contacts module, Bulk Text Message action, or Workflow automation.
## C. Uninstalling Message Media from Zuper
If you no longer need the integration, follow the steps below to uninstall the Message Media app.
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store**.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **Message Media**. Click **Deactivate**. You have the option to Uninstall **Message Media**.

3. The Message Media is uninstalled successfully.

A confirmation message will appear once **Message Media** has been successfully uninstalled.
# RingCentral
Source: https://docs.zuper.co/Integrations/SMS_and_Telephony/RingCentral
The **Zuper–RingCentral integration** allows you to connect your RingCentral account with Zuper to seamlessly make calls and send outbound **Email/Text Messages** directly through your RingCentral number.
> [!NOTE]
>
> **Note**:
>
> * To enable the **RingCentral integration** on your account, contact our Support Team at [**support@zuper.co**](mailto:support@zuper.co).
> * The RingCentral widget remains active and is not refreshed when navigating between Zuper pages.
> * Ensure that Text Message/Text Notifications and Phone Call are enabled for your contacts.
>
> Navigation: Contacts -> Contacts Listing page -> Edit (via three-dot icon) -> Edit Contact page-> Notification Preferences
## A. Connecting RingCentral with Zuper
Follow the steps below to integrate your RingCentral account with Zuper.
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store** from the dropdown menu.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **RingCentral** from the list of available integrations.

3. Click **Install RingCentral**.

3. Enter your **Phone Number** or **Email ID**, and click **Next**. Click **Authorize** to allow Zuper to connect with your RingCentral account.

1. In the **From Number (Mandatory)** field, enter your **registered RingCentral number**.
* This is the number from which outbound text messages will be sent.
* Click **Update** to complete the integration setup.

## B. Using the Zuper–RingCentral Integration
Once the integration is configured, you can send **Email/Text Messages** and make calls directly from Zuper using your RingCentral number.
### Step 1: Access the Email/Text Message Option
1. Navigate to the **Contacts** module from the left navigation menu. Select a contact on the listing page to open its details.
On the **Contact Details** page, click **More Actions → Email/Text Message**.
Fill in the following fields:
| Field | Description |
| :- | :- |
| **Contact Via** *(Mandatory)* | Select **Text Message** to send a notification. |
| **Contact Number** *(Mandatory)* | Choose the contact’s phone number. |
| **Message Body** *(Mandatory)* | Enter the message content. |
Click **Send** to deliver the text message via RingCentral.

### Make Calls via RingCentral
You can initiate calls directly from Zuper, either from the **Job Details** page or the **Contact Details** page.
* On the Job Details or Contact Details page, click **"Call" in** the left panel.
* Choose the contact number you wish to call.
Calls are made using the RingCentral Dialer, which is integrated within Zuper.

## C. Uninstalling RingCentral from Zuper
If you no longer need the integration, follow the steps below to uninstall the RingCentral app.
### Access the App Store
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store**.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **RingCentral**. You have the option to Uninstall RingCentral.


A confirmation message will appear once RingCentral has been successfully deactivated and uninstalled.
# Sakari
Source: https://docs.zuper.co/Integrations/SMS_and_Telephony/Sakari_with_Zuper
The **Zuper–Sakari Link SMS integration** allows you to connect your Sakari account with Zuper to automatically send outbound text messages through your Sakari number.
Sakari is a popular SMS application primarily used in the USA. However, if you have an active Sakari Link plan, you can use this integration regardless of your location.
> [!NOTE]
>
> **Note**: To use this integration, you must have a Sakari Developer Account and be subscribed to any Sakari SMS pricing plan.
## A. Connecting Sakari with Zuper
Follow the steps below to integrate your Sakari account with Zuper.
1. Log in to your **Zuper web app**. Click on your **Profile Picture** in the top-right corner. Select **App Store** from the dropdown menu.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **Sakari** from the available apps.

3. Click the **Configure Settings** button to open the integration page.
> [!TIP]
>
> Tip: Keep both Zuper and Sakari tabs open so you can easily switch between them during setup.
> **Important:**\
> Ensure that **Text Message/Text Notifications** are enabled for your end users.\
> **Navigation:** Contacts -> Contacts Listing page -> Edit (via three-dot icon)→ Notification Preferences.
Update the following fields in Zuper with the details from your Sakari account:
| Field Name | Description | Where to Find in Sakari |
| :-: | :-: | :-: |
| **Client ID** *(Mandatory)* | Enter your Sakari Client ID. | Go to **Settings → Account Settings → API Key → Client ID** |
| **Client Secret** *(Mandatory)* | Enter your Sakari Client Secret. | Go to **Settings → Account Settings → API Key → Client Secret** |
| **Account ID** *(Mandatory)* | Enter your Sakari Account ID. | Go to **Settings → Account Settings → API Key → Account ID** |
> [!NOTE]
>
> Note: After copying the Client Secret, it will be hidden when you refresh the Sakari page.
>
> Once all details are entered, click **Update** to complete the integration.

## B. Using the Zuper–Sakari Integration
Once integrated, you can send SMS notifications directly from Zuper using your Sakari number.
1. Navigate to the **Contacts** module from the left navigation menu. Select a contact on the listing page to open its details.

2. On the **Contact Details** page, click **More Actions → Email/Text Message**.

3. Configure Email/Text Message Details to Send
Fill in the following fields:
| Field | Description |
| :-: | :-: |
| **Contact Via** *(Mandatory)* | Select **SMS**. |
| **Contact Number** *(Mandatory)* | Choose the customer’s contact number. |
| **Text Message Body** *(Mandatory)* | Enter the message content. |

Click **Send** to deliver the message via Sakari.
> Once sent, the SMS is processed through Sakari and delivered to the customer.
## C. Uninstalling Sakari from Zuper
If you no longer need the integration, follow the steps below to uninstall the Sakari app.
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store**.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **Sakari**. You have the option to Uninstall **Sakari**.

3. The Sakari is uninstalled successfully.

A confirmation message will appear once **Sakari** has been successfully uninstalled.
SMS notifications are an excellent way to keep customers informed about their latest job updates.\
This **one-way integration** allows data to flow from **Zuper to Sakari**, ensuring timely SMS delivery to customers.
# Sales Message
Source: https://docs.zuper.co/Integrations/SMS_and_Telephony/Sales_Message
**Sales Message** is a widely used SMS application based in the USA region, trusted by businesses for reliable message delivery, two-way communication, and easy integration with various business tools.
The **Zuper–Sales Message Link SMS integration** enables seamless communication by connecting your **Sales Message** account with **Zuper**. Once integrated, you can automatically send outbound **Email/Text Messages** directly through your **Sales Message** number, ensuring that your contacts stay informed about important updates such as job progress, appointment reminders, and service notifications in real time.
> [!NOTE]
>
> Note:
>
> * This integration is available to all users with an active Sales Message Link plan, regardless of their location.
> * You must create a Sales Message developer account and subscribe to any Sales Message SMS pricing plan to enable this integration.
> * Ensure that Text Message/Text Notifications are enabled for your contacts.
>
> Navigation: Contacts → Contacts Listing page → Edit (via three-dot icon) → Edit Contact page → Notification Preferences
### A. Connect Sales Message with Zuper
1. Log in to your Zuper account and click your **profile picture in** the top right corner. From the dropdown menu, select **App Store**.

2. Under **Browse by Category**, choose **Telephony, Video, & SMS** and select **Sales Message**.

3. Click **Install Sales Message**.

> [!TIP]
>
> Tip: Keep both the Zuper and Sales Message tabs open to switch between them during setup easily.
5. Configure the following fields in the Sales Message integration setup:
| **Field Name** | **Description** |
| :-: | :-: |
| **Zuper API Key** *(Mandatory)* | Enter your Zuper [API](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys) Key. |
| **Personal Access Token** *(Mandatory)* | Enter your Sales Message Client ID. To get this, go to **Sales Message → Settings → Developer Settings → Personal Access Tokens → Create Token.** |
| **Sales Message Team Name** *(Mandatory)* | Enter your Sales Message Team Name. To find it, go to **Sales Message → Settings → Organization → Inboxes → Name.** |



Click **Update** to complete the integration setup between Zuper and Sales Message.
### B. Send Text Messages via Sales Message Integration
Once connected, Zuper uses the Sales Message integration to send Text Notifications automatically to your contacts.
1. Navigate to the **Contacts** module from the left navigation menu. Select a contact on the listing page to open its details.

2. On the **Contact Details** page, click **More Actions** (top right corner)**→ Email/Text Message**.

3. In the **Email/Text Message** window, configure the following fields:
* **Contact Via (Mandatory)** – Select **Text Message**.
* **Contact Number (Mandatory)** – Choose the number to send the message to.
* **Message Body (Mandatory)** – Enter your message content.

5. Click **Send** to send a Text Message via your connected Sales Message account.
### C. Uninstall Sales Message from Zuper
If you no longer need the integration, follow the steps below to uninstall the Sales Message app.
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store**.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **Sales Message.** You have the option to Uninstall **Sales Message**.

3. The Sales Message is uninstalled successfully.

# SimpleTexting
Source: https://docs.zuper.co/Integrations/SMS_and_Telephony/SimpleTexting
SimpleTexting is a leading cloud-based text messaging platform, trusted by businesses in the North American region for reliable and efficient customer communication.
The Zuper–SimpleTexting integration enables seamless outbound communication by connecting your SimpleTexting account with Zuper. Once integrated, you can automatically send outbound text messages directly from your SimpleTexting number to keep your contacts informed about job updates, pending actions, or service notifications in real-time.
> [!NOTE]
>
> Note: You must have an active SimpleTexting account and subscription to use this integration.
## A. Connecting SimpleTexting with Zuper
Follow the steps below to integrate your SimpleTexting account with Zuper.
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store** from the dropdown menu.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **SimpleTexting** from the list of available integrations.

3. Click **Install SimpleTexting**.

4. Update the following fields with details from your SimpleTexting account:
| **Field** | **Description** | **Where to Find** |
| :-: | :-: | :-: |
| **SimpleTexting API Key (Mandatory)** | Enter your SimpleTexting API key to authenticate the integration between Zuper and SimpleTexting. | Log in to SimpleTexting → Dashboard → Profile & Settings → API tab → API Token |
| **Enable SMS Notification (Yes/No)** | Choose **Yes** to enable text message notifications for your contacts. This ensures that Zuper can send outbound text messages via SimpleTexting. | Available under **Contacts → Edit Contact → Notification Preferences** |

Click **Update** to complete the integration setup.
## B. Using the Zuper–SimpleTexting Integration
Once the integration is configured, you can send **Text Messages** directly from Zuper using your SimpleTexting number.
1. Navigate to the **Contacts** module from the left panel. Select a contact on the listing page to open its details.

2. On the **Contact Details** page, click **More Actions** (top-right corner) and select **Email/Text Message** from the dropdown menu.
Fill in the following fields:
| **Field** | **Description** |
| :-: | :-: |
| **Contact Via (Mandatory)** | Select **SMS** to send a notification. |
| **Contact Number (Mandatory)** | Choose the contact’s phone number. |
| **Message Body (Mandatory)** | Enter the message content. |
Click **Send** to deliver the text message via SimpleTexting.

> [!NOTE]
>
> Note: You can trigger messages via the Contacts module, Bulk Text Message action, or Workflow automation.
## C. Uninstalling SimpleTexting from Zuper
If you no longer need the integration, follow the steps below to uninstall the SimpleTexting app.
1. Log in to your **Zuper web app**. Click your **Profile Picture** in the top-right corner. Select **App Store**.

2. Under **Browse by Category**, select **Telephony, Video & SMS**. Choose **SimpleTexting.** You have the option to Uninstall **SimpleTexting**.

3. The SimpleTexting is uninstalled successfully.

With this one-way integration, data flows from **Zuper to SimpleTexting**, ensuring that customers receive instant SMS notifications for the latest job updates, appointments, and service alerts—enhancing both communication and customer satisfaction.
# Twilio
Source: https://docs.zuper.co/Integrations/SMS_and_Telephony/Twilio
With the Zuper integration with Twilio, users can now quickly send job status information to customers.
1. Click on your profile picture in the top right corner of the page to open the list of options. Next, click on the “**App Store**” link.

2. You will be redirected to “**App Store** ”. Click on “**Telephony, Video & SMS** ” under “**Browse by Category"** on your left. Click the “**Twilio**” card.

3. Click on the “**Install Twilio**” button.

4. Under the “**Update Twilio Settings**” box, enter the “**Account SID**”, “**Auth Token**”,“**Sender Number**” from Twilio.

> [!NOTE]
>
> **Note**: To get **Account SID** , **Auth Token** , **Sender Number** , Go to your **Twilio Dashboard** and copy the
>
> **Account SID & Auth Token**.
Once you have filled in the details, click the “**Update**” button.
Once you have connected your Twilio account with Zuper, all SMS notifications set up in Zuper will be sent to your customers via the connected Twilio account
# Zapier
Source: https://docs.zuper.co/Integrations/Work_Flow_Automation/Zapier
Zuper's first-class integration with Zapier seamlessly helps you set up automated workflows called Zaps, enabling you to connect apps to Zuper to deliver an exceptional customer experience.
## Installing Zapier in Zuper
Follow these steps to connect Zapier with Zuper:
1. Log in to your Zuper account. Click your profile picture in the top-right corner and select **App Store**.

2. Under the “**Browse by Category**,” select the “**Workflow Automation**” option and choose “**Zapier**.” Click **Install Zapier**.

3. You will be redirected to the Zapier login page. Enter your Zapier **Email ID** (Mandatory) and click **Continue**.

7. Provide the following:
* **API Key** (Mandatory): Generate a Zuper API key. Refer to [How to Create an API Key for Your Zuper Account ](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys)for guidance.
* **API Region** (Optional): Specify the region for your Zuper account.
* Click **Yes, Continue to Zuper**.

The integration between Zapier and Zuper is now established.
## How the Zuper-Zapier Integration Works
Zapier uses Zaps, or automated workflows triggered by events in one app to perform actions in another. Below are examples of common Zaps for Zuper modules. These can be combined or customized for complex workflows.
### i. Create an Organization
1. In Zapier, create a new Zap and select Zuper as the action app.
2. Choose **Create a New Organization** as the event and click **Continue**.

6. Choose the Event. Fill in the Action, Account, and create an Organization, then validate the flow by
Enter the ***Organization Name (Mandatory)*** and fill in the optional fields.
**1) Event** - For creating the organization, use "**Create a New Organization**" from the drop-down list and click the "**Continue**" button. (As we are going to choose the Organization's UID, in this case, we are choosing an Organization).
**2) Account** - Choose the current Zuper account that you use to act.
**3) Action** - In the "**Choose Required Field**" section, you can choose the organization, enter the organization's name, and enter the active or inactive status of the organization.


Click the "**Test Step**" button to create the **Organization UID**. Click the "**Continue**" button.
Click the "**Test**" button to create a new organization, and it generates the **Organization's UID**.

In the "**Custom**" section, you can choose the applicable custom fields.
You can view the **organization UID** that is auto-generated.

> [!NOTE]
>
> Note: Link each organization to one customer and one property only.
The Organization is successfully added.
### ii. Create a Customer
1. Enter the "**Event name**" and click the "**Continue**" button. Choose the Event. Fill in the Action, Account, and create a Customer, then validate the flow by
Enter the ***Customer Name (Mandatory)*** and fill in the optional fields.
**To create a new Customer UID:**
**1) Event** - For creating the Customer, use "**Create a New Customer**" from the drop-down list and click the "**Continue**" button.
**2) Account** - Choose the current Zuper account that you use to act.
**3) Action** - In the "**Choose Required Field**" section, you can choose the Customer, enter the customer's name, and enter the active or inactive status of the customer.


In the "**Custom**" section, you can choose the custom fields that are applicable.
Click the "**Test Step**" button to create the **Customer UID**. Click the "**Continue**" button.


The Customer is successfully added.
### iii. Create a Property
1. Enter the "**Event name**" and click the "**Continue**" button. Choose the Event. Fill in the Action, Account and create a Property, then validate the flow by
Enter the ***Property Name (Mandatory)*** and fill in the optional fields.
**To create a new Property UIDs:**
**1) Event** - For creating the Property, use "**Create a New Property**" from the drop-down list and click the "**Continue**" button.

**2) Account** - Choose the current Zuper account that you use to perform the action.
**3) Action** - In the "**Choose Required Field**" section, you can choose the Property, enter the Property's name, and enter the active or inactive status of the Property.


In the "**Custom**" section, you can choose the custom fields that are applicable.
You can view the **Property UID** that is auto-generated.

The Property is successfully added.
### iv. Find Organization/Customer/Property
* The Find Organization, Customer, or Property Zap is used when creating a Job, Invoice, Quote, or Asset.
* This Zap is a one-stop solution for finding and selecting the exact organization/customer/property while using it in other modules.
1. Select the "**Organization**" and create the new action.

**2) Account** - Choose the current Zuper account that you use to perform the action.
**3) Action** - In the "**Choose Required Field**" section, you can choose the Customer, enter the customer's name, and enter the active or inactive status of the customer and click the "**Continue**" button.

**Select Customer:**
Create the "**Customer**" by choosing the created Organization UID from i) Create an Organization section.

**Select Property:**
Create the "**Property**" by choosing the created Organization UID and Customer UID from i) Create an Organization section.

The Find action is successfully added.
### v. Create Parts & Services List
The same zap can be reused in the various modules with the predefined parts and services created.
The Product zap is first created, and we can link the same in the Jobs, Invoices, and Quotes creation process.
1. Enter the "**Event name**" and click the "**Continue**" button. Choose the Event. Fill in the Action, Account, and create a Customer, then validate the flow by
Enter the **Mandatory fields** and fill in the optional fields.

2. Under the "**Action**" section, enter the details.
Product UID (Comma-Separated) - Enter the product UID, followed by - Enter the product UID followed by the commas.
**Product Price (Comma-Separated)** - Enter the price of the product followed by the commas.
**Product Quantity** **(Comma-Separated)**- Enter the quantity of the product, followed by the commas.
> [!NOTE]
>
> **Note**: The number of Product UIDs and Product Quantity count should be equal.


### vi. Create an Asset
You can use the “Find Organization / Customer / Property” zap to create an asset.
1. Enter the "**Event name**" and click the "**Continue**" button. Choose the Event. Fill in the Action, Account, and create a Customer, then validate the flow by
Enter the **Mandatory fields** and fill in the optional fields.

2. Choose the **Organization UID**, **Customer UID**, and **Property UID** and other Custom fields.

The asset action is successfully added.
### vii. Create a New Job
With all the details created from the various steps in the above section. Now you can create a new job.
1. Enter the mandatory Job details
**Job Title (Mandatory)** - Enter the title of the Job.
**Job Category (Mandatory)** - Choose the Job category.

Job scheduled Start Date & Time (Mandatory) - Choose the start date and time of the Job. \
Job scheduled End Date & Time (Mandatory) - Choose the end date and time of the Job.
> [!NOTE]
>
> Note: The date and time format should be YYYY-MM-DD HH:MM:SS

Choose the **Product UID, Service Contract UID, Organization UID, Customer UID, Property UID, and Asset UID**.

Click the "**Test Step**" button to create the **Job**. Click the "**Continue**" button.

The new Job is successfully added.
### VIII. Create a Job Note
You can create a Job note that is related to the work order.
1. Enter the "**Event name**" and click the "**Continue**" button. Choose the Event. Fill in the Action, Account, and create a Job UID and Note, then validate the flow by,
* Enter the (**Mandatory fields**) and fill in the optional fields.
* **Job UID (Mandatory Field)** - Select the Job UID from the list.
* **Note (Mandatory Field)** - Enter the job-related notes.


The Job note is successfully added.
### ix. Reschedule a Job
When the Job schedule needs a change, you can reschedule the Job date and timings.
1. Enter the "**Event name**" and click the "**Continue**" button. Choose the Event. Fill in the Action, Account, and Reschedule Job, then validate the flow by,
Enter the **Mandatory fields** and fill in the optional fields.
* **Job UID (Mandatory Field)** - Select the Job UID from the list.
* **New Start Date & Time (Mandatory)** - Choose the new start date and time of the Job.
* **New End Date & Time (Mandatory)** - Choose the new end date and time of the Job.

Click the "**Test Step**" button to create the **Job Note**. Click the "**Continue**" button.

The Job rescheduling is successfully done.
### x. Update a Job Status
When the Job status needs to changed, you can update the Job status using the Job UID.
1. Enter the "**Event name**" and click the "**Continue**" button. Choose the Event. Fill in the Action, Account, and status update, then validate the flow by,
Enter the Mandatory fields and fill in the optional fields.
* **Job UID (Mandatory Field)** - Select the Job UID from the list.
* **Status UID (Mandatory)** - Choose the status UID of the Job.


### xi. Create a New Project
Creating a project involves multiple steps. We must enter/choose the various details and create a new project.
1. Select the "**Action Event**” as “**Create a New Project**” and click the "**Continue**" button within the Zuper app action in the Zap.
2. Connect your Zuper account to the Zap by entering your API key.
3. In the “**Configure**” section, enter the project details in the respective fields. Ensure that you’ve added all the required fields.
4. The Project Category values set in Zuper will appear for selection in a dropdown here.

Click the "**Test Step**" button to create the **Project UID**. Click the "**Continue**" button.
Click the "**Test**" button to create a new project, and it generates the **Project's UID**.
### **Add job to the project**
1. Enter the "**Event name**" and click the "**Continue**" button.
2. Choose the Event. Fill in the Action, Account and add job to project, then validate the flow by adding:
***Project UID, Job UIDs (Mandatory).***
Click the "**Continue**" button.

### **Add Parts and Services**
1. Enter the "**Event name**" and click the "**Continue**" button.
2. Choose the Event. Fill in the Action, Account and add parts and services, then validate the flow by
***Project UID, Product UIDs (Mandatory).***
Click the "**Continue**" button.

You can create a new project, add the job to it, and add a parts and services list to it.
### xii. Create a New Quote
There are two ways to provide organization/customer/property UID while creating the quote / invoice / job.
a. Directly type and provide the UID. (We used this flow in Quote creation below).
b. We can use “**find organization / customer / property**” zap (We used this flow in Invoice creation)
With all the details created from the various steps in the above section. Now you can create a new Quotation.
1. Enter the Quotation details.

2. Enter the Mandatory Quotation fields.
**Quote Date (Mandatory Field)** - Choose the quote creation date.
**Expired Date (Mandatory Field)** - Choose the expired date of the Quote.
> [!NOTE]
>
> **Note**: The date and time format should be YYYY-MM-DD HH:MM:SS

Click the "**Test Step**" button to create the **Quotation**. Click the "**Continue**" button.

The new quote is successfully created.
### xiii. Create a New Invoice
There are two ways to provide organization/customer/property UID while creating the quote/invoice/job.
a. We can use “**find organization/customer/property**” zap (We used this flow in Invoice creation below).
b. Directly type and provide the **UID**. (We used this flow in Quote creation in the previous section).
With all the details created from the various steps in the above section. Now you can create a new Invoice.
1. Enter the Invoice details.



The new invoice is successfully created.
## Uninstalling Zapier from Zuper
To remove the Zapier integration:
1. Log in to your Zuper account. Click your profile picture in the top-right corner and select **App Store**.

2. Under the “**Browse by Category**,” select the “**Workflow Automation**” option and choose “**Zapier**.” Click "**Uninstall**."

3. **Uninstall the App**:
* Click **Uninstall App**.
* The Zapier app will be uninstalled successfully.
**Note**: This disables the integration in Zuper but does not affect existing Zaps in Zapier. Delete or pause Zaps in Zapier as needed.
**Key points to note:**
1. Product UID, Qty, and Price should be the exact count in Part & Service List Zap - Please ensure to map the respective count of product UID based on the count entered in the Zap
2. Org/Customer/Property are inter linked for the smooth integration to happen. - Please ensure that the organization, customer & property are associated in Zuper for smoother integration
3. Job, Invoice, and Quote need to use Part and Service List zap, and create Asset need to use Product UID - For modules that require parts & services, please use the Product UID in the Zap. You can also use the lookup action to find the product UID using the name or SKU
4. In new Assets, while adding asset parts UID, Qty should be in the exact count; also, we can only add "**parts**" and not add products and services. - While creating assets through Zap, please ensure to add only Product UID, which is of type "**PART**" configured in Zuper. Items of type "PRODUCT" / "SERVICE" are not supported for inclusion in Asset.
With our Zuper - Zapier integration, you can perform various module action by automating the flows.
# FieldNation
Source: https://docs.zuper.co/Integrations/Workforce_and_Time_Tracking/FieldNation
FieldNation is an on-demand field workforce platform that connects businesses with skilled technicians. This guide outlines how to integrate FieldNation with Zuper, a work order management platform, to enable seamless bi-directional synchronization of job-related information.
The integration allows users to:
* Push work order details from Zuper to FieldNation.
* Sync status updates, notes, and attachments from FieldNation to Zuper.
* Track FieldNation job details directly from Zuper.
## Installing FieldNation in Zuper
Follow these steps to install and configure the FieldNation app in Zuper:
1. Once you are logged in to your Zuper Account, click on your profile picture in the top right corner of the screen and click on “**App Store**.”

2. Select the "**Workforce and Time Tracking**" option and choose “**FieldNation**.” Select the “****Install App” button.****

* Fill in the following fields to connect Zuper and Fieldnation.
* **Zuper API Key** (Mandatory Field) - Enter the Zuper API key. Refer to [How to Generate a Zuper API Key](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys) for guidance.
* **Environment** (Mandatory Field) – Enter Zuper’s Environment name. This can be either "**Sandbox**" or " **Production**."
* **Field Nation OAuth Client ID** (Mandatory Field) - Enter the OAuth Client ID from the Field Nation account.
* **Field Nation OAuth Client Secret** (Mandatory Field) - Enter the OAuth Client Secret from the Field Nation account.

> [!NOTE]
>
> **Note**: You must have a FieldNation account with REST API and Webhooks enabled to obtain the OAuth Client ID and Client Secret.
> [!NOTE]
>
> **Important**: Click **Generate New Secret** in FieldNation to obtain a new Client ID and Client Secret. Copy these from the pop-up and update them in Zuper, replacing any existing credentials. The "**Copy link**" button in the FieldNation REST API will not work.

> [!WARNING]
>
> **Warning**: The old "**Client ID and Client Secret**" should be replaced with the existing copied Client ID and client secret, respectively.
* **Field Nation User Name** (Mandatory Field) – Enter the user name of the Field Nation.
* **Field Nation Password** (Mandatory Field) – Enter the password of the Field Nation.
* **Push to Field Nation on** (Mandatory Field) – The action to push data to Field Nation whenever "**Status Update**," "Assignment," or "**Status Update and Assignment**."
> [!NOTE]
>
> **Note**: If selecting "Status Update" or "Status Update and Assignment," ensure an active "Status" is configured for the job category in Zuper.
* **Work Order Creation Status** – Enter the status of the work order from Field Nation.
* **Work Order Creation User and Team** – Enter the user and team responsible for work order creation. The recommended format for the input: User and Team should have "**:**" Colon separator, followed by "**;**" semi-colon, and select "**No**" to avoid syncing the next set. (A sample format: Alex: Team California; Peter: Team NewYork).
* **Category Mapping**– Map FieldNation categories to Zuper categories, separated by the “**Semi-Colon**”(;).
* **Sync Notes from Field Nation to Zuper** – Select "**Yes**" to sync notes from Field Nation to Zuper, and select "No" to avoid syncing notes from Field Nation to Zuper.
* **Sync attachments from Field Nation to Zuper**– Select "**Yes**" to sync attachments from Field Nation to Zuper, and select "**No**" to avoid syncing attachments from Field Nation to Zuper.
* Select the “**Update**” button to integrate Zuper with Field Nation.

#### Field Nation and FieldNation and Zuper Status Mapping
The following table maps equivalent statuses between FieldNation and Zuper:
| **Field Nation** | **Zuper** |
| - | - |
| On My Way | On My Way |
| Work Done | Completed |
| Postponed | On Hold |
| Canceled | Canceled |
| Checked-In | Started |
## How the Zuper-FieldNation Integration Works
The integration enables bi-directional synchronization between Zuper and FieldNation, ensuring seamless data flow for work orders.
**Sync Work orders from the Zuper to FieldNation:**
1. The type of work and the payment details are updated in Zuper and synced with FieldNation based on the category mapping.

2. The schedule details and attachments on FieldNation are updated on Zuper.

3. FieldNation job details can be tracked from the Zuper Job module in a single click. Under the **Other Details** section, locate the FieldNation ID and click **Open Link** to view the work order in FieldNation.

4. Track scheduled job times directly within Zuper.

## Uninstalling FieldNation from Zuper
To remove the FieldNation integration from Zuper:
1. Once you are logged in to your Zuper Account, click on your Profile Picture on the top right corner of the screen & click on “**App Store**.”

2. Select the "**Workforce and Time Tracking**" option and choose “**FieldNation**.” Select the “****Install App” button.****

3. Click on the “**Uninstall App**” button.

4. The FieldNation app will be uninstalled successfully.

The business can easily ensure that the work order gets updated on Zuper in sync with FieldNation. In addition, with the bi-directional data flow, job details get updated on both apps (FieldNation & Zuper).
# QuickBooks Time
Source: https://docs.zuper.co/Integrations/Workforce_and_Time_Tracking/QuickBooks_Time
QuickBooks Time, formerly known as tsheets, is an application that provides Employee Time Tracking, Scheduling, and Payroll Management features.
Zuper’s integration with QuickBooks Time syncs entries from the Timesheets module on Zuper to the Time entries module on QuickBooks Time.
The integration offers a unidirectional sync between the modules:

> [!NOTE]
>
> Note: We currently sync time entries from all Zuper users to QuickBooks Time. There are no restrictions based on role.
## Installation
1. Open a new tab in your browser once logged in to your Zuper Account. Click on your Profile Picture in the top right corner of the screen and select the “**App Store**.”

2. Under the “**Browse by Category**,” select the “**Workforce & Time Tracking**” option and choose “**QuickBooks Time**.”

3. Click on the “**Install QuickBooks Time**” button.

2. Update Zuper Settings by configuring the following fields:
* **Zuper API Key** (Mandatory) – To create the **Zuper API,** refer to the article ([How do I create an API Key for my Zuper account?](https://docs.zuper.co/Settings/Developer_Hub/API_Keys#api-keys)).
* **QuickBooks Time Token** (Mandatory) – Enter the QuickBooks Time Token. The token should be taken from QuickBooks Time.
> [accordion] To retrieve the token from QuickBooks Time
>
> 1. Under "**QuickBooks Time**" Choose the "**Feature Add-ons**" and select the "**Manage Add-ons.**"
>
>  2. Install the "API".
>
>  3. After installing the "**API,**" click the "**Add a new application.**"
>
>  4. Add the "**Name**", "**Description**","**Technical Contact**", and "**OAuth Redirect URL**".
>
>  5. Kindly use the OAuth Redirect URL in QuickBooks Time - [https://apps.zuperpro.com/app/quickbooks\_time/oauth/callback](https://apps.zuperpro.com/app/quickbooks_time/oauth/callback) 4. Click "**Add Token**" and enter the "**User Name**" and "**Expiry Date**."
>
> 
>
> The token is added successfully. Copy the token from QuickBooks Time and add it to the "**QuickBooks Time Token**" in Zuper.
>
> 
* **Sync Users**(Mandatory)—Enter the QuickBooks Desktop Connector Username. If you select "**Yes**," Users will be pushed one-way from Zuper to QuickBooks Time. If you choose “**No**,” then the User sync will not happen from Zuper to QuickBooks Time.
* Click the “**Update**” button to save the settings.

## **Uninstallation**
1. Open a new tab in your browser once logged in to your Zuper Account. Click on your Profile Picture in the top right corner of the screen and select the “**App Store**.”

2. Under the “**Browse by Category**,” select the “**Workforce & Time Tracking**” option and choose “**QuickBooks Time**.”

3. Click the “**Uninstall App**” button.

4. The App is uninstalled successfully.

> [!NOTE]
>
> **Important Points:**
>
> 1. The integration doesn’t support the syncing of job codes or customers associated with Time Entries.
> 2. Locations are currently not supported and will always be tagged as ‘**Zuper**. '
# Overview
Source: https://docs.zuper.co/Inventory_Management/Overview
In Zuper, **Parts, Products, and Services** are essential components used in jobs, quotes, and invoices. These items can be individual goods, services, or bundled offerings that businesses manage within their inventory.
* **Products & Parts** – Tangible items that are either purchased from vendors or consumed during service jobs.
* **Services** – Labor or activities performed for customers that are billable or non-billable.
* **Bundles** – A combination of multiple parts, products, or services grouped together for streamlined pricing and inventory tracking.
Zuper helps businesses efficiently track inventory by automatically adjusting stock levels when items are used in jobs or transfers between locations.
# Product Bundles
Source: https://docs.zuper.co/Inventory_Management/Parts_Services/Bundles
Product Bundles in Zuper allow your business to streamline operations by grouping multiple parts, products, or services into a single unit. Whether you need to sell a collection of items together or offer a package of services as one, product bundles simplify the process by allowing you to create **bundle level** or **Roll-Up items**, giving you flexibility in pricing and managing products.
Using product bundles, you can customize how grouped items appear to customers as a single line item or with a detailed breakdown, ensuring transparency where needed. Additionally, these bundles can be incorporated into Quotes, Invoices, Proposals, Contracts, Jobs, and Projects, allowing seamless workflows across various transactions.
This article will guide you step-by-step through the process of creating, managing, and integrating product bundles into your transactions for seamless workflows.
## Prerequisites
1. Product Bundle is only available on the V3 Web app. If you are using V2, you can get started with V3 using the link below. Your login credentials will be the same as those for V2: **V3 Live (Production)** - [https://web.zuperpro.com/login.](https://web.zuperpro.com/login.)
2. To enable the Parts & Services module for your account, please contact the account admin or email [support@zuper.co](mailto:support@zuper.co).
3. Ensure you have configured the following settings under **Settings > Organizations >Parts & Services Settings** :
* **Default pricing level for Bundle?:** This setting allows you to choose between **Bundle price** (fixed price for the entire bundle) or **Roll up price** (automatically sums individual item prices). Note that even with the default pricing setting configured, you can still select the pricing method—either **Bundle level price** or **Roll up item prices**—when creating a new product bundle.
* **Display the Bundle to the Customer as**
1. **One Item**: Display the entire bundle as a single line item in transactions.
2. **All Items**: Shows a detailed breakdown of each component within the bundle. This setting determines how individual items within a bundle are displayed to customers in transactions.

**Navigation**: *Inventory & Pricebook*-> *Parts & Services*
## Creating a product bundle
Now, let's get started with creating the Product Bundle. Follow these steps to group your parts, services, or products into a single unit:
1. Select the "**Inventory & Pricebook**" module from the left navigation menu and choose " **Parts &** **Services**".

2. In the action bar, click “ **+ New Part/Service** ."  3. Select “ **Bundle** ” as a Type under the " **Parts & Services Details** " section.

4. The Product Bundle creation page appears.

5. Provide a descriptive **Bundle Name**.
6. Provide a unique identifier for the **Bundle Number**.
7. Assign the bundle to a relevant **Category**.
8. Specify whether the item is **Billable** or **Non-Billable** :
* **Billable**: The cost of the bundle will be included in the transaction document.
* **Non-Billable**: The bundle will be shown as a non-billable line item, which is excluded from the total amount billed but will still be tracked for reference.

9. **Choose pricing options** —either a “ **Set Bundle Price** ” (with a set price for the group) or a “ **Roll-Up Item Price** ” (with individual item prices adding up).

> [!NOTE]
>
> **Info**: If you haven't set Bundle as Billable in the master level, when you use it in transactions (e.g., a Job or Quote), the "**Non-Billable**" status will be reflected in all subsequent transaction documents. However, you can choose to edit it in the transaction, allowing you to modify the status on a case-by-case basis.
> [accordion] Understanding Bundle Price and Roll-Up Item Price
>
> * **Bundle Price**: The Bundle level price allows you to set a fixed selling price for the entire bundle of items. This price is defined at the bundle level, and it represents the total cost for all the included parts, products, and services, regardless of the individual item prices. *Example:* If "Product X" costs $50 and "Service Y" costs $100, and you set the Bundle selling price to $200, the customer will see $200 as the total price for the entire bundle.
> * **Roll-Up Item Price**: With a Roll-Up Item bundle, the final price is determined by adding the prices of each item within the bundle. This is useful when you want customers to see how much each component costs but still sell it as a package. *Example:* If you offer "Product X" for $50 and "Service Y" for $100, the bundle will automatically calculate to \$150.
10. Add Bundle Items:
* Click "**Add"** and select parts, products, or services in the **Bundle Items** section.

* Specify the **Quantity** of each item to be included in your bundle.
* After specifying the parts and products, click "**Add Product**".

11. Enter the following pricing details. Based on your bundle type selection:
> [accordion] For Set bundle price
>
> * **Bundle Cost Price:** Specify the total cost of the entire bundle.
> * **Markup** (optional): Apply a markup percentage, which will automatically adjust the final price based on the cost price.
> * **Bundle Sell Price**: This is the total price at which the bundle will be sold to the customer, calculated based on the cost price and the markup you set.
>
> 
> [accordion] For Roll-Up item prices
>
> The system will automatically calculate the price of the bundle based on the sum of the individual prices of the parts, products, and services included in the bundle. **Markup** is not applicable for **Roll-Up** pricing.
>
> 
12. Enter the relevant tax codes for the bundle. If the bundle has a **Set Price** (i.e., a fixed price for the entire bundle), tax will be applied to the total price of the entire bundle. If the bundle consists of individual **Roll-Up Items** (components with separate prices), the tax will be automatically calculated for each item based on its individual price and tax rate.
> [accordion] Setting the Bundle's Display Quantity
>
> When a roll-up bundle contains items with different units of measure, selecting one item’s quantity as the bundle quantity helps show a single clear number on quotes, invoices, and proposals.
>
> You can now choose which item’s quantity and unit of measure Zuper will use as the bundle’s display quantity on these documents.
>
> > [!NOTE]
> >
> > **Note**: This applies to **Roll-Up bundles** only.
>
> **To set the display quantity:**
>
> 1. In the **Bundle Items** section, click the **context** menu next to the item whose quantity should represent the entire bundle.
>
> 2. Select **Set as Bundle's Display Quantity**.
>
> 3. Click **Save Part / Service**.
>
> The selected quantity and unit of measure are reflected on the present proposal screen, proposal PDF, and public links of proposals, quotes, and invoices.
>
> 
>
> > [!NOTE]
> >
> > **Important Note:** Update your quote and invoice templates for these changes to take effect. This does not apply retroactively to existing templates or previously created documents.
13. Now, click " **Save Part / Service** ."

Your new Product Bundle is now ready to use!
## Adding product bundles to a transaction
When creating a transaction such as a Quote, Invoice, Proposal, Contract, Job, or Project, follow these steps to add Product Bundles:
1. During the transaction creation, Under the " **Parts/Services** " tab.
2. Click the " **Add** " button and select “ **Bundle** ” to open the Product Bundle selector.  3. The left-hand side displays a list of available product bundles. The filter options at the top allow you to search for specific bundles and filter by category, availability, or pricing.  4. After selecting a product bundle, the **Primary Details** section on the right side will show key information. The fields available in this section depend on the pricing level configured for the bundle.
* **Description**: Description will be auto-populated. However, you can choose to modify.
* **Quantity**: Enter the bundle quantity to add the desired number of bundles to the transaction.
* **Bundle Cost**: Specify the total cost of the entire bundle.
* **Markup**: You can apply a markup percentage, which will automatically adjust the final price based on the cost price.
* **Bundle Sell Price**: The price for the entire bundle.
> [!NOTE]
>
> **Note:** For Roll-Up item bundles, the system calculates the total price based on the individual prices of the parts, products, or services included in the bundle.
* **Billable**: Specify whether the product bundle is billable or not.

5. Under the **Bundle Items** section, you will see the components included in the bundle:
* **Line Item:** The name of each part or product in the bundle.
* **Description:** A brief description of the item. You can update the description of the item.
* **Type:** Indicates whether the item is a part, product, or service.
* **Location:** Specify the item’s location of each item in the bundle during the transaction.

6. After selecting and reviewing the bundle, click " **Add Bundle** " to include it in your transaction. Note that only one bundle can be added to a transaction at a time since the location for each component needs to be specified individually.

7. The bundle will now appear in your Parts/Services list on the transaction. The visibility of the grouped items is based on the setting configured in **Settings -> Organizations ->** **Parts and Services Settings -> “Display Bundle to Customer as** ."

> [!NOTE]
>
> **Note:** The visibility of product bundles as either a single line item or a detailed breakdown of each item within the bundle will not apply to existing templates (e.g., Quotes, Invoices, Proposals, or Jobs in the Customer Portal). Existing templates will continue to display bundles based on their original configuration, regardless of changes to the bundle display settings. To reflect these changes, new templates must be created for Quotes, Invoices, Proposals, or Jobs.
### Adding product bundles to a service package
The following procedure describes how to add product bundles to a Service Package. The steps are similar for adding product bundles to a Contract Package.
1. Select the **Settings** icon from the left navigation menu.
2. Under **Configuration** Settings, click the **Quotes & Invoices** section.
3. Select **Service Packages** and click the **+ New Package** button.
4. Fill in the Service Package Details:
* **Name**: Enter the name of the service package.
* **Description**: Provide a brief description of the service package.
* **Remarks**: Add any additional notes or remarks.
5. Add items to the package:
* Click the **+ Add Item** button to include individual parts, products, and services.
* Alternatively, use the dropdown menu next to the **+ Add Item** button to:
i. **Add from Group**: Select a predefined group of items to add to the package.
ii. **Bundle**: Include a product or service bundle.
> [!NOTE]
>
> **Note**: Bundles will not appear in the **Product Type** filter menu; you can add them separately.

Once all details are added, the Service Package is created successfully.
## FAQs
1. **What is the difference between an Item Group and a Product Bundle in Zuper?** A Product Bundle in Zuper combines multiple items into a single package for streamlined pricing and sales, with options to display as a single item or with itemized details in transactions. An Item Group is used grouping items without impacting pricing or how they appear to customers.
2. **How can I update the billable status for a bundle item while working on a transaction?** If you are logged in with Admin access or your role permits, you can update the billable status of a bundle item directly on the **Update Line Item** page. If you are experiencing issues while trying to update the billable status, please reach out to us at [support@zuper.co](mailto:support@zuper.co).
3. **What should I know about syncing product bundles with QuickBooks Online** **(QBO)?** For product bundles to sync correctly with QuickBooks Online (QBO), ensure the bundle is first created manually in QBO. If a bundle doesn’t exist in QBO, the sync will fail, and an error message appears in the Sync History. **Note that:** a. Bundle Level Pricing is currently not supported by QBO. b. Roll-Up bundle will sync using the combined item costs. c. Discounts and markups may not sync properly due to integration limitations. d. If an invoice with bundles fails to sync, the entire transaction will not be processed.
# Create a new part/product or service
Source: https://docs.zuper.co/Inventory_Management/Parts_Services/Create_New_Part_Service
The **Products and Services Listing** page lets you add default products and services, ensuring that details such as name, description, and unit price are pre-filled when adding line items to quotes, jobs, or invoices.
**Navigation**: *More* -> *Catalog* -> *Parts & Services*
## Accessing the parts & services page
1. Select **More** from the left navigation menu, then select **Catalog** > **Parts & Services**.

2. Click "**+ New Part/Service**".

### **Parts and Service Details Pane**
The left pane is the **Parts & Services Details** section, where you must fill in the required details.
1. Select the **Type** from the drop-down list. Available options include: **Product**, **Part**, **Service**, or **Bundle**.
2. If you selected **Service**, choose a **Service Type**:
* **Hourly**: Use for labor your own team performs and charges by the hour. Enter the hourly rate as the **Unit Purchase Price/Unit Cost**. Because this rate isn't linked to each user's hourly wage, use an average rate for estimating.
* **Fixed**: Use for labor charged at a flat rate per unit, such as subcontractor work or a dumping fee.
**Service Type** defaults to **Hourly**.
3. Based on the selected type, the fields will be displayed dynamically.
4. Enter the **Name** and unique **Number** for the part.
5. Specify whether it's **Billable** or not. You can now define whether a part, service, product, or bundle is billable or non-billable directly on the master page.
* **Billable**: The cost of the part/service/product/bundle will be included in the transaction document.
* **Non-Billable:** The part/service/product/bundle will be displayed as a non-billable line item, excluded from the billable total but still tracked for reference.
> [!NOTE]
>
> **Note:** If you haven't set the Part/Service/Product/Bundle as **Billable** in the master level, when you use it in transactions (e.g., a Job or Quote), the "*Non-Billable*" status will be reflected in all subsequent transaction documents. However, you can choose to edit it in the transaction, allowing you to modify the status on a case-by-case basis.
6. Define whether this part should be **Consider for Profitability** or not.

### **1. Primary Details**
The primary details section helps you to manage all the core inventory-related information. If you've enabled **Markup**, you can also view the "**markup**" option between the Unit Purchase Price/Cost and Unit Selling Price.
> [accordion] Markup Configuration
>
> **Markup** is a percentage or fixed amount added to the purchase price of parts and services to determine the selling price. It represents the profit added on top of the cost. Once a markup is specified, the system automatically calculates the selling price for the respective part or service.
>
> ### **Enabling Markup in Organization Settings**
>
> To use the markup feature effectively in **Parts & Services**, you must enable it in the **Organization Settings**.
>
> 1. Select the " **Settings** " module from the left navigation menu, and under **General Settings**, click "**Organization Settings**."
> 2. In the **Organization Settings** page, select "**Part and Services Settings** " under configuration, set "**Yes**" to **Enable Markup**, and click "**Save Settings**."
>
> You can now add markup to parts and services and edit the markup for jobs, quotes, and invoices.
* **Trade Type(s)**: Select the trade type from the list.
* **Category**: Select either a **Category** or a **Sub-Category** (Sub-categories are displayed nested under their respective parent category for better clarity and choice). \
Once selected, this part/service will be associated with that specific classification. 
* **Minimum Quantity**: Specify the minimum quantity that must be maintained before triggering a low-stock alert. This value is auto-filled based on the "**Minimum Quantity**" set in the ***Availability By Location*** section.
* **Unit Purchase Price/Unit Cost**: The purchase price of the unit.
> [!NOTE]
>
> **Note**: With purchase tax enabled for your organization, this section also includes Pre-Tax Cost and Purchase Tax %. These work together with the Unit Purchase Price/Unit Cost to calculate your actual item cost. See [Purchase Tax](/Inventory_Management/Parts_Services/Purchase-Tax) for details.
> [accordion] Hide purchase cost from specific roles
>
> Purchase cost shows how much your business pays for a product. If certain users do not need access to this information, such as field technicians adding products to jobs, you can hide purchase costs based on their custom role.
>
> When **Hide Purchase Cost** is enabled for a custom role, users assigned to that role cannot view a product's purchase cost in either the Zuper web app or the Zuper Field Service app.
>
> To hide purchase costs for a role:
>
> 1. Select **Settings** from the left navigation menu, then select **Users & Teams** > **Custom Roles**.
> 2. Select the role you want to update. To create a new role, select **+ New Role**.
> 3. Open the **Permissions** tab.
> 4. From the **List of Modules**, select **Products**.
> 5. Turn on **Hide Purchase Cost**. To find it quickly, enter **purchase** in **Search Permissions**.
> 6. Select **Update Role**. For a new role, select **Save Role**.
>
> Once enabled, purchase costs are hidden for all users assigned to that custom role.
>
> > [!TIP]
> >
> > **Good to know:** Unlike most permissions, **Hide Purchase Cost** removes access when enabled. Leave this permission turned off for roles that need to view product costs, such as purchasing or inventory management teams.
* ***Unit Selling Price:*** The selling price of the individual product. It is automatically determined based on the markup applied to the purchase price of parts and services. Markup has the following conditions.
* *Flat* (+): With the flat markup condition, a predetermined fixed amount is added to the unit purchase price to determine the unit selling price.
* *Percentage* (%): Under the percentage markup condition, a specified percentage of the unit purchase price is added to calculate the unit selling price.
* *Multiplier* (x): With the multiplier markup condition, the unit purchase price is multiplied by a specified amount to obtain the unit selling price.

* **Track Quantity**: Enable inventory tracking for this part or product. If '*Yes*' is selected, the system tracks part consumption based on the module chosen in the ***Choose Module to Track Part Consumption*** field under ***Settings > Organization Settings > Part and Service Settings.*** If '*No*' is selected, the system does not track the part's consumption in inventory.
* **Quantity Formula:** Select an existing [formula](Zuper_for_Roofing/Formula_Library) or create a new one to automatically calculate the correct quantity or pricing for this part or product. When the item is added to a CPQ proposal or quote, the formula defined in the product master is applied to the line item, and the quantity is calculated automatically based on the job’s measurements and checklist answers.

### **2. Tax Details**
In this section, you can configure and manage the tax preferences. Choose whether the tax applies to your transactions or if it's tax-exempt.
> [accordion] Taxable
>
> Enter the following details:
>
> * **Tax Name (Required):** Enter the name of the tax.
> * **Tax Rate (Required):** Enter the tax rate.
> [accordion] Tax exempt
>
> **Tax Exempt Reason (Optional):** Enter the reason for the exemption.
### **3. Options**
Zuper’s [**Options**](https://docs.zuper.co/Settings/Modules/Parts-Services/Parts-Services-Settings#parts-and-services-general-settings) feature lets you offer choices directly to your customers on the **Proposal Authorization** page. For example, customers can select material colors, styles, or designs before approving the proposal.
* In the **Option** section, click **+ Add** to create attributes:
* Upload an image for visual reference.
* Set Name, Label, and toggle **Available** to "**Yes**".
* ·For proposal behavior, select any one of the options from the list:
* **Internal Only** - The option is visible only to your internal team. Customers do not see it on the authorization page. Your back-office team can mark this option for the line item directly.
* **Mandatory Customer Selection -** The option appears on the authorization page. The customer must select it for the line item before they can sign and accept the proposal.
* **Non-Mandatory Customer Selection -** The option appears on the authorization page. The customer can select it for the line item, but it is not required to sign and accept the proposal.
> [!NOTE]
>
> Note: How does this help?
>
> Use selection options to decide how much control your customer has over each line item. Mark high-priority items as mandatory to secure financial commitment, and leave lower-priority items as optional to give your customer time to think and decide.
* The customer-facing label entered here will appear as a subheading for the line item on the proposal presentation page.

**Usage Standards:**
* A product can have up to 20 options.
* Each option name can be up to 200 characters long.

### **4. Other Details**
The other details section will display all the custom fields you define under the Settings.

### **5. Location Availability**
The location availability helps to manage the inventory items based on the warehouse location with available and minimum quantity.
* Enable "**Track Serial Number"** to assign unique serial numbers to individual inventory items.

* Add the serial numbers required for the parts. You need to enter the serial numbers individually and press the "**Enter**" key to save the serial number.

* Click the “**Update Item"** button.
> [!NOTE]
>
> Important: The location assigned to a part/product at creation cannot be changed after the record is saved.
>
> This applies both to correcting an incorrect location and to adding an additional warehouse location to a part that has already been imported or created.
### **6. Add Attachments**
You can add attachments related to the product by following these steps:

* Click to open the attachments dialog box.
* Upload your files.
* Once uploaded, the attachments will be added successfully.
After filling in all the required details, click the "**Save Part/Service**" button to add the product to the inventory.

The new product is created successfully.
The serial track number can be viewed from the **Location Availability** section. To do so, click the "**Location Availability**" section and tap the "**View Details**" button on the **Parts & Services Details** page.

### Editing Part/Service
You can edit a part/service detail in the following areas:
1. From the Parts/services listing page
2. From job, quote, and invoices.
**From the Parts/Services listing page**
1. Click the "**Parts & Services**" from the left navigation menu, then select the desired part or service from the list.
2. Once in the respective part or service, click "**More Actions**" at the top right corner and select "**Edit Part**." From there, you can make the necessary changes.
3. After you have made the edits, the part or service will be updated in the mastery. You can add the updated part/service when creating a job, quote, or invoice.

**From Job, Quotes, and Invoices**
You can edit a part, service, or product within a transaction. Follow these steps to update the details:
1. Navigate to the "**Jobs"** module from the left navigation menu and select " **Jobs**."
2. In the **Jobs** listing page, locate and select the relevant job where you want to edit the part, service, or product.
3. In the **Parts & Services** section, find the respective part or service:
* Click the three-dot icon next to the item.
* Select **"Edit"** from the dropdown menu.
* Make the necessary changes, such as editing the markup for the selected part or service.
* Click the **"Update Line Item"** button to save your changes.

> [!NOTE]
>
> Note: If you are logged in with Admin access or your role permits, you can update the billable status of a part, product, or service directly on the **Update Line Item** page. If you are experiencing issues updating the expense policies, please reach out to us at [support@zuper.co](support@zuper.co).
## Listing Views
Customize the Parts & Services listing by adding/removing or reordering columns, then Update View to overwrite or save it as a new view.
* **Update View**: Click Update View to modify the current view after changes.
* **Save as new view**: Use the dropdown beside Update View → Save as new view.
* In the Create View dialog, enter the View Name (mandatory), choose Share with (User/Team) and add users, toggle the Visibility to all users, and click Create.
* **Reset View**: Click Reset View to restore the current view to the default.
* **Permissions**:
* **Edit**: Add/remove/reorder columns; save as new or overwrite existing views.
* **View-only**: Apply views but can’t edit; can Save as new view to copy without altering the original.
* **Manage view**: Rename, adjust Visibility (Only Me/User/Team or global toggle), Duplicate, or Delete (creator only; reverts to default/another saved view).
* **Open item details**: After filtering, click a Product name to view and manage details.
The respective part/service will be updated only for the specific job and will not be added to the mastery list.

## Pin Filters for Quick Access
Once your filters are set, click the Pin Filters button in the filters panel as pinned. Pinned filter appears on the listing page, allowing you to apply it with one click in future sessions.

To **unpin** a filter, select it and click Remove. To apply pinned or default filters, click the filters option and unpin to remove active filters.

### FAQ
**Where can I find Parts & Services and Expenses now, and why was this change made? How does it affect my workflow?**
The **Parts & Services** and **Expenses** sections have been moved to the **Line Items** navigation tab on the **Job** **Details** page, effective July 23, 2025, 02:45 PM IST. This change shifted from a vertical scrolling layout, where you had to scroll up and down to view details, to a connected view that organizes product, service, and expense details for a clearer, more streamlined experience. The update enhances your workflow by consolidating related data into a single place, making management and review more efficient.

# Product/Item Groups
Source: https://docs.zuper.co/Inventory_Management/Parts_Services/group
A **Product/Item Group** is used to categorize and organize items such as parts, services, and products to streamline inventory management and job planning. This group helps businesses quickly locate and utilize relevant items when creating Jobs, invoices, or service requests.
**Navigation**: *Inventory & Pricebook*-> *Parts & Services -> Manage Group*
### **To create a Product/Item Group**
* Select the **"Inventory & Pricebook**” module from the left navigation menu and choose "**Part & Service.**"

2. Click **Manage Group** at the top right of the page.

3. Click **+ New Group** to create a new group.

3. The **Product Group c**reation page appears. Enter a group **Name** (e.g., *Electrical Supplies*).

4. If the [Add-on](https://docs.zuper.co/Settings/Modules/Quotes-Invoices/Quotes-Invoices-Settings#add-ons) is enabled, you will be able to select the product group item to differentiate the Add-on product group.

5. Provide a group **Description** (optional but recommended for clarity). 7. **Add Parts/Services:**
* Click **+ Line Item** in the **Part/Service Details** section.

* Select the items to include in this group and specify the item quantities.
* Click **Add Item** to confirm the selection.

8. After adding the necessary items, click **Create Group**.

The **Product/Item Group** has now been successfully created.
### **Managing a Product/Item Group**
To **edit** or **deactivate** a **Product/Item Group**, follow these steps:
1. Navigate to the **Product/Item Group Listing** page.
2. Select the group you want to manage.
3. Click the **ellipsis icon** (three dots) next to the group name.
4. Choose one of the following options:
* **Edit Product Group** – Modify the group name, description, or included items.
* **Deactivate Product Group** – Remove the group from active use (this action can be reversed if needed).

# Apply a pricelist to a transaction
Source: https://docs.zuper.co/Inventory_Management/Pricelists/Apply_Pricelist
Using a price list ensures consistent pricing across different modules, including customers, organizations, properties, quotes, invoices, jobs, contracts, and proposals.
1. Go to the module where you want to apply the pricelist, such as **Customers**, **Organizations**, **Properties**, **Quotes**, **Invoices**, **Jobs**, **Proposals**, or **Contracts**.
2. Choose the specific customer, organization, or transaction to which you want to apply the pricelist or create a new one.
**For Customers/Organizations/Property:**
When you associate a pricelist with an organization, customer, or property, you set a default pricing framework for future transactions involving these entities. This ensures that whenever you initiate a transaction, such as creating a quote, invoice, job, or contract, the associated pricelist will be applied.
> [!NOTE]
>
> **Note:** The pricelist associated with properties takes priority, followed by customers, and then organizations. If a property's pricelist isn't specified, the system defaults to the customer's pricelist.
On the “**Customer,**” “**Organization**,” or “**Property**” details page, in the “**Pricelist**” field, select the desired pricelist from the “**Pricelist**” field.
* **Customer**

* **Organization**

* **Property**

**For Transactions (Quotes, Invoices, Jobs, Contracts, Proposal):**
By default, the pricelist associated with Customer/Organization/Property is applied when creating or editing a quote, invoice, job, proposal, or contract. If needed, you can manually select a different pricelist in the “**Pricelist**” field within the “**Parts & Services**” sub-section to suit specific transactions.
Applying a pricelist does not limit which line items are available. All items from the master list can still be added to a job, quote, or invoice. The pricelist only adjusts the selling price for items associated with it — items outside the pricelist keep their default pricing.
> [!NOTE]
>
> **Note:** When you first select a customer and adjust pricing, selecting a different customer afterward will override the pricing based on the newly selected customer's Pricelist.
* **Quote**

* **Proposal**

* **Contract**

* **Job**

When applying a pricelist to your transactions, any discounts you set at the transaction level will persist. However, these discounts will be applied to the selling price determined by the pricelist. This ensures that your pricing calculations remain accurate and that you can apply customized discounts as needed.
And there you have it! By following the straightforward instructions outlined above, you can effortlessly apply pricelists to your customers, organizations, properties, and transactions within Zuper.
# Create, edit, and delete a pricelist
Source: https://docs.zuper.co/Inventory_Management/Pricelists/Create_Pricelist
The Pricelist feature in Zuper streamlines pricing processes, boosts customer satisfaction, and drives revenue growth by allowing businesses to update pricing efficiently and maintain consistency.
**Navigation**: *Inventory & Pricebook* *-> Pricelists* -> *+ Create Pricelist*
## Create new pricelist
To create a new pricelist, follow these steps:
1. Select the **"Inventory & Pricebook**” module from the left navigation menu and choose "**Pricelists.**"

2. The Pricelists listing page opens.
3. Click the “**+ Create Pricelist**” button in the top-right corner of the page.

4. A new Pricelist creation page appears. Fill in the following sections:
#### **1. Primary Details section:**
1. **Name** (Mandatory): Enter a unique name for the pricelist.
2. **Description**: Add a brief description explaining the purpose or scope of the pricelist. 
#### **2. Pricelist Details section:**
Choose the type of item, either “**All items**” or “**Individual items.**”
> [accordion] All Items
>
> Enter the following details:
>
> * **Type** (Mandatory): Select either the “**Discount**” or “**Margin**” option.
>
> > [!NOTE]
> >
> > **Note:** This selection applies to all parts and services when configured for all items.
>
> * **Amount** (Mandatory): Enter the value.
> * Choose “**USD**” or “**%**” from the drop-down menu.
>
> 
> [accordion] Individual Items
>
> Enable the checkboxes to “**Enable Discount**” and/or “**Margin**”.
>
> 
>
> > [!NOTE]
> >
> > **Note:** You must activate the respective checkboxes during pricelist creation or editing to include a margin or discount in your pricing.
#### **3. Parts / Services section:**
1. Add the relevant parts and products by clicking the “**+ Add**” button.

2. A dialog box with the existing parts and products will appear.
3. Select the part/product(s) and click the “**Add**” button.

4. You can specify either “*Margin*”, “*Discount*”, or “*Custom Rate*” for each item.
* **Margin**: An additional percentage or fixed amount added to the cost price of items to determine the unit selling price.
* **Discount**: A flat or percentage amount subtracted from the selling price you set in the master list for a part or service. The updated selling price, reflecting the applied discount, will be displayed accordingly in the Updated Price field.
* **Custom Rate**: A fixed rate or percentage applied to the item or service.
> [!NOTE]
>
> **Note:** Only one of these options, “*Margin*”, “*Discount*”, or “*Custom Rate*” can be selected for each item.

After providing all the required details, click the “**Save**” button at the top right corner. A new Pricelist will be created successfully. You can add the newly created pricelist to specific customers, organizations, or individual transactions, such as Quotes, Invoices, Jobs, or Contracts.
### Edit a Pricelist
You can edit a pricelist from any one of the following pages:
1. From the Pricelists listing page
2. From the Pricelist details page
**From the Pricelists listing page**
To edit a pricelist from the Pricelists listing page, follow these steps:
1. Select the pricelist you want to edit on the listing page.
2. Click the “**Ellipsis**” icon under the “**Action**” column and select “**Edit Pricelist**”. 
3. Modify the necessary fields.
4. Click the “**Save**” button to update the pricelist. 
**From the Pricelist details page**
You can view the pricelist details page directly after saving a pricelist or from the Pricelists listing page. To edit a pricelist from the Pricelist details page, follow these steps:
1. Select the pricelist you want to edit.
2. On the **Pricelist details** page, under “**More Actions,**” select “**Edit Details.**” 
3. Modify the necessary fields.
4. Click the “**Save**” button to update the pricelist. 
### Deactivate/Delete a Pricelist
You can deactivate/delete a pricelist from any one of the following pages:
1. From the Pricelists listing page
2. From the Pricelist details page
**To deactivate/delete a Pricelist:**
1. On the Pricelists listing page, select the pricelist you want to deactivate.
2. Click the “**Ellipsis**” icon under the “**Action**” column and select “**Deactivate**”. 
3. Alternatively, you can click the “**Ellipsis**” icon under the “**Action**” column and select “**View Details**”. 
4. On the **Pricelist details** page, under “**More Actions**”, select “**Deactivate**”. 
5. The pricelist will be deactivated successfully. To reactivate it, click “**Activate**”. 
**Delete a Pricelist**
To delete a pricelist, you must first deactivate the specific pricelist. Only after deactivation can the pricelist be deleted.
1. On the **Pricelists listing** page, select “**Delete Pricelist**” under “**Action**” to delete the pricelist. 
2. Alternatively, you can delete the pricelist from the **Pricelist detail** page. 
3. A pop-up message will appear. Click the “**Delete**” button to delete the pricelist.  So, that's it! Whether you're creating a pricelist, making updates, or deactivating and deleting a pricelist, these procedures facilitate streamlined pricelist management within the application, ultimately contributing to efficient operations and enhanced productivity.
## Listing Views
Customize the Transfer Orders listing by adding/removing or reordering columns, then Update View to overwrite or save it as a new view.
**Update View**
* Click Update View to modify the current view after changes.
**Save as a new view**
* Use the dropdown beside Update View → Save as new view.
**Create View dialog**
* Enter the View Name (mandatory), choose Share with (User/Team) and add users, toggle Visibility to all users, and click Create.
**Reset View**
* Click Reset View to restore the current view to the default.
**Permissions**
* Edit: Add/remove/reorder columns; save as new or overwrite existing views.
* View-only: Apply views but can’t edit; can Save as new view to copy without altering the original.
* Manage view: Rename, adjust Visibility (Only Me/User/Team or global toggle), Duplicate, or Delete (creator only; reverts to default/another saved view).
**Open transfer order details**
* After filtering, click a Transfer Order Number or Transfer Order ID to view and manage details.

## Pinned filters
Zuper's Pricelists module lets you use pinned filters to streamline your filter experience. Pinned filters keep your most-used criteria readily accessible for quick application.
**Navigation**: *Pricelists ->Filters -> Pinned Filter*
Pin up to 3 filters in any module.
1. Select the **"Inventory & Pricebook**” module from the left navigation menu and choose "**Pricelists.**"

2. **Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

3. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters.

# Overview
Source: https://docs.zuper.co/Inventory_Management/Pricelists/Overview
In modern inventory and sales management, the pricelist feature offers a convenient way to streamline pricing processes, enhance customer satisfaction, and drive revenue growth. Tailored to fit unique pricing strategy, it enables businesses to maintain pricing consistency, efficiently manage updates, customize pricing for different customer segments, and ensure compliance with regulations.
A pricelist in Zuper is a comprehensive list of prices used to determine the appropriate price for a customer. It significantly reduces the time and effort required for manual price adjustments by allowing the creation of multiple pricelists, the application of margins and discounts, and the setting of custom rates. Businesses can adapt quickly to market changes, optimize their sales strategies, and make data-driven decisions, all while integrating seamlessly with other key business processes such as job creation, quotes, invoices, and contracts.
## **Pre-requisites**
1. Pricelist is only available on the V3 Web app. If you are using V2, you can get started with V3 using the link below. Your login credentials will be the same as those for V2: **V3 Live (Production)** - [https://web.zuperpro.com/login.](https://web.zuperpro.com/login.)
2. If you are experiencing issues accessing the V3 Web app, please reach out to us at [support@zuper.co](mailto:support@zuper.co).
3. To enable the Pricelist module for your account, please contact the account admin or email [support@zuper.co](mailto:support@zuper.co).

## User Roles and Permissions
The pricelist feature is available to users with specific roles and permissions. Based on the settings enabled by the admin in “**Settings**” > “**Custom Role**” > “**Part**,” users can access the pricelists differently.
Available permissions include:
1. **Create Pricelist**: Allows the creation of new pricelists.
2. **Update Pricelist**: Permits editing existing pricelists.
3. **Delete Pricelist**: Permits deactivating or deleting pricelists that are no longer needed.
The admin can customize these permissions to suit the needs of the organization.

# Create a new transfer order
Source: https://docs.zuper.co/Inventory_Management/transfer/Create_Transfer
In Zuper, transfer order enables seamless inventory movement between locations by specifying the required date and the number of parts and products to be transferred.
Once the order has been created, you can also view and update the transfer status throughout the process, ensuring clear visibility and control over inventory movements.
**Navigation:** *Inventory & Pricebook* -> *Transfer Orders*
To create a new Transfer Order, follow these steps:
1\. Select the **"Inventory & Pricebook**” module from the left navigation menu and choose "**Transfer Orders.**" The listing page displays the list of transfer orders created earlier.
2\. Click the "**+ New Transfer Order**" button at the top right corner of the page.

3\. A new Transfer Order creation page appears. Fill in the following subsections:
## 1. Primary Details
1\. **From Location** (mandatory): Select the location from where you want to initiate the transfer of parts and products.
2\. **To Location** (mandatory): Select the location of the parts and products that need to be sent.
> [!NOTE]
>
> **Note**: The "From Location" cannot be the same as the "To Location."
3\. **Required By Date**: Select the date the line items need to reach the destination using the date picker. The Required By date allows you to plan logistics and ensure that transfers are initiated in the order of priority.

4\. **Remarks**: Add any additional comments or notes regarding the transfer.
> [!NOTE]
>
> **Note**: The From and To locations that appear here are those configured under Product Locations under Parts & Services settings.
## 2. Line Items
1\. You can add the Parts and Products to be transferred here. To do so, click the “**+ Add**” button.
2\. A pop-up will appear with the existing parts and products from the chosen "**From Location**."

> [!NOTE]
>
> **Note**: You cannot add parts or products to Transfer Orders until you choose the "**From**" and "**To**" locations in the Primary Details section.
3\. Select the part/product(s) and enter the quantity to be transferred under “**Quantity**.” Once you've done this, click the “**Add**” button.

> [!NOTE]
>
> **Note**: You can also add serial numbers as needed for each quantity under Serial No.
4\. The chosen part/product(s) will be successfully added under the **Line Items** section, along with the quantity, and serial numbers if any. Next to, Qty & serial column, you can also view a column called “**Post Transfer Qty**” indicates availability in the From and To Locations once the transfer is completed.

5\. You can also view details and edit or remove any of the added parts and products by clicking the “**ellipsis**” icon under the “**Actions**” column.

#### Edit Line Items
1\. To edit any line item, click the "**Edit**" button under the Action column. A pop-up will appear, allowing you to update the selected line item.

2\. Update the quantity to be transferred under “**Quantity**” and modify the serial numbers for each quantity as needed under "**Serial Number.**" Once done, click "**Update Line Item**" to save the changes.

> [!NOTE]
>
> **Note**: When you click "**Edit**," you can only update the quantity and the serial numbers of the product, not the product/parts themselves. However, you can remove part/product(s) and add new parts and products if necessary by clicking the "**Remove**" button.
## 3. Attachments
Attach files or documents related to the Transfer Order. The attachment can either be an **image** (supported file formats: png, jpg, jpeg, gif), **video** (supported file formats: mp4, avi, flv, mov, mpg, 3gp), **audio** (supported file formats: mp3, wav, m4a, wma)**, Document (**supported file formats: doc, docx, xls, xlsx, txt, pdf, webp, msg, eml) that you can add to the Transfer Order for more clarity. To add an attachment, follow these steps:
1\. Click “**+ Add Attachment**.” A pop-up appears.

2. Click to upload or drag and drop the file from your computer. Once uploaded, click "**Close**". You can also preview or remove attachments as needed.

Once all mandatory fields in the sub-sections are complete, you can choose to save the transfer order in one of the following ways:
* **Save as Draft**
* **Save & Initiate Transfer**
* **Save and Complete Order**

This comprehensive information allows you to quickly create Transfer Orders with specified parts, products, and required dates.
# Manage your transfer order
Source: https://docs.zuper.co/Inventory_Management/transfer/managing_transfer
The Transfer Orders listing page provides summarized information about transfers between different locations for a selected date range, including their statuses such as **Draft, In-Transit, Completed,** and **Voided.**
**Navigation**: *Inventory & Pricebook* *-> Transfer Orders*
## Accessing the transfer order listing page
1. Select the “**Inventory & Pricebook**” module from the left navigation menu and choose “**Transfer Orders**.” You will then be taken to the transfer orders listing page.
2. On the **Transfer orders listing** page, you can view an overview of existing transfer orders, including the transfer order number, status, sent date, required date, and more, based on the period selected at the top right corner of the page.

## **Exploring the listing page**
The transfer orders listing is designed to help you stay organized and quickly access the information you need.
**Summary Cards:** On the top of the listing page, you’ll see summary cards displaying high-level information about your transfer orders. Each card highlights details such as:
* Total number of transfer orders
* Draft, In-transit, Completed, and void.
These cards provide a quick overview of your progress and help you identify areas that may need attention.
Customize the Transfer Orders listing by adding/removing or reordering columns. Then, update the View to overwrite it or save it as a new view. Control visibility and sharing so the right teammates can use or edit each view.
**Update View**
* Click Update View to modify the current view after changes.
**Save as a new view**
* Use the dropdown beside Update View → Save as new view.
**Create View dialog**
* Enter the View Name (mandatory), choose Share with (User/Team) and add users, toggle Visibility to all users, and click Create.
**Reset View**
* Click Reset View to restore the current view to the default.
**Permissions**
* Edit: Add/remove/reorder columns; save as new or overwrite existing views.
* View-only: Apply views but can’t edit; can Save as new view to copy without altering the original.
* Manage view: Rename, adjust Visibility (Only Me/User/Team or global toggle), Duplicate, or Delete (creator only; reverts to default/another saved view).
## Pinned filters
Zuper's Transfer Orders module lets you use pinned filters to streamline your filter experience. Pinned filters keep your most-used criteria readily accessible for quick application.
Pin up to 3 filters in any module.
**Navigation**: *Inventory & Pricebook* *-> Transfer Orders* -> *Filters -> Pinned Filters*
1. Select the “**Inventory & Pricebook**” module from the left navigation menu and choose “**Transfer Orders**.”

2. **Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

3. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters.

***Open transfer order details***
* After filtering, click a Transfer Order Number or Transfer Order ID to view and manage details.

## Managing transfer order details
Once a transfer order is created or accessed from the listing page, the **Transfer Order Details Page** becomes your central hub for managing its lifecycle. Upon landing the details page, you can view and update the status of the Transfer Order.
Depending on the status of the Transfer Order, you can perform actions such as **Edit, Update status, Clone,** and **Delete**. Each status has been explained in detail below:
### 1. Save as Draft
When you choose to save the Transfer Order as a draft, the order will be saved in draft status, and you can continue to make changes to the Transfer Order.

During **Draft** status, you can also “**Edit**,” “**Clone**,” or “**Delete**” the transfer order as needed by clicking the “**More Actions**” button at the top right as shown below:

### 2. In-Transit
This status indicates that the stock has left the From Location. When you **update the status to in-transit**, you are prompted to **choose the sent date** using the date picker. The sent date cannot be a future date.
Once chosen, click the “**Update**” button. The status will be updated, and the transferred quantity will be deducted from the ‘**From Location**’ for each of the line items.

During **In-Transit** status, you cannot edit or delete the Transfer Order created but can perform various actions such as **“Edit Remarks,” “Edit Required Date,” and “Clone**” by clicking the “**More Actions**” button at the top right as shown below:

### 3. Completed
When you mark the order as complete, you’ll be asked to choose the received date, which cannot be a future date.
Once a Transfer Order is marked as completed, the transferred quantity is increased in the **To Location** for each line item. If the transfer is completed instantly (i.e., it is marked as completed during creation or from draft status), the sent date will be the same as the received date, and the line-item quantity and serial numbers will be updated in both the From and To Locations.

When the status is ‘**Completed**’, you can only “**Edit Remarks**” and “**Clone**” a transfer order as needed by clicking the “**More Actions**” button at the top right, as shown below:

### 4. Void
If you need to cancel or invalidate any of the Transfer Orders, you can mark them as void. This action will reverse the quantity transferred between locations.
Once an order is marked as void, you will be prompted to provide a reason. After providing the reason, click the “**Update**” button to void the Transfer Order successfully. The provided reason is captured under activity.

> [!NOTE]
>
> **Note:** Once an order is marked as void, you cannot edit or process it further. You can only “**Clone**” an order as needed by clicking the “**More Actions**” button at the top right as shown below:

### More Actions
Managing transfer orders doesn’t stop at viewing details—you can take various actions to keep things moving. Things you can do are:
> [accordion] Print
>
> To generate a physical copy of the transfer order for record-keeping or customer reference, use the “**Print**” button at the top right of the page.
> [accordion] Share
>
> Compose the email and click on the ‘**Share**’ button. Note that the Transfer Order will be attached to the email as a pdf by default.
> [accordion] Activity Log
>
> To view activity, click on "**Activity**" in the right pane, where you can see all the actions performed within the Transfer Order, along with the corresponding user names.
> [accordion] Clone
>
> To clone the transfer order, use the "**Clone**" button at the top right of the page.
# Overview
Source: https://docs.zuper.co/Inventory_Management/transfer_order
A Transfer order is a formal document used to track and record the transfer of inventory from one location to another. With Transfer Orders in Zuper, you can:
* Track the status of a transfer
* Ensure accurate quantity updates in Source and Destination at various stages of transfer
* Transfer serialized inventory
* Record instant Transfers
* Access the activity log of all the actions on a Transfer Order
## Pre-requisites
1. Transfer Order is only available on the V3 Web app. If you are on V2, you can get started with V3 using the below link. Your login credentials would be the same as that for V2. **V3 Live (Production)** - [https://web.zuperpro.com/login.](https://web.zuperpro.com/login.)
2. If you are experiencing issues accessing the V3 Web app, please reach out to us at [support@zuper.co](mailto:support@zuper.co)
3. If Transfer Orders are enabled for your account, you can access the module in the left menu under the Parts & Services icon. If you encounter any issues accessing the Transfer Orders module, contact your account admin or write to [support@zuper.co](mailto:support@zuper.co)
4. Configure the locations under **Settings** > **Configuration Settings** > **Parts & Services** > **Product Locations**. When creating a location, you can also choose users or teams who can access the location.

**Transfer Order Status flow**

## **Access Control**
1\. Admin can view and edit all the Transfer Orders
2\. Team Leader can view and edit:
* Transfer Orders created by them
* Transfer Orders From and/or To Locations the Team Leader has access to
* Transfer Orders created by their team
* Transfer Orders whose From and/or To Locations their team has access to
3\. Field Technician can view and edit:
* Transfer Orders created by them
* Transfer Orders whose From and/or To Locations they have access to
4\. Custom role permissions available for Transfer Orders:
* Create Transfer Order
* Update Transfer Order (includes status update, adding attachments, sending email)
# Configuring Job Costing
Source: https://docs.zuper.co/Job_Costing/Configuring_Job_Costing
Before you can start tracking profitability, you need to configure your costing settings. This ensures that Zuper calculates your costs based on your specific business model.
## Access Job Costing Settings page
1. Navigate to the **Settings** module from the left navigation menu.

2. Click the **Jobs module** in the Settings menu on the left.
3. Choose **Job Costing & Expenses**.

The **Job Costing** & **Expenses** **setting** page opens.
### General tab
This tab helps you define how Zuper should calculate your profit:
1. **Profit Calculation Method**: Choose the method that aligns with your financial goals and customer agreements.
* **Margin**: Use this to calculate profit as a percentage of the total selling price ***((Selling Price – Cost) ÷ Selling Price × 100***). This method is ideal for cost-based pricing, ensuring a specific profit percentage relative to the final price.
* **Markup**: Use this to calculate profit as a percentage added to costs ***((Selling Price – Cost) ÷ Cost × 100***). This method is suitable for fixed-profit pricing, where a consistent profit amount is added on top of the cost.
**Example**: For a job with \$1,500 in costs (labor, materials, expenses) and a 30% markup, the total price is \$1,950, yielding a \$450 profit and a 23.08% margin.
2. The **Specialized Labor Service** field is disabled by default. When enabled, labor services quantity and their pricing are automatically calculated based on the technician's working hours on the respective job. This is particularly useful for **Time and Material** billing scenarios. For more detailed guidance, refer to the [Labor Service](/Job_Costing/Labor_Service) and the [Calculating Job Profitability: Time and Material Billing](Job_Costing/Time_and_Material) guides.
### Labor tab
This tab helps you define labor cost markups and pricing rules based on work conditions, roles, and job levels.
### *Labour Codes*
You can define labor codes for different work scenarios (e.g., regular hours, overtime, double time) and their associated cost and pricing rules. Each labor code specifies how technician time is costed internally and billed to customers. Zuper provides three default labor codes:

| **Labor Code** | **Cost Markup** | **Price Markup** |
| :- | :- | :- |
| Regular | 1x | 1x |
| Overtime | 1.5x | 1.5x |
| Double Time | 2x | 2x |
You can also customize the above-listed codes or add new labor codes in Zuper to reflect your organization’s unique pay and billing policies.
> [!NOTE]
>
> **Information:**\
> ***Cost Markup -*** This markup applies to a technician’s hourly rate based on the assigned labor/cost code. This decides the internal cost of labor for your business.
>
> *For example*, a technician with a fully loaded rate of \$18/hour assigned to a ‘Regular’ (1x) cost code incurs a cost of **\$18** for one hour. The same technician assigned to an ‘Overtime’ (1.5x) cost code incurs a cost of **\$27** for one hour.
>
> ***Price Markup*** - This markup applies to the unit selling price of labor services based on the labor/price code. This decides the price charged to customers.
>
> *For example*, a labor service priced at \$20/hour with a ‘Regular’ (1x) price code is sold for **\$20** per hour. The same service with an ‘Overtime’ (1.5x) price code (e.g., for an emergency repair) is sold for **\$30** per hour.
> [!NOTE]
>
> **Note**: Zuper separates cost and price markups to maximize your flexibility. This allows your businesses to:
>
> * Charge higher prices for specialized services, such as emergency repairs, while paying technicians at a standard rate.
> * Tailor pricing strategies to market demands or service urgency without affecting technician compensation.
#### *Managing the Labor Codes*
1. Click **+ New Labor Code** or the **Edit** icon next to an existing labor code.
2. Enter the labor code name and description.
3. Set the **Cost Markup** and specify whether it is a flat amount, a percentage, or a multiplier.
4. Set the **Price Markup** and specify whether it is a flat amount, a percentage, or a multiplier.
5. Click **Update** to save.

### Labor Types
Labor types in Zuper classify technicians based on their role or job level, such as Technician, Installer, or Supervisor, and define which labor services they can perform under the Time & Materials (T\&M) billing method. You can use the ***Filter by Labor Services*** option during job assignment to ensure that only users associated with the relevant labor services are listed for scheduling.

**To configure labor types:**
Follow these steps to set up labor types in Zuper:
1. Click "**+** **New Labor Type"**.
2. Provide a **Name** (e.g., Technician, Supervisor) and a **Description** for the labor type.
3. Choose the relevant **Job Categories** that align with the labor type’s responsibilities (e.g., Plumbing, HVAC).
4. Choose one of the following options to associate labor services with the selected job categories:
* **Option 1: Associate ALL Labor Services** \
It links all labor services from the Parts & Service master to the chosen job categories.
* **Option 2: Pick Specific Labor Services** \
It allows you to manually select relevant labor services to associate with the chosen job categories. This provides granular control, enabling you to link specific services (e.g., Plumbing services to Plumbing job categories, HVAC services to HVAC job categories).
5. Click **Create** to save the new labor type configuration.

> [!NOTE]
>
> **Note:** To assign this Labor Type to a user so they appear in the job assignment list, go to **Settings > Users & Teams > User Management**. Edit the user’s details and select the desired Labor Type in the **Labor Type** field.
## Expenses
This tab helps you to manage job-related expenses (e.g., transportation, lodging, field-purchased materials) by defining:

* **Billable vs. Non-Billable**: Whether the expense is charged to the customer.
* **Reimbursable Status**: Whether the expense is reimbursed to employees.
* **Capping Values**: Maximum allowable amounts.
For more details, refer to [Creating an Expense Category](/Settings/Modules/Jobs/Configuring_expense).
## **Set Hourly Labor Costs for Users**
To calculate labor cost accurately, Zuper uses each employee’s **fully loaded hourly rate**. This includes:
* The **base hourly wage**
* Any additional employer-paid costs (e.g., travel, taxes, insurance, benefits)
Using the fully loaded rate offers a realistic view of labor costs, aiding long-term budgeting and profitability analysis.
For businesses where all technicians are *paid a uniform hourly rate*, you can configure it in the default settings as follows:
1. Navigate to **Settings > Users & Teams > General Settings > Wage Information**.
2. Set the following:
* **Default Hourly Labor Charges**: The standard hourly rate for technicians.
* **Default Burden Rate**: Additional costs (e.g., taxes, benefits) as a flat value or percentage.
* Zuper’s **Minimum Roundoff Multiple Number** automatically rounds technician job time log entries to the nearest specified interval. The default is **30 minutes**, but you can adjust it to 10, 15, or 45 minutes.

**Note**: These functions apply only when the Timelog feature is enabled, not for manually entered technician times.
## Setting a Fully Loaded Rate for Individual Employees
To assign a fully loaded rate to a specific employee:
1. Go to **Settings > Users & Teams > User Management**.
2. Select the desired user from the list.
3. Click the **kebab icon (⋮)** and choose **Edit Details**.

4. In the **Wage Information** section:
* Enter the **Hourly Labor Charge** (base wage).
* Enter the **Burden Rate** (as a flat value or percentage for additional costs).

5. Save the changes.
Zuper will use the configured fully loaded rate to calculate labor costs for any job the employee is assigned to.
# Calculating Job Profitability for Fixed Price Service Jobs
Source: https://docs.zuper.co/Job_Costing/Fixed_Price
Fixed Price billing offers customers a predetermined, flat rate for a specific service. The customer pays a fixed amount, regardless of how long the job takes or the effort required to complete it. This model offers predictable costs for customers and helps businesses maintain clear and upfront pricing.
Zuper tracks your actual job costs, including labor hours, parts, and expenses, to give you complete visibility into your true profitability. This allows you to see exactly how much you're earning on each job by comparing the fixed price charged to the customer against your actual costs.
This guide walks you through the process of adding a fixed price service to a job, understanding the cost breakdown, and reviewing profit.
**Prerequisite:**
Ensure you have created a service in the Master Parts and Service module and set the **Unit Selling Price** for the service. Refer to the [Create Parts, Products, & Services](/Inventory_Management/Parts_Services/Create_New_Part_Service) guide.
**Let’s add a fixed price service to a job and calculate profitability!**
1. Go to the respective **Job Details** page.
2. **Add a fixed price service in the Line Items**: These include the price of all products, parts & services added to a Job.
3. On the **Job Detail Page**, locate the **Line Items** section.
* On the **Parts & Services** tab, click **+ Add** and select the **Line Item**. 
* In the **Product Type** field, choose **Service**. 
* Select the relevant service (e.g., Water Heater Installation) from the list. If you want to add more parts, products, and services, add to it. 
* Click **Add Product** to include the service in the job.
> [!NOTE]
>
> **Note:** You can add multiple parts, products, and services to a Fixed Price job as needed. When you add products or parts as line items, their selling price contributes to the job's Total Revenue, and their purchase cost is added to COGS.

4. **Labor** tab: Displays the time technicians spend on the job, recorded from timelogs or entered manually.
> [!WARNING]
>
> **Behavior change**: Time shown on the **Labor** tab is for time tracking only and is not included in COGS. To include labor in profitability, add the work as a **Service** line item and set its **Unit Purchase Price/Unit Cost**.
> [!NOTE]
>
> **Important:** The labor hours shown here are for your internal tracking, not what the customer pays. The customer pays the fixed service price set in Step 2.

* If the [Timelogs](/Timesheets_Management/Timelogs/Overview) feature is enabled, Zuper automatically captures the time spent on the job. If Timelogs is disabled, you must **manually add time entries** by clicking **+ Add** in the Labor tab.
* You can also update the **Cost Code** for a technician by editing their time entry. When a Cost Code is changed, Zuper creates a new line item instead of modifying the existing one, which helps maintain a clear audit trail of labor cost changes.
> [!NOTE]
>
> **Note:** If your organization is using the **Timelog** feature, you **cannot delete a labor line item directly** if it was created through a time log. To remove such a labor line item, first delete all related time logs for that technician within the job, and then delete the labor line item. This ensures corrections can be made when a technician logs time against the wrong job.
>
> If **Timelog** is **not enabled**, you can delete labor line items directly from the job.
5. **Expenses** tab: Add job-related expenses (e.g., travel costs) if the **Expenses** setting is configured. 
## **Review Job Profitability**
Once line items, labor hours, and expenses are added, Zuper calculates job costs and profitability automatically. Check the **Job Profitability Bar** at the top of the **Line Items** section on the **Job Detail** page.

> [!NOTE]
>
> ***Note***: Visibility of cost breakdowns depends on your **Job Costing Permissions** settings. Refer to the Job Costing Permission article for more info.
Here’s a detailed breakdown of profitability for a **Water Heater Installation** job billed using the **Fixed Price** method in Zuper:
> [!WARNING]
>
> **Review needed**: The example below reflects the earlier behavior, where labor hours recorded on the **Labor** tab were included in COGS. In the current release, those hours are not included. This example needs to be recalculated with labor cost carried on the service's Unit Purchase Price.

**Total Price (Revenue): +\$1,200**\
This is the fixed price agreed upon with the customer before the job began.
**COGS: -\$444**
| **Component** | **Details** | **Cost** |
| :- | :- | :- |
| Parts & Services | Water Heater Installation | - |
| Labor | Technician Shawan Edward worked 6 hours at \$69/hour | -\$414 |
| Misc. Expenses | Travel fuel expense | -\$30 |
| **COGS:** | \$0 (Parts) + \$414 (Labor) + \$30(Misc.) | **\$444** |
**Profit:**
`$1,200`(revenue) − `$444`(total job cost in system) = `$756` **profit**
**Profit markup:** `170.3%`
### **FAQs**
1. **Can I specify a Price Code for a Fixed Price service?**\
Price Codes are not applicable to Fixed-Price services in Zuper, as the entire job is billed at a flat, predefined amount.
2. **Should I create a separate category for labor services?** Yes, we recommend creating a “**Labor**” category to help distinguish labor-related services from other parts or materials. This improves clarity in reporting, job costing, and service management.\
To create or manage service categories: Go to: **Settings** > **Modules** > **Parts and Services** > **Category Settings**.
3. **Should I specify the Unit Purchase/Cost Price when creating a fixed-price service?** When creating a **fixed-price service** (e.g., *AC Installation*), do not specify the Unit Purchase/Cost Price. In Zuper, labor costs are calculated separately based on technician hours and are not tied to the service item itself.
# Labor Service
Source: https://docs.zuper.co/Job_Costing/Labor_Service
> [!WARNING]
>
> **Labor Service** is deprecated and may be removed in a future release. For new labor items, create a **Service** and set its **Service Type** to **Hourly** or **Fixed**. See [Create a new part/product or service](/Inventory_Management/Parts_Services/Create_New_Part_Service).
In Zuper, the **Labor Service** type in the **Parts & Services** module is designed for **Time and Materials (T\&M)** based jobs, where the actual time logged by technicians on a specific service is counted as the **quantity** against that labor service. This method is widely used in commercial trade and service industries for jobs where the scope or duration may vary.
This ensures that both billing and cost tracking are based on real work performed rather than an estimated or fixed price.
> [!NOTE]
>
> **Note**: Use **labor services** when you want job charges to reflect actual technician time, rather than a fixed or quoted price.
**Things to know before creating a labor service**
* **No warehouse or location is required** since a Labor Service is not a physical item. The quantity is derived from the actual hours the technician spends on the service.
* **No purchase cost is required** because labor costs are automatically calculated based on each technician’s fully loaded hourly rate.
* Once a labor service is added to a job, its quantity auto-syncs are based on the technician’s time log.
* You **cannot update a Labor Service to another product type** (Parts, Services, or Products) and vice versa. This restriction ensures accurate cost and billing calculations.
## **Creating a Labor Service**
A Labor Service is created in Zuper just like you would create a part or product.
1. Click the **Inventory Management** module from the left navigation menu and select **Parts & Services**.
2. Click **+ New Part/Service**. 
3. In **Type**, select **Labor Service**. 
4. Enter a **Service** name (for example, *Plumbing Repair Labor*).
5. Choose the category for service.
> [!TIP]
>
> **Tip:** We recommend creating a dedicated **“Labor”** category to easily distinguish labor-related services from other parts or services. To create categories, go to **Settings > Parts and Services > Categories**.

6. Specify the **Unit Selling Price** (per hour).

7. Click **Save Part/Service**.
# Overview
Source: https://docs.zuper.co/Job_Costing/Overview
When managing a field service business, profitability isn't just about how much you charge your customers; it's about understanding the actual cost of getting the job done. Labor, parts and services, and incidental expenses can all eat into your margins if not tracked accurately.
That’s where Zuper’s **Job Costing** feature comes in. It allows you to track all job-related costs in the same place you manage the rest of your job, providing real-time visibility into your profitability. You’ll gain a clear, accurate picture of how much you're earning and spending on each job.

This feature provides a comprehensive view of the financial performance of every job, helping you answer key questions like:
* How much profit did we make on this job?
* Are we charging enough to cover labor and material costs?
* Which jobs are eating into our margins?
**Prerequisite:** \
To enable the Job Costing feature for your company, contact your account admin or email [support@zuper.co](mailto:support@zuper.co).
## **Services and Pricing Models**
How you bill your customers in the field service industry can significantly impact your profitability. Whether you're billing at a **Fixed Price** or based on **Time and Materials (T\&M)**, Zuper gives you the flexibility to align your pricing with the nature of the work.
You can track and calculate costs across both models, offering detailed insights into each job's financial health.
#### **Fixed Price Services**
Offer customers a predictable, upfront price for the defined scope of work. In this model, the customer pays a fixed amount for the service, which remains unchanged even if the job requires more time or effort from your technicians. This approach provides consistent pricing for customers while giving you full visibility into the actual effort and costs involved.\
**Example:** You charge a fixed **X** amount for an HVAC installation service to your customer. However, your profitability depends on the hours clocked by your technicians; fewer hours mean higher profit, and vice versa.
> [!NOTE]
>
> **Note:** In Fixed Price jobs, service/labor costs are calculated based on actual hours worked by your technicians. You can also add products or parts necessary to complete the work; their selling prices contribute to the job's Total Revenue, while their purchase costs are added to COGS. This provides a complete view of your job's profitability.
#### **Time and Materials (T\&M)**
Charge customers based on the actual hours worked and the materials used. In this approach, the quantity of the service (and therefore, the price of the service) is driven by the hours clocked by the technicians in the field. As technicians log more hours or use more materials, both the cost and customer invoice increase accordingly.\
**Example:** You charge an hourly rate for HVAC maintenance service. As the number of hours clocked by your technicians increases, both job revenue and profitability increase proportionally, and vice versa.
> [!NOTE]
>
> **Note:** Similar to Fixed Price, T\&M jobs can include products or parts necessary to complete the work. The selling price of each item contributes to the job's Total Revenue, while their purchase costs are added to COGS, enabling accurate profitability tracking.
### Getting Started
Let’s put Job Costing into action. The following guides will help you get started.
* [Configure Job Costing in Zuper](https://docs.zuper.co/Zuper_for_Roofing/Job_Costing_Settings)
* [Understand Job Costing Details](/Job_Costing/Understanding_Job_Costing_details)
* [Add a Fixed Price Service to a Job and View Job Cost and Profit](/Job_Costing/Fixed_Price)
* [Add a Labor Service to a Job and View Job Cost and Profit](/Job_Costing/Time_and_Material)
# Calculating Job Profitability for Time and Material Jobs
Source: https://docs.zuper.co/Job_Costing/Time_and_Material
Time and Materials (T\&M) billing is a widely used method in the commercial trade and service industries. In this model, customers are billed based on the actual hours worked by technicians and the materials consumed, rather than a fixed price for the entire job.
Zuper’s **Job Costing** feature streamlines this process by enabling you to add **labor services** to jobs, track labor hours in real time, and automatically update labor service quantity based on total hours worked—whether you're applying different pricing rules for overtime or ensuring every expense is accounted for.
We will walk you through adding a labor service to a job and gaining accurate visibility into job costs and profitability, helping you stay financially in control.\
\
**Prerequisite**
Ensure a **Labor Service** is created in the **Master Parts and Services** module. Refer to the [Create Labor Service](/Job_Costing/Labor_Service) guide for instructions.
**Let’s add a labor service and calculate profitability!**
1. Open the relevant job in Zuper to access the **Job Details page** or create a new job from the **Job Creation** page.
2. On the **Job Details page**, go to the **Line Items** section and click the **Parts & Services** tab.
1. Click **+ Add** and select **Line Item**. 
2. In the **Product Type** field, choose **Labor Service**. 
3. Pick an existing Labor Service (e.g., HVAC System Diagnostic Repair) from the list.
> [!NOTE]
>
> **Note**: The labor services available here depend on your configuration in the **Job Costing and Expense** settings > **Labor Type** section.
4. Click **Save** to add the labor service to the job.  The ***Labor service quantity*** on the line will automatically update based on the actual hours clocked by technicians. For example, if technicians take 5 hours to complete the job, the quantity will automatically update to 5.
> [!TIP]
>
> **Tip**: Need to adjust the labor service pricing for different work conditions like Overtime or Double Time? Click the **context menu (⋮)** next to the labor service, select **Edit**, and update the **Price Code**. Learn more about Price Codes in our Labor Codes guide. 
5. Add any required parts or products to the job’s line items by clicking **+ Add** and selecting the relevant items.
6. Specify quantities and ensure the **Unit Purchase/Cost Price** and **Unit Selling Price** are set for accurate cost and revenue calculations. 
3. **Labor** tab: Displays the time technicians spend on the job, recorded from timelogs or entered manually. 
> [!WARNING]
>
> **Behavior change**: Time shown on the **Labor** tab is for time tracking only and is not included in COGS. To include labor in profitability, carry the cost on the service's **Unit Purchase Price/Unit Cost**.
* If the [Timelogs](/Timesheets_Management/Timelogs/Overview) feature is enabled, Zuper automatically captures the time spent on the job. If Timelogs is disabled, you must **manually add time entries** by clicking **+ Add** in the Labor tab.
* You can also update the **Cost Code** for a technician by editing their time entry. When a Cost Code is changed, Zuper creates a new line item instead of modifying the existing one, which helps maintain a clear audit trail of labor cost changes. 
> [!NOTE]
>
> **Note:** If your organization is using the **Timelog** feature, you **cannot delete a labor line item directly** if it was created through a time log. To remove such a labor line item, first delete all related time logs for that technician within the job, and then delete the labor line item. This ensures corrections can be made when a technician logs time against the wrong job. If **Timelog** is **not enabled**, you can delete labor line items directly from the job.
4. **Expenses** tab: Add job-related expenses (e.g., travel, fuel, or equipment rentals) in the **Expenses** tab. Accurate expense entries ensure your total job cost is complete. See our Job Expenses guide for more details. 
**Review Job Profitability**
Once line items, labor hours, and expenses are added, Zuper calculates job costs and profitability automatically. Check the **Job Profitability Bar** at the top of the **Line Items** section on the **Job Detail** page.

> [!NOTE]
>
> ***Note***: Visibility of cost breakdowns depends on your **Job Costing Permissions** settings. Refer to the Job Costing Permission section for more information.
Here’s a detailed breakdown of profitability for an HVAC repair job billed using the Time and Materials (T\&M) method in Zuper:
> [!WARNING]
>
> **Review needed**: The example below reflects the earlier behavior, where labor hours recorded on the **Labor** tab were included in COGS. In the current release, those hours are not included. This example needs to be recalculated with labor cost carried on the service's Unit Purchase Price.

**Total Price (Revenue): +\$650**\
This includes labor and parts selling prices.
**Note:** The labor service quantity on the job line items is automatically updated to reflect the total hours worked by the technician (5 hours).
**COGS: -\$460**
| **Component** | **Details** | **Cost** |
| :- | :- | :- |
| **Parts & Services** | Refrigerant Canisters (2 × \$60) + Sealant Kit (1 × \$120) (These are the purchase costs for the parts and materials used in the repair) | **-\$240** |
| **Labor** | Technician **Joseph Xero** worked 5 hours at \$38/hour | **-\$190** |
| **Expense** | Travel-related fuel cost | **-\$30** |
| **COGS** | \$240 (Parts) + \$190 (Labor) + \$30 (Fuel) | **\$460** |
**Profit:**\
`$650` (revenue) − `$460` (total job cost in system) = `$190` (Overall profit for the HVAC repair job )
Profit Markup is `41.3%`.
**FAQs**
1. **When should I use 'Service' vs 'Labor Service' in Zuper?**
* Use **Service** when offering a **fixed-price service**. This means the customer is charged a predetermined selling price regardless of how much time or how many materials are used.
* Use **Labor Service** when billing the customer **based on actual time spent by the technician and the materials used** to complete the job. This method is ideal for **Time & Materials (T\&M)** billing.
2. **How is the quantity of a Labor Service determined?** The quantity of a **Labor Service** is based on the actual hours clocked by the technician. If the **Timelogs** feature is enabled, Zuper automatically updates the quantity based on recorded hours. If disabled, manually enter the hours in the **Labor** tab.
3. **What if my organization does not use the Timelog feature?**\
If Timelog is not enabled, you can still track labor costs manually. In the **Labor** tab of the job, click **+ Add** to add a time entry for the technician. Enter the number of hours worked, select the appropriate **Cost Code**, and save. Zuper will calculate the labor cost based on the entered hours and the technician’s fully loaded hourly rate.
# Understanding job costing details
Source: https://docs.zuper.co/Job_Costing/Understanding_Job_Costing_details
In Zuper, the Job Costing feature breaks down costs on jobs so you can gain insights into payroll costs, parts & services costs, and opportunities to increase gross margins.

\
On your **Job** details page, there is a “**Line Items**” section that includes details about your parts and services, labor, and expenses for that job. These make up the calculation for your job's profitability.
At the top of this section, you will find the "**Job Profitability Bar**," which displays:
* **Profit Margin/Markup (%)** – This is how much profit you're making as a percentage of your revenue or cost. It's calculated by dividing your profit by the total revenue or cost.
* **Total Price (Revenue)** – This is what you’re billing the customer (*pre-tax and before discounts*). It’s calculated from the unit selling price of all your line items, labor charge, and expenses for the Job.
* **COGS** – This represents the actual costs incurred to complete the job. The total job cost includes the following components:
* **Parts & Services Cost** – Shows how much those line items are costing you internally. Services are reported as **Hourly Labor** or **Fixed Labor**, based on the **Service Type** set for each service.
* **Labor Cost** – Time recorded against the job appears on the **Labor** tab for time tracking. It is not included in COGS. Refer to the Labor section for detailed information.
* **Expenses** – Any extra costs you’ve added manually, like meals, materials, or fuel.
* **Profit** – This is the amount left after subtracting all your actual job costs from your revenue.
Each time you add or change a line item, log more time, or update an expense, the **Job Profitability Bar** updates automatically, so you’re always seeing the most accurate numbers.

> [!NOTE]
>
> **Note**: Admins can access Job Costing by default. Other office employees must have the “**Manage Labor Line Items** and **View Job Profitability**” permissions to view and manage it. For more information, refer to [Job Costing Permissions](/Job_Costing/Understanding_Job_Costing_details#job-costing-permissions).
## View or Hide the Costing Breakdown
To explore detailed job costing information, click **View Costing Breakdown**. This section provides a comprehensive breakdown of how profit is calculated across each component, including **line items**, **labor**, and **expenses**. The breakdown includes:
* **Total Revenue Breakdown** - Displays the total job revenue, split between the **total job cost** and **profit**.
* **COGS Breakdowns** - Details the total cost incurred, segmented into **expenses**, **labor costs**, and the **cost of parts/services**.
To minimize the job profitability bar, click **Hide Costing Breakdown** to collapse the section.
### Line Items: Parts, Products, Services, and Labor
Everything starts with **line items**. These are the parts, services, and labor you add to a job. Each line item has:
* A **unit price** – what you charge the customer
* A **unit cost** – what it costs your business
* A **quantity** – how many units you're billing for
* Price Code (only for labor services) - if the end customer has different pricing based on various considerations such as urgency, time of day, or day of the week.
Zuper calculates the total cost and total price based on these fields, so it’s important to keep them accurate.

> [!NOTE]
>
> **Note**: If you want to exclude a line item from profitability calculations, disable the *Consider for Profitability* toggle when editing the line item.
### Labor
Labor Cost represents the internal expense your business incurs for the time employees spend on a job.
> [!WARNING]
>
> **Behavior change**: Labor cost is no longer derived from timelog entries. Time recorded against a job is captured on the **Labor** tab for time tracking only and is not included in COGS or the COGS Breakdown.
>
> To include labor in profitability, add the work as a **Service** line item and set its **Unit Purchase Price/Unit Cost**. Zuper then reports that cost under **Hourly Labor** or **Fixed Labor**, based on the **Service Type** set for the service in **Parts & Services**. See [Create a new part/product or service](/Inventory_Management/Parts_Services/Create_New_Part_Service).

> [!NOTE]
>
> **Note**: Zuper supports job profitability using the Timelogs feature. When enabled, time spent by users on jobs is automatically captured. [Learn more about using Timelogs](/Timesheets_Management/Timelogs/Overview).
#### How Labor Cost is Calculated
> [!WARNING]
>
> **Behavior change**: The formula below describes how labor cost was calculated from timelog entries in earlier releases. In the current release, timelog entries do not contribute to COGS. Use the **Unit Purchase Price/Unit Cost** on the labor service instead.
Labor costs in Zuper are calculated based on three key factors: the **time worked** by the technician, their **Fully Loaded Hourly Rate**, and the assigned **cost code**, such as **Regular**, **Overtime**, or **Double Time**.
Zuper uses the following formula to calculate labor cost:
**Labor Cost** = *Time Worked × Fully Loaded Hourly Rate × Cost Code*
The fully loaded rate is configured per user and includes:
* The employee’s base hourly wage
* Employer-paid contributions such as taxes, insurance, benefits, or overheads (entered as a burden rate)
> [!NOTE]
>
> **Note:** To update the **Cost Code**, go to the **Labor Line Item** page, select the relevant user, and modify the assigned cost code. The updated cost will automatically be reflected in the job cost breakdown.
>
> 
### Expenses
Sometimes jobs come with additional costs, like buying materials on-site, paying tolls, or reimbursable expenses. You can log these directly in Zuper.

#### To add an expense:
1. Go to the **Expenses** tab inside the job.
2. Click **+ Add** to add a new expense.
3. Choose how you want to add the expense details:
* **Upload a receipt image** to let **Zuper AI** automatically extract the expense information, or
* **Manually enter** the expense details.
4. Review the details, including the **expense name**, **amount**, **date**, and other relevant fields.
5. Choose whether the expense is reimbursable or not.
6. Click **Save** to add the expense.

These values are added to your total job cost and reflected in the Job Profitability Bar, helping you track every penny you spend. For more detailed information, refer to **Expenses**.
### Reporting
Zuper provides a **Job Profitability Report** for users who have the “**View Profitability**” permission enabled.

To view the report:
* Navigate to the **Reports** module from the left navigation menu.
* Select **Job Profitability Report**.
* Generate the report to view key financial metrics for each job, including:
* **COGS**
* **Revenue**
* **Profit**
* **Profit Margin (%)**
**Things to Know**
* Jobs created before the Job Costing feature was enabled may not have accurate labor line-item or profit details. These jobs will be updated with correct profitability data only when an action is performed on them, such as editing the job, assigning a technician, adding a time log, etc.
* Labor service pricing is not impacted by customer-specific **Pricelists**. Labor charges will remain as configured in the service catalog.
* In the **mobile app**, the **Labor Code** applies only to labor hours, not travel hours.
### **Job Costing Permissions**
Zuper provides default access control for Job Costing features based on user roles. However, if your business requires a different level of visibility, you can customize access using **Custom Roles**.
**Default Role-Based Access**
| **Role** | **Labor Line-Items tab** | **Job Profitability Bar** |
| :- | :- | :- |
| **Admins** | Accessible | Visible |
| **Team Leaders (TLs)** | Accessible | Not visible |
| **Users (FEs)** | Not accessible | Not visible |
**Customizing Job Costing Permissions**
You can override the default access controls and define visibility for specific roles using custom role settings.
**To update Job Costing permission:**
1. Go to **Settings > Users & Teams > Custom Roles**. 
2. Select an existing custom role or create a new one.
3. Click the **Jobs** module.
4. Enable or disable the following permissions:
* **Manage Labor Line Items** – Controls access to the **Labor** tab within a job.
* **View Job Profitability** – Controls access to the **Job Profitability Bar** and the related profitability dashboard.
5. Click **Save** to apply the changes.  By setting these permissions, you can ensure that job costing information is only visible to the appropriate team members, maintaining control over sensitive financial data.
# Reports
Source: https://docs.zuper.co/Legacy_Reports/Legacy_Reports
Generate and download pre-built reports across jobs, invoices, assets, contracts, employees, customers, purchasing, and more.
The Reports module in Zuper offers pre-built exports across every area of your field service operation. Choose a report type, set your date range, apply optional filters, and download your data as an Excel file.
> [!TIP]
>
> **Looking for the new Report Builder?** Zuper offers a modern, interactive reporting experience with saved views, flexible filtering, and shared reports. See [Reports Overview](/Reports/Overview) to know more.
## Before You Begin
* You must have Admin or Team Lead access to generate reports.
* The **Legacy Reports** module is accessible from the left navigation Menu under **Reports**.
* Reports are downloaded as Excel (.xlsx) files. For large data sets, Zuper will email you a download link instead of generating the file immediately.
* Ensure your date range is accurate before generating. Broad date ranges on high-volume accounts may trigger the email delivery method.
## Generating and Downloading a Report
All Legacy Reports follow the same generation process. Follow these steps for any report listed here.
1. Select the “**Reports**” module from the left navigation menu. Choose “**Legacy Reports**.”

2. Click the report you want to generate.

3. Set your filters:
* **Date Range**: Enter the **From** and **To** dates for the period you want to analyze.
* **Job Category**: Filter by one or more job categories. Multi-select is supported.
* **Team**: Filter by one or more teams. Multi-select is supported.
* **Generate Report By**: Choose how to apply your date range: **Created Date**, **Scheduled Date**, **Due Date**, or **Current Status Updated At**.
* **Advanced Filter** *(optional)*: Click **+ Add Filter** to apply additional criteria such as job status, priority, or assignee.
4. Click **Generate Report**. The report data previews on screen.

5. Click **Download Report** to save the Excel file.
> [!NOTE]
>
> If your report contains a large volume of data, it will not download immediately. Zuper will send a notification email with a link to download the report.

## Job Reports
It helps you analyze field team performance and track every stage of the job lifecycle.
> [accordion] Job Reports
>
> * **Job Master Report** Exports the overall status of all jobs across one or more job categories. Includes job title, category, priority, type, scheduled start and end times, assigned employee, current status, customer name, phone, and service address.
> * **Job Status Report** Displays all jobs organized by their current status. Each status appears on a separate sheet in the downloaded Excel file. Use this to track which jobs are new, in progress, on hold, or completed.
> * **Jobs Status Summary Report** Provides a count of jobs in each status, grouped by job category, for the selected date range. Useful for a quick snapshot of workload distribution across your operation.
> * **Job Status History Report** Tracks all previous status changes for every job, including the date, time, and the user who made each update. Each job category is placed on a separate sheet.
> * **Job Deviation Report** Compares actual job start times, end times, and durations against the originally scheduled values. Use this report to identify recurring delays and improve scheduling accuracy.
> * **Job Notes Report** Exports all notes added to jobs, including the note type (text or image), the job it belongs to, who added it, and when it was created.
> * **Job Average Duration / Category Report** Shows the number of jobs and the average time taken to complete them, broken down by job category, for a selected period. Useful for benchmarking and estimating future job durations.
> * **Job Products Report** Lists every product used to complete jobs, including Product ID, product name, price, and quantity consumed.
> * **Jobs Product Details Report** Provides a detailed breakdown of products purchased by each customer across all job categories, including Product ID, name, price, and quantity.
> * **Jobs Customer Cohort Report** Groups jobs that share similar work patterns or customer behavior. Use this to identify segments of recurring or related job activity.
> * **Jobs Feedback Report** Exports customer feedback submitted after job completion. Includes job details, customer details, star ratings, and written feedback comments.
> * **Jobs Checklist Report** Exports checklist data for all jobs across categories, organized by the status of each job at the time the checklist was completed.
> * **Jobs By User Report** Shows the total number of jobs assigned to each employee, with a daily count breakdown for the selected time period.
> * **Job User Utilisation Report** Details employee utilization across recurring jobs, including job title, category, customer details, repeat start and end times, duration, and frequency.
> * **Job Product Consumption Report** Provides a detailed view of all products and parts used within each job, including Product ID, name, quantity, and price.
> * **Jobs Activity Report** Exports a timestamped log of all activities performed by field technicians on each job — including status changes, rescheduling, note additions, and employee assignments.
> * **Jobs By Team Report** Displays complete job details for each team individually. Each team's data appears on a separate sheet within the same Excel file.
> * **Job Status Details Report** Provides an in-depth look at each job's status history, including Job ID, status change dates, and the current status.
> * **Recurring Jobs Report** Exports data on all jobs set to repeat, including job title, category, customer details, repeat start and end times, duration, and recurrence frequency.
> * **Job Timelog Report** Logs time-related data for each job, including clock-in and clock-out times, break times, total time spent, hourly charges, and the total amount billed.
> * **Jobs Route Summary Report** Summarizes the jobs available on each route, including route name, total number of jobs, total distance, and total travel time.
> * **Job Route Details Report** Provides job-level detail organized by route, including sequence, work order number, job title, customer, service address, assigned employee, and travel distance and time.
> * **Route Insights Report** Shows key performance insights for each job route, including total jobs, jobs yet to start, jobs on the way, jobs started, and jobs completed.
> * **Job Task Report** Exports all tasks associated with jobs, including task ID, description, estimated and actual duration, inspection form status, assigned employee, and current task status.
> * **Job Expense Report** Exports expense data logged against jobs, including expense type, amount, job details, and the employee who submitted the expense.
> * **Expense Master Report** Provides a master-level export of all expenses recorded in Zuper across jobs and categories.
> * **Job Profitability Report** Exports profitability data per job, including revenue, costs, and margin. Use this report to assess the financial performance of your jobs by category, team, or date range.

## Quotations and Invoices Reports
These reports help you track quoting and invoicing activity, monitor payment status, and analyze revenue.
> [accordion] Quotations and Invoices Reports
>
> * **Quote Master Report** Exports all quotes created within the selected date range. Includes quote date, expiry date, customer name, billing address, work order status, total line items, quote status, discount, converted status, and who created it.
> * **Quote Status Report** Displays quotes organized by their current status (Draft, Approved, Archived, etc.). Each status appears on a separate sheet in the Excel file.
> * **Quote Product Consumption Report** Shows the products and parts associated with each quotation, including product ID, name, quantity, and price.
> * **Quote Status History Report** Tracks all status changes made to quotes, including the date and time of each update and the user who made the change.
> * **Quote Status Summary Report** Displays a daily count of quotations in each status (Open, Approved, Rejected, Archived, Closed, etc.), grouped by quote date within the selected range.
> * **Invoice Master Report** Exports all invoices created within the selected date range. Includes invoice date, due date, customer name, billing address, work order status, total line items, invoice status, subtotal, total, and payment terms.
> * **Invoice Summary Report** Displays a daily count of invoices in each status (Draft, Paid, Open, Bad Debt, Archived), grouped by invoice date within the selected range.
> * **Invoice Status Report** Displays all invoices organized by their current status. Available invoices are distributed across sheets based on their status (Draft, Accepted, Rejected, Expired, etc.).
> * **Invoice Product Consumption Report** Shows the products and parts consumption history linked to each invoice, including product ID, product name, quantity, and price per unit.
> * **Invoice Status History Report** Tracks the full status update history for all invoices, including who changed the status, when it changed, and the status values before and after each update.
> * **Invoice Status Summary Report** Provides a high-level daily count of invoices in each status, grouped by invoice date, for the selected range.
> * **Invoice Product Summary Report** Summarizes product and parts usage across all invoices for a given period.
> * **Invoice Payment History Report** Exports payment history for each invoice, including invoice number, customer name, payment date, payment mode, amount paid, payment reference, and creation details.
> * **Proposal Master Report** Exports all proposals generated through Zuper, including proposal details, associated job, customer information, package options selected, and approval status.

## Product Reports
These reports give you visibility into your parts and services inventory, pricing, and stock movement.
> [!NOTE]
>
> **Inventory reporting scope and limitations**
>
> Zuper's product reports reflect the **current state** of your inventory. The following limitations apply:
>
> * **Product Availability Report** and **Product Location Report** show real-time stock quantities only. They do not support point-in-time or as-of-date queries.
> * **Product Transaction Report** exports all inward and outward inventory movements with timestamps. However, it does not calculate or reconstruct inventory balances as of a specific historical date.
> * Zuper does not maintain historical inventory snapshots. There is no native report that can return inventory quantity or valuation as of a past date (e.g., year-end, go-live date).
>
> **Workaround for historical inventory tracking:** Export the Product Transaction Report for the full period and use an external spreadsheet or BI tool to reconstruct point-in-time balances by applying running totals to the transaction history.
>
> If point-in-time inventory valuation is a reporting requirement for your business, contact your Customer Success Manager to discuss your needs.
> [accordion] Product Reports
>
> * **Product Master Report** Exports all products created in Zuper, including product creation date, product name, type, category, brand, specifications, purchase price, selling price, availability, and unit of measure.
> * **Product Transaction Report** Exports all inward and outward inventory transactions, including transaction type (inward, outward, transfer), module, location, quantity, serial number, and the user who recorded the transaction.
> * **Product Location Report** Shows the current quantity of each product at each storage location. Includes Product ID, product number, product name, and quantity per location.
> * **Product Availability Report** Exports real-time product availability data, including Product ID, product number, product name, and total available quantity across all locations.
> * **Product Group Report** Exports product group information, including group name, group description, total items in the group, who created it, and when it was created.
> * **Transfer Order Report** Exports all transfer order records, detailing stock movements between locations including transfer dates, quantities, origin location, and destination location.

## Contract Reports
These reports help you manage and track service agreements, billing, and contract-linked jobs.
> [accordion] Contract Reports
>
> * **Contract Master Report** Exports all contract master data, including contract ID, contract name, contract months, start and end dates, parent contract, activation date, billing address, customer name, and approval status.
> * **Contract Status Report** Exports status-related information for all contracts, including product ID, product type, contract transactions, subtotal, total, and billing details.
> * **Contract Jobs Report** Exports all jobs linked to contracts, including job category, job type, customer name, customer address, scheduled dates, and current job status.
> * **Contract Product Consumption Report** Shows the products and parts consumed against each contract, including product name, quantity, and associated contract details.

## Asset Reports
These reports help you track equipment and assets managed in Zuper, including service history and planned maintenance schedules.
> [!NOTE]
>
> Asset and PPM reports include contract-related information such as contract name, contract ID, and billing address, where applicable.
> [accordion] Asset Reports
>
> * **Asset Master Report** Exports master-level data for all assets, including asset name, asset code, customer name, asset category, quantity, serial number, purchase date, purchase price, placement date, warranty details, asset owner, active status, next service date, last service date, and creation details.
> * **Asset Submission Report** Exports asset submission records associated with inspections or service events, including submission date, asset details, and the employee who submitted the record.
> * **PPM Master Report** Exports Planned Preventive Maintenance (PPM) data for all assets, including asset name, asset code, contract details, last service date, next service date, PPM period, frequency, estimated duration, and the product and user associated with each PPM entry.

## User and Team Reports
These reports give you visibility into employee activity, attendance, time tracking, and performance.
> [accordion] User and Team Reports
>
> * **User Master Report** Exports a full list of all employees in Zuper, including first and last name, email, phone number, employee code, active status, role, team, home work location, and account details.
>
> * **User Skillset Report** Exports each employee's skills, including skill name, skill level, and validity dates. Use this to match the right technician to the right job.
>
> * **Location History Report** Exports a timestamped record of each employee's location activity, tracking their movement throughout the workday.
>
> * **Time And Distance Report** Exports time spent and distance traveled by each employee during their shift. Useful for mileage reimbursement and productivity analysis.
>
> * **Timesheet Master Report** Exports all timesheet activity for the selected period, including punch-in, break, resume work, and punch-out events. Includes employee name, email, designation, activity type, time of activity, and location.
>
> * **Timesheet Location Report** Exports location data captured at each timesheet event (clock-in, clock-out, break), including GPS coordinates and address.
>
> * **Timesheet User Shift Report** Exports shift-related information tied to each employee's timesheet, including shift name, scheduled hours, and actual hours worked.
>
> * **Timecard Report** Provides a daily breakdown of each employee's work activity, including check-in time, check-out time, work time, and break time for each day in the selected range.
>
> * **Timeoff Report** Exports all leave requests placed by employees, including the requester, request dates, reason, approval status, who approved it, and the approval date.
>
> * **Timesheet Approval Report** Exports a full log of timesheet approvals and rejections, including who reviewed each timesheet and when.
>
> * **User Feedback Report** Exports day-to-day feedback submitted by employees about their workday, including feedback content, date, and the employee who submitted it.
>
> * **Timesheet By Team Report** Exports timesheet activity organized by team, showing day-by-day totals per employee within each team for the selected period.
>
> > [!NOTE]
> >
> > **Location History Report date range limit**
> >
> > The **Location History Report** can be generated for a maximum of 7 consecutive days per report. To cover a longer period, generate multiple 7-day reports and combine them, or set up a [Scheduled Report](#scheduled-reports) to receive recurring exports automatically.
> >
> > If a user's location data is missing or incomplete within that range, see [User & Team Settings](/Settings/Users_Teams/General#users-teams-general-settings) for the organization- and user-level settings, and device permissions required to capture it.

## Contact Reports
These reports help you understand customer activity, payment history, and account credits.
> [accordion] Contact Reports
>
> * **Contact Master Report** Exports a full list of all contacts in Zuper, including first and last name, category, company, number of jobs, email, mobile, home and work phone, description, tags, city, state, zip code, account manager, lifetime value (LTV), and creation date.
> * **Contact Activity Report** Exports a log of all activity associated with each contact, such as job creation, status updates, and notes. Useful for tracking the full history of a customer relationship.
> * **Payment Transaction Report** Exports all payment transactions linked to contacts, including organization, customer name, created user, payment mode, payment provider, module, description, currency, amount, type, source, status, transaction ID, and creation date.
> * **Contact Credit History Report** Exports the credit balance history for each contact, including credit amounts applied, when they were applied, and the associated invoices or jobs.
> * **Email Communication Report** Exports a log of all email communications sent to or from contacts through Zuper, including email subject, recipient, sent date, and the associated job or record.

## Request Reports
These report exports all service requests submitted through Zuper, including request ID, title, category, customer details, assigned employee, priority, status, and creation date.

## Project Reports
> [accordion] Project Reports
>
> * **Project Master Report** Exports all project records, including project name, category, customer, assigned team, start and end dates, project status, and total associated jobs.
> * **Project Timelog Report** Exports time-tracking data for each project, including the employee, clock-in and clock-out times, total time spent, and the project the time was logged against.
> * **Project Task Report** Exports all tasks associated with projects, including task name, description, assignee, due date, status, and the project each task belongs to.

## Organization Reports
**Organization Master Report** Exports all organization records in Zuper, including organization name, description, address, number of customers, associated teams, created by, and creation and update timestamps.

## Property Reports
**Property Master Report** Exports all property records linked to your customers, including property name, address, number of jobs, associated organization, customers linked, created by, and creation and update timestamps.

## Purchasing Reports
**Purchasing Reports** give you visibility into vendor management, material requests, and purchase order activity.
> [accordion] Purchasing Reports
>
> * **Vendor Master Report** Exports all vendor records in Zuper, including vendor name, contact details, address, associated products or services, and creation details.
> * **Vendor Catalog Report** Exports the products and services catalog linked to each vendor, including item names, prices, and vendor details.
> * **Material Request Master Report** Exports all material requests raised within Zuper, including request ID, requested items, quantities, requested by, status, and associated job or project.
> * **Material Request Items Report** Provides a line-item-level breakdown of all material requests, including individual item names, quantities requested, quantities fulfilled, and current status.
> * **Purchase Orders Master Report** Exports all purchase orders created in Zuper, including purchase order number, vendor name, items ordered, total value, order status, and creation and expected delivery dates.
> * **Purchase Orders Status Report** Exports purchase orders organized by their current status, helping you track which orders are pending, received, or cancelled.

## Miscellaneous
> [accordion] Miscellaneous
>
> * **Non Job Event Report** Exports data for time or activities logged outside of a specific job. For example, administrative time, travel without an associated job, or downtime entries.
> * **Global Task Report** Exports all tasks created across Zuper, regardless of whether they are linked to a job or project, including task name, assignee, priority, due date, status, and creation date.
> * **Commissions Master Report** Exports commission-related data for your team, including employee name, associated jobs or invoices, commission amounts, and relevant dates.

## Custom Reports and Scheduled Reports
In addition to the standard reports listed above, Zuper provides two additional reporting tools accessible from the left panel under **Others**.
### Custom Reports
**Custom Reports** let you build your own report by selecting the module, filters, and fields you need. You can filter by multiple job categories and teams simultaneously using the multi-select pickers. You can also choose how the date range is applied - by Created Date, Scheduled Date, Due Date, or Current Status Updated At.

### Scheduled Reports
Scheduled Reports let you automate report delivery on a recurring basis. Zuper generates and emails the report to the recipients you specify, on the schedule you define.
To set up a Scheduled Report:
1. Click **Scheduled Reports** at the top right of the Reports module.

2. Click **+ New Scheduled Report**.

3. Fill in the following details:
* **Schedule Report Name:** Give the report a descriptive name.
* **Report Type**: Choose **Default Report** or **Custom Report**.
* **Report Module:** Select the module (e.g., Jobs, Invoices, User, and Team).
* **Choose Report:** Select the specific report type within that module.
* **Generate Report By**: Choose whether to apply the date range by Created Date, Scheduled Date, Due Date, or Current Status Updated At.
* **Job Category**: Select the relevant job category.
* **Schedule Frequency**: Set how often to generate: Daily, Every Week, Every Month, or Every Year.
* **Send At**: Set the time of day to send the report.
* **Report Data Duration**: Define how far back the report data should reach (e.g., 30 Days, 3 Months).
* **Send To**: Enter one or more recipient email addresses.
* **Email Subject and Email Body**: Customize the email that delivers the report.

4. Click **Create Report**. Zuper will generate and deliver this report automatically on your defined schedule.
> [!TIP]
>
> Use Scheduled Reports to automatically send weekly or monthly summaries to managers without any manual effort. Set the Report Data Duration to match your review cycle, for example, 7 days for a weekly report.
### Rebuilding a Legacy Report in Report Builder
If you need to update or modify a legacy report, the recommended path is to rebuild it using the new Report Builder — which gives you full control over fields, filters, and scheduling going forward.
> [accordion] Rebuilding a Legacy Report in Report Builder
>
> > [!WARNING]
> >
> > The Report Builder is a **paid add-on**. If you do not currently have access to it, contact your Zuper account manager or email [support@zuper.co](mailto:support@zuper.co) before proceeding.
>
> **1. Review your existing legacy report**
>
> Open the legacy report from the **Legacy Reports** section in the sidebar and note the following before rebuilding: the data it covers, the fields displayed as columns, any filters or conditions applied, and whether it was delivered on a schedule. If you are unable to view the configuration details, contact Zuper Support at [support@zuper.co](mailto:support@zuper.co) for assistance.
>
> **2. Open the Report Builder**
>
> Navigate to **Reports** in the left navigation menu and select **Reports (beta)**. You will land on the Report Builder home page.
>
> **3. Create a new report**
>
> Click **+ New Report** and select either **Summary** or **Detailed** depending on your original report type. Select the module(s) that match the data your legacy report covered — for example, Jobs, Invoices, or Customers.
>
> **4. Recreate fields and filters**
>
> Add the same fields as columns that appeared in your legacy report. Apply equivalent filters and conditions using the filter panel. Use **Group By** if your legacy report aggregated data by category, team, or date range.
>
> **5. Set up scheduled delivery**
>
> Click **Schedule** to set up automated delivery. Choose the frequency (daily, weekly, or monthly) and enter the recipient email addresses.
>
> **6. Validate and save**
>
> Preview the report output and compare it against a recent export from your legacy report to confirm the data matches. Click **Save** when complete.
>
> > [!NOTE]
> >
> > Legacy reports remain accessible in read-only form under the **Legacy Reports** section in the sidebar. They will not be removed, but cannot be edited or scheduled from the webapp. Rebuilding in the Report Builder is the recommended path for any report you need to modify or automate.
## FAQs
1. **Why did I receive an email instead of a file download?** When your report contains a large volume of data, Zuper cannot generate and download the file immediately. Zuper sends a notification email to your registered address with a link to download the report. This is expected behavior and not an error.
2. **Can I filter a report by more than one team or job category at the same time?** Yes. The Job Category and Team fields support multi-select. You can choose multiple categories and teams simultaneously before clicking Generate Report.
3. **Can I automate reports so I don't have to generate them manually each time?** Yes. Use **Scheduled Reports** to configure automatic delivery. You set the frequency, timing, recipient email addresses, and the data window for each report. See the [Custom Reports and Scheduled Reports](#custom-reports-and-scheduled-reports) section above for full setup steps.
4. **What file format do Legacy Reports download as?** All Legacy Reports download as Excel (.xlsx) files. Some reports contain multiple sheets; for example, the Job Status Report places each status on a separate sheet.
5. **How do I narrow down results when a report returns too much data?** Use the **Advanced Filter** option when generating the report. Click **+ Add Filter** to apply additional criteria such as job status, priority, assigned employee, or customer. You can also refine your date range or change the Generate Report By setting.
6. **What is the difference between Legacy Reports and the new Reports module?** Legacy Reports are pre-built, module-specific exports that download as Excel files. The new Reports module offers a modern, interactive experience with flexible filtering, saved report views, folder organization, and shared reports. See [Reports Overview](https://docs.zuper.co/Reports/Overview) to learn more.
# Overview of Legacy Reports
Source: https://docs.zuper.co/Legacy_Reports/Overview
## Key Features
* **Comprehensive Data Access**: Retrieve data on work orders, jobs, projects, and customer interactions from legacy databases.
* **Customizable Reports**: Select specific date ranges and modules to tailor reports to your business needs.
* **Historical Insights**: Monitor trends and performance metrics from pre-upgrade data to support decision-making.
# Managing commission payouts
Source: https://docs.zuper.co/Managing-commission-payouts
Track and manage all commission payouts across jobs and projects from a single page.
The Commissions Listing page is your central hub for tracking and managing all commission payouts across jobs and projects. Instead of handling payments job by job, you can view every commission in one place, record individual payouts, or do bulk-payout updates for multiple commissions at once. This saves time and gives you a real-time picture of what has been paid and what is still outstanding.
## Before You Begin
* This feature requires account configuration. Please contact Zuper Support for details.
* Zuper provides default access control for this feature based on your user roles. However, if your business requires a different level of visibility, you can customize access using Custom Roles.
## Accessing the Commission Listing Page
1. Select the **Accounting** module from the left navigation menu and choose **Commissions**.

2. The Commission Listing page opens. You see a full list of commissions across all jobs and projects.
## Recording a Payout for a Single Commission
Use this to record a full or partial payment for one commission at a time.
1. On the Commissions Listing page, find the commission you want to pay.
2. Click **Payout** in the **Actions** column for that row.

3. The **Add Payout** dialog opens.
4. Review or update the **Payment Date**. It defaults to today's date. Change it if the payment was made on a past date.
5. Enter the **Amount** you are paying. You can enter the full commission amount or a partial amount.
6. Check the **Balance Due** field - it updates in real time to show the remaining amount after this payout.
7. Add an optional note in the **Payout Notes** field.
8. Click **Record Payout**.

\
The payout status updates automatically:
* Full payment recorded → status changes to **Paid**
* Partial payment recorded → status changes to **Partially Paid**, with the remaining balance tracked
> [!NOTE]
>
> You can record multiple partial payouts against the same commission. Each payout reduces the balance due until the commission is fully settled.
## Updating Multiple Commissions at Once
Use bulk actions to mark several commissions as Paid or Unpaid in a single step, ideal for processing multiple commissions at once or correcting payout statuses.
1. On the Commissions Listing page, select the checkboxes next to the commissions you want to update.
2. A bulk action bar appears at the bottom of the page showing the number of selected commissions.
3. To select every commission on the current page, click **Select All** in the bulk action bar.
4. Choose your action:
1. **Mark as Paid** - Records the full commission amount as paid
2. **Mark as Unpaid** - Reverses the payout status back to Unpaid
5. If you click **Mark as Paid or Mark as Unpaid**, a confirmation dialog opens. Review or update the **Payment Date** and add optional **Payout Notes**.
6. Click the **button** to confirm. All selected commissions update immediately.

## Payout Status Labels
Every commission row displays one of four payout statuses:
Every commission row displays one of four payout statuses:
* **Unpaid** - No payment has been recorded yet
* **Partially Paid** - A partial payout has been recorded; a balance remains
* **Paid** - The full commission amount has been paid out
* **Overpaid -** The amount paid exceeds the current commission value
> [!NOTE]
>
> Overpaid status cannot be triggered manually through the Payout action. It occurs only when a commission is fully paid, but subsequent changes to the associated job, such as deleted or modified line items. This might reduce the commission amount below what was already paid.
>
> > [accordion] Why does this happen, and how to avoid it
> >
> > [Commissions](/Commissions/Commissions) in Zuper are directly derived from a job's key financial parameters: Projected Revenue, Projected Profit, Actual Revenue, and Actual Profit. These values are dynamic and recalibrate automatically as materials, labor, and expenses are updated throughout a job's lifecycle.
> >
> > **For example:** A 10% commission on an actual profit of \$1,000 creates a \$100 commission entry. If you pay out \$100 and a subsequent expense of \$100 reduces the profit to \$900, the commission automatically adjusts to \$90, but the \$100 payout remains, resulting in an Overpaid status.
> >
> > **Zuper recommends:**
> >
> > * Create commissions only after a job's financial parameters are finalized.
> > * If commissions are created earlier in the job lifecycle, defer payouts until the financials are stable.
> > * Premature commission creation and early payouts can lead to multiple overpaid entries and directly impact your business's cash flow.
## The KPI Banners
At the top of the page, three KPI cards give you an instant financial summary:
* **Total Commissions:** Display the total count and value of all commissions.
* **Total Paid:** Display the count and value of fully paid commissions.
* **Total Unpaid:** Display the count and value of commissions with outstanding balances.
Toggle **Hide KPIs** in the top-right corner to collapse the banner and get more room on the listing.
> [!TIP]
>
> **Tip**: The KPI cards update dynamically based on any filters applied to the listing. For example, applying a **Commission Date** filter for the past week reflects only that period's totals across all three cards.

## Customizing Your Columns
You can choose which columns appear in the listing so you see only the data relevant to your workflow.
1. Click **Columns** in the top-right corner of the listing page. The Customize Columns panel opens on the right.
2. The **Displayed Columns** list shows what is currently visible. Columns shown by default include Commission Date, User, Job, Project, Commission Amount, Payout \$, and Payout Status.
3. Drag a column from **Available Columns** into **Displayed Columns** to add it.
4. Click the button on a column to remove it from Displayed Columns.
5. Reorder columns by dragging them into your preferred position.
6. Close the panel. Your changes apply immediately.

## Filtering the Commission List
Use filters to narrow down the list to the commissions you need to act on.
1. Click **Filter** at the top-left of the listing page.
2. Select a filter attribute.
3. Set the condition and value for each filter.
4. Click **Add** to apply the filter. The listing updates immediately.
> [!TIP]
>
> Combine filters to find exactly what you need. For example, filter by a specific user and a date range to review all outstanding commissions for that person over the past month.

## Commission Payout Report
Use this report to reconcile commissions paid during a specific period. Filter by commission date to get an accurate picture of payments processed within your chosen timeframe.
**To access the Commission Payout Report**
1. Click the **Reports** module from the left navigation menu.
2. Navigate to **Miscellaneous Reports >** **Commissions Payout Report**.
> [!NOTE]
>
> This report is accessible to Admin roles only, as it contains financially sensitive information.

## Frequently Asked Questions
> [accordion] Can I pay out a commission in installments?
>
> Yes. Click **Payout** in the Actions column and enter any amount less than the full commission. The status changes to **Partially Paid** and the remaining balance is tracked. You can record additional payouts until the commission is fully settled.
> [accordion] What is the difference between the individual Payout action and the bulk Mark as Paid?
>
> The individual Payout action lets you enter a specific amount and supports partial payments. Bulk **Mark as Paid** records the full commission amount as paid for all selected commissions at once.
> [accordion] Can I undo a payout after it has been recorded?
>
> Yes. Select the commission and click **Mark as Unpaid** from the bulk action bar to reverse the payout status. For reversing individual partial payout records, contact your administrator.
> [accordion] Where can I view the history of payouts made against a commission?
>
> Hover over the **Payout Status** of any commission row to see its full payout history. The tooltip shows each payout made, along with the date and amount, in the order they were recorded.
>
> 
> [accordion] Why is the Payout option not visible against a commission on the job details page?
>
> The Payout option is not available when the commission value is zero. This typically occurs when the financial parameters the commission is based on have not yet been populated for that job.
> [accordion] Can commissions be based on attributes beyond a job's financials?
>
> Yes. Zuper supports flat dollar amount commissions as an alternative to percentage-based ones. If your business has more complex rules driving commissions, you can also leverage Zuper Workflows to automatically create flat dollar commissions based on custom conditions.
> [accordion] How do I handle an overpaid commission?
>
> As a temporary measure, mark the commission as **Unpaid** and hold off on the payout until the job's financial parameters are finalized. For a permanent fix, follow Zuper's recommendation to create commissions only after the associated job finances are frozen, so payout amounts are stable before any payment is recorded.
> [accordion] Can commissions be created automatically based on business rules?
>
> Automatic commission creation is not available as a built-in feature in Zuper. However, you can achieve this by setting up Zuper Workflows to trigger commission creation based on your specific business rules and conditions.
# Creating a new project
Source: https://docs.zuper.co/Projects/Creating_a_new_project
The projects module in the Zuper web app allows you to create and manage multiple complex projects, namely construction, interior designing, cleaning, and more. These projects often involve multiple jobs it and can take several months to complete. With the new projects module, you no longer need to create separate quotes and invoices for each job to proceed. Instead, you can easily create and track a project, associate multiple jobs with it, send a quote, and collect invoice payments from the customer, all in one place.
Let’s get started with creating a new project in Zuper!
## Create project
**Navigation**: *Projects -> Projects listing page -> + New Project*
1. Click the "**Projects**" icon from the left navigation menu. You can view the list of projects created earlier on the listing page. To create a new project, click the “**+ New Project**” button at the top right corner of the page.

2. A new project creation page appears. Fill in the following sub-sections:
## A. Project Details
Project image (*Optional*): Upload an image with dimensions of 120x120 px. Having an image helps in
project identification.
* **Project name**(*Mandatory*): Provide a name for the project.
* **Category** (*Mandatory*): Choose the category to which this project belongs from the dropdown menu.
* **Project Prefix:** Provide any Prefix that will then be displayed as Project number.
> [!NOTE]
>
> **Note:** The available categories are those configured in the project settings.

* **Organization/Customer**: Add an organization/customer. To add one, click the "**+ Add Organization/Customer**" button under "**Organization/Customer**" and choose from the existing list. Alternatively, click the "**New Organization/Customer**" tab to add a new one.

## B. Primary Details
* **Project Priority**: Select the project's priority level from the dropdown menu. By default, the priority levels are low, medium, high, and urgent.
> [!NOTE]
>
> **Note**: When an organization is selected, the service address will be auto-filled. You can use the same
>
> address as the billing address or add a new one by the "**Edit** " icon next to the billing address.
* **Project tags**: Click Enter to add several tags to this project. Adding tags helps organize and search for projects.

* **Project Description**: Add a brief description explaining the purpose or scope of this project.
* **Project schedule** (*Mandatory*): Specify either the project's due date or its start and end dates.
3. Once you have completed all the mandatory fields, click the "**Save Project**" button at the top right corner of the page.

4. A new project is created successfully, and you'll be prompted to add a job. You have the option to either add an existing job or create and add a new one. You can close this pop-up if you prefer not to add a job now.

### Options
When adding a new part or product to a project, you can select the available **Options** configured for that specific item.

## Add job to the project
You can add a Job to the project through either of the following ways:
1. Existing Job
2. Create New Job.
### Add existing job
To add an existing job, follow these steps:
1. In the dialog box, click "**Add Existing Job**"

2. A sidebar appears with existing jobs (which you've created earlier). Search and select a job from the list. Upon selection, click the "**Choose Job**" button.

3. The Existing job will be added to the project successfully. You can then click the **"Job Title** " to view the job's primary details and notes associated with the job.

### Create new job
To create and add a new job to the project, follow these steps:
1. Click the "**+ Create New Job**" button in the pop-up.
> [!NOTE]
>
> **Note**: For detailed step-by-step instructions on creating a Job in Zuper Web App, click here.

2. A sidebar appears on the right with prefilled details such as organization/customer name, priority level, and service/billing address. You can also add details such as job title, category, and due date to these records and click the "**Create**" button. A new job will be created and associated with the project.
Add more information, such as service tasks, parts/services, assets, contracts, and any attachments, and click "**Create Job**". The job is created successfully.

> [!NOTE]
>
> **Note**: If you want to add more details to the job, click "**Create Detailed Job**" at the top right corner of the new job creation sidebar. This will redirect you to a new page.
For detailed step-by-step instructions on how to create a Job in the Zuper Web App, click [here](https://docs.zuper.co/Work_Order_Management/Jobs/creating_a_new_job).
# Managing your projects
Source: https://docs.zuper.co/Projects/Managing_your_projects
The projects listing page provides an overview of the projects you can access with summarized information like project number, name, status, and other records. (For step-by-step instructions on how to create a project, click [here](https://docs.zuper.co/Projects/Creating_a_new_project).)
Once created, you can access and manage projects from the listing page, where you can view more detailed information and make any necessary changes or deletions as needed.
**Navigation:** Projects -> Projects listing page
1. Click the "**Projects**" icon in the left navigation menu. You can view the list of projects in columns such as project name, customer, category, project address, status, and so on.

## Exploring the listing page
The Projects Listing Page is designed to help you stay organized by providing a centralized view of all projects and enabling quick access to critical project details. The page includes several key features to streamline project management:
The Project Module Listing Page layout in Zuper includes view management, column selection, views, and saving customized views. This process is performed directly on the module’s listing page.
**Default Listing Behavior**
The system retains its existing default listing behavior, ensuring that pre-set configurations or default views are preserved. When you first access the Project Module Listing Page, you’ll see the default view with columns such as Work Order Number, Project Title, Contact, Users/Teams Assigned, Category, and Service Address.
## Create View Configuration
**Selecting Columns**
You can choose which columns to display to focus on relevant data:
1. Select the “**Projects**” module from the left navigation menu. You can view the listing page.

2. From the “**Views**” list, click “**+Create new view**.”

3. A “**Create View**” dialog box appears.
View Name (**Mandatory**) – Enter the view name.
Share with - Select any one of the options (User, Team), and you can add the relevant users.
Visibility to all users – Toggle on to make this view visible.

4. Once you click “**Create**,” the **Columns** sidebar appears, showing “**Available Columns**” and “**Displayed Columns**.” To add a column, drag and drop it from the “**Available Columns**” list on the left to the “**Displayed Columns**” list on the right. You can click “**Continue**.”

5. To remove a column, drag it from the “**Displayed Columns**” list back to the “**Available Columns**” list or click the **-** next to the column name. Click **Continue** to apply the changes.

6. If you wish not to add any filter, click “**Skip and Save**” to create the view.

7. The view is saved successfully.

## **Applying filters**
The Filter feature lets you refine your view by applying multiple filters based on available attributes. For example, you can select an attribute like "**Project Status Type**," choose conditions such as "**Equal to**," "**Contains**," or "**Does Not Contain**," and choose the desired value. Once the filter is applied, the results will update to show only the Projects that meet your criteria, making it easier to find and manage relevant Projects.
1. Click "**Filter"** at the top left of the page. Choose the attributes you want to filter by, apply the desired conditions, and click the "**Add"** button to view the results.

## Update view
1. Click “**Update View**” to modify the existing view.

2. The new view is set successfully with the filter. You can view the filter created and the filter name from the view list.

3. Click the down arrow below the “**Update View**” to create a new view by clicking “**Save as new view**.”

4. A “**Create View**” dialog box appears.
* View Name (**Mandatory**) – Enter the view name.
* Share with - Select any one of the options (User, Team), and you can add the relevant users.
* Visibility to all users – Toggle on to make this view visible.
Click “**Create**” to create the new view.

5. Click “**Reset View**” to reset the current view.

## **Setting Permissions for Views**
### **Edit Permissions**
Users with edit permissions can modify the layout:
* They can add/remove columns, reorder them, and adjust views as described above.
* If permission is given, changes can be saved as a new view or overwritten as an existing one.
### **View Permissions**
Users with view-only permissions can see the layout but cannot make changes:
* They can view the customized columns and filters but cannot edit them. To ensure consistency for viewers, they can save them as a new “**View**.”
### **Make changes to the view**
* **Rename**: This option allows you to change the view's name (e.g., from “Prj” to something else).
* **Visibility**: This lets you adjust who can see the view. Options include sharing with a user or team or keeping it private (“Only Me”), as well as toggling visibility for all users in Zuper (as shown in the “Create a View” dialog in prior images).
* **Duplicate**: This function creates a copy of the “Prj” view, allowing you to modify the duplicate without affecting the original.
* **Delete**: Removes the view entirely. Since this is a custom view, deleting it would revert the listing to the default view or another saved view. Only the created user can delete the view.

The Project Module Listing Page in Zuper allows for flexible layout customization directly on the listing page. You can select and reorder columns, apply views, save customized views, and set permissions to ensure the right level of access for your team. Use the steps above to tailor the view to your workflow and save it for future use.
### Associating tasks with a Project
You can associate tasks with a project to manage deliverables, timelines, and team responsibilities. Each task represents a step toward completing the overall project. You can assign, reorder, and update tasks directly from the project’s Tasks section. To learn how to create and manage them, refer to the [Associating Tasks with Jobs and Projects](/Zuper_Dashboard/Tasks#associating-tasks-with-jobs-and-projects) section.

## Pinned filters
Zuper's Projects module lets you use pinned filters to streamline your filter experience. Pinned filters keep your most-used criteria readily accessible for quick application.
Pin up to 3 filters in any module.
**Navigation**: *Projects -> Filters ->Pinned Filter*
1. Select the “**Projects**” module from the left navigation menu.

**2. Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

3. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters.

After filtering a specific Project, click the “**Project Name**” or “**Project Number**” to view and manage its details.
## Managing project details
Once a project is created or accessed from the listing page, the Project Details Page serves as your central hub for managing its lifecycle. The details page provides a centralized workspace for viewing and managing project information. It follows a three-panel layout consisting of the left panel, center workspace, and right panel.
## Left Panel- Project information
The left panel displays the project's basic information and provides quick access to commonly used actions. At the top of the panel, you can view the following details:
* **Project Name:** Displays the name of the project.
* **Project Status:** Displays the current status of the project.
* **Project Date:** Displays the project's start and end dates.
You can also access quick actions, including **Update Status**, **Manual Scheduling**, and **Add Note**. Click the **+** icon to create or associate project-related records, such as **Jobs, Milestones, Phases, Quotes, Proposals,** and **Invoices**.
Below the project information, the **Primary Details** section displays key information, including the project category, priority, creator, project manager, assigned users or teams, associated contact and organization, project dates, due date, and tags.

### Center Panel – Project Workspace
The center panel provides access to the project's information through different tabs. The available tabs include:
> [accordion] Overview
>
> Displays project highlights, description, address, open tasks, and gallery.
>
> 
> [accordion] Jobs
>
> The Jobs tab displays all jobs associated with the project. You can view and manage these jobs using two different views:
>
> * **List View**: Displays the associated jobs in a list, making it easier to review job details.
> * **Gantt View**: Displays jobs along a timeline, helping you visualize their schedules and track them against the project timeline.
>
> 
> [accordion] Tasks
>
> The Tasks tab displays all tasks associated with the project, allowing you to track task progress, priorities, schedules, and assigned users.
>
> You can perform the following actions:
>
> * **Task Status:** View the task's completion status using the checkbox next to the task name.
> * **Task Details**: View the task name, priority, due date, and total task duration.
> * **Assigned User**: View the user assigned to the task.
> * **Create Task**: Click + Create Task to add a new task to the project.
> * **More Options**: Use the three-dot menu to remove and reorder the tasks.
>
> The Tasks section also displays a summary of the project's Scheduled Job Duration and Total Task Duration, helping you track the time allocated to project tasks.
>
> 
> [accordion] Line items
>
> The Line Items tab displays the materials and services associated with the project, along with their inventory and pricing details.
>
> At the top of the tab, you can view the following summary information:
>
> * Inventory Valuation: Displays the total inventory value of the project.
> * Total Planned: Displays the total quantity of items planned for the project.
> * Total Used: Displays the quantity of items used.
>
> The line items table provides the following details:
>
> * **Item**: Displays the item name, description, and image, if available.
> * **Option**: Displays the selected item option.
> * **Unit Price**: Displays the price per unit.
> * **Location**: Displays the inventory location associated with the item.
> * **Planned Qty**: Displays the quantity planned for the project.
> * **Available Qty**: Displays the available inventory quantity.
> * **Actions**: Provides additional options to manage the line item.
>
> 
> [accordion] Financials
>
> The **Financial Summary** in Projects provides a consolidated view of Quotes, Invoices, and Commission values, giving you a clear snapshot of overall project financial performance.
>
> See how to [track commissions on Project](/Commissions/Commissions#managing-commissions-in-a-project).
>
> 
> [accordion] Timelogs
>
> The Timelogs tab provides a timeline-based view of time entries recorded against the project. You can group timelogs using the available Group By options to organize entries based on different criteria.
>
> You can perform the following actions:
>
> * Group By: Organize timelog entries using the available grouping options, such as users, jobs, or dates.
> * Project Timeline: Select the timeline view to review project-related time entries.
> * Add Entry: Click + Add Entry to manually add a timelog entry to the project.
> [accordion] Notes
>
> Notes are comments or information added to a project over its course. Your notes can be anything ranging from a simple text reminder to an image of the item, service and video, or document. All added notes can be viewed under the Notes Section.
>
> 
> [accordion] Activity
>
> The Activity tab provides a chronological history of actions and updates performed on the project. It helps you track changes made by users and monitor project-related activities.
>
> You can refine the activity timeline using the following filters:
>
> * All Activity Types: Filter activities by their type.
> * Search Users: View activities performed by specific users.
> * Select Date Range: Display activities within a selected date range.
>
> 
> [accordion] Gallery
>
> The Gallery in Projects includes photos and videos associated with the project, bringing all project-related media into one unified view. You can browse, filter, and organize media uploaded to the project.
>
> > [!NOTE]
> >
> > **Note**: Photos and videos added to a job's Gallery are also available in the associated project's Gallery. However, media uploaded directly to the project's Gallery is not automatically associated with jobs linked to that project.
>
> 
>
> To learn more about viewing, filtering, organizing, downloading, and sharing job-related photos and videos, see [Jobs Gallery](https://docs.zuper.co/Work_Order_Management/Jobs/Jobs_gallery).
>
> > [!NOTE]
> >
> > To enable the gallery feature: Go to \_Settings -> Organization Settings -> Job Settings -> Enable Job Gallery. \_
> >
> > This will enable the project's gallery as well.
## Right panel
In the right panel, view the organization or contact information associated with the project and manage its links to various modules, such as properties, assets, contracts, purchase orders, and more. To associate a module, hover over and click the “+” icon next to the desired module.

> [!NOTE]
>
> **Note:** Purchase orders will only appear when the project includes an existing job that has an active PO linked to it.
>
> 
## More actions
Managing projects doesn’t stop at viewing details—you can perform various actions such as printing, sharing, editing, cloning, or deactivating the project as needed.

> [accordion] Clone
>
> The Clone option lets you quickly create a replica of an existing project, saving time. Click "**More Actions**" at the top right corner of the page and select "**Clone**." The current project details will be duplicated onto a new project page, where you can make any necessary edits before saving.
> [accordion] Update Description
>
> To modify any existing project details, click “**More Actions**” at the top right corner of the page and select 'Update Description"
> [accordion] Delete Project
>
> Click "**Delete"** under More Actions and provide your confirmation. The project is deleted successfully.
With this information, you can now create and manage various project-related elements such as quotes, proposals, invoices, and jobs. Additionally, you can update project details and status, schedule projects, and add notes.
# Milestones & dependencies
Source: https://docs.zuper.co/Projects/Milestones_and_dependencies
From the jobs section within the project module, you can manage the entire project
schedule using either the Gantt or List view. Specifically, you can:
* Plan and manage project schedule by creating or adding jobs
* Create milestones to mark significant events as the project progresses
* Create and manage dependencies between jobs and milestones
* Group jobs and milestones into phases

**Creating Jobs, Milestones, and Phases**
You can create jobs, milestones and phases in a project from either the Gantt or List view. Additionally, you can add existing jobs to a project.
## **Create and add jobs to a project**
You can create a new job or add an existing job to the project. To create a new job, follow these steps:
1. Click the "**Create Job**" button at the top right corner of the page.
2. A sidebar appears on the right with prefilled details such as customer/organization name, service and billing address. You will need to fill in the remaining details, such as the job title, category, due date, user assigned to the job, and other fields.
Click the " **Create** " button to create a new job after filling in all the necessary
details.

> [!NOTE]
>
> **Note**: If you want to add more details to the job, click the "**Create Detailed Job**" button at the top right corner. This will redirect you to a detailed job creation page
3\. Add additional information, such as service tasks, parts/services, assets, contracts,
and any attachments to the job, in the job creation page and click the "**Create Job**" button.
To learn more about job creation, see How to create a job in the Zuper web app
A new job is created successfully and associated with the project. This job can
then be accessed from the ‘**Not added to any phase**’ section in either the Gantt view
or the List view.

To add an existing job, follow these steps:
1. Navigate to the "**Create Job**" button at the top right corner of the page and select "**Add Existing Job**" from the dropdown menu.
2. A sidebar with the existing jobs appears on the right. Select one of the required jobs from the list and click the "**Choose Job"** button.
3. The existing job is added to the project successfully and can be accessed from the ‘**Not added to any phase section.**’

> [!NOTE]
>
> **Note**: You can add up to 50 jobs to a project. If you want to increase the limit, please
> reach out to at (1-888-718-7858) or email [support@zuper.co](mailto:support@zuper.co)
## Create a milestone
Milestones can be used to mark significant events or achievements throughout the
project.
1. Navigate to the "**Create Job**" button at the top right corner of the page and select "**Create Milestone**" from the dropdown menu. A dialog box will appear.
2. Enter the following details and click the “**Create**” button to create a milestone.
1. **Phase**: Select the phase you want to add the milestone to from the dropdown.
2. **Name** (Mandatory): Enter the name of the milestone.
3. **Due Date** (Mandatory): Specify the due date for the milestone.
4. **Description**: Provide a brief description of the milestone.

## Create a phase
A phase is a group of jobs and milestones and can be thought of as a sub-project. It is represented as a thick line in the timeline.
> [!NOTE]
>
> **Note**: Jobs and milestones not added to any phase can be accessed from the ‘**Not added to any phase**’ section in the Gantt and List view.
1. Navigate to the "**Create Job**" button at the top right corner of the page and select
"**Create Phase**" from the dropdown menu. A dialog box will appear.
2. Enter the following details and click the “ **Create** ” button to create a phase:
1. **Phase Name**: Enter the name of the phase.
2. **Phase Color**: Choose the color to the phase to visually differentiate it from other phases in the timeline.
3. Once the phase has been successfully created, you can create job, add existing jobs or drag and drop existing jobs and milestones from the "**Not added to any phase**" section or from other phases, as shown below.
> [!NOTE]
>
> **Note**: The duration of a phase is calculated based on the start date or due date of the earliest job or milestone and the end date or due date of the latest job or milestone in that phase.
After creating jobs, milestones and phases in a project, you can access them from either the "**Gantt view**" or the "**List view**". Each has its own benefits:
1. The Gantt view is great for planning your project since you get a clear view of the
timeline and dependencies.
2. List view on the other hand is great if you want to quickly take a look at all the jobs
in the project with information such as status, priority etc easily accessible.
### Gantt view
Gantt view provides a bird's eye view of how the project progresses over time. It features a horizontal timeline where each job is represented by a bar, milestones are depicted as diamonds, phases appear as thick lines, and dependencies are shown as arrows connecting two jobs or milestones.
## Accessing jobs, milestones, and phases
To view jobs, milestones and phases, simply click on the desired phase from the left-hand panel. The selected phase, along with its jobs and milestones, will be displayed in the Gantt view.
* A job is represented as a bar. A job bar's **length** corresponds to the **job's** **duration** , and the bar's **position** along the timeline indicates when the **job** **starts and ends**. The **color** of the bar indicates the **job status**. Additionally, you can reschedule the job, create a new note, or detach the job from its phase directly from the Gantt view by right-clicking on it.

* Milestones are represented as diamonds in the Gantt view. You can create a milestone directly from the Gantt view, add it to a phase, and create dependencies for it. Additionally, you can edit the milestone, update its status (either "**open**" or "**completed** "), or delete it by right-clicking on it.

* A phase is a group of jobs and milestones and can be thought of as a sub-project. It is represented as a thick line in the timeline. You can create a phase, add jobs and milestones to it, and edit or delete a phase by right-clicking on it.

**Managing dependencies**
Dependencies are relationships between jobs based on the order of execution. E.g., Consider if there are two jobs A and B, Job B cannot be started unless Job A is completed, they are dependent on each other. Here, Job B is said to be the ‘**Successor**’ and is ‘**Waiting on**’ Job A, while Job A is said to be the ‘**Predecessor** ’and is said to be ‘ **Blocking** ’ Job B.
Dependencies are indicated by an **arrow** connecting jobs or milestones. The arrow originates from the predecessor and points to the successor.
* To create a dependency between jobs or milestones in the Gantt view, simply drag from one edge of the job bar/milestone to another as shown below. This action visually links the jobs, establishing the sequence and indicating that succeeding jobs cannot start until the preceding jobs are completed.
* To remove a dependency, simply click on the arrow, then confirm by clicking ‘**Remove**’ in the pop-up.

* After creating a dependency, you can also reschedule the job/milestone by simply dragging the job bars or milestone diamonds to a new start or end point, as shown below.

> [!NOTE]
>
> **Note** : Additionally, when rescheduling, you can manage whether the succeeding jobs' schedule should be changed or remain unchanged.
1. Click the “ **Configure** ” button at the top right corner and choose “**Dependency Management** ”

1. A Dependency Management dialog box appears, where you can choose either of
the following. Once done, click the “**Save**” button.
* **Maintain Interval**: This option ensures that the time interval between the dependent jobs remains the same when rescheduling the preceding job.
* **None**: This option reschedules only the intended job without rescheduling the succeeding jobs.
* You can also enable/disable the “**Allow scheduling during weekends**” when the dependency management is set to "**Maintain Interval**." When disabled, scheduling on weekends will not be permitted.
Based on the settings, when rescheduling in the Gantt view, the dependent jobs will be
adjusted accordingly.

> [!NOTE]
>
> **Note** : When rescheduling the preceding job, if the dependent job is scheduled to start before the preceding job ends, the dependency will be highlighted in **red** indicating a **violation** as shown below. Technicians can clock-in to a succeeding job only after the preceding job is completed even if the succeeding job starts before the preceding job ends.
**More actions**
You can perform various other actions from the Gantt view.
**Changing the timeline view in the Gantt view**
For improved visibility, you can adjust the view between **month, week, and day** by clicking the dropdown on the top-right of the Gantt.

**View job details**
To view any of the job details, click the job in the timeline. A sidebar will appear on the right, displaying the job's primary details and any associated notes.
You can also perform various actions, such as viewing more details about the job, cloning a job, or deleting a job by clicking the "**ellipsis** " icon at the top of the sidebar.
**Access and schedule unscheduled jobs**
You can also quickly access and schedule unscheduled jobs from this view. To do so,
1. Click the " **Unscheduled Jobs** " button at the top right corner. You can view the list of unscheduled job(s) associated with the project.
2. Simply drag and drop the unscheduled job onto the timeline to schedule the job. Once scheduled, the job would be reflected in the "**Not added to any phase**" section.

### List view
The list view displays information in a tabular format, with jobs and milestones grouped under phases.

**Quick actions**
Using the quick actions available under the “**Actions**” column, you can perform various actions for phases, milestones, and jobs. Below are the quick actions available for each within the project:
* **Phases**: Create Job, Add Existing Job, Add Milestone, Edit and Delete Phase.
* **Milestones**: Edit, Update status, View dependencies, Delete milestone.
* **Jobs**: View Details, Reschedule Job, View Dependencies and Detach a job.
Detaching a job does not mean permanent deletion. You can still access the job from the “**Jobs**” module. Also, when detaching a job, you'll be prompted to choose whether to:
* Detach the job and keep the associated parts & services, or
* Detach the job and delete its associated parts & services from the project.
1. If you choose to detach the job and keep the parts and services, the job will be removed from the project, but the parts and services consumed will remain in the project under the "**Used Quantity.**" This is helpful if the parts or services were used for other jobs within the project.
2. If you choose to detach the job and delete the parts & services, the job will be
removed, and the parts and services will be replenished back to the available
quantity, making them available for other jobs within the project.

## Managing dependencies
In the list view, jobs or milestones with dependencies are marked with a "**Dependency icon**." To manage dependencies, click the dependency icon next to the job or milestone, or select "**Dependencies**" from the quick actions menu.

1\. A dialog box will appear, allowing you to view or modify the dependencies.
You can view the predecessors to the job or milestone under "**Waiting on"** (these jobs/milestones need to be completed, canceled or closed for the current job to start). Successors to the job or milestone are listed under "**Blocking**" (these jobs can start only if the current job is completed, canceled or closed).
2\. You can even create dependencies to a job or milestone by clicking the “**+ Add Job** ”
button next to the "**Waiting on**" and "**Blocking**" sections.
> [!NOTE]
>
> **Note**: When creating dependencies in the list view, jobs or milestones that could
> result in a dependency violation not being listed.
To remove a dependency, hover over the job or milestone you want to remove and
click on the " **X** " icon near the right edge.

### Rescheduling a job with dependencies
To reschedule a job with dependencies from the list view, follow these steps:
1. Click " **Reschedule Job** " next to the job with a dependency under the " **Actions** "
column.
If dependency management is set to “**Maintain interval,**” a pop-up will appear, prompting you to choose between “**Reschedule This Job Only**” or “**Reschedule All Dependent Jobs.**”
When you choose “**Reschedule All Dependent Jobs**,” you will also be able to view the rescheduled dates and times for the dependent jobs as a result of this change.

## Deleting a phase
When deleting a phase, you will be prompted with the below options:
* **Detach jobs from the project and delete milestones** - This option deletes the phase, detaches jobs from the project (the detached jobs can still be accessed from the Jobs module) and deletes any milestones in the phase.

* **Retain jobs and milestones in the project** - This option deletes the phase and retains jobs and milestones in the project. The retained jobs and milestones are moved to the "**Not added to any phase**" section.
Technicians and other users can access jobs and milestones grouped into Phases in a project's “**Jobs**” section. When a job has predecessors that are not yet completed, users cannot clock in to the job, and it will be indicated that the job has dependencies that need to be completed.
# Overview
Source: https://docs.zuper.co/Projects/Overview_of_projects
Projects allow field service providers to plan and manage undertakings that span over longer periods of time and involve multiple jobs, people, and materials. Below are some of the key features in Projects:
* **Phases, Milestones, and Dependencies**: Create comprehensive project plans by grouping jobs and milestones into phases and managing dependencies between jobs and milestones.
* **Manage finances**: Quotes and invoices can be created and managed from a project. We have more comprehensive capabilities coming up to manage finances end-to-end.
* **Parts & Services**: Plan and track consumption of parts & services within a project.
* **Time logs**: Technicians can clock into a project from a mobile device. On the web, they can access the time logs of all users in the project and group them by Users, Jobs, or Date.
* **Access projects from mob**ile: The Zuper V3 mobile app allows you to clock in, track progress, add a quick note, and update project status on the go.
# Progressive invoicing
Source: https://docs.zuper.co/Projects/Progressive_invoicing
Progressive invoicing, also known as progressive billing, is a method of billing/invoicing customers incrementally for work and materials used throughout the course of a project or a long-term service. This means that instead of billing the full amount at the end of the project, businesses divide the total cost into multiple invoices based on project milestones, time periods, or specific phases to collect payment from customers during the course of a project.
With Zuper, setting up progressive invoicing is seamless and flexible, offering options to suit your business needs:
* **Calculate from Time and Material**
Automatically generate invoice amounts based on the **actual material costs incurred by completed jobs** (i.e., sell prices of the parts and materials used by the job/s) within a timeline. This ensures customers are billed accurately for the parts and services used.
* **Fixed Amount**
Set a **predefined project price and bill in stages** , regardless of the number of completed jobs, their status, or the parts and services used. This option provides consistency and control over project invoicing.
You can further customize your progressive invoicing by selecting the frequency when invoices should be generated:
* **Milestone-Based Invoicing**
Create invoices upon reaching key project milestones, ensuring that billing aligns with the project's progress.
* **Frequency-Based Invoicing**
Set up recurring invoices on a schedule, such as bi-weekly, monthly, quarterly, or on custom dates for ongoing work.
This approach benefits both businesses and customers in many ways: businesses can maintain a steady cash flow by collecting payment for completed work in stages, while customers can manage their budgets more effectively by spreading out large expenses over time.
For example, let's take a construction project. A contractor might issue an invoice after completing foundational work, another after erecting the structure, and a final invoice upon project completion. This phased billing system ensures that the business receives payment for the work done so far while the customer gains flexibility in managing their budget.
Let’s get started on how to set up progressive invoicing in Zuper!
> [!NOTE]
>
> **Note**: Progressive invoicing is optional and should be used only when billing your customers throughout the project based on milestone completion or a predefined schedule.
# Steps to set up progressive invoicing
You can set up progressive invoicing in either of the following ways:
1. During project creation.
2. After creating a project.
## During project creation
**Navigation**: *Projects -> + New Project -> Invoicing (Setup)*
To set up progressive invoicing during project creation, follow these steps:
1. Select the “**Projects**” module from the left navigation menu. You can view the list of
projects that have been created already on the projects listing page.

2. Click the “ **+ New Project** ” button at the top right corner of the page to create a new project.
3. On the new project creation page, click the “**Setup**” button in the invoicing section. A new progressive invoicing setup page appears.

### **Choose how to generate the invoice amount**
Select one of the following options for progressive invoicing:
**Calculate from Time and Material**
Choosing this option automatically calculates the invoice amounts based on the actual material costs included as line items in the completed jobs (i.e., sell prices of the parts and materials used by the job/s) within a project at each stage.
**Fixed Amount**
Choosing this option allows you to **set an actual estimate or quotation of the project** in USD and bill it in stages, regardless of the number of completed jobs, their status, or the parts and services used.

### **Choose when to generate the invoice**
Select when you would like invoices to be generated:
**Milestone**
This option allows you to generate invoices upon reaching a specific milestone in a project, ensuring that billing aligns with the project's progress. To use this option, follow these steps:
> [!NOTE]
>
> **Note**: To save time and streamline the process, you can create a milestone directly during project creation rather than first creating a project and selecting milestones later.
* Click the " **+ Add Milestone** " button.

* Enter the milestones "**Name**" and "**Due Date.**" The due date you specify here is the date the invoice will be generated (saved as a draft), with the amount calculated based on your selected invoice amount generation option.

> [accordion] How Invoice Amount Generation Methods Impact Milestone-Based Invoicing
>
> 1. When you select the “**Calculate from Time and Material** ” option, the amount will be calculated automatically based on the actual material costs (i.e., sell prices of the parts and materials) included as line items in the completed jobs within the project up to the specified milestone due date.
> 2. If you select the “ **Fixed Amount** ” option, you must **specify a full estimate** or the **portion of the amount** (in USD) to be collected upon reaching the first milestone. The remaining amount will automatically carry over to the next milestone(s). So, when a milestone's due date is reached, the specified amount is included in the invoice, which is generated regardless of job completion status, progress, or parts and services used up to that milestone.
>
> 
>
> > [!NOTE]
> >
> > **Note**: These milestones will then be added to the **"Not added to any phase**" section in both the Gantt and List Views of the project’s job section. You can then drag and drop the milestones into the appropriate phases.
**Frequency**
This option allows you to generate invoices based on the selected billing frequency for ongoing work. To use this option, follow these steps:
* Choose the “**Frequency**” option. You will be prompted to select a billing frequency: **Bi-weekly**, **Monthly**, **Quarterly,** or **Custom.**

> [accordion] If the frequency selected is Bi-weekly, Monthly, or Quarterly
>
> Specify the invoice start and end dates in the “ **Starts on** ” and “ **Ends on** ” fields. The system will automatically calculate the billing dates within the specified range based on the chosen frequency and generate invoices (saved as draft).
> [accordion] If the selected frequency is Custom
>
> Specify the invoice start and end dates in the “**Starts on** ” and “**Ends on**” fields. These will be the invoice start and end dates (i.e., the overall range during which invoices will be generated). Within this period, you can select additional specific dates from the calendar to generate invoices by clicking the “**+ Add Invoice Date**” option. This allows for more flexibility in scheduling invoice generation. You also have the ability to delete any invoice dates you've added or add new ones as needed.

* After selecting the frequency, the system will automatically generate draft invoices on the specified dates, with the amount calculated based on your selected invoice amount generation option.
> [accordion] How Invoice Amount Generation Method Impact Frequency-Based Invoicing
>
> 1. When you select the “**Calculate from Time and Material** ” option, the amount will be calculated automatically based on the actual material costs (i.e., sell prices of the parts and materials) included as line items in the completed jobs within the project up to the specified due date.
> 2. If you select the “**Fixed Amount**” option to generate the invoice amount, you’ll be prompted to **specify the full estimate** or the **portion of the amount** in USD to be collected for the first billing date. The remaining amount will automatically carry over to the next billing date(s). So, when the billing frequency date is reached, the specified amount will be included, and the invoice will be generated regardless of the number of jobs completed, their status, or the parts and services used up to that date.

* Click the “**Save**” button to confirm your progressive invoicing setup.

> [!NOTE]
>
> **Note**: The sum of the portions allocated to each invoice should equal the total project amount. If these specified portions do not add up to the total project amount, the system will not allow you to save the setup.
## After creating a project
**Navigation**: *Projects -> Project details page -> Financials -> Invoices -> Configure -> Progressive invoicing*
If you want to set up progressive invoicing for any of the existing projects, follow these steps:
* Select the “**Projects**” module from the left navigation menu. You can view the list of projects that have been created already on the projects listing page.

* From the listing page, select any project for which you want to set up progressive invoicing. You will be redirected to the selected project details page. Select “***Financials***” on the left panel under “**Navigation**."

* On the financials listing page, switch to "**Invoices,"** click the “**Configure**” button at the top right and choose "***Progressive Invoicing***."

* Choose how you want to generate the invoice amount for progressive invoicing (either **Calculate from Time and Material** or **Fixed Amount** ). For more details, see the section above.
* Choose when you would like to generate invoices (either **Milestone** or **Frequency** ). For more details, see the section above.
> [!NOTE]
>
> **Note**: If you select the milestone option when setting up progressive invoicing for an existing project, you can view the list of previously created milestones.
* Select the milestones at which you want invoices to be generated.
* Once selected, invoices will be generated (saved as drafts) on each milestone’s due date, with the amount calculated based on your chosen invoice amount generation method.
## Accessing Invoices generated through progressive invoicing
1. After setting up progressive invoicing, you can view the progressive invoices by navigating to ***Financials*** *>>* ***Invoices*** *>>* ***Upcoming Invoices*** section on the web. To indicate ongoing progressive invoicing within a project, a progressive invoicing icon will also appear next to “**Financials**” on the project details page, as shown below:

> [!NOTE]
>
> **Note**: You cannot click to view the details of the upcoming invoices. These are displayed only to indicate the dates of the upcoming invoices for the project, as they have not yet been generated. Once an invoice is generated on the estimated date, it will be **saved as a draft**.
>
> You can then review and make any necessary changes before sending it to the customer. The **due date** will be determined based on the **payment term selected at the organization level**.
2. To view the progress of the invoices generated through progressive invoicing, click “***Progressive Invoicing***” under “**Configure**” in the financial section.
3. If the Fixed Amount option is selected, you’ll see details like the budget, billed amounts, and amounts to be billed.
4. If the Calculate from Time and Material option is selected, invoice amounts are automatically calculated based on material costs from completed jobs, and actuals won’t be displayed.
> [!NOTE]
>
> **Important**: Once the first invoice from the progressive invoicing setup is sent and paid by the customer, the setup can no longer be modified.

# Purchase Tax on parts and products
Source: https://docs.zuper.co/Purchase-Tax
Record the tax you pay on parts and products separately from their base cost, and keep cost and tax values in sync automatically when you add stock.
Purchase tax tracking lets you record the tax you pay on a part or product separately from its base cost. Whenever you add stock, whether by receiving a purchase order or recording a manual inward transaction, Zuper automatically keeps your part's cost and tax values accurate and in sync.\

> [!TIP]
>
> **Prerequisite**: The **Enable Purchase Tax?** setting must be turned on in **Settings > Parts & Services > Parts and Services General Settings**. Purchase tax fields stay hidden until this setting is on.\\
>
> 
## The cost fields
Every item with purchase tax enabled shows three related cost fields:
* **Pre-Tax Cost**: The base cost of the part, before tax.
* **Purchase Tax %**: The tax rate applied to the part's cost. This field is optional and accepts decimal values.
* **Unit Purchase Price/Unit Cost**: Your landed cost, what you actually pay per unit, tax included. This field drives the markup and Unit Selling Price calculations.\
\

## How Zuper updates the master when you add stock
Whenever you receive a purchase order or record a manual inward transaction, Zuper updates the part's cost fields based on the **Update Purchase Cost to?** setting in **Settings > Parts & Services > Parts and Services General Settings**.\

> [accordion] Latest Purchase Cost
>
> Zuper replaces the master's Pre-Tax Cost and Purchase Tax % outright with the values from the transaction you just recorded.
>
> **Example:** A part has a Pre-Tax Cost of \$500 and a tax rate of 10%, giving a landed cost of \$550. You receive stock with a Pre-Tax Cost of \$600 and a tax rate of 10%. The master updates to a Pre-Tax Cost of \$600, and the landed cost becomes \$660.
> [accordion] Weighted Average Purchase Cost
>
> With this setting, Zuper blends the cost of your existing stock with the cost of the new stock you're adding, rather than replacing it outright.
>
> Here's what happens, in order:
>
> 1. Zuper averages your landed cost (Unit Purchase Price/Unit Cost), weighted by how many units you already have versus how many you're adding.
> 2. Zuper updates the Purchase Tax % to match this transaction's rate.
> 3. Zuper works out the new Pre-Tax Cost.
>
> **Example:** You have 44 units in stock at \$750.00 per unit (10% tax built in). You receive 10 more units at \$600.00 pre-tax, taxed at 8%. Zuper updates your part to:
>
> * 54 units in stock
> * \$731.11 landed cost per unit
> * 8% tax rate (always your most recent purchase)
>
> \$676.96 pre-tax cost, worked out from the new landed cost and new tax rate
>
> > [!NOTE]
> >
> > Only the landed cost is blended across quantities. The tax rate always comes from your latest purchase, and the pre-tax cost is recalculated from there. Neither is averaged.
> [accordion] Highest Purchase cost
>
> With these settings, Zuper compares the landed cost of the stock you are receiving against the landed cost already on the master, and keeps whichever is higher.
>
> For example Your part has a Pre-Tax Cost of \$600 and a tax rate of 10%, giving a landed cost of \$660. You receive stock at a Pre-tax cost of \$500 with a 10% tax rate, a landed cost of \$550. Because \$550 is lower than \$660, the master stays at a Pre-Tax Cost of \$600, a 10% tax rate, and a \$660 landed cost.
## Selling price recalculation
When Zuper updates a part's Unit Purchase Price/Unit Cost, it checks whether to recalculate the Unit Selling Price.
* If the part has a markup configured and its Unit Selling Price is still derived from that markup, Zuper applies the markup to the new landed cost and updates the Unit Selling Price automatically.
* If you have manually changed the Unit Selling Price, Zuper keeps the price you entered. Changing the purchase cost does not overwrite a selling price you set yourself.
* If the part has no markup configured, the Unit Selling Price remains unchanged even if the cost changes.
> [!NOTE]
>
> This recalculation occurs only on the part/product master. It does not change prices on quotes, jobs, or invoices you already created using the old cost.
# Creating a Material Request from the Mobile App
Source: https://docs.zuper.co/Purchasing/Material-Requests/Creating-Material-request-from-mobile
The Material Request feature enables field technicians to request missing or damaged parts required to complete a job. This feature ensures seamless service delivery by facilitating the procurement or transfer of necessary materials.
In Zuper, you can create a material request from the Material Request or Jobs module.
# Creating a Material Request from the Material Request Module
The Material Request Module allows you to raise requests for required parts and products essential for job completion. This feature ensures that necessary materials are procured on time, linked to specific jobs or quotes, and tracked efficiently.
Follow the steps below to create a material request.
## Step 1: Accessing the Material Request Module
1. Tap the Hamburger Menu at the top left corner of the screen and select **Material Requests**. The Material Requests listing page will appear.

3. On the listing page, you can:

* **Sort and Filter** material requests based on request number, status, priority, associated job, associated quote, and more using the filter icon.

* **Search** by entering the material request title or number using the search icon.
3. To create a new material request, tap the “**+**” (Add) icon at the bottom of the page. The New Material Request Creation Page will open.

## Step 2: Adding Parts and Products
The Parts & Products section allows you to define the materials required for the request.
**Associate Job/Quote**
This section allows you to link the material request to an existing job or quote.
1. Tap the **+ Add Job/Quote** button.

2. A list of available jobs and quotes will appear.
3. Search for and select the required job or quote.

4. Once selected, the material request will be associated with the chosen record, and relevant parts/products (if any) will be available for selection in the Parts & Products section.
**Parts/Products**
This section allows you to add parts or products from:
* The associated job/quote (if applicable).
* The inventory.
* Custom line items.
> [accordion] To add Items from a Job, Quote, or Inventory
>
> Tap the “**+ Add**” button and select “**Add item**”. The Add Products page will open, displaying two tabs:
>
> 
>
> * **Parts Added to Job** – Lists all parts/products already associated with the job (if applicable).
>
> 
>
> * **All Parts** – Displays the complete inventory available for selection.
>
> 
>
> Choose the required quantities from either tab, and click **Proceed** to add them to the material request.
> [accordion] To add a custom item
>
> Tap the “+ **Add**” button and select “**Add custom item**”. The Add custom item bottom bar will appear.
>
> 
>
> * Enter the ID, Name, Description, and specify the Quantity.
> * Click **Add**.
>
> 
Once all items are finalized, click **Next** to move to the Basic Details section.

## Step 3: Entering Basic Details
The Basic Details Section captures essential information related to the material request:
* **Material Request Title** - Provide a short and descriptive title for easy identification.
* **Required by** - Select the date when the requested material is required.
* **Delivery Method** - Select how the requested materials should be delivered.
1. **Direct Shipment to Job’s site** – Materials are shipped directly from the vendor to the customer’s job site or the field technician’s location.
2. **Deliver to Warehouse** – Materials are shipped to your organization’s designated warehouse.
* **Delivery To** - When the delivery method is **Delivery to Warehouse**, select the **warehouse location** from the Delivery To dropdown to ensure accurate routing and inventory tracking.
> [!NOTE]
>
> The **Delivery To** field pre-populates with your preferred warehouse location if one has been configured in your organization's settings. If the pre-populated location is not correct, tap the field and select a different warehouse from the list. If no preferred location is set or the correct warehouse does not appear, contact your administrator to update the preferred location in **Settings**.
* **Priority** – Set the urgency of the request by selecting one of the following options: Low, Medium, High, or Urgent.
* **Remarks** – Enter any additional comments, instructions, or special requirements related to the request.
* **Attachments** – Upload supporting documents, such as product specifications, reference images, or vendor-provided details.
* **Other Details** – Fill in any custom fields configured by your organization.
After entering the details, click **Next** to review the request summary.

## Step 4: Review Summary and Submit
* Verify all the details provided in the material request, including parts/products, and primary details.
* Click **Create** and select one of the following options:
1. **Submit**: To submit the request for approval.
2. **Save as Draft**: To save the request and complete it later.

Once successfully created, the material request will appear in the listing page, and its details can be viewed.
# Viewing Material Request Details
You can view detailed information about any material request from the Material Requests listing page. Each request displays key information such as its status, associated job or quote, delivery location, and linked parts or products, allowing users to track and manage material requests effectively.
**Steps to View a Material Request**
1. On the Material Request Listing page, tap the Material Request you want to view.
2. The request will open, displaying all associated information under the relevant sections: Details and MR Item(s).
## Details Section
The Details section provides the main information about the request:
* **Title** – The name of the request for easy identification.
* **Required Date** – The deadline for fulfilling the request.
* **Material Request Status** – The current progress of the request, which can be:
1. Draft – Saved but not yet submitted.
2. Submitted – Sent for approval.
3. Awaiting Approval – Pending approval from a supervisor or administrator (if configured).
4. Accepted – Approved and in progress.
5. Rejected – Declined by the approver.
6. Received – Requested materials have been delivered.
* **Requested By** – The user who created the request.
* **Priority** – The urgency level assigned to the request.
* **Created Date** – The date the request was created.
* **Delivery To** – The designated warehouse location.
* **Remarks** – Additional notes or instructions provided.
* **Job/Quote** – Displays the associated job or quote along with the scheduled date and time (if applicable).
* **Attachments** – Any supporting documents or files linked to the request.

## MR Items Section
The MR Item(s) section provides a complete overview of all materials associated with the request. You can review the list of items, check their quantities, and verify whether each item is custom or added from a job, quote, or inventory.
* Tap the **MR Item(s)** tab to view all items linked to the Material Request. From here, you can edit the required quantities or remove items as needed.
> [!NOTE]
>
> **Note:** These actions are available only when the Material Request is in **Draft** status.

## Additional Options
In addition to viewing details, you can perform quick actions on the selected material request without navigating away from the Details page. These options allow for efficient management and greater flexibility in handling requests.
To access additional options:
* Click the Kebab menu at the top-right corner of the Material Request Details page.
* From here, you can:
1. **Edit the material request** (available when the status is Draft or Submitted).
2. **Manage Custom Fields** associated with the request.
3. **View Activity History** to track all updates and changes made to the request.
4. **Delete** the material request.

# Creating a Material Request from the Jobs Module
The Jobs Module allows you to raise material requests directly from an active job. This ensures that all necessary parts and products are sourced efficiently, linked with the job, and made available for seamless job execution. By creating a request within a job, the job is automatically associated with the request, reducing duplication of effort and ensuring accurate tracking.
**Step 1: Accessing the Jobs Module**
* Tap the Hamburger Menu located at the top left corner of the screen and select **Jobs**. The Jobs Listing Page will appear.

* From the listing page, select the job for which you need to create a material request.
* The Job Details Page will open.
* On the Quick Actions Bar, click **New** and select “**New Material Request**” from the dropdown menu.

* The New Material Request Creation Page will open.
* The request will display prefilled details, including the associated job and its existing parts/products under the Parts/Products section. You can manually add or remove items as required.

**Step 2: Adding Parts and Products**
The Parts & Products section allows you to add materials required for the request from:
1. The associated job (if applicable).
2. The inventory.
3. Custom line items.
> [accordion] To add Items from a Job or Inventory
>
> Tap the “+ **Add**” button and select “**Add item**”. The Add Products page will open, displaying two tabs:
>
> 
>
> * **Parts Added to Job** – Lists all parts/products already associated with the job (if applicable).
> * **All Parts** – Displays the complete inventory available for selection.
>
> Add the required quantities from either tab, and click **Proceed** to include them in the material request.
>
> 
> [accordion] To add a custom item
>
> Tap the “+ **Add**” button and select “**Add custom item**”. The Add custom item bottom bar will appear.
>
> * Enter the ID, Name, Description, and specify the Quantity.
> * Click **Add**.
>
> 
Once all items are finalized, click **Next** to move to the Basic Details section.
**Step 3: Entering Basic Details**
The Basic Details Section captures critical information required for processing the request. Complete the following fields and click "**Next**" to review details.
* **Material Request Title** - This field is prefilled when creating a material request directly from a job.
* **Required by -** This field is prefilled based on the job’s scheduled start date. If no start date is available, the due date is used instead.
* **Delivery Method** - Select how the requested materials should be delivered.
1. **Direct Shipment to Job’s site** – Materials are shipped directly from the vendor to the customer’s job site or the field technician’s location.
2. **Deliver to Warehouse** – Materials are shipped to your organization’s designated warehouse.
* **Delivery To** - When the delivery method is Delivery to Warehouse, select the warehouse location from the Delivery To dropdown to ensure accurate routing and inventory tracking.
* **Priority** – Set the urgency level: Low, Medium, High, or Urgent.
* **Remarks** – Enter any additional information or instructions.
* **Attachments** – Upload supporting documents such as specifications, images, or vendor details (if applicable).
* **Other Details** – Fill in any additional fields configured by your organization.

**Step 4: Review Summary and Submit**
* Review all details of the material request, including parts/products and basic information.
* Click **Create** and choose one of the following options:
1. **Submit** – To submit the request for approval.
2. **Save as Draft** – To save the request and complete it later.

Once successfully created, the material request will be listed in the Material Request listing page and associated with the job.
## Viewing and Managing Material Request Details from a Job
After submission, you can track and manage material requests directly from the associated job or material request listing page. This provides real-time visibility into the request’s progress and ensures the timely fulfillment of materials.
To view material requests from the associated job:
1. Navigate to Jobs listing page > Select a Job > Job details page > Associated Tab> Material Requests.
2. A list of all material requests linked to the job will be displayed.

> [!NOTE]
>
> Note: The status of each request updates dynamically, reflecting its current stage in the approval and fulfilment process.
3. Click a material request to open its details page for a complete view.
For more information about the details page, see the Viewing Material Request Details section.
> [accordion] Material Request Statuses
>
> * **Submitted** – The request has been created and sent for approval.
> * **Awaiting Approval** – The request is pending review and authorization from a supervisor or administrator.
> * **Approved** – The request has been approved, and the fulfillment process is underway.
> * **Rejected** – The request has been declined by the approver, typically due to unavailability, budget constraints, or other organizational considerations.
> * **Received** – The requested items have been delivered, and the material request is marked as complete.
### Approval and Fulfillment Process
* Once submitted, the material request is routed through the Approver Hierarchy (if configured). Authorized personnel will review and either approve or reject the request based on priority, budget, or availability.
* After approval, the fulfilment process begins, and the required parts/products are prepared for delivery.
* When the items are delivered, the status updates to Received, confirming completion.
**Important Note:**
* If the associated job is pending materials from the material request, an indication labeled “**Waiting on MR**” will be displayed. Similarly, if a Purchase Order (PO) is created from the material request, a “**Waiting on PO**” tag will be shown.
This indication helps stakeholders track dependencies and manage timelines effectively.

* A job cannot be marked as completed if there is an active or unfulfilled material request associated with it.
* You will only be able to close the job once the material request is either **fulfilled** or **rejected**.
# Creating a Material Request in Web
Source: https://docs.zuper.co/Purchasing/Material-Requests/Creating-material-request
The Material Requests (MR) feature allows administrators to request parts and products on behalf of a **field technician** to ensure seamless job execution. When a technician encounters a missing or damaged part, an admin can raise a material request in the web application.
This process ensures efficient sourcing, approval, and fulfillment of necessary materials either by transferring parts/products from an existing warehouse or **purchasing** new items if they are unavailable.
In Zuper, you can create a material request from the following areas:
* **Material Request Listing** page
* **Jobs** → **Line Items** tab (on the left side of the **Job Details** page) → **Parts and Services** table
* **Quotes** → **Quote Details** page
> [!NOTE]
>
> **Note**: This feature is available only on select Zuper plans. To enable it for your account, please contact your account administrator or email us at [support@zuper.co](mailto:support@zuper.co)
**Note:** Before creating a material request, confirm that your purchasing settings are configured. This includes approval hierarchies and any custom fields for material requests. See [Configuring Purchasing Settings](https://docs.zuper.co/Settings/Modules/Purchasing/Configure-PO#material-requests).
# Creating a Material Request from the Listing Page
To create a new material request from the material request listing page, follow these steps:
**Navigation**: Purchasing Module -> Material Requests -> + New Material Request (on the right corner of the Material Request listing page)
* Click the **Purchasing** module from the left navigation menu and select **Material Requests**.

* You will view a list of existing material requests with details such as: Material Request No., Material Request Title, Status, Total items, and more.
* Click the **+ New Material Request** button in the top right corner to create a new material request. A New Material Request creation page will open.

* Fill in the following sections to create a new material request.
## Primary Details
The **Primary Details** section captures all the essential information about the material request.
* **Material Request Title** – Enter a unique title for the material request.
* **Requested By** – This field is prefilled based on the account. However, you can select a different employee from the dropdown if needed.
* **Required By** – Select the date when the material is required.
> [!NOTE]
>
> **Note**: This date must be today or a future date.
* **Delivery Method -** Select how the requested materials should be delivered.
1. **Direct Shipment to Job’s site** – Materials are shipped directly from the vendor to the customer’s job site or the field technician’s location.
2. **Deliver to Warehouse** – Materials are shipped to your organization’s designated warehouse. From there, they can be transferred to the required job site or assigned to specific jobs using Transfer Order.
When selecting this option, choose the Warehouse location from the **Delivery To** dropdown menu to ensure accurate routing and inventory tracking.
* **Priority** – Choose from **Low, Medium, High, or Urgent** to indicate the urgency.
* **Remarks** – Add additional instructions or notes related to the material request.

## Parts & Products
This section allows you to add parts and products for the material request.
You can:
* Choose parts/products from the Inventory, or
* Add Custom Line Items that are specific to this material request.
Request items with [Options](https://docs.zuper.co/Inventory_Management/Parts_Services/Create_New_Part_Service#3-options) (**Material Requests > New**).

> [!NOTE]
>
> **Note**: If the material request is associated with a job, a modal window will appear displaying the parts/products already linked to that job. You can select from the job’s existing items, modify quantities, or add/remove items as necessary.
> [accordion] To add parts/products from the Inventory
>
> Select parts or products directly from the organization’s inventory. This ensures that standard and pre-approved items are requested.
>
> * Click +**Add** and select “**Line item**” to open the parts & products selection pop-up.
>
> 
>
> * The pop-up displays a list of available parts & products across different warehouse locations.
>
> * Select the required Parts/Products to be added for the material request.
>
> > [!NOTE]
> >
> > Negative values are not accepted. If you enter a decimal quantity, an inline warning appears before and after submission. The number of decimal places displayed follows your organization's decimal setting.
>
> * Click **Add** to include it in the MR.
>
> 
>
> > [!NOTE]
> >
> > **Note**: If the required part/product is not in stock, you may need to initiate a purchase order to procure the items. For more details on how to create a purchase order, refer [Creating a Purchase Order](https://docs.zuper.co/Purchasing/Purchase-Orders/Creating-purchase-order) article.
> [accordion] To add a custom line item
>
> Use this option to create and add custom items that are not listed in the inventory but are required specifically for this material request.
>
> * In the Parts & Products section, click “**+ Add**” and select “**Custom Line Item**.”
>
> 
>
> * The Create New Line Item dialog box will open.
>
> * Enter the following details: **1. ID** - A unique identifier for the Material request item. **2. Name** - The name or description of the part/product. **3. Type** - Select whether the item is categorized as a **Part** or a **Product**. **4. Required Quantity** - \* Enter the number of units needed under the "**Required Quantity**" field. You can enter fractional values between 0.1 and 0.9 — for example, 0.5 feet.
>
> > [!NOTE]
> >
> > Negative values are not accepted. If you enter a decimal quantity, an inline warning appears before and after submission. The number of decimal places displayed follows your organization's decimal setting.
>
> **5. Description** - Add any additional details about the item, such as specifications, model number, or special instructions, to provide clarity during procurement.
>
> * Once all fields are completed, click **Create** to add the item to the material request.
>
> 
>
> > [!NOTE]
> >
> > **Note**: Custom line items are specific to this MR only. They are not added to the inventory.
> [accordion] Viewing and Managing Selected Parts/Products
>
> Once added, the selected parts/products will appear in the Parts & Products section of the material request creation page with the following columns:
>
> * **Item**– Displays the name of the part or product and indicates whether it is a standard catalog product, custom product, or part.
> * **Type**– The classification of the item (e.g., part or product).
> * **Required Quantity** – The number of units needed.
> * **Action** – Option to remove the selected part/product.
>
> 
## Other Details
This section displays any **custom fields** that have been configured by your organization. These fields may capture additional MR specific data such as project codes, cost centers, priority levels, expected delivery timelines, or any other information required by your business process.
## Associate Job/Quote
You can associate the Material Request (MR) with either a Job or a Quote.
To do this:
* Click “+ **Add Job/Quote**” in the Associations section.

* Select the appropriate Job or Quote from the list and click **Proceed** to associate it with the Material Request.

> [!NOTE]
>
> Note: Associating a Job/quote with the material request helps track the purpose of the requested materials and streamlines your workflow by linking related records and products
## Attachments
This section allows you to upload supporting documents, such as images, videos, or invoices related to the material request.
To upload an attachment:
* Click “**+ Add Attachment**.”

* Choose and upload the file from your computer.
* Once the file is uploaded, click “**Done**.”

> [!TIP]
>
> Tip: You can also download or remove attachments, as needed
After completing all mandatory fields and verifying the details, choose one of the following actions at the top of the material request creation form.
1. **Save as Draft**: Save the MR without submitting. Useful if you need to review or complete it later.
2. **Save & Submit:** Select this to submit the material request for approval. Based on your approval hierarchy, the request moves to the next stage for review. To set up or update approval hierarchies, see [Configuring Purchasing Settings](https://docs.zuper.co/Settings/Modules/Purchasing/Configure-PO#material-requests).

The new MR has been created successfully.
# Creating a Material Request from the Jobs Module
In Zuper, you can create a Material Request directly from an existing job when a technician requires additional parts or products to complete the job. This ensures that all requested materials are linked to the job, making tracking and fulfillment more efficient.
> [!NOTE]
>
> **Note:** A material request can be created only if the associated job has an item added under **Line Items → Part/Service Details**.
**Navigation**: Jobs -> Jobs listing page -> Select a Job -> Job Details Page -> Line Items -> Part/Service Details -> Click Request -> Select Material Request
**Steps to Create a Material Request:**
* From the left navigation menu, select the **Jobs** module.

* On the **Jobs Listing Page**, locate and select the job for which you need to create a material request.

* The **Job Details Page** opens, displaying the job’s essential information.
* Navigate to the **Line Items** section and scroll down to **Part/Service Details**.
* In the **Part/Service Details** section, click **Request** and select **Material Request** from the drop-down menu.

* A modal window will appear, displaying the list of items associated with the job.
* Select the required item(s). The default quantity needed for the job is prefilled; however, you can update it in the **Required Quantity** field if necessary
* Click **Add**. A new Material Request creation page will open with prefilled data, including Material Request Title, Delivery Method, Parts & Products, and the Associated Job.

> [!NOTE]
>
> Note: When a Material Request is created from the Jobs module, the system automatically links the request to the corresponding job to ensure accurate tracking.
* Request items with [Options](https://docs.zuper.co/Inventory_Management/Parts_Services/Create_New_Part_Service#3-options).
* Review the prefilled details, update any additional required fields, and click **Save as Draft** or **Save & Submit** to create the Material Request.

# Creating a Material Request from the Quotes Module
In Zuper, you can also create a Material Request directly from an existing quote when additional parts or products are required to fulfill customer requirements. This ensures that all requested materials are linked to the quote, providing clear visibility into procurement needs and streamlining the fulfillment process.
**Navigation**: Quotes -> Quotes Listing Page -> Select a Quote -> Quote Details Page -> On the right pane, locate the Material Request module -> Click “+” to create a new material request
**Steps to Create a Material Request:**
You can create a material request from the Quote Details page in two ways:
**1. From the top-right:**
* Navigate to the **Quotes Listing Page**.

* Select the desired quote to open the **Quote Details Page**.
* Click **New** at the top right of the page and select **Material Reques**t from the dropdown menu to create a new material request.

**2. From the right panel:**
* In the right pane of the quote details page, locate the **Material Requests** module.
* Click the **“+”** icon to create a new material request.

* A modal window will appear, displaying the list of quoted items.
*Enter the number of units needed under the* **Required Quantity** field. You can enter fractional values between 0.1 and 0.9 — for example, 0.5 feet.
> [!NOTE]
>
> **Note**: Negative values are not accepted. If you enter a decimal quantity, an inline warning appears before and after submission. The number of decimal places displayed follows your organization's decimal setting.


Click **Add**. A new Material Request page will open with prefilled data, including Material Request Title, Delivery Method, Parts & Products, and the Associated Quote.
* Request items with [Options](https://docs.zuper.co/Inventory_Management/Parts_Services/Create_New_Part_Service#3-options).
> [!NOTE]
>
> **Note:** When creating a Material Request from the Quotes module, the system automatically links the request to the corresponding quote for accurate tracking.
* Review the prefilled details, complete any additional required fields, and click **Save** **as Draft** or **Save & Submit** to create the Material Request.

# Managing Material Request
Source: https://docs.zuper.co/Purchasing/Material-Requests/Managing-material-request
Material requests ensure that field technicians have the necessary parts and products for seamless job execution. Once a field technician submits a material request via the Zuper mobile app, administrators can track, manage, and fulfill these requests through the Material Requests module in the web application.
This guide walks you through accessing, managing, and fulfilling material requests, ensuring efficient inventory handling and procurement.
# Accessing the Material Request Listing Page
To view all material requests:
1. Click the **Purchasing** module from the left navigation menu and select Material Requests.

2. You’ll see a list of material requests with key details, including:
* **Material Request No**. - This is the system-generated unique number assigned to each material request for easy identification.
* **Material Request Title** - This is the name given to the material request, often auto-filled if created from a job or quote.
* **Status** - Indicates the current stage of the material request. Statuses include:
1. Draft – The request is still being prepared and has not been submitted.
2. Submitted – The request has been submitted for review.
3. Awaiting Approval – The request has been submitted and is pending action from an approver before it can proceed (Only applicable if approval hierarchy is configured).
4. Approved – The request has been approved by authorized users (Only applicable if approval hierarchy is configured).
5. Rejected – The request has been declined by the internal approver and cannot proceed further (Only applicable if approval hierarchy is configured).
6. Ordered – The items in the request have been ordered through a Transfer Order or a Purchase Order.
7. Received – The requested items have been delivered and recorded in the system.
8. Canceled- The MR has been canceled and will not be processed further.
* **Total Items** - Displays the total number of parts or products requested within the material request.
* **Priority** - Categorizes the urgency of the request into:
1. Low – Non-urgent request.
2. Medium – Standard priority request.
3. High – Needs to be addressed soon.
4. Urgent – Requires immediate attention.
* **Required By** - The deadline by which the materials are required.
* **Associated** - Displays the job or quote linked to the material request, providing context on where or why the order originated.

## Exploring the Listing Page
The listing page is designed to provide a structured view of material requests, making it easier to track and manage them efficiently.
### Summary Cards
Enable Show KPIs to display the summary cards at the top of the listing page. These cards provide a quick snapshot of your material request pipeline, including:
* **Total Material Requests** – The total number of material requests created.
* **Submitted** – The number of material requests that have been submitted for approval.
* **Approved** – The number of material requests that have been authorized and are ready for procurement.

* **Ordered** – The number of material requests for which items have been ordered through a Transfer Order or Purchase Order.
* **Received** – The number of material requests for which all requested items have been received and recorded.
* **Rejected** – The number of material requests that have been declined and will not proceed further.
> [!NOTE]
>
> Note: The Approved and Rejected KPIs are displayed only if the Approval Hierarchy setting is enabled in your organization.
These summary cards help you monitor your material request lifecycle at a glance, giving you visibility into how many requests are pending, progressing, or closed.

### Customization Options
Tailor the listing view to match your workflow:
* Click the **Columns** button at the top-right corner of the screen to open a panel with Displayed Columns and Available Columns.

* Hover over any column under **Available Columns** to reveal the option to add it or drag and drop it into the **Displayed Columns** section.
* Reorder fields by simply dragging and dropping columns within the Displayed Columns list.
This flexibility ensures that you see only the data most relevant to your operational preference.
### Search & Filtering
Quickly locate specific material requests using the search and filter tools:
* Use the **Search Bar** to look up material requests by title or MR Number.
* Apply filters to narrow down results based on:
1. **Material Request Status** (e.g., Draft, Submitted, Approved)
2. **Priority**
3. **Material Request Date**, and more.
This functionality helps you quickly find what you need without scrolling through the entire list.

### Bulk Actions
Easily manage multiple material requests in one go. To do so,
* Select the checkboxes next to the material requests you want to update.
* A bottom bar appears with the following options:
1. Click “**Update Status**” to update the status of the selected material requests in bulk.
2. Click “**Update Priority**” to update the priority of the selected material requests in bulk.
3. Click “**Delete**” to delete the selected material requests.
Bulk actions save time and ensure consistency across multiple records.

### Creating a New Material Request
To create a new material request from the listing page:
* Click the **+ New Material Request** button in the top-right corner.

For step-by-step instructions on how to create a material request, refer to the [Creating a Material Request](https://docs.zuper.co/Purchasing/Material-Requests/Creating-material-request) article.
### Customize Your View
You can further refine how your material requests are displayed:
* Create and save personalized views based on your preferences.
* Set view-specific permissions to ensure the right team members have appropriate access.
For more information on how to create a new view and set permissions, refer to this [article](https://docs.zuper.co/Work_Order_Management/Jobs/managing_your_jobs#applying-filters).

# Managing Material Request Details
Once a material request is created, the Material Request (MR) details page serves as the central hub for tracking and managing all aspects of the material request. The page features a three-column layout, providing quick access to relevant information and actions within each panel.
1. Click on any material request from the listing page to open its details.

## Left Panel
The left panel displays key material request information, such as the MR title and current status, along with quick action buttons to order materials through a **Transfer Order** (TO) or **Purchase Order** (PO).

> [!NOTE]
>
> Note: A Transfer Order can be created from a Material Request only when the Delivery Method is set to Deliver to Warehouse.
It also provides easy navigation to view MR Details, MR Items, Notes, and Activity History.
### Details
The Material Request Details section provides an overview of the request, including:
* **Priority** – Indicates the urgency of the request (Low, Medium, High, or Urgent).
* **Required By** – The date when the requested materials are needed.
* **Deliver Method** – Specifies how the requested materials should be delivered.
* **Requested By** – The name of the user or team member who created the request.

### MR Items
This section displays the requested materials in a clear, tabular format, making it easy to review and verify details. This includes:
* **Item** – The name of the item requested; also shows if the item was added from a Job or Quote.
* **Type** – Indicates whether the item is a standard catalog product, a custom product, or a part.
* **Required Quantity** – The number of units required.
* **Received Quantity** - The number of units that have been received so far.

Edit the material request — available only when the status is Draft or Submitted. Once the request moves past Submitted, editing is locked on both the mobile app and the web. To make changes at a later stage, contact your administrator.
### Notes
The Notes section allows you to add comments or additional information to a material request throughout its lifecycle. Notes can provide extra context and may include anything from a simple text reminder to an image of parts/products, or even a video or document.
For more information on how to use the notes feature, refer to the [Notes and chats](https://docs.zuper.co/Work_Order_Management/Jobs/notes_and_chats) article.

### Activity
The Activity section logs all actions and updates related to the material request, helping you track recent changes and monitor status updates made by each user.
> [!NOTE]
>
> Note: You can also filter activities by user and within the selected date range.

### Status History
Displays the complete status lifecycle of the material request in chronological order, allowing you to see each status update, timestamp, and the user who made the change.
This helps in tracking the material requests’ progress from creation to fulfillment.

## Right Panel
The Right Panel provides additional contextual information and quick-access links related to the selected Material Request (MR). This panel enhances visibility and traceability by consolidating related data in one place.
* **Associated Job/Quote** – Shows the job or quote linked to the material request and allows quick navigation to its details. This provides clear visibility into which job or customer quote the material request supports, ensuring better coordination between material management and job execution.

> [!NOTE]
>
> Note: If the associated job or quote is pending materials from the material request, an indication labeled “**Waiting on MR**” will be displayed. This indication helps stakeholders track dependencies and manage timelines effectively. A job or quote linked to a material request can only be closed when the material request status is set to Draft, Cancelled, Closed, or Fulfilled.
>
> 
* **Attachments** – Allows you to upload and view supporting files such as images, specification sheets, invoices, or approval documents.
* **Purchase Order** – Lists any purchase orders created from the MR, along with their status and links to view details.
* **Transfer Order** – Displays associated transfer orders (if applicable), along with their status and quick links to view the order details.

## **FAQs**
1. Why is my Material Request still in “Ordered” status even though the Transfer Order is marked as Completed?
**Issue**
You may notice that a Material Request remains in “Ordered” status even after completing a linked Transfer Order. This can prevent the associated job from being completed.
**Cause**
A Material Request will automatically move out of the **“Ordered”** status **only when all associated Transfer Orders are completed**.
If even one linked Transfer Order remains in Draft, Pending, or any status other than Completed, the Material Request will not update.
**Resolution**
1. Open the relevant **Material Request** details page.
2. Check the **Associated Transfer Orders** section.
3. Verify the status of all linked Transfer Orders.
4. Complete any Transfer Orders that are still in **Draft** or incomplete status.
5. Ensure items are received (if applicable).
Once **all linked Transfer Orders are marked as Completed**, the Material Request status will update automatically.
# Understanding Material Request Status
Source: https://docs.zuper.co/Purchasing/Material-Requests/Material-request-status
When a **Material Request (MR)** is created in Zuper, it progresses through several stages from initiation to fulfillment. Understanding what each status signifies allows you to track progress, manage procurement efficiently, and take appropriate actions at every stage.
This guide explains the different MR statuses, their meanings, and the actions you can perform at each stage.
# Navigating to Material Request Status
To view the status of a material request:
* Click the **Purchasing** module from the left navigation menu and select **Material Requests**.

* A list of existing material requests will be displayed, showing key details such as Material Request No., Material Request Title, Status, Total items, and more.
* Select any MR from the list to open its Details page.

* The current status of the MR is displayed prominently at the top of the screen.
## Statuses of a Material Request
### 1. Draft
This status indicates that the material request has been created but not yet submitted for approval.
**Available Actions:**
* **Mark as Submitted** - This moves the MR to the next stage.
**More Actions menu (top-right):**
* **Edit** - Modify the details of the material request.
* **Clone** - Creates a duplicate of the current material request, including all items and details, allowing you to quickly generate a new request with similar information.
* **Cancel** - Change the material request status to Cancelled. Doing this will stop the material request from moving further in the process.
* **Delete** - Permanently removes the material request from the system.

### 2. Submitted
This status indicates that the material request has been submitted and is awaiting approval from the designated approvers. Once submitted, the relevant approvers are notified via email and prompted to take the necessary action.

**Approver Actions**:
* Approve or reject the MR directly from the email notification.
* Log in to the Zuper web application to approve, reject, and/or add comments.
All approval and rejection comments are automatically recorded in the Activity Section for tracking, accountability, and transparency.
> [!NOTE]
>
> Note: If your organization has enabled the Approval Hierarchy setting, the material request will require approval and will remain pending at this stage until an authorized user reviews and approves it.
>
> If the Approval Hierarchy is not enabled, the material request is automatically approved, allowing you to directly create a **Transfer Order** (TO) or **Purchase Order** (PO) without requiring additional approval.
>
> 
You can configure approval workflows from the settings as follows:
> [accordion] Enable Approval Hierarchy:
>
> Navigate to Settings → Modules → Purchasing → General Settings → Material Requests → Choose Approval Hierarchy.
>
> 
> [accordion] Create & Manage Hierarchies:
>
> Navigate to Settings → Miscellaneous → Approval Hierarchy to define and manage approval levels.
>
> 
**Available Actions**:
* **Mark as Approved** – Approves the material request and moves it to the next stage in the workflow.
**More Actions menu (top-right)**:
* **Clone** - Creates a duplicate of the current material request, including all items and details, allowing you to quickly generate a new request with similar information.
* **Edit** – Opens the Material Request in edit mode, allowing you to modify existing details such as title, delivery method, parts, products, or other relevant fields.
* **Mark as Rejected** – Rejects the material request, preventing it from progressing further.
* **Cancel** – Changes the material request status to Canceled, stopping it from moving forward in the process.
* **Delete**: Permanently removes the material request from the system.

### 3. Rejected
This status indicates that the material request has been reviewed and declined by an approver.
> [!NOTE]
>
> Note: The MR cannot proceed to procurement unless it is updated and resubmitted for approval.
**Available Actions**:
* **Edit** – Update the material request as required and resubmit it for approval.
* **Clone** – Creates a duplicate of the current material request, including all items and details, allowing you to quickly generate a new request with similar information.
* **Delete** – Permanently removes the material request from the system.

### 4. Approved
Indicates that the material request has been approved internally by all required approvers and is now ready to be converted into a Purchase Order or a Transfer Order, depending on material availability and procurement needs.
> [!NOTE]
>
> Note: Transfer Order creation is available only when the **Deliver to Warehouse** method is selected.
**More Actions menu (top-right):**
* **Convert to Purchase Order** – Initiates a Purchase Order directly from the approved material request.
* **Convert to Transfer Order** – Initiates a Transfer Order if the requested materials can be fulfilled from existing stock in another location.
* **Clone** – Creates a duplicate of the current material request, including all items and details, allowing you to quickly generate a new request with similar information.
* **Cancel** – Cancels the approved material request, preventing further processing.
* **Delete** - Permanently removes the material request from the system.

#### Steps to Convert MR to Transfer Order (For In-stock items)
If the requested items are available in inventory, you can create a Transfer Order to move materials from the source location to the field technician’s delivery location.
* From the left panel of the material request details page, click **Transfer Order** or select **Convert to Transfer Order** under the **More Actions** menu.

* The Parts & Products dialog appears, listing all requested items.
* Select the items to be transferred and provide the following details:
1. **Transfer Quantity** – The number of units to be transferred.
2. **From Location** – The source stock location.
3. **To Location** – The destination location (pre-filled when creating the request).
> [!NOTE]
>
> Note: The From Location and To Location cannot be the same.
* Once done, click **Proceed**.

* The Create Transfer Order page opens. Review the details and click **Create Transfer Order(s)**.

A Transfer Order will be created for the requested items with a status of **Draft** in the Transfer Order module.
> [!NOTE]
>
> Note: Ensure that your organization has enabled the Transfer Order module to manage stock transfers. For more information on how to access and manage transfer orders, refer to the Transfer Orders article.
#### Steps to Convert MR to Purchase Order (For Out-of-Stock Items)
If the items are not available in inventory, you can create a Purchase Order from a vendor.
* From the left panel of the material request details page, click **Purchase Order** or click “**Convert to Purchase Order**” at the top-right.
* The Parts & Products dialog appears with all requested items.
> [!NOTE]
>
> Note: Vendor mapping must be configured for the items before they can be converted into a Purchase Order. If vendor mapping is missing, you cannot create a Purchase Order for the MR items.
* Select the required items to be purchased and choose the Vendor from the drop-down menu.
* Once chosen, click **Next**. The Create Purchase Order screen appears.

* Fill in the necessary details and click **Create Purchase Order** to finalize.

The newly created Purchase Order will then appear on the Purchase Orders listing page with a status of Draft.
> [!NOTE]
>
> Note: Ensure that your organization has enabled the Purchase Orders module to manage procurement. For more information on how to access and manage purchase orders, refer to the Creating a Purchase Order article.
### 5. Ordered
This status indicates that the requested materials have been converted into either a **Transfer Order** or a **Purchase Order**. Once this conversion is completed, the material request status automatically updates to Ordered, confirming that the requested items have been formally placed.
> [!NOTE]
>
> Note: During this stage, you can track and monitor the status of your requested items from the right panel under Purchase Orders or Transfer Orders.
Once the requested materials are transferred or purchased and delivered to the field technician, the material request status automatically updates to **Received**, and the request will be closed, indicating successful fulfillment.

### 6. Received
This status indicates that the requested materials have been successfully delivered to the designated location and the material request has been fulfilled.
The status changes to **Received** automatically once the associated **Purchase Order** or **Transfer Order** has been marked as **completed**/fulfilled in the system.

## Impact on the Job & Quote
If the material request is associated with a Job/quote, the delivered items are automatically linked to that job/quote.
1. **For job**: The quantity of parts or products received will be reflected under Job > Details > Line Items> Part & Service Details.
2. **For quote**: The received parts or products will be displayed under Quote > Details > Parts & Products to ensure accurate visibility of material allocation against the quoted work.
# Overview
Source: https://docs.zuper.co/Purchasing/Material-Requests/Overview
In the field service business, delays often occur when technicians discover that essential parts or materials are missing, damaged, or insufficient while performing a job. Communicating these needs through calls, emails, or chat messages can lead to miscommunication, a lack of traceability, and project delays. To address this challenge, Zuper introduced the **Material Request (MR)** feature, a structured, trackable way for teams to request and fulfill required materials efficiently.
The **Material Request (MR)** feature enables your organization to streamline the process of requesting, approving, and fulfilling parts and products needed by the field technician. It ensures that when a technician encounters missing, damaged, or additional material requirements during job execution, those requirements can be captured, tracked, and fulfilled efficiently either through internal stock transfer or vendor purchase order.
## Prerequisite
This feature is available only on select Zuper plans. To enable it for your account, please contact your account administrator or email us at [**support@zuper.co**](mailto:support@zuper.co)
## Key Benefits of Zuper’s Material Request Feature
Zuper’s **Material Request** feature offers several key benefits that enhance coordination between field, inventory, and procurement teams, ensuring materials are requested, approved, and delivered efficiently.
1. **Streamlined Material Planning**
Create and manage material requests directly from Jobs or Quotes. This ensures field technicians and back-office teams can communicate material needs instantly and avoid project delays due to unavailable parts.
2. **Centralized Request Tracking**
Track every material request from creation to fulfillment. View request history, status, and linked Purchase Orders or Transfer Orders, ensuring complete transparency and accountability across teams.
3. **Seamless Inventory & Procurement Integration**
Easily convert approved material requests into **Transfer Orders** (for internal stock movement) or **Purchase Orders** (for vendor procurement). Real-time integration keeps your inventory updated and eliminates duplicate entries.
4. **Improved Field Efficiency**
Enable technicians to raise material requests directly from the mobile app, whether on-site or in the field. This reduces communication gaps, accelerates approvals, and helps ensure that required materials reach the job location on time.
5. **Approval & Prioritization Control**
Configure approval workflows and set material request priorities (Low, Medium, High, Urgent) to ensure critical items are processed first. This adds governance and improves turnaround time for high-priority work.
6. **Enhanced Traceability & Audit Readiness**
Every request is automatically linked to the associated Job, Quote, or Purchase Order, creating a clear audit trail from request initiation to receipt, ensuring accuracy and accountability throughout the material lifecycle.
Let’s put the Material Request into action. The following guides will help you get started.
* [Creating a Material Request in Web](https://docs.zuper.co/Purchasing/Material-Requests/Creating-material-request)
* [Creating a Material Request from Mobile ](https://docs.zuper.co/Purchasing/Material-Requests/Creating-Material-request-from-mobile)
* [Understanding Material Request Status](https://docs.zuper.co/Purchasing/Material-Requests/Material-request-status)
* [Managing Material Request ](https://docs.zuper.co/Purchasing/Material-Requests/Managing-material-request)
# Creating Purchase Order
Source: https://docs.zuper.co/Purchasing/Purchase-Orders/Creating-purchase-order
A Purchase Order (PO) is a formal document issued to a vendor specifying the parts or products you intend to buy, including quantities and agreed prices. It serves as a crucial step in ensuring efficient procurement, cost control, and timely service delivery.
In Zuper, you can create a PO from the following areas to request Parts & Products:
* Purchase Order listing page
* Material Request details page
* Jobs > Parts and Services
* Quotes
> [!NOTE]
>
> **Note:** This feature is available only on select Zuper plans. To enable it for your account, please contact your account administrator or email us at [**support@zuper.co**](mailto:support@zuper.co)
**Prerequisites**
Before creating a Purchase Order (PO) in Zuper, ensure the following are set up:
* **Purchase Order Module**: The Purchase Order module must be enabled for your account.
* **Vendors**: Vendors should be added with complete contact and address details.
* **Parts & Products**: Items must be added to the vendor catalog.
* **Custom Line Items**: If the **job includes a custom line item**, ensure it has a **unique ID**, as this will be used as the **SKU** during PO creation.
> [!NOTE]
>
> Note: **Receiving free or \$0 items**
>
> Zuper does not currently support receiving products with a unit purchase cost of \$0 on a purchase order. If a vendor is supplying items at no charge, enter a nominal cost to complete the receiving process. If you need assistance, contact [Support.](mailto:support@zuper.co)
# Creating a New Purchase Order
To create a new purchase order from the purchasing module, follow these steps:
* Select the **Purchasing** module from the left navigation menu and select **Purchase Orders**.

* You will view a list of existing purchase orders with details such as: Purchase Order No, Purchase Order Title, Required by date, Status, Vendor name, Total PO amount, and more.
* Select the **+ New Purchase Order** button in the top right corner to create a new purchase order. A New Purchase Order creation page will open.

* Fill in the following sections to create a new purchase order.
## Primary Details
This section captures all essential information related to the purchase order.
1. **PO Title**: Enter a unique title for the Purchase Order.
2. **Vendor:** Select a vendor from the existing vendor list. Only **active vendors** will be available for selection. Once selected, the following details will automatically populate (all of which are **editable** if needed):
* **Billing Address**: The vendor's registered billing address is populated by default.
* **Delivery Address**: The destination where the goods should be delivered. This is determined by the selected delivery method:
1. If Direct shipment to Job's site is selected, the job's service address will be used.
2. If Pickup from Vendor is selected, the vendor's pickup address will be shown.
3. If Deliver to Warehouse is selected, the selected warehouse address will be used.
* **Delivery Method**: Specifies how the goods will be delivered. This typically includes:
1. Direct shipment to Job's site
2. Pickup from Vendor
3. Deliver to Warehouse
* **Payment Term**: Indicates the payment agreement between your organization and the vendor.
> [!NOTE]
>
> Note: For more information on how to set up your vendors, see the [Vendors](https://docs.zuper.co/Purchasing/Vendors/Vendors) article.
3. **Delivery Method**: This defines how the items in the Purchase Order will be delivered. Choose one of the following delivery methods based on your logistics or vendor arrangement:
* **Direct Shipment to Job's site** When this option is selected, the ordered items will be shipped directly to the job location.
> [!NOTE]
>
> **Note**: If this method is selected, the delivery address will be automatically populated with the service address linked to the associated job.
* **Deliver to Warehouse**\
When this option is selected, the ordered items will be delivered to the selected warehouse within your organization for storage or future dispatch.
> [!NOTE]
>
> **Note:** If this method is selected, ensure that the correct warehouse is chosen from the **Delivery To** dropdown list and that the delivery address for the selected warehouse is added in the **Delivery Address** field.
* **Pickup from Vendor**\
When this option is selected, your team will collect the ordered items directly from the vendor's location and transport them to one of your organization's warehouses.
> [!NOTE]
>
> **Note:** If this method is selected, the delivery address will be auto-filled with the vendor's pickup address.
4. **Delivery Time**: Select the preferred time window for receiving the item. This helps the vendor plan the delivery more accurately. The available options include:
* **Anytime** – No specific delivery window is required.
* **Morning** – Delivery is expected during morning hours.
* **Afternoon** – Delivery is expected during afternoon hours.
* **Special Request** – Select this option if you need the delivery at a specific time or under special conditions.
5. **Reference Number**: Enter an optional internal or vendor-specific reference ID.
6. **Required By**: Select the date by which the items are required.
> [!NOTE]
>
> **Note**: This date must be today or a future date.
6. **Payment Term**: Automatically filled based on the selected vendor's default payment terms. You may update it if required.
7. **Template**: A default template is pre-selected. If required, you can choose a different template for the purchase order from the drop-down menu.
8. **Remarks**: Add any additional notes or instructions related to the purchase order.

### Options
When creating a PO, select [options](https://docs.zuper.co/Inventory_Management/Parts_Services/Create_New_Part_Service#3-options) for procurement alignment.

## Associations
You can associate a Purchase Order (PO) with either a Job or a Quote.
To do this:
* Select **"+ Add**" in the Associations section.
* Select the appropriate Job or Quote from the list.

* Once the association is made, a modal will appear displaying the list of products from the selected Job or Quote. Choose the relevant items, and they will automatically populate in the PO Items section.

> [!NOTE]
>
> Note: Associating a PO with a Job or Quote helps track the purpose of the purchase and streamlines your workflow by linking related records and products.
## PO items
This section allows you to add parts and products that you wish to purchase from the selected vendor.
You can:
* Choose items from the **Vendor Catalog**, or
* Add **Custom Line Items** that are specific to this PO.
> [accordion] To add parts/products from the Vendor Catalog:
>
> 1. In the *PO Items* section, select **"+ Add"** and select **"Line Item."**
>
> 
>
> 2. The Vendor Catalog will open.
> 3. Browse or search to find desired parts/products.
> 4. Select the Vendor SKU / ID.
> 5. Enter the quantity in the **Required Qty** field.
> 6. Select **"Add Item"** to include it in the PO.
>
> 
> [accordion] To add a custom line item:
>
> Use this option to add items that are not listed in the Vendor Catalog.
>
> 1. In the *PO Items* section, select **"+ Add"** and select **"Custom Line Item."**
>
> 
>
> 2. The **Create New Line Item** dialog box will open.
>
> 3. Enter the following details:
> * **ID** – A unique identifier for the purchase order item.
> * **Name** – The name or description of the product.
> * **Unit Purchase Cost** – The cost per unit of the item (in USD).
> * **Required Quantity** – The number of items needed.
> * **Remarks (if any)** – Optional notes or instructions related to the item.
>
> 4. Select **"Create"** to add the item to the PO.
>
> 
>
> > [!NOTE]
> >
> > **Note:** Custom line items are specific to this PO only. They are **not added to the Vendor Catalog** or inventory.
> [accordion] Viewing and Managing Selected Parts/Products
>
> Once added, all PO items will be displayed in a table with the following columns:
>
> * **Item** shows the name of the part or product you want to purchase.
>
> * **Vendor SKU/ID** shows the unique product identifier from the vendor.
>
> * **Unit Purchase Cost** shows the per-unit cost charged by the vendor.
>
> * **Required Quantity** shows the number of units to order.
>
> * **Total** shows the line item total, calculated as Required Quantity × Unit Purchase Cost. This column appears across all PO statuses, from Draft through Paid.
>
> * **Remarks** shows any notes or special instructions added to the PO.
>
> > [!NOTE]
> >
> > **Note**: The **Total** column shows the calculated amount for each line item. The overall PO total shown at the bottom of the table is the sum of all line item totals.
>
> To modify the required quantity or remove an item:
>
> * Select the ellipsis (⋯) icon under the **Actions** column next to the item.
> * Select the desired action: **Edit** or **Remove**.
>
> 
## Other Details
This section displays any **custom fields** that have been configured by your organization. These fields may capture additional PO-specific data, such as department codes, project references, and approval notes.
## Attachments
The **Attachments** section allows you to upload supporting documents such as images, videos, specifications, or invoices related to the purchase order.
To upload an attachment:
1. Select **"+ Add Attachment."**

2. Choose and upload the file from your computer.
3. Once the file is uploaded, select **"Done."**

You can also **download** or **remove** attachments, as needed.
After completing all mandatory fields and verifying the details, choose one of the following actions at the top of the purchase order creation form.
* **Save as Draft**: Save the PO without submitting. Useful if you need to review or complete it later.
* **Save & Submit**: This option allows you to submit the Purchase Order (PO) for approval. Based on the configured workflow, the PO will then move to the next stage in the approval hierarchy for review.
* **Discard PO**: Cancel and permanently delete the draft PO.
The new PO will be created successfully.

# Creating a Purchase Order from Other Areas
As mentioned above, you can also create a purchase order (PO) directly from other modules where material needs arise, such as **Jobs** or **Quotes**.
This association streamlines the procurement process by linking the PO to its source, auto-filling relevant details, and ensuring accurate tracking.
## Material Request details page
You can initiate a purchase order from the **Material Request Details** page when the requested materials are unavailable in inventory and need to be sourced externally.
> [!NOTE]
>
> **Note:** If your organization has enabled the Approval Hierarchy setting, the material request must first be internally approved before a purchase order can be created. This approval step ensures that procurement is based on validated needs, helping prevent unnecessary or duplicate purchases.
Once approved, the **Purchase Orders** button becomes available on the Material Request Details page, allowing you to seamlessly convert the request into a PO.
**Navigation: Material Requests Listing Page → Select a Material Request → Material Request Details Page → Select "Purchase Orders**\*"\* (available after approval)
### Creating the Purchase Order
* From the left panel of the material request details page, select **Purchase Order** or select "**Convert to Purchase Order**" at the top-right.

* The Parts & Products dialog appears with all requested items.
> [!NOTE]
>
> Note: Vendor mapping must be configured for the items before they can be converted into a Purchase Order. If vendor mapping is missing, you cannot create a Purchase Order for the MR items.
* Select the required items to be purchased and choose the Vendor from the drop-down menu.
* Once chosen, select **Next**. The Create Purchase Order screen appears.

* Fill in the necessary details and select **Create Purchase Order** to finalize.

The newly created Purchase Order will then appear on the Purchase Orders listing page with a status of Draft.
## Jobs
When a technician identifies missing or additional parts during a job, you can raise a purchase order directly from the **Job Details** page. This helps ensure that materials needed to complete the job are procured without delay.
> [!NOTE]
>
> **Note:** A purchase order can be created only if the associated job has an item added under the **Line Items**>> **Part/Service Details** section and the required quantity is not available in stock.
If the **job includes a custom line item**, please make sure it has a **unique ID**, as this ID will be used as the **SKU** during PO creation.
This seamless workflow connects the job with the purchase process, improving accuracy and reducing manual effort.
**Navigation:**
*Jobs Listing Page -> Select a Job -> Job Details Page -> Select Line Items -> Part/Service Details -> Select "Request" -> Choose Purchase Order(s)*
### Creating the Purchase Order
* In the Part/Service Details section, select **Request** and choose **Purchase Order(s**) from the drop-down menu.

* A modal window will appear with the list of items.
* Select the item(s) you want to purchase and choose the vendor from the dropdown menu.
> [!NOTE]
>
> If an item has a **preferred vendor** configured, that vendor will be **pre-filled** during vendor selection
* Once selected, select "**Next**." The Create Purchase Order screen will appear.

* Fill in the necessary details and select **Create Purchase Order** to finalize.

* The newly created PO will then appear in the Purchase Orders listing page with a status of **Draft**.

> [!NOTE]
>
> **Note:** A job associated with a purchase order cannot be closed unless the purchase order status is **Draft**, **Cancelled**, **Closed**, or **Fulfilled**.
## Quotes
You can create a purchase order directly from the **Quote Details** page when the quoted items need to be sourced externally.
> [!NOTE]
>
> **Note:** A purchase order can be created only if the quote includes line items that are not currently available in inventory. This helps streamline procurement and avoid discrepancies during fulfillment.
This ensures a smooth transition from the quoting stage to procurement, helping maintain alignment between what was promised to the customer and what is ordered from vendors.
**Navigation:**\
You can create a purchase order from the Quote Details page in two ways:
1. *1. Quotes Listing Page -> Select a Quote -> Quote Details Page -> On the right pane, locate the Purchase Orders module -> Select "+" to create a new purchase order.*
2. *2. Quote Details Page -> On the top-right corner of the page, select New -> Select Purchase Order to create a new purchase order.*
### Creating the Purchase Order
* You can create a purchase order from the Quote Details page in two ways:
1. **Directly from the top-right corner:**
* Navigate to the **Quotes Listing Page**.
* Select the desired quote to open the **Quote Details Page**.
* On the top-right corner of the page, select **New**.
* Select **Purchase Order** to create a new purchase order.
2. **From the right panel:**
* In the right pane of the quote details page, locate the **Purchase Orders** module.
* Select the **"+"** icon to create a new purchase order.

* A **modal window** will appear with the list of quoted items.
* **Select the item(s)** you want to purchase and choose the **vendor** from the dropdown menu.
* Once selected, select **Next**. The **Create Purchase Order** screen will appear.

* Fill in the required details and select **Create Purchase Order** to finalize.

The newly created purchase order will then appear on the purchase orders listing page with a status of **Draft**.
For more information on the stages a purchase order goes through, refer to this [article](https://docs.zuper.co/Purchasing/Purchase-Orders/Purchase-order-status).
## Editing a purchase order inline
Once a purchase order is saved, you can update key fields directly on the details page — without reopening the creation form. This lets you correct details quickly and keeps the PO moving without interruption.
Fields that support inline editing
* **PO Title**
* **Required By** date
* **Reference Number**
* **Payment Terms**
* **Delivery Time**
* **Remarks**
* Any configured **Custom Fields**
> [!NOTE]
>
> **Note**: Inline editing is available to PO initiators and administrators only. Inline editing is not available when a PO is in Cancelled or Closed status. All fields are locked in those states.
### Edit a field inline
1. Open the purchase order from the **Purchase Orders** listing page.
2. Select the field you want to update. When you hover over the field, you will get the **Pencil** icon to edit. A dialog box appears, and you can update the latest information.
3. Enter the new value.
4. Select "**Update**" to save the latest changes.
Every inline edit is automatically recorded in the PO's Activity section, providing a full audit trail of what changed, when, and by whom.
> [!NOTE]
>
> **Note**: Check the Activity section after editing to confirm your changes were captured.
## Troubleshooting
> [accordion] Not all active vendors are appearing in the vendor dropdown
>
> The vendor selection dropdown should show all vendors with Active status.
>
> If only a subset of your active vendors appears:
>
> 1. Confirm that the missing vendors are set to Active status in the Vendors module (Purchasing > Vendors).
> 2. Verify that the missing vendors have complete contact and address details configured — incomplete vendor profiles may prevent them from appearing.
> 3. If all vendors appear correctly in the Vendors module but not in the PO dropdown, this may be an instance-specific issue. Contact [Zuper Support](mailto:support@zuper.co) with the names of the affected vendors and a screenshot of the dropdown.
## FAQs
> [accordion] Can I associate one PO with multiple jobs?
>
> A Purchase Order can only be linked to one job or one quote at a time. If parts are needed across multiple jobs or locations, you need to create a separate PO for each job.
>
> If the jobs are related — for example, the same customer requiring parts across different site locations — consider using Child Jobs to group them under a single Parent Job. This keeps your work organized in one place while still allowing each job to have its own PO.
***
# Managing Purchase Order
Source: https://docs.zuper.co/Purchasing/Purchase-Orders/Manage-Purchase-Order
Purchase Orders (POs) are essential for the timely procurement of parts and materials required for field service operations. Whether sourcing tools for a job or replenishing stock, effective PO management helps prevent delays, control costs, and ensure vendor accountability.
Once a PO is created in the Zuper web application, administrators can track its progress, manage approvals, collaborate with vendors, and handle fulfillment — all within the Purchase Orders module.\
This article explains how to access, manage, and update purchase orders at every stage of their lifecycle to support a streamlined and transparent procurement process.
# Accessing the Purchase Orders Listing Page
To view all purchase orders:
1. Click the **Purchasing** module from the left navigation menu and select **Purchase Orders**.

2. You’ll see a list of purchase orders for the selected date range with key details, including:
* **Purchase Order No.** – This is the system-generated unique number assigned to each purchase order for easy identification.
* **Purchase Order Title** – This is the name given to the purchase order, often auto-filled if created from a job or quote.
* **Required By**: Indicates the target date by when the requested purchase order is expected to be fulfiled.
* **Status** – Indicates the current stage of the purchase order. Statuses include:
1. **Draft** – The PO is being prepared and not yet submitted for approval.
2. **Submitted** – The PO has been submitted and is awaiting internal approval.
3. **Approved** – The PO has received internal approval and is ready to be sent to the vendor.
4. **Rejected** – The PO has been declined during the internal approval process.
5. **Sent to Vendor** – The approved PO has been sent to the vendor for processing.
6. **Vendor Accepted** – The vendor has accepted the PO.
7. **Vendor Rejected** – The vendor has rejected the PO, possibly with comments.
8. **Partially Fulfilled** – Only some items have been received; pending items remain.
9. **Fulfilled** – All items in the PO have been delivered by the vendor.
10. **Invoiced-** The vendor has issued an invoice for the items delivered, and the invoice has been recorded against the Purchase Order. This status indicates that the PO has moved into the billing stage and is awaiting payment.
11. **Paid**-The payment for the vendor invoice has been completed. This status confirms that all financial obligations related to the Purchase Order have been settled.
12. **Cancelled** – The PO has been cancelled and will not be processed further.
13. **Closed** – The PO has been completed and closed after fulfillment.

3. **Associated** – Displays the job/project or quote linked to the purchase order, providing context on where or why the order originated.
4. **Created on** – Shows the date on which the purchase order was generated, making it easier to track order timelines and monitor processing efficiency.
> [!TIP]
>
> **Tip:** After rolling up and creating the new PO, ensure the current PO is closed to prevent discrepancies in associated Jobs or Quotes.
### How costs are calculated on a roll-up
When you roll up a partially fulfilled PO, Zuper recalculates costs automatically so your records stay accurate with no manual adjustment needed.
* The **original PO** updates its total to reflect only the quantity already fulfilled — not the full ordered amount.
* The **roll-up PO** carries only the unfulfilled remainder, so no items or costs are counted twice across the two POs.
Before the roll-up completes, a confirmation modal appears summarising what will be rolled over.
> [!NOTE]
>
> If you need to audit a roll-up after the fact, go to the **Activity** tab on either PO. The log shows who initiated the roll-up, when it occurred, and which items moved to the new PO.
[Roll Up PO with new cost](https://player.vimeo.com/video/1203209269?badge=0\&autopause=0\&player_id=0\&app_id=58479)
### Identifying a rolled-up PO
> [!NOTE]
>
> **Note: Rolled-up POs** are marked with a dedicated icon next to the PO number on the listing page. Hover over the icon to see the parent PO number and select the link to open the parent PO in a new tab. This helps you trace the relationship between a rolled-up PO and its origin at a glance. The same indicator appears on the **Vendor PO** page and on associated **Jobs** and **Quotes**. For more details, see Understanding [Purchase Order Status](https://docs.zuper.co/Purchasing/Purchase-Orders/Purchase-order-status).

## Exploring the Listing Page
The listing page is designed to provide a structured view of purchase orders, making it easier to track and manage them efficiently.
### 1. Summary Cards
Enable **Show KPIs** to display the summary cards at the top of the listing page. These cards provide a quick snapshot of your purchase order pipeline. The status cards are arranged in chronological order, following the PO workflow from Draft through to Fulfilled.
> [!NOTE]
>
> Note: Each summary card includes:
>
> * **Total Amount** – The combined value of all POs under that status.
> * **PO Count** – The number displayed in the small badge indicates how many POs fall under that status.

* **Total Purchase Orders** – Displays the total value of all purchase orders, along with the total count of POs created.
* **Submitted** – Shows the total value and count of purchase orders that have been submitted for approval.
* **Vendor Accepted** – Indicates the value and count of purchase orders accepted by the vendor.
* **Partially Fulfilled** – Represents the value and count of purchase orders where only some items have been received, and others are pending.
* **Fulfilled** – Shows the value and count of purchase orders for which all items have been successfully received.

* **Invoiced**- Displays the value and count of purchase orders for which the vendor has issued an invoice, and it has been recorded in the system.
* **Paid**- Shows the value and count of purchase orders for which the vendor invoice has been fully paid.
* **Rejected** – Displays the total value and count of purchase orders that were declined during the internal approval process.
**Receiving Items**: In **Receive Items**, verify selected [options](https://docs.zuper.co/Inventory_Management/Parts_Services/Create_New_Part_Service#3-options) match.
These summary cards help you monitor your procurement activity at a glance and quickly identify areas that require attention.
> [!NOTE]
>
> Note: The **Vendor Accepted**/**Rejected** KPI will be displayed only when an approval hierarchy is configured in settings. Also, clicking a summary card filters the list to show only purchase orders with that status.
### 2. Customization Options
Tailor the listing view to match your workflow:
* Click the **Columns** button at the top-right corner of the screen to open a panel with **Displayed** **Columns** and **Available Columns.**

* Hover over any column under Available Columns to reveal the option to **add** it, or **drag and drop** it into the Displayed Columns section.
* Reorder fields by simply dragging and dropping columns within the Displayed Columns list.
This flexibility ensures that you see only the data most relevant to your operational preference.
### 3. Search & Filtering
Quickly locate specific purchase orders using search and filter tools:
* Use the **Search Bar** to look up purchase orders by title or PO number.
* Apply filters to narrow down results based on:
1. PO Status (e.g., Draft, Submitted, Approved)
2. Vendor Name
3. Associated Project, Job
4. PO Title, and more.

This functionality helps you quickly find what you need without scrolling through the entire list.
### 4. Bulk Actions
Easily manage multiple purchase orders in one go:
* Select the checkboxes next to the purchase orders you want to update.
* Click “**Update Status**” to update the status of the selected purchase orders in bulk.

Bulk actions save time and ensure consistency across multiple records.
### 5. Pinned filters
Zuper's Purchase Orders module lets you use pinned filters to streamline your filter experience. Pinned filters keep your most-used criteria readily accessible for quick application.
Pin up to 3 filters in any module.
**Navigation**: *Purchase Orders -> Filters -> Pinned Filter*
1. Select the “**Purchase Orders**” module from the left navigation menu.

2. **Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

3. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters.

### 6. Notes quick action
You can add or view notes on a purchase order directly from the listing page — without opening the full PO record. This saves time when you need to leave a quick update or check a note while reviewing multiple POs.
The same quick action is available from the:
• **Purchase Orders** listing page
• **Vendor** listing page
• **Material Requests** listing page
### 7. Creating a new Purchase Order
To create a new purchase order from the listing page:
* Click the **+ New Purchase Order** button in the top-right corner.

For step-by-step instructions on how to create a purchase order, refer [Creating a Purchase Order](https://docs.zuper.co/Purchasing/Purchase-Orders/Creating-purchase-order) article.
### 8. Customize Your View
You can further refine how your purchase orders are displayed:
* Create and save personalized views based on your preferences.
* Set view-specific permissions to ensure the right team members have appropriate access.

For more information on how to create a new view and set permissions, refer to this [article](https://docs.zuper.co/Purchasing/Vendors/Vendors#create-view-configuration).
# Managing Purchase Order Details
Once a purchase order is created, the Purchase Order Details Page serves as the central hub for tracking and managing all aspects of the purchase order. The page features a three-column layout, providing quick access to relevant information and actions within each panel.
1. Click on any purchase order from the listing page to open its details page.
## Left Panel
The left panel displays key purchase order information—such as the PO title, vendor name, and current status—along with quick action buttons for calling, emailing, or adding notes. It also provides easy navigation to view PO details, items, notes, and activity history.
> [accordion] Call
>
> Click the **Call** icon to view the vendor’s contact number and initiate a phone call (available only if contact details are provided).
>
> 
> [accordion] Mail
>
> Click the **Mail** icon to view the vendor’s email address and send them an email regarding the purchase order.
>
> 
> [accordion] Add Note
>
> Click “**Add Note**” to add comments or additional information to a purchase order throughout its lifecycle. Notes can provide extra context and may include anything from a simple text reminder to an image of parts/products, or even a video or document.
>
> 
>
> \
> \
> For more information on how to use the notes feature, refer [Notes and chats](https://docs.zuper.co/Work_Order_Management/Jobs/notes_and_chats#notes) article.
> [accordion] Details
>
> The purchase order details section provides an overview of the purchase order, including
>
> 
>
> | Details | Description |
> | :-: | :-: |
> | Required By | The date on which the order needs to be fulfilled. |
> | PO sent date | The date on which the purchase order was officially sent to the vendor. |
> | Reference No. | An internal or external reference ID used for tracking or cross-referencing purposes. |
> | Payment Term | Indicates the agreed-upon payment terms between your organization and the vendor |
> | Delivery Method | Specifies how the goods will be delivered by the vendor. (e.g., Direct shipment to Job’s site, Deliver to Warehouse, pickup from vendor). |
> | Created By | Displays the name of the user who created the purchase order. |
> | Remarks | Additional comments or notes entered while creating the PO, offering further context. |
> | Vendor Address | Displays two key address types associated with the purchase order: • **Billing Address**: Automatically populated with the vendor’s registered billing address from their profile. This is where invoices and payment-related documents are directed. • **Delivery Address**: Determined by the selected delivery method: o If Direct shipment to Job’s site is chosen, the delivery address will be the job’s service location. o If Pickup from Vendor is selected, the vendor’s pickup address will be shown. o If Deliver to Warehouse is selected, your organization’s default warehouse address will be used. |
> [accordion] PO items
>
> This section displays the requested items in a clear, tabular format, making it easy to review and verify purchase order details. Each row contains the following information:
>
> * **Item** shows the name of the part or product to be purchased.
> * **Vendor SKU/ID** shows the unique identifier or stock-keeping unit assigned to the item by the vendor.
>
> 
>
> * **Requested Quantity** shows the total number of items initially requested.
>
> * **Fulfilled Quantity** shows the number of items that have already been supplied or delivered.
>
> * **Required Quantity** shows the remaining number of items that still need to be purchased. This field is not available when the status is Fulfilled.
>
> * **Unit Purchase Cost** shows the price per unit charged by the vendor.
>
> * **Total** shows the line item total, calculated as Required Quantity × Unit Purchase Cost. This column appears across all PO statuses, from Draft through Paid.
>
> * **Remarks** shows any specific notes, instructions, or clarifications related to the individual line item.
>
> > [!NOTE]
> >
> > **Note:** The **Total** column shows the calculated amount for each line item. The overall PO total shown at the bottom of the table is the sum of all line item totals, ensuring transparency, accuracy in vendor billing, and better internal budgeting control.
> [accordion] Activity
>
> This section captures the log of all activities performed on the purchase order, such as:
>
> * Notes added
> * Status changes
> * Attachments uploaded
> * Comments or approvals
>
> 
>
> This running log helps you trace every interaction with the PO.
> [accordion] Status history
>
> Displays the **complete status lifecycle** of the purchase order in **chronological order**, helping you view each status update along with the timestamp and the user who made the change.
>
> This helps in tracking the PO’s progress from creation to fulfillment.
>
> 
>
> > [!NOTE]
> >
> > Every time you send a PO to a vendor in PDF or XLS format, Zuper saves a copy of the document in the PO's Status History section. This gives you a permanent record of exactly what was shared with the vendor and when.
> >
> > What you can do from document history
> >
> > • View the document inline.
> >
> > • Open it in a new browser tab.
> >
> > • Download it directly to your device.
> >
> > 
> >
> > | **Scenario** | **What is saved** |
> > | :- | :- |
> > | You manually send the PO as separate attachments in PDF and XLS formats, or as either a PDF or an XLS file. | The attachment is saved in document history |
> > | Auto-send is enabled in your settings | Documents are captured as PDF automatically on each auto send |
> > | You send only a hyperlink (no attachment) | A PDF is still generated and saved so you can verify what was shared |
> > | You clone a PO | The cloned PO starts with a fresh document history — previous sends are not carried over |
> >
> > **Note:** For a detailed explanation of the statuses a PO goes through, refer to the [*Purchase Order Status*](https://docs.zuper.co/Purchasing/Purchase-Orders/Purchase-order-status) article.
## Right Panel
The **Right Panel** provides additional contextual information and quick-access links related to the selected Purchase Order (PO). This panel enhances visibility and traceability by consolidating related data in one place.
> [accordion] Vendor Details
>
> Displays key information about the vendor, including:
>
> * Vendor name
> * Contact information (if available)
> * Address
>
> 
>
> This helps you quickly reach out to vendors when needed.
> [accordion] Associated Job/Quote
>
> This section displays any job or quote associated with the current purchase order. It allows quick navigation to the corresponding Job or Quote details, offering clear visibility into which job or customer quote the PO supports.
>
> 
>
> This ensures better coordination between purchasing activities and job execution, improving operational transparency and reducing the risk of misalignment between procurement and service delivery.
>
> **Note**: If the associated job or quote is pending materials from the purchase order, an indication labeled **"Waiting on PO"** will be shown. This indication helps stakeholders track dependencies and manage timelines effectively. A job or quote linked to a purchase order can only be closed when the purchase order status is set to **Draft**, **Cancelled**, **Closed**, or **Fulfilled**.
>
> 
> [accordion] Attachments
>
> This section allows you to upload and manage documents related to the purchase order. It displays all files added, such as:
>
> * Vendor quotes
>
> * Product images
>
> * Delivery slips
>
> * Invoices or other supporting documents
>
> 
>
> > [!TIP]
> >
> > **Tip:** You can preview or download attachments directly from this panel, making it easier to access important information and streamline documentation for audits or reference.
> [accordion] More Actions
>
> * Modify Status - You can modify the existing PO status.
>
> * Edit PO - Modify the purchase order. You can edit the purchase order for the following statuses: **Draft, Submitted, Approved, Sent to Vendor, Vendor Accepted, Vendor Rejected, Partially Fulfilled, and Fulfilled**.
>
> > [!NOTE]
> >
> > Note: If a PO is edited while in the **Vendor Accepted** state, the new PDF sent to the vendor is recorded as a new version in the **Status History** section.
>
> * Clone PO - Make a new copy of your existing PO.
> * Cancel PO - Cancel your current PO.
> * Delete PO - Delete your current PO.
>
> 
>
> | Status | Edit PO? | Other key actions under More Actions |
> | - | - | - |
> | Draft | ✓ Yes | Clone, Cancel, Delete |
> | Submitted | ✓ Yes | Send to Vendor, Clone, Cancel, Delete |
> | Approved | ✓ Yes | Clone, Cancel, Delete |
> | Sent to Vendor | ✓ Yes | Clone, Cancel, Delete |
> | Vendor Accepted | ✓ Yes | Clone, Cancel, Delete |
> | Vendor Rejected | ✓ Yes | Clone, Cancel, Delete |
> | Partially Fulfilled | ✓ Yes | Clone, Roll-up as New PO, Delete |
> | Fulfilled | ✓ Yes | Clone, Close PO, Delete |
> | Invoiced | ✗ No | Clone, Close PO, Delete |
> | Paid | ✗ No | Clone, Delete PO |
> | Closed PO | ✗ No | Clone, Delete |
1. Select the “**Purchase Orders**” module from the left navigation menu.

2. **Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

3. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters.

# Overview
Source: https://docs.zuper.co/Purchasing/Purchase-Orders/Overview
When running a field service business, staying on top of parts, products, and vendor purchases is just as critical as managing jobs. Without a clear process, tracking vendor purchases, monitoring costs, and ensuring the timely availability of parts and products to complete a job can become overwhelming. That’s where Zuper’s **Purchase Orders (PO) feature** comes in. It streamlines the entire procurement process—from request to approval to vendor fulfillment—giving you complete visibility and control over your purchasing operations.
With Purchase Orders in Zuper, you can create, approve, and manage all your procurement needs in one place. You can also create a purchase order directly from a job or quote, ensuring a smooth connection between customer requirements and procurement.
Whether the PO items are added from an associated job or quote, selected from the vendor catalog, or created as a custom line item, the feature ensures that every purchase order is tracked, documented, and associated with the jobs or quotes that require them. This not only improves accuracy but also keeps your field teams supplied with what they need, when they need it.
This feature provides a comprehensive view of your procurement cycle, helping you answer key questions like:
* What PO items and quantities are requested for upcoming jobs and quoted to customers?
* Which purchase orders are pending, approved, or fulfilled?
* How much are we spending on procurement across vendors?
* Are our procurement costs aligned with job and project budgets?
## Prerequisite
This feature is available only on select Zuper plans. To enable it for your account, please contact your account administrator or email us at [support@zuper.co](mailto:support@zuper.co)
## Key Benefits of Zuper’s Purchase Order Feature
1. **Centralized Procurement Management**
Create and track purchase orders status directly from the associated Quotes, Jobs, or Material Requests. Every PO is documented and connected, giving you a clear trail from request to delivery.
2. **Vendor Management**\
Manage and link vendors to your purchase orders with ease. Track vendor approvals and rejections, monitor delivery timelines, and build stronger supplier relationships.
3. **Approval Workflows**\
Set up internal approval processes to ensure that only authorized purchases are made. This adds an extra layer of accountability and prevents overspending.
4. **Cost Transparency**\
Stay on top of your spending by monitoring purchase order amounts, fulfillment status, and outstanding requests. Gain better financial control across jobs and projects.
5. **Seamless Job and Inventory Integration**\
If associated with a job, received items are automatically updated under the job’s details. If linked to inventory, stock levels are updated in real time, ensuring field teams always have the parts they need.
**Next Steps**\
The following guides will help you get started with Purchase Orders in Zuper:
* [Creating a Purchase Order](https://docs.zuper.co/Purchasing/Purchase-Orders/Creating-purchase-order)
* [Understanding Purchase Order Status](https://docs.zuper.co/Purchasing/Purchase-Orders/Purchase-order-status)
* [Managing Purchase Order](https://docs.zuper.co/Purchasing/Purchase-Orders/Manage-Purchase-Order)
# Understanding Purchase Order Status
Source: https://docs.zuper.co/Purchasing/Purchase-Orders/Purchase-order-status
Once a Purchase Order (PO) is created in Zuper, it goes through various stages from initiation to fulfillment. Understanding each status helps track progress, manage procurement efficiently, and take appropriate action at each stage.
This guide outlines the different PO statuses, what they mean, and the actions you can perform at each stage.
## Navigating to Purchase Order Status
To view the status of a purchase order:
1. Click the **Purchasing** module from the left navigation menu and select **Purchase Orders**.

2. A list of existing purchase orders will be displayed, showing key details such as **PO ID**, **Title**, **Status**, **Vendor Name**, **Total Amount**, and more.
3. Select any PO from the listing to open its **Details** page.

4. The **current status** of the PO is displayed prominently at the top of the screen.
## Statuses of a Purchase Order
### 1. Draft
This status indicates that the purchase order has been created but **not yet submitted for approval**.

**Available Actions:**
* **Mark as Submitted** – This moves the PO to the next stage.
* **More Actions** menu (top-right):
1. Edit PO: Update the details of the purchase order.
2. Clone: Create a duplicate of the purchase order.
3. Cancel PO: Mark the purchase order as cancelled.
4. Delete PO: Permanently remove the purchase order from the system.

### 2. Submitted
This status indicates that the purchase order has been submitted and is **ready to be sent to the vendor**.
* Click **Send to Vendor** to send the purchase order details to the vendor in XLS or PDF format.

**Available Actions** (via **More Actions** menu):
* Mark as Sent to Vendor – Update the purchase order status to indicate it has been sent to the vendor.
* Edit PO – Modify the details of the purchase order.
* Clone – Create a duplicate of the purchase order.
* Cancel PO – Change the purchase order status to *Cancelled*.
* Delete PO – Permanently remove the purchase order from the system.

> [!NOTE]
>
> **Note:** This status applies when no approval hierarchy is configured in the organization settings. If an approval hierarchy is enabled, the purchase order will first follow the approval workflow before it can be sent to the vendor. For more details on configuring and managing approval workflows, refer to the [Approval Hierarchy](https://docs.zuper.co/Purchasing/Purchase-Orders/Purchase-order-status#approval-hierarchy%E2%80%93related-statuses) section.
> [!NOTE]
>
> For POs linked to an integrated vendor such as SRS or ABC Supply, **Send to Vendor** is a direct action — no email modal appears. Status changes for these POs are driven automatically by vendor webhooks and do not require a manual trigger.
> [!NOTE]
>
> **Send to Vendor** emails the PO to the vendor as a PDF or XLS. **Mark as Sent to Vendor** only updates the status and does not send any email — use it when the order was already placed outside Zuper (for example, on the vendor's website or by phone). You can then receive items as usual to move the PO to Fulfilled.
**Mark as Invoiced** — Available under **More Actions**. Use this to record that the vendor has issued an invoice for items delivered so far. You can attach the invoice document and view it in the **Status History** panel. This does not move the PO to Invoiced status as a CTA — it is a manual record action only.
### 3. Sent to Vendor
This status indicates that the PO has been shared with the vendor and is now **ready for fulfillment tracking**.

You can initiate the receiving process by clicking the **Receive Items** button. While recording received items, you may need to provide the following details:

* **Receiving Qty** (mandatory): Enter the number of items received from the vendor.
> [!NOTE]
>
> **Note**: With purchase tax enabled for your organization, the Receive Items page shows Pre-Tax Cost and Purchase Tax %. These work together with the Unit Purchase Price/Unit Cost to calculate your actual item cost. See [Purchase Tax](/Inventory_Management/Parts_Services/Purchase-Tax) for how these values update the part/product master.
* **Delivery Location**: Not mandatory if the delivery method is **Direct Shipment** or **Vendor Pickup**. If the delivery method is **Warehouse**, the location will be prefilled. For custom line items, location selection is not available as these items are not linked to a predefined inventory location.
* **Serial No.**: Only applicable if a location is selected. The count should match the quantity received (for example, if two items are received, enter two serial numbers such as “4, 5”).
If a location is selected, all received items are automatically recorded as inward transactions and added to the Parts Inventory in the Parts & Services module. If no location is selected, the inward transaction will not be recorded in the module.
When a line item on a purchase order includes an option — such as a color or size — that option now appears in the PO PDF. The **Options** column is visible in the PDF only when at least one line item has an option selected. If you edit the PO after sending it to a vendor, the next PDF you send reflects the updated options. PDFs shared via **Print → Share via email** also include the latest options, whether sent before or after the vendor send.

> [!NOTE]
>
> **Note**: This applies to Zuper's internal PO template only. Custom or third-party templates are not affected.
**Available Actions (via More Actions menu):**
* Clone
* Cancel PO
* Delete PO

The **Status History** panel on a PO details page logs every status change with a timestamp, the user who made it, and a versioned PDF or XLS document where one was generated. Zuper captures a document snapshot automatically each time you edit the PO or send it to a vendor — you do not manage versions manually. If the PO was sent by email with a link instead of an attachment, that link is preserved in the panel so you have a complete audit record of what the vendor received.
> [!NOTE]
>
> Note: To access the panel, go to **Purchasing** → **Purchase Orders** → select a PO → **Status History**. Select the file name or download icon on any entry to open or save the document for that version.

### 5. Partially fulfilled
This status means only some items in the purchase order have been received from the vendor. The remaining items are still outstanding.
**Available actions**
* **Receive Items** — Wait for the remaining items and receive them together when they arrive.
* **Roll-up Remaining as New PO** — Go to **More Actions** and select **Roll-up Remaining as New PO** to create a new purchase order for the outstanding items. When you do this, the **original PO** automatically moves to Fulfilled status.
> [!NOTE]
>
> A job linked to this PO cannot be closed while the PO is in **Partially Fulfilled** status. Once the roll-up items are created as a new PO, the linked job can be closed.
All status transitions are recorded in both the **Status History** and **Activity** sections of the PO.

**Available Actions:**
* **Receive Remaining Items in Bulk**: Wait until all pending items arrive and receive them together using the **Receive Items** button.

**Mark all as received** — Marks all items on the PO as received in a single action, moving the PO to Fulfilled status.

* **Roll-up Remaining as New PO**: From the More Actions menu, select **Roll-up Remaining as New PO** to generate a new purchase order for the pending items.

* Clone
* Delete PO
> [!TIP]
>
> **Tip:** After rolling up and creating the new PO, ensure the current PO is closed to prevent discrepancies in associated Jobs or Quotes.
### Identifying a rolled-up PO
When a new PO is created from a roll-up, Zuper marks it with a **Rolled-Up PO** icon next to the PO number. This icon appears on the:
• **PO details** page
• **PO listing** page
• **Vendor PO** page
• Associated **Jobs** and **Quotes**
This approach ensures workflow continuity across associated modules, such as Jobs and Quotes, while keeping records clean and accurate.
> [!NOTE]
>
> Note: When you hover over the Rolled-up PO icon, you will see the number of the parent PO from which the rolled-up PO came.
>
> Click on the Rolled-PO icon to open the parent PO in a new tab.
>
> If the parent PO is deleted, the current Rolled-up PO blue icon will be grayed out, and you will be able to hover and see only the parent PO number; you will not be able to view the parent PO.

### 6. Fulfilled
This status indicates that all items on the purchase order have been received from the vendor. A PO reaches **Fulfilled** status in two ways:
* All items are received in full via **the Receive Items process**.
* A roll-up PO is created from a **Partially Fulfilled** PO — the original PO moves to **Fulfilled** status automatically.

**Note:** Once a PO is marked as **Fulfilled**:
* Any associated Jobs or Quotes will automatically receive the items from this PO.
* This ensures a smooth handover of materials and keeps your supply chain records accurate and up to date.
### 7. Invoiced
This status indicates that the vendor has issued an invoice for the delivered items and it has been recorded against the purchase order. You can attach the invoice document directly to this status entry and view it in the **Status History** panel.
You can now select **Mark as Paid** to complete the financial process.
**Edit rules at this status:**
* Requested Qty is editable.
* Inline edits are allowed for Receiving Qty, Price, Location, and Remarks.
* You cannot reduce Requested Qty below the fulfilled quantity.
Adding a new line item moves the PO back to *Partially Fulfilled*\*.
* Removing a line item that is partially fulfilled is not allowed.

When marking a PO as paid, a remarks dialog box will appear, allowing you to record the payment amount and any additional comments (optional).

### 8. Paid
This status indicates that payment for the vendor invoice has been successfully completed. All financial obligations related to the purchase order have now been settled.
> [!WARNING]
>
> **Warning**: No edits are allowed at this status. Adding, removing, and editing line items are all locked. A warning appears if you attempt to make changes.

## Editing a purchase order
Zuper uses a two-tier edit model for purchase orders. The type of edit available to you depends on the current status of the PO.
### Hard edit
A hard edit lets you modify the full PO details — including primary details, line items, and vendor information. It is available via the **More Actions** menu at the following statuses: Draft, Submitted, Approved, Rejected, and Vendor Rejected.
> [!NOTE]
>
> Selecting **Edit PO** from More Actions at any of these statuses moves the PO back to **Draft**. All prior status history is retained.
### Line item edit
A line item edit lets you add or modify individual line items without moving the PO back to Draft. It is available across most statuses up to and including Invoiced (before Paid). The PO status stays intact except in the following cases:
* Adding a new line item when the PO is in **Fulfilled** or **Invoiced** status moves the PO back to **Partially Fulfilled**.
| Status | Requested Qty | Add line item | Remove line item | Inline edits |
| - | - | - | - | - |
| Draft | Editable | Allowed | Allowed | Allowed |
| Submitted | Editable | Allowed | Allowed | Allowed |
| Approved | Editable | Allowed | Allowed | Allowed |
| Rejected | Editable | Allowed | Allowed | Allowed |
| Vendor Rejected | Editable | Allowed | Allowed | Allowed |
| Partially Fulfilled | Cannot go below fulfilled qty | Allowed | Not allowed for partially fulfilled items | Allowed |
| Fulfilled | Cannot go below fulfilled qty | Allowed — triggers rollback to Partially Fulfilled | Not allowed for partially fulfilled items | Allowed |
| Invoiced | Cannot go below fulfilled qty | Allowed — triggers rollback to Partially Fulfilled | Not allowed for partially fulfilled items | Allowed (Receiving Qty, Price, Location, Remarks) |
| Paid | Locked | Locked | Locked | Locked |
## Additional Statuses Based on Organization Settings
Some purchase order (PO) statuses appear conditionally, depending on how your organization has configured **Approval Hierarchy** and **Vendor Approval** settings.
These settings can be accessed under:\
**Settings -> Modules -> Purchasing -> General Settings**

### Approval Hierarchy–Related Statuses
If your organization has set up or configured an approval hierarchy, a submitted PO will move through the following statuses:
**Configuration Path:**
* **Enable Approval Hierarchy:** *Settings -> Modules -> Purchasing -> General Settings -> Choose Approval Hierarchy*

* **Create & Manage Hierarchies:** *Settings -> Miscellaneous -> Approval Hierarchy*

**1. Awaiting Approval**
Indicates the PO is pending review by one or more approvers as defined in the configured hierarchy. Relevant approvers are notified via email and prompted to take action.
**Approver Actions:**
* Approve or reject the PO directly from the email notification.
* Log in to the Zuper web application to approve, reject, and/or add comments.
All approval and rejection comments are recorded in the **Activity** section for tracking and transparency.

**Available Actions (via More Actions menu):**
* Mark as Approved / Rejected– Approve or decline the PO. ( Available to Admin users)
* Clone – Create a duplicate PO.
* Cancel – Mark the PO as Cancelled.
* Delete – Permanently remove the PO from the system.
**2. Approved**
Indicates the PO has been approved internally by all required approvers and is ready to be sent to the vendor.
> [!NOTE]
>
> **Note:** No further edits are allowed once the PO is in this status.
**Available Actions (via More Actions menu):**
* Mark as Sent to Vendor – Update the status to indicate the PO has been sent.
* Clone – Create a duplicate PO.
* Cancel PO– Mark the PO as Cancelled.
* Delete PO– Permanently remove the PO from the system.

**3. Rejected**
Indicates the PO has been reviewed and declined by an approver.
> [!NOTE]
>
> **Note:** The PO cannot proceed to vendor communication unless it is revised and resubmitted. Rejection comments are recorded in the **Activity** section for transparency.
**Available Actions (via More Actions menu):**
* Edit PO – Update the PO and resubmit for approval.
* Clone – Create a duplicate PO.
* Cancel PO – Mark the PO as Cancelled.
* Delete PO – Permanently remove the PO from the system.

### Vendor Approval–Related Statuses
If your organization has enabled vendor approval after a purchase order (PO) is sent, you can record the vendor’s response. In such cases, the following statuses may appear:

**Configuration Path:**\
**Enable Vendor Approval**: *Settings -> Modules -> Purchasing -> General Settings -> Require Vendor Approval -> Toggle "**Yes**"*

**1. Vendor Accepted**
Indicates the vendor has reviewed and accepted the PO. You can now proceed to fulfillment tracking using the **Receive Items** option.
**Available Actions (via More Actions menu):**
* Clone – Create a duplicate PO.
* Cancel PO – Mark the PO as Cancelled.
* Delete PO – Permanently remove the PO from the system

**2. Vendor Rejected**
Indicates the vendor has reviewed and declined the PO. If provided, the rejection reason will be visible in the **Activity** section.
**Note:** During this stage, the PO will not proceed to fulfillment.
**Available Actions (via More Actions menu):**
* Clone – Create a duplicate PO.
* Cancel PO – Mark the PO as Cancelled.
* Delete PO – Permanently remove the PO from the system

> [card] Status Flow Summary
>
> * **Approval Hierarchy** enables the PO to move through the following statuses: *Awaiting Approval → Approved / Rejected.*
> * **Vendor Approval** enables the PO to move through the following statuses: *Vendor Accepted / Vendor Rejected.*
> * If neither setting is configured, the PO moves directly from *Submitted → Sent to Vendor → Partially Fulfilled* or *Fulfilled → Invoiced → Paid* based on the items received and payment recorded.
# Vendors
Source: https://docs.zuper.co/Purchasing/Vendors/Vendors
# Overview
Zuper's **Vendor Management** module helps streamline how businesses manage vendors, their product catalogs, and related transactions. From maintaining contact and banking details to assigning delivery preferences and organizing product SKUs, this feature centralizes all essential vendor-related data in one place.
## Pinned filters
**Navigation**: *Vendors -> Filters -> Pinned Filter*
Pin up to 3 filters in any module.
1. Select the “**Vendor Management**” module from the left navigation menu.

2. **Pin Filters for Quick Access**
* Once your filters are set, click the **Pin Filters** button in the dialog box to save them as pinned.
* Pinned filters appear in the dialog box's "**Pinned Filters**" section, allowing you to apply them with one click in future sessions.

3. To Unpin the filter:
* To unpin, select a pinned filter and click **Remove**.
* To apply pinned or default filters, open the dialog box and select them.
* Use **Clear All** to remove active filters.

## 1. Primary Details
* **Vendor Name**: Enter the name of the vendor.
* **Contact Name**: Enter the primary contact person’s name.
* **Display Name**: Enter a recognizable name for the vendor. This name will be displayed across the platform.
* **Vendor Email**: Enter the vendor's email address.
* **Vendor Work No**: Enter the vendor's work phone number.
* **Mobile Number**: Enter the vendor’s mobile contact number.

## 2. Transaction Details
Delivery Method: Choose any delivery method: direct shipment, delivery to warehouse, or pickup address.
When adding or modifying a vendor, indicate their preferred delivery method.
* **Direct Shipment to Job’s site**: If the purchase order (PO) is associated with a job, the delivery address will automatically populate with the job’s service address.
You must choose a warehouse or provide a custom address if no job is linked.
* **Deliver to Warehouse**: If the assigned technician has a designated product location, it will be prefilled. Otherwise, select from the available warehouse locations.
* **PickUp Only**:The vendor won’t deliver the parts to a warehouse or job site. Instead, you’ll need to pick them up at a designated location. If this option is selected, a dialog box appears where you can enter the pickup address.
* **Lead Time**: This represents the days required for the part to become available at the warehouse or designated location. Essentially, it reflects the time it takes for the vendor to fulfill and deliver the part to the agreed-upon delivery location.
* **Payment Term**: Select the payment term (e.g., a two-month term). The term is defined under the organization settings.
* **Vendor Tax ID**: Enter the vendor's tax identification number.
* **Default Tax Rate**: Choose the applicable tax rate.

## 3. Product Catalog
You can include one or more SKUs (variants like size, color, or model) for each product and input the vendor-specific cost associated with each SKU.
* Click the "**+ Add**" button to add products associated with the vendor. A dialog box will appear. Choose and add the Parts or Products and click “**Next**.”



Ensure all product details are accurately entered. Parts in the product catalog can be managed in two ways. If variants are not tracked in the master catalog, they can be managed directly under the vendor details. Alternatively, if the business requires all parts to be maintained in the master catalog, the Vendor SKUs will remain consistent across both the product catalog and the master.

* Parts in the product catalog can be managed in two ways. If variants are not tracked in the master catalog, they can be managed directly under the vendor details. Alternatively, if the business requires all parts to be maintained in the master catalog, the Vendor SKUs will remain consistent across both the product catalog and the master.
**Mapping items with the vendor.**
* **Vendor Side**: Add items with multi-select [options](https://docs.zuper.co/Inventory_Management/Parts_Services/Create_New_Part_Service#3-options)
When adding a new part or product to a Vendor, you can select the available [**Options**](https://docs.zuper.co/Inventory_Management/Parts_Services/Create_New_Part_Service#3-options) configured for that specific item.

## 4. Addresses
* Billing Address: Add the billing address using the "**Add Billing Address**" option.
* Pickup Address: Use the "**Add Pickup Address**" option to add the pickup address. When the delivery method is set to Pick Up only, providing a pickup address is mandatory.
Always use “**Pick from map**” option.
## 5. Bank Details
Input the vendor's bank details under the "**Bank Details**" section.
**Name on Account** - The account holder's full name.
**Account Number** - Enter the vendor’s bank account number.
**Bank Name** - Name of the vendor’s bank.
**Branch Identifier** - Typically the routing number or branch code.
**Remarks** - Notes or description about the account.


## 6. Attachments
* Upload relevant documents or files using the "**Add Attachment**" option.

* Click “**Save Vendor**” to save the vendor details.

* Click “**Create Vendor**” to create the new vendor.

* The new vendor is created successfully.

**Impact to Parts and Services:**
The vendors can be selected based on the details of the part. You can have multiple vendors that supply a product. These can be added when you create or a new part or add details to an existing part/product. This would not be available for the product type services or Labor. You could also select a preferred vendor for each part. While creating a PO, the vendor field would be prefilled with the preferred vendor, but the user can choose to select a different vendor if need be
# Vendor Listing Page:
The Vendor Management Module Listing Page layout in Zuper includes view management, column selection, views, and saving customized views. This process is performed directly on the module’s listing page.
## Default Listing Behavior
The system retains its existing default listing behavior, ensuring that pre-set configurations or default views are preserved. When you first access the Vendor Management Module Listing Page, you’ll see the default view with columns such as Vendor ID, Vendor Name, Contact, Vendor Email, Vendor Catalog, Vendor Contact Number, Vendor, Lead Time, Created On, and Created By. main
### Create View Configuration
Selecting Columns
You can choose which columns to display to focus on relevant data:
1. Select the “**Vendor Management**” module from the left navigation menu. You can view the listing page.

2. From the “ **Views** ” list, click **“+Create a view.** ”

3. A “**Create View**” dialog box appears.
* View Name (**Mandatory**) – Enter the view name.
* Share with - Select any one of the options (User, Team), and you can add the relevant users.
* Visibility to all users – Toggle on to make this view visible.

4. Once you click “**Create**,” the Columns sidebar appears, showing “**Available Columns**” and “**Displayed Columns**.” To add a column, drag it from the “**Available Columns**” list on the left to the “**Displayed Column**s” list on the right. You can click “**Continue**.”

5. To remove a column, drag it from the “**Displayed Columns**” list back to the “**Available Columns**” list or click the - next to the column name. Click Continue to apply the changes.

6. If you not wish to add any filter, click “**Skip and Save**” to create the view.

7. To add a filter, click “**+Add**.”

8. The new view has been set successfully. You can view the filter created and its name from the view list.

### Update View
An update view allows you to modify the current display settings of the "**Vendor Management**" section. After making changes, you can save the updated configuration to the existing one or use it as a new view by naming it.
1. Add/remove the existing columns and we can update the view for the existing view.

2. The view is updated successfully.

### To save as new view:

A “**Create View**” dialog box appears.
* View Name (**Mandatory**) – Enter the view name.
* Share with - Select any one of the options (User, Team), and you can add the relevant users.
* Visibility to all users – Toggle on to make this view visible.

3. The view is updated successfully.

4. Click “**Reset View**” to reset the current view.

5. The view is updated successfully.

### Setting Permissions for Views
**Edit Permissions**
Users with edit permissions can modify the layout:
* They can add/remove columns, reorder them, and adjust views as described above.
* If permission is given, changes can be saved as a new view or overwritten as an existing one.
**View Permissions**
Users with view-only permissions can see the layout but cannot make changes:
* They can view the customized columns and filters but cannot edit them. To ensure consistency for viewers, they can save them as a new “**View**.”
**Make changes to the view:**
* **Rename**: This option allows you to change the view's name.
* **Visibility**: This lets you adjust who can see the view. Options include sharing with a user or team or keeping it private (“Only Me”), as well as toggling visibility for all users in Zuper (as shown in the “Create a View” dialog in prior images).
* **Clone**: This function creates a copy of the view, allowing you to modify the duplicate without affecting the original.
* **Delete**: Removes the view entirely. Since this is a custom view, deleting it would revert the listing to the default view or another saved view. Only the created user can delete the view.

The Vendor Management Module Listing Page in Zuper allows for flexible layout customization directly on the listing page. You can select and reorder columns, apply views, save customized views, and set permissions to ensure the right level of access for your team. Use the steps above to tailor the view to your workflow and save it for future use.
# Managing Vendor Details
The details page allows you to view and manage the selected job details. Its three-column layout provides quick access to information and actions within each panel.
1. Click any of the vendors to view the details page.

## Left Panel
The left panel contains vendor-related details such as Call, Mail, and Add Note. Below this is the quick actions bar, which provides contextual action buttons, including options such as Details, Product Catalog, Notes, and Activity.
Details:
1. Click the “ **Details** ” button to view the Vendor’s details.

2. Select the “ **Product Catalog** ” to view the catalog item details.

3. Select the “ **Notes** ” section to add and manage the notes.

4. Click the “ **Activity** ” section to view the list of actions.

## Right panel
You can view the bank details and add attachments.

## More Actions
On the details page, in addition to editing details, you can also perform various actions, such as sending an email or SMS or deactivating the vendor.
The “**Delete**” option is only available to admins by default. To enable Delete access for users with a Team Leader role, you can create a custom access role and turn on the “**Delete Job**” permission in the Jobs module. Once enabled, use the delete option under “**More Actions**” to delete the vendor.

Once deactivation is done, you can delete or activate the vendor again.
Zuper’s Vendor Management module offers a complete toolkit for managing vendor data effectively. It reduces manual effort, ensures vendor accountability, and aligns vendor interactions with business workflows. By providing flexibility in configuration and visibility, Zuper ensures that teams can collaborate more efficiently when sourcing, ordering, or tracking materials from external vendors.
## **Best Practices**
1. **Standardize Vendor Naming**\
Use a consistent naming format for vendors to avoid duplicates and improve searchability.
2. **Set Preferred Vendors**\
For each part or product, assign a preferred vendor to speed up PO creation and ensure consistency.
3. **Use Pickup Locations Judiciously**\
When using "PickUp Only" as the delivery method, always provide a precise pickup address using the “Pick from map” option.
4. **Update Lead Times Regularly**\
Keep lead times accurate to prevent delays in planning and field execution.
5. **Leverage View Customization**\
Create views based on role-specific needs (e.g., Procurement Team vs. Finance Team) to improve focus and productivity.
6. **Audit Attachments and Notes**\
Regularly review notes and uploaded documents to ensure all vendor records are current and complete.
7. **Apply Permissions Thoughtfully**\
Use role-based permissions to ensure sensitive details (e.g., bank info) are only accessible by authorized users.
***
## **FAQs**
**Q1: Can I assign multiple vendors to a single product?**\
Yes. You can associate multiple vendors with a product and also define one as the preferred vendor for auto-selection during PO creation.
**Q2: What happens if no job is linked to a PO with Direct Shipment?**\
If no job is linked, you’ll be prompted to choose a warehouse or enter a custom delivery address manually.
**Q3: Is it mandatory to provide a pickup address for "PickUp Only" delivery?**\
Yes. When this delivery method is selected, entering a pickup address is mandatory.
**Q4: Can I restrict who sees or edits a custom view?**\
Yes. You can control visibility by sharing views with specific users or teams and toggling public access.
**Q5: Are vendor SKUs always synced with the master product catalog?**\
Only if the business mandates centralized control. Otherwise, SKUs can be managed directly in the vendor catalog.
**Q6: How do I delete a vendor?**\
Only Admins (or Team Leaders with the right permission) can delete a vendor via the “More Actions” menu. Deactivation must be done first.
**Q7: Can I update product costs per vendor?**\
Yes. Each vendor's SKU entry can have its own cost, which helps track pricing variations.
# Accept or Reject a Work Order
Source: https://docs.zuper.co/Purchasing/Work Orders/Accept reject work order
When your business sends work to a subcontractor, Zuper uses a two-stage process to make sure everyone agrees before work begins. An internal approver inside your Zuper account reviews and approves the work order first. Then, the subcontractor receives an email with a link to review, sign, and formally accept or reject the order on the subcontractor portal.
Once a subcontractor accepts the work order, an **Uploaded Photos** tab becomes active on their portal. They can use it to upload photos of the completed work, giving your team a clear on-site record. Those photos then appear inside Zuper — on the work order and on the related job gallery — so your internal team always has full visibility.
This article covers each stage of the process: internal approval, subcontractor review and sign-off, photo upload, and where those photos appear inside Zuper.
***
## Internal approval
An internal approver — an admin or team lead must review and approve the work order inside Zuper before Zuper sends it to the subcontractor.
### Approve a work order internally
1. Select **Purchasing** from the left navigation menu and choose **Purchase Orders**.
2. Select the work order you want to approve. The work order detail page opens.
3. Review the work order details to confirm everything is correct.
4. Select **Mark as Approved** in the top-right corner of the page.
The work order status updates and Zuper sends an email notification to the subcontractor with a link to review the order.

> [!NOTE]
>
> The **Approved** status appears only if your organization has an approval hierarchy configured in **Settings → Modules → Purchasing → General Settings**. If no approval workflow is set up, the work order moves directly from Submitted to the sending workflow.
***
## Subcontractor review and acceptance
The subcontractor receives an email from Zuper with the work order attached as a PDF and a link to review and accept or reject the order on the subcontractor portal.
### Open the work order from the email
1. Open the email from Zuper in your inbox.
2. Select the **View to approve Work Order** link in the email body.

The subcontractor portal opens in your browser and displays the full work order details.
### Review the work order
Before accepting or rejecting, review all the information on the portal carefully. The portal includes the following tabs:
| Tab | What it shows |
| - | - |
| **Details** | work order details, work date, location, and contact information |
| **Measurements** | Site measurement data shared by the business |
| **Reference Photos** | Site photos shared by the business for reference |
| **Uploaded Photos** | Becomes active after acceptance — use it to upload completed work photos |
You can also select **Download** to save a copy of the work order PDF for your records. This button appears once the status is set to accepted.

***
### Accept the work order
1. Select **Accept** in the top-right corner of the portal page. The **Accept work Order** dialog opens.

2. Draw your signature in the signature area using your mouse or touchscreen.
3. Select the checkbox to confirm you agree to the Terms and Conditions outlined in the work order.
4. Select **Accept** to submit your signature.

> [!NOTE]
>
> You must sign and select the Terms and Conditions checkbox before you can complete the acceptance. The **Accept** button remains inactive until both are done.
5. Select Done to close the confirmation.

A confirmation screen appears showing your **Signature Summary**, including the work order number, your company name, and the date and time of signing.
The work order is now accepted. Your internal team receives a notification, and the **Uploaded Photos** tab becomes active on the portal.
> [!NOTE]
>
> Two settings in Zuper affect how the subcontractor portal behaves when the email link is opened.\
> \
> **Require Vendor Approval:** If your business has disabled this setting, the email link still takes you to the subcontractor portal to view the work order details. However, the **Accept** and **Reject** buttons do not appear. Contact your business to confirm how they want you to proceed.\
> \
> **Auto-send PO to vendor after approval:** If your business has enabled this setting, Zuper automatically sends the work order to the subcontractor as soon as it is approved internally — no manual send is required. If you receive the email unexpectedly, this setting is likely on.
***
### Reject the work order
If the work order details are not correct, you can reject it. Your business receives a notification to review and reissue the order.
1. Select **Reject** in the top-right corner of the portal page.
2. Confirm the rejection when prompted.

The work order returns to the business for review, and the WO status moves automatically to Subcontractor Rejected inside Zuper. Contact the person who sent you the order to discuss what needs to change.
> [!WARNING]
>
> If you reject the work order by mistake, contact the business directly so they can reissue it.
***
## Upload completed work photos
After you accept the work order, the **Uploaded Photos** tab becomes active on the subcontractor portal. Use it to upload photos of the completed work as evidence of completion.
### Upload photos to a work order
1. Return to the subcontractor portal using the original link from your email, or open a new link if the business shares one.
2. Select the **Uploaded Photos** tab at the top of the portal.
3. Select **Upload Photos** in the top-right corner. The **Add Attachments** dialog opens.

4. Select **Upload Photos** inside the dialog to browse and select files from your device.
> [!NOTE]
>
> Supported file types: image and video files. Maximum file size per upload: 20 MB.
5. Review the selected files shown in the **Selected** section of the dialog. To remove a file before saving, select the **X** on its thumbnail.
6. Select **Save and Close** to upload the photos.

The photos are saved and appear in the **Uploaded Photos** tab. The count next to the tab name updates to reflect the number of uploaded files.
> [!TIP]
>
> You can return to the portal and upload more photos at any time after acceptance, as long as the work order remains active.
***
## Where to find uploaded photos in Zuper
Once a subcontractor uploads photos through the portal, they become visible in Zuper in two places, so your internal team always has a complete record of the completed work.
**Work order attachments** — The uploaded photos appear in the **Attachments** section of the corresponding work order detail page. Your team can view, download, or reference them directly from there.
**Job gallery** — The photos also appear on the related job's **Gallery** page in a dedicated album named **work Order – \[WO Number] Work Photos**. This keeps all site evidence organized by work order, making it straightforward to review completed work alongside other job photos.
***
## FAQs
> [accordion] What happens after I accept the work order?
>
> Zuper notifies your internal team that the work order has been accepted. The **Uploaded Photos** tab becomes active on the portal so you can upload photos of the completed work.\
> \
> The signature summary — including the work order number, your company name, and the time of signing — is recorded and stored against the work order. Zuper also sends a confirmation email to the Zuper user or admin with a PDF attachment containing the full order details
> [accordion] Can I accept or reject a work order after the link expires?
>
> The approval link in the email might expire depending on your business settings. If the link no longer works, contact the business that sent the work order and ask them to resend it.
> [accordion] I do not see the Measurements or Reference Photos tabs. Why?
>
> There are two possible reasons for this.\
> \
> The business might not have added any measurements or reference photos to the work order. If no data of that type exists, the tab does not appear.\
> \
> Alternatively, the business might have added measurements or photos but left the option to share them with you unselected when they sent the work order email. The data exists in Zuper but was not included in what was shared with you.\
> \
> In either case, contact the business to confirm what has been shared and ask them to resend the work order if needed.
> [accordion] Can I upload photos before I accept the work order?
>
> No. The **Uploaded Photos** tab becomes active only after you accept the service order. You must complete the acceptance and signature process first.
> [accordion] I accidentally rejected the work order. What should I do?
>
> Contact the business that sent the work order. They can review and reissue it so you can accept it again.\
> \
> If the issue continues, contact [Support](mailto:support@zuper.co).
***
## Related articles
* [Creating work orders](/Purchasing/Work%20Orders/Creating%20work%20orders)
* [Work order status](/Purchasing/Work%20Orders/Work%20order%20status)
* [Subcontractors](/Purchasing/Work%20Orders/Sub-Contractors/Sub-Contractors)
* [Creating a purchase order](/Purchasing/Purchase-Orders/Creating-purchase-order)
* [Understanding purchase order status](/Purchasing/Purchase-Orders/Purchase-order-status)
# Creating Work Orders
Source: https://docs.zuper.co/Purchasing/Work Orders/Creating work orders
A work order keeps subcontractor work visible and accountable. When you raise one in Zuper, the job link, subcontractor, scope, and cost are all in one place — giving you a clear record of what was commissioned, who is doing it, and where the work stands at every stage.
Use this article to create a work order, add items, and manage it from start to finish.
**Navigation**: *Purchasing* → *Purchase Orders* → *+ New* → *Work Order*
> [!NOTE]
>
> **Plan availability**: To enable this feature, contact your account administrator or email [support@zuper.co](mailto:support@zuper.co).
## Before you begin
Make sure the following are in place before you create a work order:
* The **Purchase Orders** module is enabled for your account.
* The subcontractor is added under **Vendors** with complete contact and address details.
* The job you want to associate with the work order exists in Zuper.
***
## Create a work order
**Open the work order form**
1. Select the **Purchasing** module from the left navigation menu and choose **Purchase Orders**.
2. Select **+ New** in the top-right corner. A dropdown appears with two options.
3. Select the **work Order**. The **New Work Order** form opens.

***
**Add an association**
The **Association(s)** section links the work order to an existing job. This is how Zuper connects the subcontractor's work to your project record.
1. In the **Association(s)** section at the top of the form, select **+ Add**.
2. Search for and select the job you want to link to this work order.
Once the job is linked, proceed to the next section to enter the primary details.

***
**Fill in the primary details**
1. Review the **Work Order Title** field. If a job is associated, this field pre-fills with the job name. If no job is associated, enter a clear, descriptive title manually.
> [!TIP]
>
> Associate a job before filling in other details. Zuper automatically pre-fills several fields, saving time and reducing errors.
2. In the **Select Sub Contractor** field, choose the subcontractor from your vendor list. Only active vendors appear here. When you select one, their contact details and address automatically populate the right panel.
> [!NOTE]
>
> If the subcontractor has not been added to Zuper yet, you can create them directly from the side sheet. Select **+ Quick Create** at the bottom of the vendor list, enter their details, and save. The new subcontractor becomes available to select immediately.
3. In the **Work Order Date** field, enter the date the subcontractor is scheduled to perform the work.
* If a job is associated, this field pre-fills with the job's start date.
* If no start date is set on the job, Zuper uses the job's due date instead.
> [!NOTE]
>
> A work order cannot be created without associating a job.
4. From the **Work Order Slot** list, select the preferred time of day — for example, **Morning** or **Afternoon**.
5. In the **Reference Number** field, enter an optional internal or vendor-specific reference ID.
6. From the **Payment Term** list, select the applicable payment agreement.
7. From the **Template** list, select the template for the work order PDF.
> [!NOTE]
>
> Keep the selection as **Choose Template** to use Zuper's built-in default format — this is the recommended option for work orders. If your organization has created a custom template, select it from the list. The **Default Template** option is intended for purchase orders and should not be selected for work orders.
8. In the **Remarks** field, enter any internal notes relevant to this work order. These notes are visible on the work order record.
> [!NOTE]
>
> **Addresses** \
> The **Service Address** and **Billing Address** in the right panel are automatically pulled from the associated job and the selected subcontractor. Select the pencil icon next to each address to edit them.
***
**Add WO items**
WO items are the services or labor tasks you are commissioning the subcontractor to perform. Add them from your existing catalog, or enter a custom item for anything not in the catalog.
1. Scroll down to the **WO Items** section.
2. Select **+ Add**. A dropdown appears with two options:
* **Line Item** — Select from your existing services.
* **Custom Line Item** — Enter a one-off item that is not in your inventory.
> [!TIP]
>
> You can select multiple items at once. Use the filters at the top of the modal to narrow results by service type, trade, or category.
> [!NOTE]
>
> If a job is associated with this work order — or if the WO was created directly from a job — services from that job carry forward automatically into the **WO Items** section.
>
> Services that are part of a **Bundle**, **Section**, or **Item Group** also appear as individual line items.

After adding items, you can bulk-select them and remove them using the bulk action controls at the top of the section.
***
**Viewing WO items**
Once added, all WO items appear in a table with the following columns:

* **Category** shows the trade or service category of the item, such as Roofing or Electrical.
* **Qty** shows the quantity or number of hours for the item.
* **Unit Purchase Cost** shows the rate charged by the subcontractor, per unit or per hour.
* **Total** shows the line item total, calculated as Qty × Unit Purchase Cost. This column appears across all WO statuses, from Draft through Paid.
> [!NOTE]
>
> **Note**: The **Total** column shows the calculated amount for each line item. The overall WO total shown at the bottom of the table is the sum of all line item totals.
To edit or remove a line item, select the ellipsis (⋯) icon under the **Actions** column next to the item, then select **Edit** or **Remove**.
***
**Complete custom fields**
If your organization has configured custom fields for purchase orders, those same fields apply to work orders. Scroll to the **Custom Fields** section and complete any field marked as required before saving.
***
## Right-side panel
The right-hand panel provides three additional sections to enrich the work order before you send it to the subcontractor.
**Measurements** \
Record site measurements relevant to the job. The subcontractor can view these on the portal when you choose to include them while sending.
**Job site photos** \
Attach reference photos from the job site. These give the subcontractor visual context before they begin work. You can choose whether to include them when you send the work order.
**Attachments** \
Upload supporting documents — drawings, specifications, contracts, or other files the subcontractor needs. Select **+ Add Attachments** and choose files from your device.

> [!NOTE]
>
> Files added in **Attachments** also appear in the email configuration dialog box when you send the work order. You can choose to include or remove them before sending.
***
## Left-side panel
Once the work order is saved, the left-side panel gives you access to four sections that support the full WO lifecycle.

| Section | What it shows |
| - | - |
| **WO items** | All services and labor tasks added to the work order. Review and manage line items from here after creation. |
| **Notes** | Internal notes added at any point in the lifecycle. Notes are visible to your team and are not shared with the subcontractor. |
| **Activity** | A timestamped log of every action taken on the work order — including status changes, edits, and communications. |
| **Status history** | The full audit trail of every status change: who made it, any remarks recorded at that stage, and any documents attached. Select any entry to download attached files. |
***
## Save the work order
Once you have filled in all required details and added your WO items, you have two options:
* **Save as Draft** — Saves the work order without submitting it. Use this if you need to review or complete the details later.
* **Save and Submit** — Saves the work order and immediately moves it to **Submitted** status, ready for approval or sending workflow.

***
## Work order creation from job, quote, and subcontractor
### Create a work order from the Subcontractor
From the existing subcontractor details page, from the work orders tab, select "**+ Create New WO**" to create a new work order.
**Navigation**: *Subcontractors* → *Work Orders* → *+ Create New WO*
1. Go to the **Vendors** module from the left navigation menu and select the subcontractor.
2. Select the **Work Orders** tab on the subcontractor details page.
3. Select **+ Create New WO** in the top-right corner of the work orders list.
4. Complete the work order form and save.

The new work order appears in the **Work Orders** tab. The status summary bar at the top of the tab updates to reflect the new total.
### Create a work order from a job
**Navigation**: *Jobs* → *\[Job name]* → *Assets Associated* → *Work Order*
1. Go to the **Jobs** module from the left navigation menu and open the job.
2. In the right-side panel, locate **Purchase Orders**.
3. Select the **+** icon next to **Purchase Orders**.
4. From the menu that appears, select **Work Order**.
5. Complete the work order form and save.

The work order is created and linked to the job. You can view it under **Assets Associated** on the job details page.
### Create a work order from a quote
**Navigation**: *Quotes* → *\[Quote name]* → *New* → *Work Order*
1. Go to the **Accounting** module from the left navigation menu and select **Quotes**.
2. Open the quote you want to create a work order for.
3. Select **New** in the top-right corner of the quote details page.
4. From the dropdown menu, select **Work Order**.

5. Complete the work order form and save.
The work order is created and linked to the quote.
## What happens next
Once the work order is created, it enters the status workflow. You advance the work order manually at each stage from the work order detail page.
```text theme={null}
Draft → Submitted → Approved / Rejected → Sent to Subcontractor
→ Subcontractor (Accepted /Rejected) → Work Completed → Paid → Closed / Canceled
```
> [!NOTE]
>
> Zuper does not automatically advance the status — except when the **Automatically Send WO to Subcontractor after Approval?** toggle is enabled in your Purchasing settings. When that setting is on, Zuper sends the work order to the subcontractor automatically as soon as it is approved, without requiring a manual send action.
***
## More actions
From the work order detail page, you can perform the following actions after creation.
| Action | What it does | When available |
| - | - | - |
| **Edit** | Opens the work order for editing. Selecting **Edit** returns the WO to **Draft** status so you can make changes. | Draft through Subcontractor Accepted / Rejected |
| **Clone** | Creates a copy of the work order with all details pre-filled. Use this when you regularly work with the same subcontractor on similar jobs. | Any status |
| **Print / Share via email** | Generates a PDF of the work order and lets you email it directly to the subcontractor from Zuper. | All statuses except Draft |
| **Delete WO** | Permanently removes the work order. This action cannot be undone. | All statuses |
> [!NOTE]
>
> **Print / Share via email** is not available while the work order is in **Draft** status. Once the WO moves past Draft, you can use this option at any point to send a copy to the subcontractor or any other recipient.
***
## FAQs
> [accordion] Who can create a work order?
>
> Only users with admin-level access can create work orders in Zuper. These users also have access to the **Purchase Orders** module. If you do not see the option to create a work order, contact your Zuper administrator to verify your permissions.
> [accordion] What is the difference between a work order and a purchase order?
>
> A purchase order is used to buy physical parts or products from a vendor. A work order is used to commission labor or specialist services from a subcontractor. Both live in the **Purchase Orders** module but follow different workflows.
> [accordion] Can I edit a work order after saving it as a draft?
>
> Yes. While the work order is in **Draft** status, you can reopen it and update any details. Once the work order reaches **Work Completed** status, editing is no longer allowed.
> [accordion] What file formats are supported for document templates?
>
> Zuper generates work order documents as PDFs. Select the template that matches your organization's standard format from the **Template** list when creating the work order.
> [accordion] What happens if the subcontractor is not in my vendor list?
>
> You can add them on the spot. In the **Select Sub Contractor** field, select **+ Quick Create** at the bottom of the vendor dropdown, enter their details, and save. The new subcontractor is available to select immediately.
***
## Related articles
* [Subcontractors](/Purchasing/Work%20Orders/Sub-Contractors/Sub-Contractors)
* [Work order status](/Purchasing/Work%20Orders/Work%20order%20status)
* [Creating a purchase order](/Purchasing/Purchase-Orders/Creating-purchase-order)
* [Understanding purchase order status](/Purchasing/Purchase-Orders/Purchase-order-status)
* [Vendors](/Purchasing/Vendors/Vendors)
# Manage work orders in mobile
Source: https://docs.zuper.co/Purchasing/Work Orders/Manage work orders on mobile
Work orders help you coordinate work assigned to subcontractors and track their progress. In the Zuper Field Service app, you can review work order details, verify completed work, mark a work order as completed, and share the order or review its history while you're on site.
> [accordion] **Before you begin**
>
> * Confirm that your role has permission to view work orders. The permissions set in the Zuper web app also apply to the Zuper Field Service app.
> * Work orders are created and sent from the Zuper web app. In the mobile app, you can view work orders and mark them as completed. To create or edit a work order, change other statuses, or add, edit, or delete items, use the web app.
> * You can mark a work order as completed when its status is **Subcontractor Accepted**. If **Automatically Send WO to Subcontractor after Approval?** is turned off in your Purchasing settings, you can also mark it as completed when its status is **Sent to Subcontractor**.
## Open a work order
Work orders are associated with jobs and quotes. You can access them from either record.
1. Open the **Zuper Field Service app**.
2. Open the job or quote that the work order is linked to.
3. Scroll to the **Work Orders** section:
* **Job:** On the **Overview** tab.
* **Quote:** On the **Associations** tab.\
The section shows the number of linked work orders and the most recent ones.

4. Do one of the following:
* Tap a work order to open it.
* Tap **View all Work Orders** to see every linked work order. On the **Work Orders** screen, use **Search Work Orders** to find a specific order, then tap it to open it.
## Review a work order
Review the work order to confirm what the subcontractor agreed to do, check the order details, and contact the subcontractor if you need clarification.

### Check where the work order stands
The progress tracker at the top shows the work order's progress. The status label next to the work order date shows the current status.\

### **Contact the subcontractor**
If you need to clarify any details, tap **Call** or **Email** next to the subcontractor's name to contact them.

### View the items
The **Items** tab opens by default. It lists the work order's line items, quantities, and costs, along with the order total.
* Compare the listed items with the work completed on-site.
* Items labeled **Added from Job** were carried over from the associated job.
* Tap an item to view its details.

### View work order details and attachments
The **Details** tab provides the work order information you need on site, including the service address, job site photos, remarks, and attachments. You can view attachments uploaded by your team and subcontractors, filter them by uploader, or add files from your device.
To add an attachment, such as a photo of the completed work, tap the **(+)** icon in the **Attachments** section. You can take a photo or video, or select a file from your device.
> [!TIP]
>
> **Tip:** To view all attachments, tap **Attachments**. To view only files uploaded by the subcontractor through the public work order link, tap the filter icon and select **Uploaded by Subcontractor**.
>
> 
### View notes
The **Notes** tab shows the conversation around the work order.
* Select **This Order** to view notes added to the work order only.
* Select **Related Notes** to also view notes and activity from the linked job and quote.
> [!TIP]
>
> **Tip:** To return to the associated job, tap the job name at the top of the work order.
## Mark a work order as completed
When the subcontractor finishes the work and you've checked it, mark the work order as completed. The **Mark as completed** button appears when the status is **Subcontractor Accepted**.
> [!NOTE]
>
> If **Automatically Send WO to Subcontractor after Approval?** is turned off in your Purchasing settings, the **Mark as completed** button also appears when the status is **Sent to Subcontractor**. You don't need to wait for the subcontractor to accept the work order.
1. Open the work order.
2. Tap **Mark as completed** at the bottom of the screen.
The status changes to **Work Completed**, and the progress tracker shows **Completed**.

> [!TIP]
>
> **Important**: After a work order is marked as **Work Completed**, its status can't be changed from the mobile app or the public work order link. Verify the work before you complete it.
## Share a work order
1. Open the work order.
2. Tap the **More options** icon (three dots) in the top-right corner, or tap the **Share** icon in the bottom-right corner to access the email and PDF options.
3. Select one of the following options:
* **Share via email:** Sends the work order by email.
> [!NOTE]
>
> Note: When the work order’s status is **Sent to Subcontractor**, the email includes a public work order link that allows the subcontractor to review and respond to the work order.
* **Save as PDF:** Saves the work order as a PDF using your work order template.
* **Share:** Opens your device’s sharing options so you can send the public URL through another app, such as a messaging app or social media apps.

## View work order history
Use the **More options** menu to review status changes and activity associated with a work order.
* **Status History:** View status changes, including the date, the user who made each change, and any remarks. The PDF sent to the subcontractor is attached to the **Sent to Subcontractor** entry, so you can download the copy that was sent.
* **Activity History:** Review changes made to the work order.
To view the history:
1. Open the work order.
2. Tap the **More options** icon (three dots).
3. Select **Status History** or **Activity History**.\

## Customize the work order screen
Customize the work order details screen to show or hide the information you need.
1. Open the work order.
2. Tap the **More options** (⋯) icon in the top-right corner, then select **Customize**.
3. Turn on the options for the information you want to display, or turn them off to hide it.
4. Tap the checkmark icon to save your changes.

To go back to the original layout, tap **Restore to Defaults**.
## Frequently asked questions
> [accordion] Why don't I see the Mark as completed button?
>
> The button appears when the work order status is **Subcontractor Accepted**. If **Automatically Send WO to Subcontractor after Approval?** is turned off in your Purchasing settings, it also appears when the status is **Sent to Subcontractor**. Check the progress tracker to see where the order is.
> [accordion] I marked a work order as completed by mistake. Can I undo it?
>
> No. After a work order is marked as **Work Completed**, its status can't be changed from the app or the public work order link.
> [accordion] Can I create or edit a work order from the mobile app?
>
> No. Create and edit work orders, and add, edit, or delete items, from the Zuper web app.
> [accordion] Where can I find the PDF that was sent to the subcontractor?
>
> Open **Status History** from the **More options** menu. The PDF is attached to the **Sent to Subcontractor** entry.
> [accordion] What can I change before I share a work order by email?
>
> When you select **Share via email**, the email opens with the subcontractor as the recipient and the subject and message already filled in. You can add more recipients, edit the subject and message, and tap **Aa** to format the text.
>
> At the bottom of the email, choose what to include: **Measurements**, **Job photos**, **Parts/Products**, and **Send as PDF**. All options are selected by default, so clear any you don't want to send. When you're ready, tap the **Send** icon in the top-right corner.
>
> 
> [accordion] What does Added from Job mean on an item?
>
> The item was carried over from the job that the work order is linked to.
> [accordion] Where do I find work orders on a job or quote?
>
> On a job, they're on the **Overview** tab. On a quote, they're on the **Associations** tab.
# Subcontractors
Source: https://docs.zuper.co/Purchasing/Work Orders/Subcontractors/Subcontractors
**Navigation**: *Vendors → + New → Subcontractor*
## Overview
Subcontractors are external companies or individuals you engage to carry out work on your behalf. Instead of tracking them separately, Zuper lets you add them directly inside the **Vendors** module, so their details sit alongside your other external partners in one place.
When you raise a purchase order, Zuper pulls the subcontractor's details automatically from the saved record, which saves you from re-entering the same information each time. This article covers how to add a new subcontractor and how to edit a saved record if details change later.
> [!NOTE]
>
> Fields marked with an asterisk (\*) are required. You cannot save the record without completing them.
***
## Add a subcontractor
1. Select the **Vendors** module from the left navigation menu.
2. Select **+ New** at the top right of the page. A dropdown appears with two options.
3. Select **Subcontractor**. The **New Subcontractor** page opens.

***
## Enter primary details
The primary details section captures the subcontractor's identity and contact information. Work through each field in order, then move on to transaction details.
1. Under **Primary Details**, enter the **Subcontractor Name**. This is the legal or trading name of the subcontractor.
2. Enter the **Subcontractor Contact Name**. This is the primary contact person at the subcontractor company.
3. Enter the **Subcontractor Display Name**. This is a short name shown in lists and documents.
4. Enter the **Subcontractor Email**. This is the main email address for the subcontractor.
5. Enter the **Subcontractor Work Number**. This is the primary phone number.
6. Enter the **Subcontractor Mobile Number** if one is available.
***
## Enter transaction details
Transaction details control how Zuper handles payment and tax calculations for this subcontractor on purchase orders.
1. Under **Transaction Details**, select a **Payment Term** from the list. This is the agreed payment timeline between your business and the subcontractor.
2. Enter the **Subcontractor Tax ID** if you have one. This is the subcontractor's tax registration number.
3. Select a **Default Tax Rate** from the list if applicable. This is the tax rate Zuper applies by default to transactions with this subcontractor.

***
## Add a billing address
The billing address is required before you can save the record. You will find this section in the right panel of the page.
1. In the right panel, select **Billing Address**.
2. Enter the **Street Address**, **City**, **State**, and **ZIP Code**.
3. Select the **Country** from the list.
> [!NOTE]
>
> **Billing Address is required.** You cannot save the subcontractor record without adding one.

## Add bank details
Bank details are optional at this stage. You can leave this section blank now and return to fill it in later.
1. In the right panel, select **Bank Details**.
2. Enter the **Name on Account**.
3. Enter the **Account Number**.
4. Enter the **Bank Name**.
5. Enter the **Branch Identifier**. This is the branch or routing code for the subcontractor's bank.
> [!TIP]
>
> If you do not have bank details on hand, you can skip this section and add it after saving. To update the record later, open it from the Vendors listing page, select **More Actions**, then select **Edit**, and expand the **Bank Details** section in the right panel.

## Attach files and save
1. Select **Add Attachment** to upload any relevant files, for example, a signed contract or insurance certificate.
2. Select **Save Subcontractor** at the top right of the page.
Zuper saves the record and adds it to the **Vendors** listing page. The record appears under the **Subcontractor** type label so you can distinguish it from vendor records at a glance.
***
## FAQs
> [accordion] What is the difference between a vendor and a subcontractor in Zuper?
>
> Both record types live in the **Vendors** module, but they serve different purposes. A vendor is a supplier from whom you purchase parts or materials. A subcontractor is a company or individual you engage to perform work on your behalf.
>
> Zuper keeps them in the same module so you can manage all external partners from one place. The **Type** column on the listing page shows clearly which record is which.
> [accordion] Can I change a vendor record to a subcontractor after saving?
>
> No. The record type is set at creation and cannot be changed after saving. If you created a record with the wrong type, create a new record with the correct type and transfer the details across.
> [accordion] What happens if I leave bank details blank?
>
> Zuper saves the subcontractor record without bank details. You can add or edit them at any time by opening the record, selecting **More Actions**, then **Edit**, and expanding the **Bank Details** section in the right panel.
>
> If the issue continues, contact [Support](mailto:support@zuper.co).
***
## Related articles
* [Creating work orders](/Purchasing/Work%20Orders/Creating%20work%20orders)
* [Work order status](/Purchasing/Work%20Orders/Work%20order%20status)
* [Vendors](/Purchasing/Vendors/Vendors)
* [Creating a purchase order](/Purchasing/Purchase-Orders/Creating-purchase-order)
# Work Order Status
Source: https://docs.zuper.co/Purchasing/Work Orders/Work order status
A work order tracks every step of work you send to a subcontractor — from the moment you create it to the moment you close it. Each status tells you exactly where the work stands and what action to take next. Use this article to understand every status in the lifecycle, the actions available at each stage, and how to read the full status history.
**Navigation**: *Purchasing → Purchase Orders → \[Work order name]*
## The work order lifecycle
A work order moves through the following stages in order:
**Draft → Submitted → Accepted / Rejected (Internally)→ Sent to Subcontractor → Subcontractor Accepted / Rejected → Work Completed → Paid → Closed / Canceled**
> [!NOTE]
>
> The **Approved** and **Subcontractor Accepted** statuses appear only when specific settings are enabled in your Purchasing configuration. See [How Purchasing settings affect work orders](#how-purchasing-settings-affect-service-orders) below for details.
***
## Navigating to a work order
1. Select **Purchasing** from the left navigation menu and choose **Purchase Orders**.
2. Select any work order from the listing page to open its detail page.
3. The status badge appears at the top left of the detail page, below the WO number.
The left panel on the detail page shows two tabs — **Navigation** and **Status History**. Select **Status History** at any time to see a complete audit trail of every status change, including who made the change and any attachments or remarks recorded at that stage.

> [!NOTE]
>
> When a work order moves to **Send to Subcontractor** status, Zuper sends the subcontractor a PDF of the work order by email. This PDF includes the full work order details — line items, measurements, and any reference photos you chose to include.
***
## How Purchasing settings affect work orders
Two settings in your Purchasing configuration control how a work order moves through the workflow. Your administrator can find them at **Settings → Purchasing → General Settings → Purchase Orders**.
| Setting | Enabled | Disabled |
| - | - | - |
| **Require Vendor Approval?** | The subcontractor receives an email with **Accept** and **Reject** buttons. The WO moves automatically to Subcontractor Accepted or Subcontractor Rejected based on their response. | The email is sent without **Accept** or **Reject** buttons. The Subcontractor Accepted step is skipped. The WO moves directly to Work Completed when you are ready to record completion. |
| **Automatically Send WO to Subcontractor after Approval?** | Zuper sends the work order to the subcontractor automatically as soon as it reaches Approved status. The **Send to Subcontractor** button does not appear — no manual action is needed. | You must send the work order manually. Select **Send to Subcontractor** on the detail page to open the send dialog and dispatch the WO. You can also mark the work as completed while the WO is still in Sent to Subcontractor status. |
> [!NOTE]
>
> If you are unsure which settings your organization uses, check with your administrator before sending a work order. To update these settings, go to **Settings → Purchasing → General Settings** and select the **Purchase Orders** tab.
***
## Status 1: Draft
When a work order is in Draft, you have created it but have not yet submitted it for review. The subcontractor cannot see it at this stage — it stays internal until you are ready to move it forward.
**Available actions**
* **Mark as Submitted** — Moves the WO to the next stage. This button appears in the top-right corner of the detail page.
* **More Actions → Clone** — Creates a duplicate of the work order.
* **More Actions → Canceled** — Cancels the work order without deleting it, keeping the record for your audit trail.
* **More Actions → Delete WO** — Permanently removes the work order. This action cannot be undone.

> [!WARNING]
>
> **Delete WO** is permanent. If you might need to reference this work order later, use **More Actions → Canceled** instead to keep the record.
***
## Status 2: Submitted
Once you submit the work order, it enters the approval stage. What happens next depends on whether your organization has an approval hierarchy configured.

* **If an approval hierarchy is configured** — The WO waits for sign-off from the designated approver. A banner on the detail page shows whose approval is pending. The approver selects **Mark as Approved** to move the WO forward.

* **If no approval hierarchy is configured** — The **Mark as Approved** step does not appear. The next available action is to send the WO directly to the subcontractor.
> [!NOTE]
>
> If your organization does not use an approval hierarchy, the **Mark as Approved** button does not appear. The WO moves directly from Submitted to the sending workflow.
***
## Status 3: Approved
Your approver has reviewed and signed off on the work order. You can now send it to the subcontractor.

> [!NOTE]
>
> If the **Automatically Send WO to Subcontractor after Approval?** toggle is enabled in your Purchasing settings, Zuper sends the work order to the subcontractor automatically when it reaches Approved status. The **Send to Subcontractor** button does not appear — the WO moves to Sent to Subcontractor without any action from you.
> [!NOTE]
>
> The **WO Sent Date** field on the detail page records the date the WO was dispatched. Zuper populates this automatically when the WO reaches Sent to Subcontractor status.
***
## Status 4: Send to subcontractor
Once Zuper sends the work order, the **WO Sent Date** appears on the details panel. Check the **Awaiting Approval From** field to confirm which subcontractor is expected to respond.

### Send the work order to the subcontractor
1. Select **Send to Subcontractor**. The send dialog opens.
2. Confirm or enter the subcontractor's email address in the **To** field.
3. Select the items to include: **Measurements**, **Job site photos**, and **Parts and products**.
4. Confirm **Send as PDF** is selected.
5. Select **Send**. The WO moves to Sent to Subcontractor and the subcontractor receives the PDF by email.

What happens next depends on your **Require Vendor Approval**? setting:
* If **Require Vendor Approval is enabled** — The subcontractor receives an email with an Accept or Reject button. When they respond, the WO moves automatically to Subcontractor Accepted or Subcontractor Rejected.
* If **Require Vendor Approval is disabled** — The email is sent but does not include Accept or Reject buttons. The WO moves directly to Work Completed when you are ready to record completion. The Subcontractor Accepted step is skipped.
> [!NOTE]
>
> If **Automatically Send WO to Subcontractor after Approval?** is turned off, you can select **Mark as Work Completed** while the WO is in Sent to Subcontractor status. You don't need to wait for the subcontractor to accept the work order.

***
## Status 5a: Subcontractor accepted
The subcontractor has accepted the work order through the email link. Zuper updates this status automatically when the subcontractor selects **Accept** and signs the work order on the subcontractor portal — no action is needed from you.

> [!NOTE]
>
> If the **Automatically Send WO to Subcontractor after Approval?** toggle is enabled in your Purchasing settings, Zuper sends the work order to the subcontractor automatically when it reaches Approved status. The **Send to Subcontractor** button does not appear — the WO moves to Sent to Subcontractor without any action from you.
> [!NOTE]
>
> The **WO Sent Date** field on the detail page records the date the WO was dispatched. Zuper populates this automatically when the WO reaches Sent to Subcontractor status.
***
## Status 5b: Subcontractor rejected
The subcontractor has declined the work order. The WO returns to your team for review.
**Available actions**
* **Edit the WO** — Update the work order details and resend it to the subcontractor.
* **More Actions → Clone** — Create a new work order based on this one and assign it to a different subcontractor.
* **More Actions → Canceled** — Cancel the WO if the work is no longer needed.

***
## Status 6: Work completed
The subcontractor has finished the work and you are ready to record completion. A dialog opens where you can attach the subcontractor's invoice before confirming.
### Record work completion
1. Select **Mark as Work Completed** in the top-right corner of the detail page. A dialog opens.
2. Select **Click to upload file** to attach the subcontractor's invoice (optional). Supported formats: JPEG, PNG, PDF. Maximum file size: 20 MB.
3. Select **Mark as Work Completed** in the dialog to confirm.
The WO moves to Work Completed status. Any invoice you attached is recorded in the **Status History** tab. The **Mark as Paid** button appears in the top-right corner.


***
## Status 7: Paid
Once you mark the work order as paid, the record is locked and no further changes are permitted.
### Record payment
1. Select **Click to upload file** to attach a copy of the payment confirmation or invoice (optional). Supported formats: JPEG, PNG, PDF. Maximum file size: 20 MB.
2. Enter any payment notes or reference details in the **Remarks** field.
3. Select **Mark as Paid** to confirm payment.
> [!WARNING]
>
> Once you mark a work order as paid, the record is locked and no further changes are permitted. Review all details carefully before selecting **Mark as Paid**.
The WO status updates to Paid. The **Close WO** button appears in the top-right corner. All invoices and payment remarks are visible in the **Status History** tab.


## Status 8: Closed
With payment recorded, the work order has reached its final step. Closing it removes the WO from your active workload and permanently locks the record.
### Close a work order
1. Select **Close WO** in the top-right corner of the detail page.
2. Confirm the action when prompted.
The WO status updates to Closed. No further actions are available.

> [!NOTE]
>
> Closing is final. If you need to revisit the work or engage the same subcontractor again, use **More Actions → Clone** to create a new work order based on this one before closing it.
***
## Status history
Zuper records every status change automatically. To view the full audit trail:
1. Open the work order detail page.
2. Select the **Status History** tab in the left panel.
Each entry shows the status name, the date and time of the change, and the name of the user who made the change. It also includes any remarks entered at that stage and any attached invoice or document, with a download link.

***
## Work order status at a glance
| Status | What it means | Primary action |
| - | - | - |
| Draft | Created but not yet submitted | Mark as Submitted |
| Submitted | Awaiting internal approval (if configured) | Mark as Approved or Send to Subcontractor |
| Approved | Approved internally | Send to Subcontractor |
| Sent to subcontractor | Dispatched to subcontractor | Awaiting subcontractor response, or Mark as Work Completed (when automatic sending is turned off) |
| Subcontractor accepted | Subcontractor confirmed via portal | Mark as Work Completed |
| Subcontractor rejected | Subcontractor declined | Edit, clone, or cancel |
| Work completed | Work finished | Mark as Paid |
| Paid | Payment recorded | Close WO |
| Closed | Lifecycle complete | None |
| Canceled | Canceled before completion | None |
***
## FAQs
> [accordion] What happens if I skip the Approved status?
>
> If your organization does not have an approval hierarchy configured, the Approved status does not appear in the workflow. The SO moves directly from Submitted to the sending workflow without requiring a separate approval step. To set up an approval hierarchy, go to **Settings → Modules → Purchasing → General Settings**.
> [accordion] Can I edit a work order after it has been submitted?
>
> Yes. You can edit a work order from Draft through Subcontractor Accepted or Subcontractor Rejected. Once the WO moves to Work Completed, the record is locked — only existing line items can be edited at that stage, and no other changes are allowed.
> [accordion] Can I undo the Mark as Paid action?
>
> No. Once you confirm **Mark as Paid**, the record is locked, and no further changes are permitted. Review all details carefully before confirming payment.
> [accordion] Where can I find invoices attached during the workflow?
>
> All attachments — including invoices added at the Work Completed and Paid stages — are available in the **Status History** tab on the work order detail page. Select the file name to download the attachment.
> [accordion] What if the subcontractor does not respond or rejects the work order?
>
> If the subcontractor rejects the WO, select **More Actions → Mark as Subcontractor Rejected** to record the rejection and preserve the audit trail.\
> \
> To reassign the work, select **More Actions → Clone** and assign the new WO to a different subcontractor.\
> \
> To address the subcontractor's concerns, edit the existing WO and resend it.\
> \
> If the issue continues, contact [Support](mailto:support@zuper.co).
***
## Related articles
* [Creating work orders](/Purchasing/Work%20Orders/Creating%20work%20orders)
* [Subcontractors](/Purchasing/Work%20Orders/Sub-Contractors/Sub-Contractors)
* [Creating a purchase order](/Purchasing/Purchase-Orders/Creating-purchase-order)
* [Understanding purchase order status](/Purchasing/Purchase-Orders/Purchase-order-status)
# Detailed Report
Source: https://docs.zuper.co/Reports/Detailed_report
The **Detailed Report** in Zuper provides a granular, tabular view of individual records across modules like **Jobs**, **Customers**, **Invoices** and more. This makes it ideal for auditing or performance tracking requiring detailed data, as each job status, transaction, or activity is presented as a separate entry.
In this article, you will learn how to create a **Detailed Report** in Zuper, starting from selecting the primary module to customizing your report’s data fields and generating the final report.
[https://drive.google.com/file/d/1-Li-TB7e-Ol4mtChd\_m0\_z1C0ODsR29g/preview](https://drive.google.com/file/d/1-Li-TB7e-Ol4mtChd_m0_z1C0ODsR29g/preview)
1. Click the “**Reports**” module from the left navigation menu and select "**Reports**" (beta). This will direct you to the **Reports** builder home page, where you can view all previously created reports.
2. Click the **+ Create New Report** button in the top-right corner of the **Reports** home page. 
3. A pop-up will appear.
4. Choose **Detailed Report** from the available options. 
5. Click **Next** to proceed.
6. After selecting the **Detailed Report**, you will be prompted to choose the **Primary Module** on which you want to focus your report (e.g., Jobs) and click **Next**. 
> [!NOTE]
>
> **Note:** The primary module determines the main data source that will be included in the report.
7. Select the additional modules you need. You can select up to 3 additional modules. Zuper allows you to pull in the fields' data from **Additional Modules** associated with your primary module. This optional step helps you to create comprehensive reports by combining related data from various modules of your account/company.

> [accordion] Understanding Primary and Associated Modules in Zuper Report Builder
>
> You’re about to build a report in Zuper, and you're thinking, *“Where do I start?”*
> The answer lies in choosing the **right modules**, and understanding the difference between a **Primary Module** and **Associated Modules** is the first step toward creating reports that truly work for you. Let’s walk through it together.
> **Meet the Primary Module: Your Report's Backbone**
> Here, the **Primary Module** is the foundation of your report. It sets the stage and decides the "main character" for each row of data. If you want to build a report that shows a list of customers, then “**Customer**” should be your Primary Module. If you're more interested in seeing job progress, then “**Jobs**” might be a better fit.
> Whatever you choose here becomes the center of attention.
> **Introducing Associated Modules: Supporting Cast with Valuable Details**
> Now that you've set your stage with a Primary Module, it's time to bring in some supporting roles. **Associated Modules** are additional sources that provide related details without changing the number of rows in your report. They're optional, but incredibly helpful. You can add **up to three** associated modules to pull in extra information, like the number of jobs linked to each customer or the total invoice value associated with a job.
> **Scene 1: You’re Reporting on Customers**
> You want to see a list of all your customers and how many jobs each one has.
> So, you choose:
> **Primary Module:** Customer
> **Associated Module:** Jobs
> Your report might look like this:
>
> | **Customer Name** | **Number of Jobs** | |
> | :- | :- | - |
> | Alpha Corp | 2 | |
> | Beta LLC | 1 | |
> | Gamma Inc | - | |
> | Notice something? Even **Gamma Inc., which** hasn't had any jobs yet, is included. Why? Because your report revolves around customers, that’s your Primary Module. | | |
> | **Scene 2: Now You're Focused on Jobs** | | |
> | This time, you're interested in tracking job statuses and who they belong to. | | |
> | So, you switch it up: | | |
> | **Primary Module:** Jobs | | |
> | **Associated Module:** Customer | | |
> | Now your report looks like this: | | |
> | **Job ID** | **Status** | **Customer Name** |
> | :-- | :-- | :-- |
> | JOB101 | Completed | Alpha Corp |
> | JOB102 | In Progress | Alpha Corp |
> | JOB103 | Completed | Beta LLC |
> | Here, **only jobs** are shown. Gamma Inc isn’t listed anymore because they don’t have any jobs, and the report is all about jobs this time. | | |
8. Click **Go to Builder**.
9. Once the report creation page opens, you can start defining the fields to be included in the report.
* **Fields selection for row and column grouping**: A list of all available fields (including *Defaults*, *Custom*, and \_System \_fields) from the selected modules will be displayed in the **Available Fields** panel. You can choose the relevant fields that should appear in your report, such as **Job Title**, **Invoice Date**, **Technician Name**, etc., according to your preferences. Use the “+” icon or drag and drop to add the fields you want to include in your report. You can include up to **30 columns** in a detailed report.

As you add fields, a preview of your report displaying up to 50 records will appear on the left side of the report builder to help you visualize the data.
> [!NOTE]
>
> **Note:** You can reselect the modules by clicking the **Edit** button. However, updating the modules will reset the report.
>
> 
* **Customize column:** You can rename column names and customize how each column behaves within the report. To know more, see [Configure Report Settings](/Reports/Detailed_report#configure-report-settings).

10. After selecting your fields, click **Filter** tab > **Add** **Filter** to filter the report based on various attributes. For example, if you only want to see jobs completed within the last month or invoices over a specific amount, you can add those filters. Note that you can use up to **10 filters** to refine your data.

11. Set a **Title** to save the newly created detailed report.

> [!NOTE]
>
> **Note:** The maximum allowed length for a report name is **50 characters.**
12. Click **Save Changes**.

13. Once the report is created, you can view it by clicking “**View Report**,” and you can also share it directly with your teams, customers, and so on through email. **To share**, add people by their name or email address and specify the permissions.

> [!NOTE]
>
> **Note:** When generating a Detailed Report, up to 2,000 records can be processed and displayed in the report builder. If you need to access more data, you can download the report, which supports up to 20,000 records in the exported file.
14. You can also decide if you want to **schedule** this report. For example, you can set this report to generate automatically every week, month, or any custom interval you need. Scheduled reports will be delivered to your inbox or shared with team members according to your preferences. To learn more, see [Schedule Report](/Reports/Scheduling_report).
### Configure Report Settings
* **Field Name**: You can change the name for the field (column) that will be displayed in the report (e.g., “Amount”).
* **Pin**: You can pin a column that allows you to fix it to the left side of the report when scrolling horizontally.
* **Group Row**: You can group up to **4** rows to organize data based on shared values within that column. When this is enabled, rows with the same value in this column will be grouped together. For example, if you’re generating a report on invoices and want to group them by customer, enabling this for the “Customer Name” column will group all invoices by customer, making the report easier to read.
* **Aggregate**: This section offers options for summarizing or calculating column values. Based on the column field values, the following fields will be available. \
**Sum**: Adds up all values in the column. \
**Minimum**: Displays the smallest value in the column. \
**Maximum**: Displays the largest value in the column. \
**Average**: Calculates the average value for the column. \
**Count**: Displays the number of entries (rows) in the column.
[https://drive.google.com/file/d/12aGhfusv9pn3UjkqqhB0-Qw2rCSXbQyH/preview](https://drive.google.com/file/d/12aGhfusv9pn3UjkqqhB0-Qw2rCSXbQyH/preview)
### FAQs
**1. Can I change the default name of the report and its location to save?** Yes, you can update the report name and its storage location. To do this, click on the default name and edit it as needed. You can also choose the saving location from the drop-down menu.

**2. How do I remove fields from the report?** To remove fields, click the “-” icon next to the field you want to delete. This will remove the selected field from your report.

**3. How can I add fields from my associated modules to my report?**
To include fields from an associated module, select the respective module from the drop-down menu. This allows you to add fields from your pre-selected associated modules to your report.

**4. Can I add custom fields to my report?** Yes, you can add custom fields to your report if they are available in the selected modules. Simply select the custom fields from the **Available Fields** panel.

**5. What is the purpose of each report type, and when should I use them?**
* **Detailed Report**: Provides in-depth data with multiple columns and filters in tabular form. Use this when you need granular insights, such as transactional records or job logs.
* **Summary Report**: Offers a high-level view with aggregated data. This report resembles a **pivot table**, with expandable sections that allow users to drill down into specific details. Choose this when you need quick insights, such as total revenue or average job duration.
* **Report Template**: A pre-built, standard reports provided for quick use. Use this when you want to start with a ready-made report and optionally you can customize it by editing or adding fields.
**6. What should I do if my report exceeds the 20,000 row limit?**
If your report exceeds 20,000 rows, it cannot be downloaded in a single attempt due to system constraints. To retrieve the complete dataset, apply filters to segment the report into smaller chunks below the row limit.
For example, if you are generating an **Invoice Master Report**, and the total number of rows is **30,000**.
Apply a filter such as *Job Status = Completed* or *Completion Date = Last Month* to reduce the row count below 20,000. Download this filtered report. Then, remove or reverse the filter (e.g., *Job Status ≠ Completed*) and download the remaining records. This ensures that all data is retrieved without exceeding the row limit per download.
7. **Which modules can I report on?**
Report Builder supports the following modules as primary or additional data sources: Organization, Customer, Property, Users, Teams, Products, Assets, Jobs (including Timelogs and Service Tasks), Estimates, Invoices, Service Contracts, and Timesheets.
**Payments, Requests, and Purchase Orders are not available as modules in Report Builder.** If you need payment data — for example, totals grouped by payment mode — use [Zuper Pay Reports](https://docs.zuper.co/Zuper-pay/Zuper-pay-reports) instead. For a full list of supported and unsupported modules, see the [Report Builder Overview](https://docs.zuper.co/Reports/Overview).
# Managing your reports
Source: https://docs.zuper.co/Reports/Managing_report
In Zuper, the **Reports home page** serves as a centralized workspace where you can view, manage, and organize all available reports. The page provides access to reports you have created or shared with you and allows you to perform several actions, such as creating, scheduling, editing, and deleting reports.
> [!TIP]
>
> **Report Access Permissions by Role** \
> Your user role determines access to reports in Zuper:
>
> * **Admins**: Can create, edit, and delete reports, as well as share and schedule them.
> * **Team Leaders (TLs)**: Can view reports that have been shared with them, but cannot create, edit, or delete reports.
> * **Users (FEs)**: Cannot access reports in Zuper.
This guide provides step-by-step instructions on how to explore, manage, and interact with reports within Zuper.
**Navigation**: *Reports -> Reports (beta)*
## Accessing the Reports home page
1. Click the **Reports** module from the left navigation menu and select "**Reports**" (beta). 
2. The **Reports home page** will open, displaying a comprehensive list of all reports available to you.
The home page is your dashboard for managing existing reports, creating new reports, and scheduling reports for automated delivery.
## Panels on the Reports home page
The Report home page is laid out in two main panels:

### A. Navigation panel
The **Navigation panel** is located on the left side of the page and helps you filter and navigate between different categories of reports. The available categories are:
* **All Reports:** Displays a complete list of all reports that are accessible to you. 
* **Starred Reports:** Lists your favorite or most-used reports that you have marked with a star for easy access. 
* **My Reports:** Shows the reports you have created or own. 
* **Shared Reports:** Displays reports that have been shared with you by other users or teams. 
* **Templates:** Allows you to access and use predefined templates to create new reports quickly. 
* **Folders:** Organize your reports into folders to categorize them based on your organizational needs. You can create up to 10 folders. 
* **Scheduled Reports:** View reports that are set to be generated automatically at specified intervals. You can also create a new scheduled report by selecting the **New Scheduled Report** button. 
* **Report History:** Track previous versions or iterations of reports that have been modified or updated over time. This feature provides a record of changes made to each report. 
Each category facilitates report management and access, allowing you to find specific reports quickly.
### B. Main Panel
The **Main Panel** is the central area where you interact with reports. The following features are available in this panel:
* **Report Modules:** This allows you to switch between modules, such as 'All Reports' or any specific report module. Reports that belong to the selected module will be displayed in the list. 
* **Create New Report:** Click on this button to start creating a new report. You will be directed to the Report Builder interface, where you can define the parameters of your report. 
* **Search Bar:** This allows you to search for reports by name, category, or type. As you type, Zuper will filter the reports to match your search criteria. 
* **Recently Viewed Section:** Displays the reports you have accessed recently. This section allows for quick navigation to previously viewed reports. 
* **Reports List:** This section provides a detailed listing of all the reports available to you. Each report entry includes critical information, such as the report’s **Title**, **Creator**, **Location**, **Creation Date**, **Sharing Status**, and more. 
## Actions and features on the Reports list
Next to each report in the Reports List, there are several actions you can take. These functions allow you to manage your reports efficiently:

* **Share Report:** Share a report with other users or teams and define their access permissions, such as view-only or edit permissions.
> [!NOTE]
>
> ***Note:*** The Share option appears when you hover over the report you want to share.\_
* **Schedule Report:** Set up an automated schedule for reports to be generated and sent to specific recipients at defined intervals.
> [!NOTE]
>
> ***Note:*** *The Schedule option appears when you hover over the respective report.*
* **Move Report:** Organize the report by moving it into an existing folder or creating a new folder for better categorization.
* **Edit Report:** Modify the parameters, filters, or layout of the report.
* **Clone Report:** Make a copy of the existing report. The cloned report will retain the original settings but can be edited independently.
> [!NOTE]
>
> **Note:** There is a limit on the number of reports you can clone. If you select **Clone Report** and a **Cloning** pop-up appears and then disappears without creating a new report, you have reached your cloning limit. Contact [Zuper Support](mailto:support@zuper.co) to request a limit increase.
* **Delete Report:** Permanently remove the report from the system. Deletion is irreversible, so ensure that you no longer need the report before deleting it.
These actions give you control over your reports, allowing for easy sharing, scheduling, and organizing based on your needs.
## Scheduling reports for automatic generation
You can schedule reports to be automatically generated at specific times and intervals. This is useful for recurring reports that need to be sent out regularly, such as weekly or monthly reports. To know more, see [Schedule Report](/Reports/Scheduling_report).
### Organizing reports in folders
You can categorize reports based on function, department, or any custom classification in Zuper.
1. On the **Reports** home page, click the **Folders** icon to create a new folder. Note that you can create up to 10 folders. 
2. Alternatively, you can select the existing folder to categorize your reports.
When saving a report or moving a report, select the appropriate folder.
**Managing the Report detail page**
You can manage all your reports directly from the Report detail page:

1. **Schedule Report:** Click the **Schedule Report** button to set up an automated schedule for reports to be generated and sent to specific recipients at defined intervals.
2. **Editing Reports**: Click the **Edit** button to modify its settings. This will open the report configuration page, where you can adjust filters, add or remove columns, and customize the layout.
3. **Cloning Reports**: Click the **Clone** button to create a duplicate of any report, which is helpful when you want to reuse report settings for a different dataset.
> [!NOTE]
>
> **Note:** There is a limit on the number of reports you can clone. If you select **Clone Report** and a **Cloning** pop-up appears and then disappears without creating a new report, you have reached your cloning limit. Contact [Zuper Support](mailto:support@zuper.co) to request a limit increase.
1. **Moving Report**: Click the **Move** button to move it to an appropriate location.
2. **Deleting Reports**: Click the **Delete** button to permanently delete the report.
3. **Download Report**: Click the **Download Report** button to download a successfully generated report in Excel format.
### Sharing Reports
Collaboration is key when working with reports, and Zuper makes it easy to share reports with individuals or teams while maintaining control over access permissions.
You can share reports directly from the **Reports home page** or the **Report Details page**.
1. On the **Reports** home page, hover over the report and click the **Share** icon that appears.
2. Alternatively, you can open the report and share it from the Detail page.
3. Click on the **Share Access** button.
4. Select the individuals or teams you want to share the report with. 
5. Alternatively, if the report should be accessible to all users, enable the**Access to all users** option. 
6. **Set Access Levels** – Choose from:
* **View** – The recipient can only view the report.
* **Edit** – The recipient can make changes to the report. 
7. To notify recipients via email when sharing a report, check the **Send Notification to Email** option. This ensures that the individuals or teams you’ve shared the report with receive an email notification about their access. 
8. Click the “**Share Access**” button to send it successfully. 
### Managing Shared Reports
* **Viewing Shared Reports** – Once a report is shared, it will appear under the **Shared With Me** categories for the recipient. 
* **Removing Access** – To revoke access, open the **Share Access** panel and remove the user or team by clicking “Remove Access”. 
### Marking Favorites
To mark a report as a favorite:
1. Click on the **star** icon next to the report name in the Report listing. 
2. Favorite reports will appear in the **Favorites** section for quick access. 
## Troubleshooting
### Greyed-out fields in the field selector
**Symptom** A field in the **Available Fields** panel appears greyed out and you cannot select it.
**Cause** The field is already added to your report. Zuper greys out fields that are currently in use to prevent duplicates.
**Fix** No action is needed. If you want to use the field in a different position, remove it from your report first, then add it again.
1. Locate the field in your report's column list.
2. Select the remove icon next to the field.
3. Add the field again in the position you want.
> [!TIP]
>
> Greyed-out fields are not unavailable — they are already part of your report. Look for them in the columns you have already added.
***
### Expense Created At filter
**Symptom** You are building a report on expenses and want to filter by the date an expense was created, but you are unsure which filter to use.
**Cause** The **Expense Created At** filter is available in the Expenses module within Report Builder. It filters expense records by the date and time they were created in Zuper.
**Fix**
1. Select **Reports** from the left navigation menu and select **Reports**.
2. Open your expense report or create a new one using the Expenses module.
3. Go to the **Filters** panel.
4. Select **Expense Created At** from the filter list.
5. Enter the date range you want to report on.
6. Select **Apply**.
***
### Expense Category filter returns no results or an error
**Symptom** You apply the **Expense Category** filter in your report and receive no results or an unexpected error message.
**Cause** This is a known issue. The **Expense Category** filter does not return results as expected in some configurations.
**Fix** There is no workaround available at this time. Avoid using the **Expense Category** filter until Zuper confirms the fix is deployed.
> [!WARNING]
>
> Do not rely on the **Expense Category** filter for critical reporting until this issue is resolved. Use other available filters such as, **Expense Created At** to narrow your results in the meantime.
If the issue continues, contact [Support](mailto:support@zuper.co).
***
## Report Builder is not visible in my account
**Symptom** You do not see **Reports** (beta) in your left navigation menu, or the option is unavailable.
**Cause** Report Builder is a paid add-on. It is not included in the standard Zuper plan.
**Fix** Contact your Zuper account manager to confirm whether Report Builder is included in your plan, or to request access.
If the issue continues, contact [Support](mailto:support@zuper.co).
***
## FAQs
1. **Is there a limit on how many reports I can clone?** \
Yes. Zuper sets a default cloning limit for reports. If you need a higher limit, contact [Zuper Support](mailto:support@zuper.co) so the team can review your account and discuss your options.
2. **What should I do if the Cloning pop-up keeps disappearing?** \
1. Confirm that you have not reached the cloning limit for your account. \
2. Refresh the page and try again. \
3. If the issue continues, contact [Zuper Support.](mailto:support@zuper.co)
3. **Why are some fields greyed out in the Available Fields panel?** \
Greyed-out fields are already added to your report. Zuper prevents you from adding the same field twice. Remove the field from your current column list first, then add it in the position you want.
4. **Is Report Builder included in my Zuper plan?** \
Report Builder is a paid add-on and is not included in all plans. Contact your Zuper account manager for pricing details.
5. **Can I still use Legacy Reports if I have Report Builder?** \
Yes. Legacy Reports remain available to all users under the **Legacy Reports** section in the left navigation menu, regardless of whether you have Report Builder enabled.
If the issue continues, contact [Support](mailto:support@zuper.co).
# Overview
Source: https://docs.zuper.co/Reports/Overview
Imagine having all your business data at your fingertips, helping you track jobs, invoices, or quotes with ease. Zuper’s reporting tools make this a reality, guiding you through a simple process to access and create reports tailored to your needs.
Initially, Zuper provided a set of ready-to-use reports to help you quickly understand your business. These pre-built reports, like the Jobs Master Report, Invoice Summary Report, and Employee Utilization Report, covered a wide range of areas and were designed to give you instant insights without any setup. You can still access these reports by navigating to the sidebar and selecting the **Legacy Reports** section, where you will find a full list of these original reports ready to use.
To give you even more control, Zuper is introducing a more powerful way to create reports as the platform evolves. You can start by clicking the **Reports** module in the left navigation menu and selecting **Reports** (beta version). You’ll land on the **Reports** builder home page, a powerful tool that lets you create your own reports. This enables you to visualize any field's information needed for insightful reports. Using this feature, you can transform raw data into actionable insights.
You can create **Summary** or **Detailed** Reports by selecting fields from key modules like Jobs, Invoices, Customers, Assets, teams, and so on. You can also explore pre-built report templates, which allow you to customize by modifying fields, applying filters, and organizing fields to suit your specific needs. Once your report is set up, you can schedule it to run automatically and deliver real-time information without any manual effort.
With Zuper’s reporting tools, you can easily monitor, spot trends, and make better decisions, all in just a few clicks.

## Main benefits of Report Builder
With **Zuper’s Report Builder**, you’re not limited to standard templates. You can also design your own reports that suit your needs by:
* **Choosing specific fields** – You can select the exact field you need from different key modules.
* **Applying advanced filters** – You can narrow down your reports by applying filters and conditions.
* **Grouping and summarizing** – You can aggregate data for better insights.
* **Exporting and sharing** – You can download the reports or grant direct access to team members.
* **Scheduling** – You can schedule reports to generate and deliver insights at your preferred frequency, whether daily, weekly, or monthly.
### Legacy reports vs. Report Builder
| | Legacy reports | Report Builder |
| - | - | - |
| **Availability** | Included in all plans | Paid add-on |
| **Setup required** | None | Yes — you configure fields and filters |
| **Customization** | Not customizable | Fully customizable |
| **Scheduling** | Not available | Available |
| **Sharing** | Not available | Available |
| **Best for** | Quick, standard insights | Custom, business-specific reporting |
### Modules for Reporting in Zuper
In Zuper, reports are built using data from key modules that represent essential aspects of your business operations. Selecting the right modules allows you to create customized, data-driven reports tailored to your needs.
**Available Modules:**
* Organization
* Customer
* Property
* Users
* Teams
* Products
* Assets
* Jobs (Timelogs, Service Tasks)
* Estimates
* Invoices
* Service Contracts
* Timesheets
Report Builder lets you pull data from 12 modules. Each module gives you a specific set of fields you can add as columns, apply as filters, or group by when you build a report. Knowing what each module contains helps you choose the right one before you start — and avoids building a report only to find the data you need lives somewhere else.
> [!NOTE]
>
> **Custom fields** appear inside Report Builder for any module where your administrator has configured them. They are listed as **Custom Fields** in each module reference below. The fields available to you depend on your account configuration.
> [!NOTE]
>
> **Organization vs. Property — what is the difference?** An **Organization** report surfaces company-level data: who the client entity is, billing details, and contact information. A **Property** report surfaces location-level data: where service is delivered, the site address, and the associated contact.
>
> A single organization can have many properties. Use **Organization** reports for account management and billing. Use **Property** reports for dispatching, territory analysis, and site history.
> [accordion] Organization
>
> **What it covers:** Company-level client records — businesses, multi-branch accounts, and corporate entities your team services.
>
> | Field | Description |
> | - | - |
> | Organization Name | The company or business name |
> | Organization Code | System-generated unique identifier |
> | Primary Email | Main contact email for the organization |
> | Primary Phone | Main contact phone number |
> | Billing Address | The organization's billing address |
> | Website | The organization's website URL |
> | Tax Number | Tax or VAT ID on file |
> | Notes | Internal notes attached to the organization |
> | Created Date | Date the organization record was created |
> | Custom Fields | Any admin-configured custom fields for organizations |
>
> **Use this report to:** Audit your organization records, export a client list for CRM sync, or identify organizations with missing contact information.
> [accordion] Property
>
> **What it covers:** Physical service locations — homes, offices, warehouses, or any site where field work is performed. A property is always linked to a customer or organization.
>
> | Field | Description |
> | - | - |
> | Property Name | Name or label for the location |
> | Property Code | System-generated unique identifier |
> | Service Address | Full address of the property |
> | Associated Customer | Customer linked to this property |
> | Associated Organization | Organization linked to this property |
> | Property Type | Classification — for example, Residential or Commercial |
> | Notes | Internal notes on the property |
> | Created Date | Date the property record was created |
> | Custom Fields | Any admin-configured custom fields for properties |
>
> **Use this report to:** Export a list of all service locations, identify properties with no associated customer, or pull a list of sites of a specific type for scheduling or territory planning.
> [accordion] Customer
>
> **What it covers:** Individual contact records — the people who receive services or communicate with your field team.
>
> | Field | Description |
> | - | - |
> | Customer Name | First and last name |
> | Customer Code | System-generated unique identifier |
> | Email | Customer's email address |
> | Phone | Customer's phone number |
> | Address | Customer's primary address |
> | Associated Organization | Organization the customer belongs to, if any |
> | Notification Preference | Preferred contact method |
> | Created Date | Date the customer record was created |
> | Custom Fields | Any admin-configured custom fields for customers |
>
> **Use this report to:** Review contact completeness, segment customers by notification preference, or export a contact list for outreach.
> [accordion] Jobs
>
> **What it covers:** All work orders — scheduled, in progress, and completed. The Jobs module also exposes sub-module data for Timelogs and Service Tasks.
>
> | Field | Description |
> | - | - |
> | Job Title | Name of the job |
> | Job Number | System-generated job reference |
> | Job Category | Category or type assigned to the job |
> | Status | Current job status |
> | Priority | Job priority level |
> | Scheduled Date | When the job is scheduled |
> | Due Date | Job deadline |
> | Assigned User(s) | Technician or technicians assigned |
> | Team | Assigned team |
> | Customer | Associated customer |
> | Organization | Associated organization |
> | Property | Associated service location |
> | Service Address | Where the work is performed |
> | Job Value | Total value of the job |
> | Created Date | Date the job was created |
> | Completed Date | Date the job was marked complete |
> | Custom Fields | Any job-level custom fields |
>
> **Timelogs sub-fields:** Clock-in time, clock-out time, work duration, travel duration, and user.
>
> **Service Tasks sub-fields:** Task name, status, assigned user, completion date, and custom field values.
>
> **Use this report to:** Track job completion rates, review technician workloads, or analyze job value by category or team.
> [accordion] Estimates
>
> **What it covers:** Quotes sent to customers before job confirmation.
>
> | Field | Description |
> | - | - |
> | Estimate Number | System-generated reference |
> | Estimate Title | Quote title |
> | Status | Draft, Sent, Accepted, Declined, or Converted |
> | Customer | Recipient of the quote |
> | Organization | Associated organization |
> | Total Amount | Quoted value |
> | Created Date | Date the estimate was created |
> | Expiry Date | Quote expiry date |
> | Custom Fields | Any estimate-level custom fields |
>
> **Use this report to:** Monitor quote conversion rates, identify expired estimates that were not followed up on, or review outstanding quotes by customer.
> [accordion] Invoices
>
> **What it covers:** Billing records generated from jobs or created manually.
>
> | Field | Description |
> | - | - |
> | Invoice Number | System-generated reference |
> | Invoice Status | Draft, Sent, Partially Paid, or Paid |
> | Customer | Billed customer |
> | Organization | Associated organization |
> | Job | Linked job, if any |
> | Invoice Date | Date the invoice was issued |
> | Due Date | Payment due date |
> | Subtotal | Pre-tax amount |
> | Tax | Tax applied |
> | Total Amount | Full invoice value |
> | Amount Paid | Payments received to date |
> | Balance Due | Outstanding amount |
> | Custom Fields | Any invoice-level custom fields |
>
> **Use this report to:** Track outstanding balances, identify overdue invoices, or reconcile payments received within a date range.
> [accordion] Assets
>
> **What it covers:** Equipment and assets tracked in the system.
>
> | Field | Description |
> | - | - |
> | Asset Name | Name of the asset |
> | Asset Code | System-generated identifier |
> | Category | Asset type or category |
> | Status | Active, Inactive, or Decommissioned |
> | Associated Customer | Customer who owns or uses the asset |
> | Associated Property | Property where the asset is located |
> | Serial Number | Asset serial number |
> | Purchase Date | Date of purchase |
> | Warranty Expiry | Warranty end date |
> | Custom Fields | Any asset-level custom fields |
>
> **Use this report to:** Identify assets nearing warranty expiry, audit asset locations by property, or review decommissioned equipment.
> [accordion] Users
>
> **What it covers:** Team members and technicians in the account.
>
> | Field | Description |
> | - | - |
> | User Name | Full name |
> | Employee Code | System-generated or manually assigned ID |
> | Role | User's role — for example, Admin, Dispatcher, or Field Executive |
> | Team | Team the user belongs to |
> | Email | User email address |
> | Phone | User phone number |
> | Status | Active or Inactive |
> | Skills | Assigned skillsets |
>
> **Use this report to:** Review team composition by role or skill, identify inactive users, or export a staff directory.
> [accordion] Teams
>
> **What it covers:** Groups of users organized for dispatching or management.
>
> | Field | Description |
> | - | - |
> | Team Name | Name of the team |
> | Team Code | System-generated identifier |
> | Members | Users assigned to the team |
> | Manager | Designated team manager |
>
> **Use this report to:** Audit team membership, verify manager assignments, or identify teams with no assigned members.
> [accordion] Products
>
> **What it covers:** Parts, products, and services in your catalog.
>
> | Field | Description |
> | - | - |
> | Product Name | Name of the part or service |
> | SKU | Stock keeping unit |
> | Category | Product category |
> | Type | Part, Service, or Labor |
> | Unit Price | Selling price |
> | Cost Price | Purchase or cost price |
> | Stock Quantity | Units on hand, for inventory items |
> | Warehouse Location | Storage location |
> | Custom Fields | Any product-level custom fields |
>
> **Use this report to:** Audit stock levels, compare cost and selling prices, or review catalog items by category or type.
> [accordion] Timesheets
>
> **What it covers:** Daily attendance and shift-based time tracking for your team.
>
> | Field | Description |
> | - | - |
> | User | Employee name |
> | Date | Timesheet date |
> | Clock-In Time | When the user punched in |
> | Clock-Out Time | When the user punched out |
> | Total Hours | Total duration for the shift |
> | Status | Pending, Approved, or Rejected |
> | Notes | Any remarks on the timesheet entry |
>
> **Use this report to:** Review attendance by team member or date range, identify unapproved timesheets, or calculate total hours worked in a period.
> [accordion] Service contracts
>
> **What it covers:** Ongoing maintenance or service agreements with customers.
>
> | Field | Description |
> | - | - |
> | Contract Name | Name of the contract |
> | Contract Number | System-generated reference |
> | Status | Active, Expired, or Cancelled |
> | Customer | Associated customer |
> | Organization | Associated organization |
> | Start Date | Contract start date |
> | End Date / Expiry Date | Contract end date |
> | Contract Value | Total contract amount |
> | Custom Fields | Any contract-level custom fields |
>
> **Use this report to:** Identify contracts nearing expiry, review active agreements by customer or organization, or track contract value across your account.
Report Builder lets you pull data from 12 modules. Each module gives you a specific set of fields you can add as columns, apply as filters, or group by when you build a report. Knowing what each module contains helps you choose the right one before you start — and avoids building a report only to find the data you need lives somewhere else.
> [!NOTE]
>
> **Custom fields** appear inside Report Builder for any module where your administrator has configured them. They are listed as **Custom Fields** in each module reference below. The fields available to you depend on your account configuration.
> [!NOTE]
>
> **Organization vs. Property — what is the difference?** An **Organization** report surfaces company-level data: who the client entity is, billing details, and contact information. A **Property** report surfaces location-level data: where service is delivered, the site address, and the associated contact.
>
> A single organization can have many properties. Use **Organization** reports for account management and billing. Use **Property** reports for dispatching, territory analysis, and site history.
> [accordion] Organization
>
> **What it covers:** Company-level client records — businesses, multi-branch accounts, and corporate entities your team services.
>
> | Field | Description |
> | - | - |
> | Organization Name | The company or business name |
> | Organization Code | System-generated unique identifier |
> | Primary Email | Main contact email for the organization |
> | Primary Phone | Main contact phone number |
> | Billing Address | The organization's billing address |
> | Website | The organization's website URL |
> | Tax Number | Tax or VAT ID on file |
> | Notes | Internal notes attached to the organization |
> | Created Date | Date the organization record was created |
> | Custom Fields | Any admin-configured custom fields for organizations |
>
> **Use this report to:** Audit your organization records, export a client list for CRM sync, or identify organizations with missing contact information.
> [accordion] Property
>
> **What it covers:** Physical service locations — homes, offices, warehouses, or any site where field work is performed. A property is always linked to a customer or organization.
>
> | Field | Description |
> | - | - |
> | Property Name | Name or label for the location |
> | Property Code | System-generated unique identifier |
> | Service Address | Full address of the property |
> | Associated Customer | Customer linked to this property |
> | Associated Organization | Organization linked to this property |
> | Property Type | Classification — for example, Residential or Commercial |
> | Notes | Internal notes on the property |
> | Created Date | Date the property record was created |
> | Custom Fields | Any admin-configured custom fields for properties |
>
> **Use this report to:** Export a list of all service locations, identify properties with no associated customer, or pull a list of sites of a specific type for scheduling or territory planning.
> [accordion] Customer
>
> **What it covers:** Individual contact records — the people who receive services or communicate with your field team.
>
> | Field | Description |
> | - | - |
> | Customer Name | First and last name |
> | Customer Code | System-generated unique identifier |
> | Email | Customer's email address |
> | Phone | Customer's phone number |
> | Address | Customer's primary address |
> | Associated Organization | Organization the customer belongs to, if any |
> | Notification Preference | Preferred contact method |
> | Created Date | Date the customer record was created |
> | Custom Fields | Any admin-configured custom fields for customers |
>
> **Use this report to:** Review contact completeness, segment customers by notification preference, or export a contact list for outreach.
> [accordion] Jobs
>
> **What it covers:** All work orders — scheduled, in progress, and completed. The Jobs module also exposes sub-module data for Timelogs and Service Tasks.
>
> | Field | Description |
> | - | - |
> | Job Title | Name of the job |
> | Job Number | System-generated job reference |
> | Job Category | Category or type assigned to the job |
> | Status | Current job status |
> | Priority | Job priority level |
> | Scheduled Date | When the job is scheduled |
> | Due Date | Job deadline |
> | Assigned User(s) | Technician or technicians assigned |
> | Team | Assigned team |
> | Customer | Associated customer |
> | Organization | Associated organization |
> | Property | Associated service location |
> | Service Address | Where the work is performed |
> | Job Value | Total value of the job |
> | Created Date | Date the job was created |
> | Completed Date | Date the job was marked complete |
> | Custom Fields | Any job-level custom fields |
>
> **Timelogs sub-fields:** Clock-in time, clock-out time, work duration, travel duration, and user.
>
> **Service Tasks sub-fields:** Task name, status, assigned user, completion date, and custom field values.
>
> **Use this report to:** Track job completion rates, review technician workloads, or analyze job value by category or team.
> [accordion] Estimates
>
> **What it covers:** Quotes sent to customers before job confirmation.
>
> | Field | Description |
> | - | - |
> | Estimate Number | System-generated reference |
> | Estimate Title | Quote title |
> | Status | Draft, Sent, Accepted, Declined, or Converted |
> | Customer | Recipient of the quote |
> | Organization | Associated organization |
> | Total Amount | Quoted value |
> | Created Date | Date the estimate was created |
> | Expiry Date | Quote expiry date |
> | Custom Fields | Any estimate-level custom fields |
>
> **Use this report to:** Monitor quote conversion rates, identify expired estimates that were not followed up on, or review outstanding quotes by customer.
> [accordion] Invoices
>
> **What it covers:** Billing records generated from jobs or created manually.
>
> | Field | Description |
> | - | - |
> | Invoice Number | System-generated reference |
> | Invoice Status | Draft, Sent, Partially Paid, or Paid |
> | Customer | Billed customer |
> | Organization | Associated organization |
> | Job | Linked job, if any |
> | Invoice Date | Date the invoice was issued |
> | Due Date | Payment due date |
> | Subtotal | Pre-tax amount |
> | Tax | Tax applied |
> | Total Amount | Full invoice value |
> | Amount Paid | Payments received to date |
> | Balance Due | Outstanding amount |
> | Custom Fields | Any invoice-level custom fields |
>
> **Use this report to:** Track outstanding balances, identify overdue invoices, or reconcile payments received within a date range.
> [accordion] Assets
>
> **What it covers:** Equipment and assets tracked in the system.
>
> | Field | Description |
> | - | - |
> | Asset Name | Name of the asset |
> | Asset Code | System-generated identifier |
> | Category | Asset type or category |
> | Status | Active, Inactive, or Decommissioned |
> | Associated Customer | Customer who owns or uses the asset |
> | Associated Property | Property where the asset is located |
> | Serial Number | Asset serial number |
> | Purchase Date | Date of purchase |
> | Warranty Expiry | Warranty end date |
> | Custom Fields | Any asset-level custom fields |
>
> **Use this report to:** Identify assets nearing warranty expiry, audit asset locations by property, or review decommissioned equipment.
> [accordion] Users
>
> **What it covers:** Team members and technicians in the account.
>
> | Field | Description |
> | - | - |
> | User Name | Full name |
> | Employee Code | System-generated or manually assigned ID |
> | Role | User's role — for example, Admin, Dispatcher, or Field Executive |
> | Team | Team the user belongs to |
> | Email | User email address |
> | Phone | User phone number |
> | Status | Active or Inactive |
> | Skills | Assigned skillsets |
>
> **Use this report to:** Review team composition by role or skill, identify inactive users, or export a staff directory.
> [accordion] Teams
>
> **What it covers:** Groups of users organized for dispatching or management.
>
> | Field | Description |
> | - | - |
> | Team Name | Name of the team |
> | Team Code | System-generated identifier |
> | Members | Users assigned to the team |
> | Manager | Designated team manager |
>
> **Use this report to:** Audit team membership, verify manager assignments, or identify teams with no assigned members.
> [accordion] Products
>
> **What it covers:** Parts, products, and services in your catalog.
>
> | Field | Description |
> | - | - |
> | Product Name | Name of the part or service |
> | SKU | Stock keeping unit |
> | Category | Product category |
> | Type | Part, Service, or Labor |
> | Unit Price | Selling price |
> | Cost Price | Purchase or cost price |
> | Stock Quantity | Units on hand, for inventory items |
> | Warehouse Location | Storage location |
> | Custom Fields | Any product-level custom fields |
>
> **Use this report to:** Audit stock levels, compare cost and selling prices, or review catalog items by category or type.
> [accordion] Timesheets
>
> **What it covers:** Daily attendance and shift-based time tracking for your team.
>
> | Field | Description |
> | - | - |
> | User | Employee name |
> | Date | Timesheet date |
> | Clock-In Time | When the user punched in |
> | Clock-Out Time | When the user punched out |
> | Total Hours | Total duration for the shift |
> | Status | Pending, Approved, or Rejected |
> | Notes | Any remarks on the timesheet entry |
>
> **Use this report to:** Review attendance by team member or date range, identify unapproved timesheets, or calculate total hours worked in a period.
> [accordion] Service contracts
>
> **What it covers:** Ongoing maintenance or service agreements with customers.
>
> | Field | Description |
> | - | - |
> | Contract Name | Name of the contract |
> | Contract Number | System-generated reference |
> | Status | Active, Expired, or Cancelled |
> | Customer | Associated customer |
> | Organization | Associated organization |
> | Start Date | Contract start date |
> | End Date / Expiry Date | Contract end date |
> | Contract Value | Total contract amount |
> | Custom Fields | Any contract-level custom fields |
>
> **Use this report to:** Identify contracts nearing expiry, review active agreements by customer or organization, or track contract value across your account.
By choosing relevant modules, you can generate insightful reports to monitor performance, streamline workflows, and support informed decision-making.
# Scheduling a report
Source: https://docs.zuper.co/Reports/Scheduling_report
You've created a report to track job performance, team efficiency, or financial insights in Zuper. To keep the report up to date, you might find yourself manually running and exporting data multiple times a week. While doing this once a month might not seem like a hassle, the time spent refreshing reports can quickly add up as your business scales.
With **Scheduled Reports** in Zuper, you can eliminate the need for repetitive manual tasks. Instead of running reports manually each time, you can automate the process by setting up scheduled reports to generate and deliver insights at your preferred frequency, whether daily, weekly, or monthly. This ensures that stakeholders always receive the latest updates without any extra effort from your end.
[https://drive.google.com/file/d/1A-85oeiEGL03Pdq2upIFZV7qhYMUrW9Z/preview](https://drive.google.com/file/d/1A-85oeiEGL03Pdq2upIFZV7qhYMUrW9Z/preview)
**Follow the steps below to schedule a report:**
1. Click the “**Reports**” module from the left navigation menu and select "**Reports**" (beta). This will direct you to the **Reports** builder home page, where you can view all previously created reports.

2. Click the **Schedule Reports** from the left corner of the page.

3. Click **“+ New Schedule Report**”.

4. In the **New Schedule** creation panel, select the folder where the report is stored.
5. Choose the specific report you want to schedule.
6. Specify the **recurrence frequency** (Daily, Weekly, or Monthly).
7. Set the **send timing** for when the report should be delivered.
8. Click **Next** to proceed.

9. Enter a **Schedule Report Name** for easy identification.
10. Enter the recipient's email addresses.
11. Compose the email message that will accompany the report.
12. Click **Schedule Report** to complete the setup.

Once scheduled, Zuper will automatically generate and send the report to the designated recipients at the specified time, ensuring up-to-date insights without manual intervention.
### **Managing Scheduled Reports**
On the **Scheduled Reports** listing page, you can efficiently organize and refine your reports:
* **Module Filter:** Use the module dropdown to filter reports based on specific modules like **Customers, Jobs, or Invoices**.

* **Search Bar:** Quickly locate a specific report by entering its name in the search field.

## **Alternative Ways to Schedule Reports in Zuper**
Besides the primary scheduling method, Zuper offers two additional ways to schedule reports directly from different views:
### **1. Scheduling from the Reports Home page**
* Navigate to the **Reports** module and browse through the available reports.
* Hover over the report you want to schedule, and a **Schedule** icon will appear.
* Click the **Schedule** icon to open the **New Schedule** panel.

### **2. Scheduling from the Report Details Page**
* Open the specific report you want to schedule.
* On the **Report Details** page, click the **Schedule Report** button to set up an automated schedule.

# Summary Report
Source: https://docs.zuper.co/Reports/Summary_report
A **Summary Report** in Zuper, similar to a pivot table, provides a high-level overview of data by grouping information based on specific fields such as status, type, or category. This report type is useful for analyzing trends, identifying anomalies, and gaining insights into data patterns across various dimensions.
Summary Reports include row groups, column groups, and aggregation to structure and simplify data presentation. The field selection process for row and column groups works similarly to that of a Detailed Report. If you select fields from a primary module, you can further enhance your report by including relevant fields from additional modules.
A key feature of Summary Reports is aggregation, which allows data to be grouped and summarized into meaningful values. For example, a Summary Report can group jobs by status (e.g., *Open*, *In Progress*, *Completed*) and display the total number of jobs per status using the Count function.
[https://drive.google.com/file/d/1s0FwbQAV3E4boTQrYtucXzcbGi-3vlCl/preview](https://drive.google.com/file/d/1s0FwbQAV3E4boTQrYtucXzcbGi-3vlCl/preview)
In this article, you will learn how to create a Summary Report in Zuper, including selecting modules, organizing data fields, and applying aggregation functions to generate meaningful insights.
1. Click the “**Reports**” module from the left navigation menu and select "**Reports**" (beta). This will direct you to the **Reports** builder home page, where you can view all previously created reports.

2. Click the **+ Create New Report** button in the top-right corner of the Reports home page.

3. A pop-up will appear. Choose **Summary Report** from the available options.

4. Click **Next** to proceed.
5. After selecting the **Summary Report**, you will be prompted to choose the **Primary Module** on which you want to focus your report (e.g., Jobs) and click **Next**.

> [!NOTE]
>
> **Note:** The primary module determines the main data source that will be included in the report.
7. Select the additional modules you need. You can select up to 3 additional modules. Zuper allows you to pull in data from **Additional Modules** associated with your primary module. This step helps you to create comprehensive reports by combining related field information from key modules.

8. Click **Go to Builder**.
9. Once the report creation page opens, you can start defining the fields to be included in the report.
10. Select fields for the row and column to group. Summary reports have three components:
> [tab] Rows
>
> **Row**: Define how data is categorized or grouped (e.g., **Job Status, Customer Name, Service Type**). For example, if grouped by **Job Status**, the report will list categories like **Open, In Progress, and Completed** as separate rows. You can group up to 4 rows.
>
> 
> [tab] Columns
>
> **Columns**: Segment the grouped data into additional columns (e.g., Assigned Technician, Region, Service Type).
>
> For example, if a job is grouped by **Status**, column groups could show **each technician’s name** under that status. A maximum of 2 columns can be added.
>
> 
> [tab] Values
>
> **Value**: Refers to the field that you try to aggregate. A maximum of **2 value fields** can be added.
>
> 
> [!NOTE]
>
> **Note:** You can reselect the modules by clicking the **Edit** button. However, updating the modules will reset the report.
11. You can rename column names and customize how each column behaves within the report. To know more, see [Configure Report Settings](/Reports/Detailed_report#configure-report-settings).
12. After selecting your fields, click the **Filter** tab > **Add** **Filter** to filter the report based on various attributes. For example, if you only want to see jobs completed within the last month or invoices over a specific amount, you can add those filters here. Note that you can apply up to **10 filters** to a summary report.

13. Set a Title to save the newly created summary report. \*\*Note: \*\* The maximum allowed length for a report name is **50 characters.**

14. Click **Save Changes**.

15. Once the report is created, you can view it by clicking “**View Report**,” and you can also share it directly with your teams, customers, and so on through email. **To share**, add people by their name or email address and specify the permissions.

16. You can also decide if you want to **schedule** the report. For example, you can set the report to generate automatically every week, month, or any custom interval you need. Scheduled reports will be delivered to your inbox or shared with team members according to your preferences. To learn more, see [Schedule Report](/Reports/Scheduling_report).
# Template Reports
Source: https://docs.zuper.co/Reports/Template
**Template Reports** in Zuper offer a quick and efficient way to access meaningful insights without building reports from the ground up. These preconfigured templates are tailored to common business scenarios across key modules like Jobs, Customers, and Invoices. Whether you’re analyzing jobs, reviewing customer data, or monitoring invoices, template reports provide a ready-to-use foundation. You can easily customize them by adding or removing fields to suit your specific needs, saving time while ensuring data accuracy and relevance.
[https://drive.google.com/file/d/1sUcNMLZ0YQ2k7K8P\_NweiR\_A5Zt-4zyq/preview](https://drive.google.com/file/d/1sUcNMLZ0YQ2k7K8P_NweiR_A5Zt-4zyq/preview)
## **Accessing Built-in Reports**
To access the built-in reports in Zuper, navigate to the **Reports** module from the left navigation menu and select **Reports** (Beta). Then, click **Template** on the right panel of the **Report** home page to view all available preconfigured reports. These reports are categorized based on the modules they belong to, ensuring you can find the relevant data effortlessly.

### **Managing the Template page**
The **Template reports** page offers various ways to organize and refine your selection:
* **Module Filter:** Use the module dropdown to filter reports based on specific modules, such as Customers, Jobs, or Invoices.

* **Search Bar:** If you have a specific report in mind, use the search function to quickly locate it.

### **Selecting and Customizing a Template Report**
Once you have selected the appropriate template, click on it to open the report preview. Template reports provide structured data fields based on their respective modules, offering a convenient starting point for analysis. To use the template, click the **Use this Template** button.

Although template reports come preconfigured, Zuper allows you to tailor them according to your needs. You can:
* Select specific data fields to include in the report. For instance, when generating a customer report, you can add fields like **Customer Name, Contact Number, and Location**.
* Customize individual fields by pinning columns for better visibility, grouping rows for structured organization, or applying aggregate functions like **counting total jobs, summing invoice amounts**, or **calculating average job duration**.
* Drag and drop fields to adjust their position in the report table for better readability.
* Define filters to display only relevant data. For example, filter jobs by **Completion Date, Job Status, or Assigned Technician**.
* Use operators such as **Equal To, Contains, Greater Than, or Less Than** to refine the displayed data.
After customizing the report, you can save the changes and view the preview of the report. Zuper ensures that only a limited number of records are displayed in preview mode, with the full dataset available when running the complete report.
After saving, a confirmation message **"Report Saved Successfully"** appears, allowing you to proceed further. You can then click **View Report** to open and see the preview of the saved report. Additionally, Zuper provides options to share the report by copying the link or entering an email address to grant access to specific users. If needed, you can enable system-wide access by toggling the **Access to all users** option.
# Accessing the Calendar/Schedule board
Source: https://docs.zuper.co/Scheduling_and_Dispatching/Calendar
Zuper's powerful calendar module provides a unified view of your entire schedule, including one-time and recurring jobs, non-job events, technician time-offs, and holidays. With its intuitive interface, you can easily navigate through different time frames - from day to week to month - and gain a clear overview of your team's activities and availability.
Effortlessly drag and drop to reschedule jobs, quickly identify scheduling conflicts, and optimize your resource allocation. Color-coded entries allow for instant recognition of different event types, while customizable filters help you focus on specific teams, job types, or locations.
**Navigation**: *Scheduling & Dispatching module* -> *Calendar*
# Accessing calendar
* Select the **scheduling & dispatching** module icon from the left navigation menu and choose "**Calendar**."
* The calendar will display events based on the selected view (Day, Week, or Month).

> [!NOTE]
>
> **Note**: When viewing the events on the calendar in a month view, if multiple jobs are scheduled on the same day, click the "**+n more**" link to view them. A pop-up will appear, listing all jobs scheduled for that day. You can scroll through the pop-up to see the full list, as shown below.

## Actions in the Calendar Module
### 1. View and schedule unscheduled Jobs
Unscheduled jobs are pending tasks that have yet to be assigned a specific time slot. To view and schedule them:
* Click the **"Unscheduled Jobs"** button at the top right corner of the page.

* A list of unscheduled and overdue jobs will appear. Drag and drop a job onto the calendar to schedule it.
> [!NOTE]
>
> **Note**: When you drag and drop, a pop-up will appear as shown below, where you will be prompted to confirm the scheduled/rescheduled start & end date and time. Once done, click the "**Update**" button.
* The job is scheduled successfully. Once scheduled, you can **reschedule, add a note, clone, or delete** it by right-clicking on it.

### 2. Create & schedule a new Job
This feature allows you to create and schedule jobs directly from the calendar, streamlining job assignments without navigating away from the scheduling interface.
* Click and drag over the desired time slot to create a new job.
* A sidebar appears with pre-filled date and time details.

* Enter additional details such as **Job Title, Customer, Organization, Property, Category, etc.,** and click **"Save."**
* To add more details like **service tasks, parts/services, assets, contracts, and attachments,** click **"Create Detailed Job"** at the top right of the sidebar.

* Once the job is created, you can manage it by rescheduling, adding notes, cloning, or deleting it.
* You can also create a new job using the **"+ Create Job"** button at the top right corner.
> [!NOTE]
>
> **Note**: When you create a new job using the "**Create Job**" button at the top right corner. You will then need to follow the steps mentioned above but remember that the date and time won't be prefilled since you are creating a new job from scratch.
### 3. Create and review timeoff requests
Manage technician availability effectively by adding time-off requests directly in the calendar. This feature helps plan workloads efficiently while ensuring seamless scheduling.
To create a new time-off request from the calendar, follow these steps:
* Click the **drop-down menu** next to "Create Job" and select **"New Time-off."**

* Enter details such as **Start & End Date, User, Team, Reason (Sick, Vacation, etc.), and Remarks.**
* Check **"Notify User"** if you want to send a notification about the request.
* Click **"Submit"** to create the time-off request.

* After creating a time-off request, you can view more information by hovering over the request. To edit the request, simply click on it.
* Ensure that the **"Display Time-off"** checkbox is enabled to view submitted requests in the calendar.
### 4. Create and review non-job events
A **non-job event** refers to any activity that a field technician or employee participates in that is **not directly linked to a specific job**. These events can include meetings, training sessions, administrative tasks, or any other non-job-related activities. To create a new non-job event from the calendar,
Click the drop-down menu next to "Create Job" and select "**New Non Job Event**."

By creating a non-job event in the calendar, dispatchers and managers are informed that the technician will be **unavailable for job assignments** during that period.
For step-by-step instructions on how to create a non-job event, see creating and managing a non-job event article.
### 5. Calendar Sidebar
The sidebar provides quick access to the scheduled jobs in the calendar. Here's a breakdown of the components found in the sidebar:
> [accordion] Mini calendar
>
> The mini calendar displays all dates in a month, allowing you to navigate through different days, weeks, and months easily. It also serves as a visual representation of scheduled jobs on the date.
>
> 
> [accordion] Filters
>
> The filter feature allows you to search scheduled jobs in the calendar by **category, status, team,** and **user**. To remove the filters applied, click the “**Reset**” button next to the filters.
>
> 
> [accordion] Advanced filter
>
> Advanced filters feature allows you to quickly view jobs in the calendar by applying various filters. This means, if you cannot locate the specific job using the above-said parameters, you can use this option for a more refined search:
>
> 
>
> **1. Step 1**
>
> Click the “**Advanced Filters**” option at the bottom of the sidebar. This will open a “Calendar Filter” at the right.
>
> **2. Step 2**
>
> Apply filters such as **Job Type, Category, Status, Due Date, Customer, Organization, or Team.**
>
> **3. Step 3**
>
> Click **"Apply"** to update the view.
>
> **4. Step 4**
>
> To save the applied filter, check **"Save as Filter."** Saved filters appear in **"Quick Filter"** for easy access.
>
> **5. Step 5**
>
> To manage the filters you added, click the '**Manage Filter**' option. This allows you to view or add/delete filters as needed.
> [accordion] Cell control
>
> This feature allows you to adjust the height and width of individual cells within the calendar when choosing day and week view. Increasing the cell height and width gives you refined visibility of the timing associated with the job and view more information.
>
> 
### 6. Calendar settings
The settings in the calendar module allow you to customize its display and job card details for a better user experience.
> [accordion] Job card information
>
> To customize job cards displayed in the calendar:
>
> * Click the **"Settings"** icon at the top right corner.
>
> 
>
> * Select **"Job Card Information."**
>
> * Choose a primary and secondary color for job categories.
>
> 
>
> * Customize displayed attributes for **Week & Day View** and **Month View.**
>
> * Click **"Save"** to apply changes.
> [accordion] Display
>
> * Click **"Settings"** at the top right corner.
>
> * Select **"Display."**
>
> 
>
> * Set **the start of the week** (e.g., Monday, Sunday).
>
> * Choose the **default view** (Day, Week, or Month).
>
> 
>
> * Enable/disable additional options:
> 1. **Business Hours** - When enabled, calendar shows only the business hours and does not show out-of-business hours to schedule a job.
> 2. **Weekends**- When enabled, the weekend (Saturday and Sunday) is also included while scheduling a job.
> 3. **Week Numbers**: When enabled, week numbers are included in the calendar to schedule a job.
> 4. **Display Time-off** - Show time-off requests.
>
> * Click **"Save"** to apply settings.
### Troubleshooting
> [!WARNING]
>
> You can use this table to find out why a job cannot be rescheduled and what to do next.
| Cause | What to do |
| - | - |
| Job is already completed or canceled | Ask your admin to reopen the job, then try again. |
| You don't have permission to edit jobs | Ask your admin to update your access or make the change for you. |
| The new time is outside working hours | Pick a time within your business hours, or ask your admin to update the working hours in **Settings**. |
| This is part of a repeating job | Open the job directly and edit the time from there. |
| Something else is blocking the change | Contact [Zuper Support](mailto:support@zuper.co) with a description of the job and what you were trying to do. |
So, that's a comprehensive overview of the Calendar module in the Zuper. With these step-by-step instructions, you can efficiently navigate and access the calendar module.
# Setting up an Online Booking widget
Source: https://docs.zuper.co/Setting-up-Online-Booking-Widget
Let homeowners browse your services and book appointments directly on your website. Zuper shows available booking services based on the settings you configure, and each booking flows into Zuper as a scheduled job, helping your business grow 24/7.
An **Online Booking** widget turns your website into a self-service scheduling page. You decide which services homeowners can book, what information they provide, when appointments are available, and whether they can choose a technician. Zuper uses those settings to show the right booking services and creates the job when a homeowner books.
You can also share the booking experience through a public link, QR code, or embed it on your website, giving homeowners a way to schedule work without calling or emailing your team.\

This article walks you through the four steps for setting up an Online Booking widget: **Appearance**, **Manage Questions**, **Service Configuration**, and **Advanced Settings**.
## Before you begin
Before you start, decide:
* Which roofing services you want homeowners to book online.
* How long each service usually takes.
* Whether homeowners should choose an exact time or only a date.
* Whether homeowners should be able to choose a technician.
* Which teams should be available for online bookings.
> [!NOTE]
>
> **Note:** For this widget, **Create a Job** is enabled by default. When a customer completes a booking, Zuper automatically creates a job with the booking details.
## Step-1: Design the homeowner experience
The Appearance step controls how the booking widget looks on your website. The preview updates as you make changes, so you can see the experience homeowners will have.
1. Enter a **Welcome Message**. This appears at the top of the widget. Use a message that tells homeowners what they can do, such as Book Your Roofing Service!
2. Choose a **Brand Color**. This color is applied to the widget's buttons. Select a preset color or use the multicolor swatch to choose a custom color.
3. Choose a **Button Shape**: *Rounded*, *Pill*, or *Rectangle*.
4. Choose a **Button Text Color**: *Light* or *Dark*. Select the option that provides enough contrast with your brand color.
5. Select **Next** to continue to Manage Questions.\

## Step-2: Decide what information to collect
Before a homeowner can book, you need to collect the information your team needs to work with the request.
Online Booking widgets include two default questions:
* **Property Address**
* **Contact Information**
You can rename these questions by selecting the pencil icon, but you can't delete them.
### Add custom questions
Add questions when you need more information about the homeowner's request. For example, you might ask whether the homeowner needs an *inspection*, *repair*, or *replacement*.\

1. Select **+ Add custom question**.
2. Select a question type:
* **Short Answer**
* **Long Answer**
* **Single Choice**
* **Multiple Choice**
* **Dropdown**
* **Date**
3. Select the pencil icon next to **Untitled question** and enter your question.
4. For **Single Choice**, **Multiple Choice**, and **Dropdown**, add at least two answer options.
You can manage each question using the controls on its question card:
* **Change type**: Switch the question to another question type.
* **Duplicate**: Create a copy of the question, including its answer options.
* **Required**: Require the homeowner to answer the question before they can continue.
* **Update Field**: Save the homeowner's response to a Contact or Job custom field.
* **Dependent Field**: Show the question only when the homeowner selects a specific answer to another Single Choice, Multiple Choice, or Dropdown question.
* **Delete**: Remove a custom question.\

> [!TIP]
>
> **Tip**: Drag a question using its handle to change the order in which homeowners see it.\\
>
> 
5. Select **Next** to continue to Service Configuration.
## Step-3: Decide what homeowners can book
The Service Configuration step defines what appears on your booking page. Each service becomes a card that homeowners can browse, with its own description, image, price, duration, and scheduling rules.
Sample services may be available to help you get started, such as *Roof Inspection*, *Roof Repair & Replacement*, and *Emergency Tarping*. Replace these with the services your business actually offers before activating the widget.
### Add or edit a service
Select the pencil icon on an existing service to edit it, or select **+ Add a new service** to create one.
**Add service details**
Configure the information homeowners see when they browse your services:
* **Service Image**: Upload an image for the service card.
* **Service Name**: Enter the name of the service. This field is required.
* **Service Description**: Explain what the service includes so homeowners can choose the right service.
* **Starting At**: Enter the starting price to display for the service. Leave this blank if you don't want to show a price.
* **Job Category**: Select the job category to use when Zuper creates a job from a booking. This field is required.\

### Set the appointment duration and buffer
The duration you configure determines how much time a homeowner books on your calendar.
1. Set the **Slot Duration**. Zuper pre-fills this based on the selected job category. Change it if the service takes more or less time than the default.
2. Set the **Buffer Time**:
* **No buffer**: Allows appointments to be scheduled back-to-back.
* **Fixed buffer time**: Adds a set amount of time between appointments, such as 30 minutes or 1 hour. This gives your team time between appointments.
### Control when homeowners can book
Use Booking Constraints to control how far in advance homeowners can make appointments.
* **Minimum Lead Time**: Prevents bookings within a specified period from the current time. For example, a 24-hour lead time prevents same-day bookings.
* **Maximum Booking Window**: Limits how far into the future homeowners can book. For example, a 60-day window allows bookings only within the next 60 days.
> [!NOTE]
>
> Set either value to **0** to remove the restriction.

### Choose how homeowners select an appointment
Under Customer Booking Preference, decide how much control homeowners have over scheduling.
> [tab] Customer picks a date & time slot
>
> Choose this option when you want homeowners to select a specific appointment time. You can also let them choose a technician.
>
> Set *Time Slot Availability* to decide how Zuper determines the time slots homeowners can book.
>
> > [accordion] Choose from available time slots
> >
> > Use your teams' actual calendars to show homeowners when your technicians are available.
> >
> > > [!TIP]
> > >
> > > Best for: Businesses that want online bookings to follow their team's current schedule.
> >
> > * Choose whether homeowners can select a technician. Turn on **Allow customers to choose a specific technician for their appointment** to let homeowners see available technicians with their name, role, and open time slots. Leave it off to let Zuper assign the technician automatically.
> > * Set **Assignment**. Select the teams whose calendars Zuper should use to determine availability. You must select at least one team. You can select multiple teams, and bookings can draw from technicians across all selected teams.
> > * Set your **weekly availability**. Turn on each day when you accept bookings for this service, then set the start and end time for that day. Leave a day turned off to show it as **Closed**. Zuper offers time slots only within these hours and when the assigned teams have availability.
> >
> > 
>
> > [accordion] Define your preferred time slots
> >
> > Create fixed booking windows instead of using your teams' calendars.
> >
> > > [!TIP]
> > >
> > > Best for: Businesses that want to control exactly when homeowners can request appointments, regardless of individual technician calendars.
> >
> > 1. Select **+ Add time slot**.
> > 2. Set the **From** and **To** times for the booking window.
> > 3. Optionally set **Max Slots** to limit the number of bookings allowed during that time range.
> > 4. Select the days when the time slot should be available.
> >
> > Add additional time slots when you need different booking windows for different days or booking limits. Select the **trash** icon to remove a time slot.
> >
> > 
> [tab] Customer picks a date
>
> Choose this option when you want homeowners to request a day, but want your team to decide the exact appointment time and technician afterwards.
>
> Set your **weekly availability** to define when homeowners can request this service. Turn on each day when you accept bookings, then set the start and end time for that day. Leave a day turned off to show it as **Closed**.
>
> This option doesn't show time slots or technician selection because homeowners choose only a date. Your team schedules the exact time and assigns the technician after the booking is submitted.
>
> 
Select **Save Service** to save the service.
### Manage your services
After adding your services, you can manage them from the service list.
* Turn off a service to temporarily remove it from the booking widget. Existing bookings aren't affected.
* Drag a service using its handle to change the order in which homeowners see it.
* Select the pencil icon to edit a service.\

## Step-4: Decide what happens around the booking
Use **Advanced Settings** to control customer consent, booking policies, notifications, and the contact information homeowners see.
> [accordion] Messaging preferences
>
> **Text Message Opt-In** adds a consent checkbox to the contact step. Enter the message you want homeowners to see with the checkbox. Selecting the checkbox isn't required to complete a booking. It records whether the homeowner has opted in to receive text messages.
>
> > [!NOTE]
> >
> > The text editor supports **bold**, *italic*, and underline formatting, as well as links.
>
> **Out of Service Territory Message** lets you display a custom message when a homeowner enters an address outside your service area.
> [accordion] Booking policy
>
> Turn on **Booking Policy** to display your booking policy during the booking process. You can use this for cancellation terms, deposit requirements, arrival windows, or other booking conditions.
> [accordion] Customer notifications
>
> Choose how homeowners receive confirmation after they book:
>
> * **Text Message**: Sends a booking confirmation by SMS.
> * **Email**: Sends booking information by email.
> [accordion] Contact details
>
> Enter the team member's **name**, **phone number**, and **email address** that you want homeowners to see.

## Activate your widget
Once you've configured the booking experience, review it from the live preview before making it available to homeowners.
1. Review your settings across all four steps.
2. Check the live preview to make sure the booking experience looks and works as expected.
3. Select **Activate**.
After activation, Zuper generates a **public** link, **QR code**, and **embed** **code**. You can use these to add the booking experience to your website or share it directly with homeowners. See [Sharing and embedding your widget](/Zuper_for_Roofing/Sharing-and-embedding-widget).\

## What happens after a homeowner books?
When a homeowner completes a booking, Zuper automatically creates a job using the service and job category configured for the widget.
The booking is scheduled according to the homeowner's selected date and time, or according to the scheduling rules you've configured when the homeowner selects only a date.
The job then appears in Zuper for your team to manage, assign, and follow through your normal workflow.
## Frequently asked questions
> [accordion] Can homeowners book outside my working hours?
>
> Homeowners can open the widget at any time, but they can only select dates and times that meet the availability and booking rules configured for the service.
> [accordion] Can I temporarily stop taking bookings for one service?
>
> Yes. Turn off the service from the service list. The service is removed from the widget, while existing bookings remain unaffected.
> [accordion] Do homeowners see prices on an Online Booking widget?
>
> If you enter a **Starting At** price for a service, the price is displayed on the service card. Leave the field blank if you don't want to display a price.
> [accordion] What happens if a homeowner's address is outside my service area?
>
> If you configure an **Out of Service Territory Message**, the homeowner sees your custom message when their address is outside your service area.
> [accordion] Can I let homeowners choose their technician?
>
> Yes. When **Customer picks a date & time slot** is selected, turn on **Allow customers to choose a specific technician for their appointment**. Homeowners can then choose from the technicians available for the selected appointment.
# Customer Portal
Source: https://docs.zuper.co/Settings/Customer_Portal/Customer_Portal
Once the customer portal is turned on in company policy, users can configure it, including branding, appearance, navigation, etc.
**Navigation**: *Settings -> Customer Portal*
## a. Customization
1. Select the “**Settings**” module from the left panel. Under the “**Customer Portal**,” choose the “**Customization**” tab.
**Branding**
From the “**Branding**” section, fill in the following details.
| **Fields** | **Description** |
| :- | :- |
| Portal Name | Enter the name that is to be displayed in the customer portal’s title bar. |
| Portal Contact Email | The contact email ID of the portal. |
| Portal Logo | The logo of the customer portal. |
| Portal Favicon | The icon that is displayed in the title bar of the customer portal. |
**Appearance**
From the “**Appearance**" section, fill in the following details.
| **Fields** | **Description** |
| :- | :- |
| Portal Theme | From the list, choose the preferred primary color from the color picker list. |
| Font Family | From the drop-down, choose the font. |
| Footer Text | Enter the footer text to be displayed in the customer portal. |
**Authentication**
From the “**Authentication**" section, fill in the following details.
| **Fields** | **Description** |
| :- | :- |
| Authentication Type | Authentication is identifying the right user to log in to the system securely. Here, you can choose one of two methods: |
| | - Password - Only the user's email and password can be used to log in. |
| | - Password / OTP - Password and OTP can be used to log in. |
> [!NOTE]
>
> **Note**: External page links help you add your brand-related social media pages.
Select the “**Save**” button to save the customer portal settings.

## **b. Modules & Fields:**
The Modules & Fields help add a side panel menu that needs to be displayed in the customer portal:
1. From the “**Modules & Fields**” section, click “**+Add Menu**” to add the modules.

2. To add the menu, add the following details for the page:
| **Fields** | **Description** |
| :- | :- |
| Menu Name *(Mandatory)* | The menu name is to be displayed. |
| Linked to | Represent the module that is linked to the menu. |
| Visibility | Toggle portal visibility on or off. Add the icon that needs to be displayed in the navigation menu. |
| Actions | Click the "**Edit**" icon to add/modify the icon and menu name. The required field that needs to be visible under the listing and details page can be toggled on or off. |
Click the “**Add**” button to create the new menu.

Select the “**Save**” button to save the changes.
4. You can toggle the list of modules on or off as needed. Use the “**Edit**” icon to modify the navigation menu. Click the icon to re-order the menu items.

## **c. Access / Permissions**
**Enable Portal Access by Default**\
Toggle the switch to **Yes** if you want all customers to have access to the portal by default.
* **Yes**: Grants automatic access to all customers.
* **No**: Requires manual access approval.
**Allow Customers to Add Notes for Jobs**\
Toggle the switch to '**Yes**' to permit customers to add job notes, or '**No**' to restrict this action.

Click the "**Save**" button.
## **d. Notifications**
Who should be notified when a customer updates card(s) on file?
From the dropdown box, select the user to be notified.

## **e. Advanced**
1. The advanced section helps customers add custom CSS.
Once you add the code, click the “**Save**” button.

2. Select the “**Open Portal**” option to launch the customer portal.

### Troubleshooting:
### OTP Email Not Received
If the portal shows "OTP sent" but the email never arrives:
1. **Portal Access** — Open the customer's contact record and confirm Portal Access is set to **Yes**.
2. **Duplicate emails** — Make sure the email address isn't used by more than one contact in your Zuper account.
3. **Spam folder** — Ask the customer to check their spam or junk folder.
4. **Wrong email** — Confirm the customer is using the exact email linked to their portal account.
## Customer Portal User Manual link
[**Login to your customer portal**](https://docs.zuper.co/Customer_Portal/Login_to_customer_portal)
[**Adding and Managing Cards in Your Wallet**](https://docs.zuper.co/Customer_Portal/Cards)
To learn more about the Customer Portal usage, click [here](https://drive.google.com/file/d/10KQUozMwYmoUhS7GEsjY0QG_ACSIz2Ib/view?usp=sharing)
With customer portal settings, businesses can personalize their customer portal, including theme, font, and logo.
# Data Import
Source: https://docs.zuper.co/Settings/Data_Adminstration/Data_Import
The All-new Data Import feature in Zuper is designed to simplify and accelerate the process of importing data into the platform, whether you're setting up a new account or managing ongoing operations. This powerful tool allows you to upload essential master data or transaction data directly into Zuper with ease and precision.
**Navigation**: *Settings -> Data Administration -> Data Import*
With the new wizard experience, you can seamlessly complete the steps required to start the import, which is detailed below:
## Step 1: Import Type Selection
We must choose how to import data in this initial step. You can select one of the following options:
**Option 1**: Import using the file or
**Option 2**: Use Saved Template
Select "**Import using file**" to upload a new file from your device, as shown in this example.

**Module Selection**
## Step 2: Module Selection
This step lets you choose the module(s) for your data import. Modules are categorized into Master Data and Transaction Data, with specific associations and requirements.
### **Master Data Modules**
Master data modules can be imported independently and associated with other modules. Below is a table of available master data modules and their associations:
| Primary module | Can be selected with (Associated) |
| - | - |
| Customers | Organizations |
| Organizations | NA |
| Properties, Customers | Organizations |
| Products, Parts & Services | None |
| Users | None |
| Assets | Customers, Products, Properties, Organizations |
> [!NOTE]
>
> Note: There are no mandatory associations for master data imports. Each module can be created independently.
> [!NOTE]
>
> First-Time Setup Tip: If setting up an account for the first time, consider importing customers, organizations, and properties before importing transaction data like jobs or projects.
### Transaction Data Modules
Transaction data modules often require associated modules and mandatory selections. Below is a table of transaction data modules:
| Primary module | **Can be selected with (Associated)** | **Required Selection** |
| :- | :- | :- |
| Jobs | Customers, Organizations, Assets, Line Items, Properties | Customers |
| Recurring Jobs | Customers, Organizations, Line Items, Properties | Organizations |
| Projects | Customers, Organizations, Properties, Assets, Contracts | Properties, Customers |
| Requests | Customers, Organizations | Products, Parts & Services |
| Invoices | Customers, Organizations, Line Items, Properties | Users |
| Quotes | Customers, Organizations, Line Items | Assets |
* Key Requirement: When importing transaction data (e.g., Jobs), mandatory fields from required associated modules (e.g., Customer Email for Customers) must be included in the mapping to create or merge records.
> [accordion] Recurring Jobs: field format rules
>
> The Recurring Jobs template validates the following columns strictly. Rows that do not match are rejected during file validation.
>
> | Column | Required format | Example |
> | :- | :- | :- |
> | **Frequency** | Uppercase only | `DAILY`, `WEEKLY`, `MONTHLY` |
> | **Interval** | Number of **days**, not months | `180` for every six months |
> | **Start Date / End Date** | `YYYY-MM-DD HH:mm:ss` | `2026-11-01 09:00:00` |
> | Columns marked with **\*** | Mandatory | — |
>
> > [!NOTE]
> >
> > Data Import creates **new** recurring jobs. It cannot convert an existing single job into a recurring job. To make an existing job recur, recreate it as a recurring job from the Jobs module.
**Associations**
* When importing multiple associated modules (e.g., Properties and Customers), please ensure that the unique field for the associated modules are mapped.
* Zuper supports one-to-many and many-to-many associations: o Example: One Customer can be linked to multiple Properties. If a Customer Email appears in two rows of Property data, that Customer will be associated with both Properties upon import.
In this step, select the module for Import, which can be a master or transaction module. For example, Select the “**Customers**” module and click the “**Next**” button.

**File Upload**
## Step 3: Upload File
Upload your data file with the following requirements:
* File Type: CSV only.
* Size Limit: Maximum 25 MB.
* Row Limit: Maximum 20,000 rows.
* Structure: Single sheet (no sub-sheets).
* Note: These limits are displayed on the upload page.
**File Validation**
After submission, Zuper checks for errors:
* Not in the required format.
* Exceeds file size or row limit.
* Missing column headers.
* Incorrect structure.
* Blank rows within data.
* Locked/password-protected file. You’ll be alerted to correct issues before proceeding if problems are detected.
**Download Template**
* If your data isn’t formatted, download a template for the selected module (single-module imports only).
* After uploading the formatted file, skip mapping and submit directly in Step 4.
Click the “**Download spreadsheet with sample data**” button to download the Excel template in the Upload File screen.

## Step 4: Configurations
Configure how your data will be imported, including primary key selection and conflict resolution.
### Primary Key
* Use the “**Unique field**” column to choose a primary key during mapping to identify unique records and prevent duplicates. Note: This only applies to Transaction Modules.
* The primary key validates incoming records against existing data in the system and within the uploaded file.
### Conflict Resolution Options
Select how Zuper handles records with matching primary keys:
1. **Skip**: When a record has the same unique ID as one existing in the system, it skips the record.
2. **Merge**: When a record has the same unique ID as one existing in the system, it updates that record.
3. **Create Duplicates**: When a record has the same unique ID as one existing in the system, it creates a duplicate record.

## Step 5: Data Import – Mapping Table
Map your uploaded file’s columns to Zuper fields using the mapping table.
* **Multi-Module Uploads**: All fields from selected modules appear in the table. Map each “File Column Header” to an “**Import to Field**” after choosing the “**Import in Module**.”
* **Mandatory Fields**: Must be mapped for the import to proceed. Unmapped mandatory fields will block the import and notify the user.
* **Unmapped Columns**: If some columns remain unmapped, confirm whether to proceed with partial mapping.
### Saving Import Templates
* Save your mapping as a template (e.g., “HubSpot Contacts to Customers”) for reuse.
* Specify a name and save it after validation.
### Data Validation
* Mandatory Fields: Ensures all required fields for record creation are mapped.
* Field Values: Validates against acceptable values (e.g., dropdown options).
* Duplicates: Highlights duplicate primary keys in the file.
* Blank Fields: Skips blank values during import.

### Import Process
Once the mapping is complete, click Import. The process runs asynchronously, and you’ll be notified of the status.
Choose "**Allow subsequent triggers**" to activate existing workflows and webhooks, keeping your data flow dynamic and integrated.
Select "**Disable subsequent triggers**" to prevent unwanted module interactions, ensuring a smooth and focused import process.

### Tips for Success
* Ensure your file meets size and row limits.
* Include mandatory fields for primary and associated modules.
* Use templates for repetitive imports to save time.
* Validate data formats (e.g., dropdown values) before uploading.
## Select Module:
In Module Selection, your choice will be recorded.
Option 2: Use a Saved Template
* Action: Select "Use a Saved Template" to leverage a previously saved import template.
* Details: A dialog box will display a list of saved templates with the following columns: o Template Name: The name you assigned to the template. o Module Name/s: The module(s) associated with the template. o Actions: Click "Use Import Template" to proceed.

* Next Step: Skips Step 2 and takes you directly to Step 3 Configurations. o If the uploaded file matches the template’s required format, the mapping in Step 5 will be pre-filled. Otherwise, you’ll be prompted to map fields and proceed manually.
### Past Imports
Zuper Data Import enables you to import data into your workspace effortlessly, utilizing custom field mapping. The "**Past Imports**" section provides a history of your import activities, while the "Import Summary" and **"Import Errors**" sections help you track the success and troubleshoot issues with your imports. This article guides you through managing past imports and resolving data import errors.
### Accessing Past Imports
* Navigate to the Import Section: o From your Zuper workspace, click on the "**Past Imports**" tab located under the "**Import**" section. o You’ll see a list of all previous imports with details such as name, module, import date, and the user who performed the import.
View Import Details:
Each entry in the "**Past Imports**" list displays:
* Name: The name of the import (e.g., "Asset Import 3").
* Module: The module associated with the import (e.g.,"Asset").
* Imported On: The date and time of the import (e.g., 2025/02/25 02:04 PM).
* Imported By: The user who initiated the import (e.g., John Wick).
Click an import name to view more details if available.
**Understanding Import Summary**
The "Import Summary" panel provides a quick overview of the import's outcome:
* **Total Records**: The total number of records attempted to be imported (e.g., 1 record).
* **Created Records**: The number of new records successfully created (e.g., 0 records).
* **Failed Records**: The number of records that failed to import (e.g., 1 record).
* **Merged Records**: The number of existing records updated or merged (e.g., 0 records).
**Handling Import Errors**
If an import fails, the "**Import Errors**" section will provide details to help you
troubleshoot:
* Identifying Errors: o Check the "**Failed Records**" count in the Import Summary. o The "**Import Errors**" panel will list the number of errors (e.g., 1 error) and the reason (e.g., "Invalid Data").
* Downloading Error Details: o Click the "**Download errored rows as a file**" link to export a file containing the failed records and error messages. o Review the file to identify specific issues, such as missing fields, incorrect data formats, or validation errors.
* Common Error Causes and Solutions: o **Invalid Data**: Ensure all data fields match the required format and contain valid values. For example, check for empty mandatory fields or incorrect date formats. o **Mapping Issues**: Verify that the custom field mapping aligns with the imported data structure. o **Duplicate Entries**: Resolve duplicates by ensuring unique identifiers are correctly set.
4. Retrying the Import: o Correct the errors in your data file based on the downloaded error report. o Re-upload the corrected file using the "**New**" import option and monitor the results in the "**Past Imports**" section.
## Best Practices
* Regularly review the "**Past Imports**" list to track import history and identify recurring issues.
* Save templates for frequently used imports to streamline the process.
* Clear filters when not in use to ensure you see the full import history.

### FAQs \\
**What happens if I leave the Customer UID column blank?**
The asset is created successfully, but it is not linked to any customer. It appears as an unlinked asset in the **Assets** module. Zuper does not display a warning during the import. To fix this, re-import the affected rows with the correct UID values and use the **Merge** option to update the existing records.
# Recovery
Source: https://docs.zuper.co/Settings/Data_Adminstration/Recovery
Accidentally deleted a line item from a module in Zuper, such as an invoice, job, or estimate? Don’t worry, Zuper provides a straightforward way to recover deleted line items, ensuring you can restore essential details like products, services, or tasks without starting over.
**Navigation**: *Settings -> Data Administration -> Recovery*
1. Select the “**Settings**” module from the left panel. Under the “**Data Administration**,” choose the “**Recovery**.”

2. Under the modules filter, select the module. Click the recover icon to restore the line item.

3. Click the "**Recove**r" button to recover the line item.

4. The job is recovered successfully.

> [!NOTE]
>
> Note: You can recover deleted line items within 90 days. After 90 days, recovery will no longer be possible.
| Module | Supports Recovery |
| - | - |
| **Jobs** | ✅ Yes |
| **Projects** | ✅ Yes |
| **Contacts** | ✅ Yes |
| **Organizations** | ✅ Yes |
| **Properties** | ✅ Yes |
| **Parts & Services** | ✅ Yes |
| **Quotes** | ✅ Yes |
| **Invoices** | ✅ Yes |
| **Contracts** | ✅ Yes |
| **Assets** | ✅ Yes |
| **Users** | ✅ Yes |
| **Purchase Orders** | ✅ Yes |
| **Material Requests** | ✅ Yes |
| **Timesheets** | ❌ No |
| **Teams** | ❌ No |
> [!WARNING]
>
> Timesheets and the Teams module's line items are permanently deleted at the module level and are not logged or listed in the Recovery settings.
> [!NOTE]
>
> **Deleted and cancelled are not the same.** Recovery restores records that were **deleted**. A **canceled** invoice or quote is final and does not appear in Recovery. If you need the same invoice again, clone the original and send the copy.
This feature helps maintain record accuracy and minimizes disruptions to workflow, keeping operations running smoothly.
# API Keys
Source: https://docs.zuper.co/Settings/Developer_Hub/API_Keys
Zuper API Keys are essential for securely authenticating and authorizing access to the Zuper API. These keys enable seamless integration with Zuper's services, allowing developers to build powerful applications that leverage real-time data and functionality.
**Navigation**: *Settings -> Developer Hub -> API Keys*
1. From the settings, select “**Developer Hub**," choose “**API Keys**," and click "**+New API Key**."

2. A “**New API Key**” dialog box appears. Enter the “**API Key Name**.” Click the “**Create**” button to generate the API key.

3. The API key is successfully created. Click the button to copy the API key.

4. Under “**Actions**,” you can view or delete the API key.

Users can ensure their applications interact with Zuper's ecosystem efficiently and securely by generating and managing API keys.
### Troubleshooting
> [!NOTE]
>
> **Note:** QuickBooks Online (QBO) sync activities might not trigger records created or updated through an API key user, depending on your system configuration. To avoid this, create a dedicated user account for your QBO integration. Then generate the API key from that account. This keeps your integration activity separate, easier to track, and more consistent over time.
# Custom Functions
Source: https://docs.zuper.co/Settings/Developer_Hub/Custom_Functions
Custom Functions in Zuper allow you to automate and streamline workflows by creating tailored functions to interact with your data.
**Navigation**: *Settings -> Developer Hub -> Custom Functions*
1. From the settings, select “**Developer Hub**," choose “**Custom Functions**," and click "**+New Custom Function**."

2. Fill in the custom function details.

Click "**Save Function**" to save the custom function.
3. Click "**Test Function**" to test the coding.

4. A dialog box appears. Click "**Test**" to proceed.

5. The test function is successfully done.

6. Click icon to edit or deactivate the function.

7. Click the "**Execution History**" tab to view the custom function execution history.

8. The execution history details are displayed.

> [!WARNING]
>
> Custom Functions do not support complex logic and will be deprecated. Use the **Code** node in [Workflow Builder](/Workflow_builder/workflow_builder_nodes) for new automations requiring custom logic.
## Additional Tips
* **[Check API Documentation](https://developers.zuper.co/reference/getting-started-with-your-api):** For more details on available endpoints and parameters, refer to the [Zuper API Documentation ](https://developers.zuper.co/reference/getting-started-with-your-api)(linked at the top of the Custom Functions page).
* **Monitor Status:** Use the **Status** filter in the Execution History tab to view successful, failed, or in-progress executions.
# Webhooks
Source: https://docs.zuper.co/Settings/Developer_Hub/Webhooks
Webhooks form the backbone of modern API development, allowing you to monitor changes in our systems and trigger actions in external applications, such as sending text messages or updating payment statuses. Zuper provides built-in webhook support, enabling users to register an HTTP/HTTPS URL that activates when an event occurs within Zuper.
With options to create, update, and delete webhooks, the system eliminates the need for periodic API calls and ensures that new updates are seamlessly integrated into the webhook.
**Navigation**: *Settings -> Developer Hub -> Webhooks*
1. From the settings, select “**Developer Hub**," choose “**Webhooks**," and click "**+New Webhook**."

2. Create a new webhook by filling in the following details:
* Webhook Name (Mandatory) - Enter the unique name for the webhook.
* Module (Mandatory) - Choose the applicable module.
* Webhook Event (Mandatory) - Choose the applicable webhook's event.
* Request Method and Request URL - Choose the applicable method: POST, GET, PUT, and DELETE. A webhook request URL is the unique URL provided by a service or application that allows another application to send data directly to it.
* Headers - Add the key and the respective values.

| HTTP Method | General Purpose (in REST APIs) | Webhook Context | Common Use Case in Webhooks | Best Practices |
| :- | :- | :- | :- | :- |
| **GET** | Retrieve data without modifying it (idempotent, safe). | Rarely used for delivery (no body for payloads); supported in some tools for simple queries or polling-like triggers. | Fetching webhook configuration or metadata. | Avoid sensitive data; use query params sparingly. Limit to read-only ops. |
| **POST** | Create new resources or submit data (non-idempotent). | The default and most common for webhook payloads. Sends JSON/XML bodies with event details. | Delivering event data. | Always include a signature/header for verification. Expect retries on failure. |
| **PUT** | Update/replace an entire resource (idempotent). | Used in scenarios needing complete resource replacement; less common but supported for updates. | Updating webhook subscriptions. | Ensure idempotency—repeated calls shouldn't create duplicates. Use for complete overwrites, not partial updates. |
| **DELETE** | Remove a resource (idempotent). | Primarily for management, not delivery. | Unsubscribing or deleting a webhook endpoint. | Confirm deletion with a 204 No Content response. Use auth tokens to prevent unauthorized removals. |
Click "**Create**" to add the new webhook.
3. The new webhook secret key is generated successfully.

4. Click icon to Edit Webhook, Copy Webhook URL, and Activate/Deactivate Webhook.

5. Click “**Webhook History**” to view the list of webhook executions.

## Automatic webhook deactivation
A webhook works only when the system receiving it is ready to accept data. That receiving system listens at an endpoint, which is the request URL you entered when you created the webhook. If the endpoint goes offline, moves to a new address, or starts rejecting requests, every event Zuper sends to it fails. Over time, these failures fill your **Webhook History** and can hide the fact that your integration has stopped working.
To protect your integrations, Zuper automatically deactivates a webhook that fails consistently. Think of it like a circuit breaker in your home. When something keeps going wrong, the breaker trips, so you can fix the cause before you switch the power back on. After you resolve the issue at your endpoint, you can reactivate the webhook in a few steps.
### When Zuper deactivates a webhook
Zuper checks the delivery results of your webhooks once a day. During each check, Zuper deactivates any webhook that meets either of the following conditions.
| Condition | What triggers deactivation |
| :- | :- |
| **High-volume failures** | Zuper made 100 or more delivery attempts in the 24 hours before the daily check, and every attempt failed. |
| **Consecutive daily failures** | Every delivery attempt failed on each of the last 10 full calendar days, ending the day before the check. At least one attempt also occurred on each of those days. |
> [!NOTE]
>
> Zuper counts each event as one delivery attempt, however many times it retries that event. If a retry later succeeds, the event counts as delivered. Because both conditions require every attempt to fail, a single successful delivery during the period keeps the webhook active.
### What happens after deactivation
When Zuper deactivates a webhook, its status changes to **Inactive** on the **Webhooks** page. At the same time, Zuper sends an email to the user who created the webhook, so the person who set up the integration knows to investigate. Zuper then stops sending events to that endpoint until you reactivate the webhook.
### Reactivate a webhook
Before you reactivate a webhook, review its failed deliveries in **Webhook History** and fix the cause at your endpoint. Once your endpoint is ready, follow these steps.
1. Go to **Settings**, then select **Developer Hub**.
2. Select **Webhooks**.
3. Find the webhook that shows the **Inactive** status.
4. Select the icon next to the webhook.
5. Select **Activate Webhook**. \
The status changes to **Active**, and Zuper resumes sending events to your endpoint.
> [!TIP]
>
> After you reactivate a webhook, trigger a test event and check **Webhook History**. A successful delivery confirms that your fix worked.
### Webhooks linked to Workflow Builder
When you create a webhook through Workflow Builder, it stays linked to the workflow that created it. Because of this link, the webhook status follows the workflow status, as the following table shows.
| When you | The linked webhook |
| :- | :- |
| Activate the workflow | Becomes active. |
| Deactivate the workflow | Becomes inactive automatically. |
| Reactivate the workflow | Becomes active again automatically. |
> [!NOTE]
>
> To keep the workflow and its webhook in sync, activate or deactivate workflow-linked webhooks from Workflow Builder, not from the **Webhooks** page.
**Best Practices**
* Ensure your Request URL is publicly accessible and can handle the specified HTTP method.
* Use headers to include authentication tokens or other metadata as needed.
* Test your webhook configuration to confirm it receives events correctly.
Leveraging Zuper API Keys effectively strengthens the security and efficiency of your integrations. Protect your keys by storing them securely, rotating them regularly, and monitoring their usage to maintain a reliable and safe interaction with the Zuper API.
# Edit Company Details
Source: https://docs.zuper.co/Settings/Home/Edit_Company_Details
The main section provides an overview and quick actions:
* **Workspace Information**: Displays your current workspace and operational details (e.g., business hours: 10:00 AM – 06:00 PM).
* **Feedback Prompt**: Share your experience with Zuper by clicking "**Write a Review**" to help improve field service management.
* **Switch to Old Settings**: Toggle between the current and previous settings interface if needed.
1. Click the icon to modify the company details.

2. Modify the company details and click the "**Update**" button.

# Settings Home
Source: https://docs.zuper.co/Settings/Home/Home
The Zuper Settings Home Page is your central hub for managing your workspace settings. Here’s a breakdown of the key sections and features to help you navigate and make the most of this page.
## Navigation Sidebar (Left Panel)
The sidebar provides quick access to various settings and tools within Zuper:
* **Back to Workspace**: Return to your main workspace.
* **Search Bar**: Quickly find specific settings or tools.
* **Home**: The current page shows an overview of settings.
* **Modules**: Manage and configure modules for your workspace.
* **Data Administration**: Handle data-related settings and permissions.
* **Security**: Adjust security settings to protect your workspace.
* **Users & Teams**: Manage user roles, permissions, and team structures.
* **Miscellaneous**: Access additional settings and configurations.
* **Developer Hub**: Explore developer tools, APIs, and integrations.
* **App Store**: Browse and install apps to enhance your workspace.
* **Support**: Get help or contact the support team.
* **User Profile**: View your profile and sign out.
# Enable Modules
Source: https://docs.zuper.co/Settings/Home/Modules_enablement
## Overview
Zuper offers a range of features and add-on modules that extend what your team can do — from advanced quoting and purchasing to customer financing and offline field support. All modules are enabled by Zuper Support on your behalf.
This article lists the available modules, describes what each one does, and explains how to contact Support to get them activated for your account.
## Available features & modules
The table below describes the available add-on modules in Zuper.
| Module | Function | |
| - | - | - |
| [**Customer Portal**](https://docs.zuper.co/Customer_Portal/Login_to_customer_portal) | Your customers get a self-service portal where they can view their jobs, invoices, and service history. | |
| [**Service Task**](https://docs.zuper.co/Work_Order_Management/Jobs/Creating_and_managing_service_tasks) | Add individual tasks inside a job to track each work step in more detail. | |
| [**Offline Support**](https://docs.zuper.co/Zuper_Mobile_Apps/Using_Zuper_Offline) | Lets field executives use the Zuper mobile app without an internet connection. Data syncs automatically once the connection is back. \| | |
| [**Consumer Financing (Wisetack)**](https://docs.zuper.co/Integrations/Accounting_and_payments/Zuper_Wisetack) | Lets your customers apply for financing directly from their invoice or quote. | |
| [**Proposal**](https://docs.zuper.co/Accounting/Proposal) | Send service proposals to customers before creating a formal quote. | |
| **Distance and Travel Time [(Dispatch Board)](https://docs.zuper.co/Dispatch/Overview)** | Displays estimated travel distance and time for each technician on the Dispatch Board, so you can make faster, better-informed scheduling decisions. | |
| [**Transfer Orders**](https://docs.zuper.co/Inventory_Management/transfer/Create_Transfer) | Transfer parts and inventory between locations using transfer order records. | |
| [**Price List**](https://docs.zuper.co/Inventory_Management/Pricelists/Overview) | Create and manage price lists for parts and services. Apply them directly to quotes and invoices. | |
| [**New job timelog**](https://docs.zuper.co/Work_Order_Management/Jobs/Manage_timelog_summary) | Provides an updated time-logging experience for jobs, giving field executives more control over tracking time on-site. | |
| [**Stream Chat**](https://docs.zuper.co/Chat/quickstart-guide) | Let your team communicate in real time without leaving Zuper. | |
| [**CPQ (Configure, Price, Quote)**](https://docs.zuper.co/Zuper_for_Roofing/Proposal_Template) | Configure complex service packages, apply pricing rules, and generate accurate quotes — all in one place. | |
| [**Task**](https://docs.zuper.co/Zuper_Dashboard/Tasks) | Manage internal tasks that are not linked to a specific job, keeping your team's work organized in one place. | |
| [**Multi-Trade**](https://docs.zuper.co/Trade_Types/Trades) | Allows a single job to include work across multiple trade types — for example, electrical and plumbing in one job record. | |
| [**Job Profitability**](https://docs.zuper.co/Zuper_for_Roofing/Job_Costing#job-costing-and-profitability) | See how profitable each job is by comparing the estimated costs and revenue against what was actually spent and earned. | |
| [**Purchasing**](https://docs.zuper.co/Purchasing/Purchase-Orders/Overview) | Create purchase orders, manage vendor relationships, and track procurement — all within Zuper. | |
| [**Material Requests**](https://docs.zuper.co/Purchasing/Material-Requests/Overview) | Request the parts and materials needed to complete a job, so your field and office teams always know what has been ordered. | |
| [**Vendors**](https://docs.zuper.co/Purchasing/Vendors/Vendors) | Store and manage all your supplier information in one place. Link vendors directly to purchase orders and procurement workflows. | |
| [**Workflow Builder**](https://docs.zuper.co/Workflow_builder/Workflow_overview) | Automate actions in Zuper without any coding. For example, send a notification when a job status changes, or assign a job when a form is submitted. | |
| [**Report Builder**](https://docs.zuper.co/Reports/Overview) | Build custom reports using data from across Zuper to monitor the performance areas most relevant to your business. | |
***
## How to request a module
To enable any module listed above, contact Zuper Support with the following information:
1. Your company name and Zuper account name.
2. The name of the module you want to enable.
3. Your preferred activation date, if you have one.
Reach Zuper Support at [support@zuper.co](mailto:support@zuper.co).
> [!NOTE]
>
> Zuper Support will confirm activation and share any setup steps required on your side before the module goes live.
## FAQs
1. **Will a module be enabled for my entire account or just specific users?** \
Modules are enabled at the account level. Once active, all users in your account can access the module. Some modules — for example, Customer Portal — have separate permission settings that let you control which user roles can use them. Zuper Support will advise you on this when activating.
2. **What happens to existing data if a module is disabled?** \
Disabling a module hides it from your account but does not delete any existing data. Records created while the module was active remain in the system and are restored if the module is re-enabled. Contact [Support](mailto:support@zuper.co) before disabling a module if you have concerns about your data.
3. **I requested a module but cannot see it in the app. What should I do?** \
Ask your team members to log out and log back in. If the module still does not appear, verify that your user role has the correct permissions to access it. If the issue continues, contact [Support](mailto:support@zuper.co).
4. **How long does activation take?** \
Activation timelines vary by module. Modules that involve third-party integrations — for example, Consumer Financing (Wisetack) — might take longer as they require external setup steps. Zuper Support will give you an estimated timeline when you raise the request.
5. **Can I request a module that is not listed here?** \
Yes. Reach out to [Zuper Support](mailto:support@zuper.co) or your Customer Success Manager to discuss your requirements. If the capability exists on your plan, the team will guide you through enablement.
## Related articles
* [Learn more about the Customer Portal](#)
* [Learn more about Proposals and Quotes](#)
* [Learn more about the Dispatch Board](#)
* [Learn more about CPQ](#)
* [Learn more about Purchasing](#)
# Custom Dashboards
Source: https://docs.zuper.co/Settings/Miscellaneous/Custom_dashboards
Custom Dashboards in Zuper allow you to create personalized views to track key metrics and data relevant to your business operations. This article guides you through the process of creating, viewing, and managing custom dashboards.
**Navigation**: *Settings -> Miscellaneous -> Custom Dashboard*
1. From the settings, select “**Miscellaneous**." From the "**Custom Dashboards**" section, choose “**+ New Dashboard**."

2. A "**Create New Dashboard**" dialog box appears. Fill in the following details.
* **Name**: Enter a unique name for your dashboard.
* **Channel**: Select the channel where the dashboard will be available.
* **URL**: Provide the URL of the dashboard content. This could be a link to a third-party analytics tool or a custom dashboard URL (A sample URL: [*https://pre-sales.travis-gitlab-content-marketing/ll*](https://pre-sales.travis-gitlab-content-marketing/ll)).
* **Applicability**: Choose who can access the dashboard (e.g., Everyone or specific roles/users).
* **Use this as a default dashboard?**: Check this box if you want this dashboard to be the default view for the selected users.

Click "**Create**" to create the custom dashboards.
3. The "**Custom Custom Dashboard**" is successfully created.

## Best Practices
* **Naming**: Use descriptive names for dashboards to easily identify their purpose (e.g., "Sales Dashboard", "Tax Overview").
* **Access Control**: Set the **Applicability** field thoughtfully to ensure only the intended users can access sensitive data.
* **Default Dashboards**: Use the default dashboard option for frequently used dashboards to save time.
# Email Templates
Source: https://docs.zuper.co/Settings/Miscellaneous/Email_Templates
Email templates can automate communication for various workflows, such as job, quotes, or invoices.
**Navigation**: *Settings -> Miscellaneous -> Email Templates*
1. From the settings, select “**Miscellaneous**." From the "**Email Templates**" section, choose “**+ New Template**."

2. Enter the following details:
* **Name**: Enter a unique name for your email template.
* **Choose Template Module**: Select the module this template applies to from the dropdown
* **Email Template Description**: Add a brief description of the template's purpose, including any placeholders like \[#work\_order\_number] that will be dynamically replaced when the email is sent.
* **Email Subject**: Enter the subject of the email.
* **Template body**: Enter the template body. Use the available components.


Click "**Save**" to save the email template.
## Configure the payment receipt template
When a payment is recorded in Zuper, the system sends a receipt email to the customer. The content of that receipt — including the support contact link displayed in the receipt — is controlled entirely by the payment receipt email template.
To configure the payment receipt template:
1. Go to **Settings** and select **Miscellaneous**.
2. Select **Email Templates**.
3. Locate the existing payment receipt template in the list and select the three-dot menu under the **Actions** column.
4. Select **Edit**. The **Email** panel opens.
5. Confirm **Choose Template Module** is set to **Invoices**.
6. Update the **Email Subject** if needed. The default subject uses the `{{estimate_no}}` placeholder to automatically include the receipt number.
7. In the **Template body**, update your support contact details. To add or change the support contact link, place your cursor in the relevant body area, enter the link text, and use the link icon in the toolbar to attach the URL or email address.
8. Select **Save**.
> [!NOTE]
>
> If no payment receipt template exists yet, select **+ New Template**, complete all mandatory fields, and select **Invoices** from the **Choose Template Module** dropdown. Select **Save** when done.
The support contact link on a payment receipt is not configurable from the invoice or payment settings. Any change to that link must be made here, in the payment receipt email template.
**Best Practices**
* Use placeholders thoughtfully to ensure the email content is relevant and personalized.
* Test the template by triggering a sample email to verify that all placeholders are replaced correctly.
* You can edit or delete templates later by clicking the three-dot menu under the **Actions** column in the Email Templates list.
# Holidays
Source: https://docs.zuper.co/Settings/Miscellaneous/Holidays
Holiday settings allow you to define non-working days for your team, ensuring that jobs are not scheduled on those days if desired.
**Navigation**: *Settings -> Miscellaneous -> Holidays*
1. From the settings, select “**Miscellaneous**." Under the "**Holidays**" section, choose “**+ Create New Holiday."**

2. Enter the following details.
**Holiday Name**: Enter the holiday name.
**Holiday Date**: Choose the holiday date.
**Allow Jobs to be assigned on this day**? Choose "**Yes**" to assign the job on this day. Choose "**No**" to disable the option.
**Is this a holiday for all the users**? Choose "**Yes**" to assign the holiday for all users on this day. Choose "**No**" to disable the option, which will open an additional option.
**Choose applicable team (Dependent field)**: Choose the team for which the day is a working day.

Click "**Create**" to set the holiday.
3. The holiday is successfully created.

4. The team filter and date picker can be done. Click icon to edit or delete the holiday.

You can effectively manage holiday settings in Zuper to ensure your team’s schedule aligns with non-working days.
# Master Tags
Source: https://docs.zuper.co/Settings/Miscellaneous/Master_tags
Master tags in Zuper are a powerful organizational tool designed to help you categorize and manage various modules, such as Jobs, Customers, Quotations, Invoices, and Projects.
**Navigation**: *Settings -> Miscellaneous -> Master Tags*
1. From the settings, select “**Miscellaneous**." Under the "**Master Tags**" section, choose “**+ New Tag."**

2. Enter the following details.
* **Tag Name**: Enter a unique name for the tag. This field is mandatory.
* From the **Module** dropdown, you can select the module you want to map this tag to. This field is required.
* Jobs
* Customers
* Quotations
* Invoice
* Projects
* Gallery
These fields are also mandatory. This determines where the tag will be mapped to the modules.
* **Description** - Enter the master tag description.

3. The tag is created successfully.

4. Choose the "**Module**" filter to filter the list of module line items. Tags can be edited or deleted using the action icons in the table.

The process of creating a new tag is straightforward—simply enter a unique tag name, select the appropriate module, and save.
# Outbound Email Settings
Source: https://docs.zuper.co/Settings/Miscellaneous/Outbound_email_templates
**Navigation**: *Settings -> Miscellaneous -> Outbound Email*
> [!NOTE]
>
> **Coming soon**: Revamped email experience with bi-directional sync of customer replies back to Zuper. Please reach out to your account manager to enroll for Beta.
Outbound email settings let you send all customer-facing emails from your own company address. By default, Zuper sends emails from [notifications@email.zuperpro.com](mailto:notifications@email.zuperpro.com) — an address your customers might not recognize, which can cause emails to be marked as spam.
Once configured, emails such as job updates, invoices, and quotes are sent from your domain. Replies are routed directly to the appropriate inbox, ensuring seamless
You can add multiple email accounts, verify each one, and set a default account for sending emails
> [!NOTE]
>
> **What is SMTP?** Email providers use SMTP (Simple Mail Transfer Protocol) to send messages. Connecting Zuper to your SMTP account means Zuper sends emails through your provider, instead of Zuper’s default email address.
## **Before you begin**
Complete this setup before you send any customer-facing emails. Ensure you have the following:
* **Admin access** to Zuper **Settings**.
* **Your SMTP credentials:** server address, port, username, and password.
* Access to your email provider’s dashboard to complete sender or domain verification.
## **Add provider-specific requirements**
* **For Gmail:** two-factor authentication (2FA) enabled on your Google account, so you can generate an app password.
* **For Microsoft 365:** multi-factor authentication (MFA) enabled if your organization uses it, so you can generate an app password.
## **Accessing outbound email settings**
1. Select your profile icon, then select **Settings**. Alternatively, navigate to the **Settings** module from the Left Navigation menu.

2. Under Settings, select **Miscellaneous** from the left panel. Scroll to the **Outbound Email Settings** section.
**Navigation**: *Settings -> Miscellaneous -> Outbound Email Settings*
## **Adding a new outbound email account**
1. In the **Outbound Email Settings** section, select **+ Add Email**.

2. Fill in the fields as described below and click **Create**.
After you save, Zuper verifies the connection using the credentials you entered.

## **Default SMTP**
> [!NOTE]
>
> Note: If business SMTP is not configured or deleted, Zuper will use its default SMTP settings. In this case, all emails will be sent from [notifications@email.zuperpro.com](mailto:notifications@email.zuperpro.com). To use your own sender address, please make sure your business SMTP settings are configured correctly. See **General Job Settings – Default from email** for more details.
### **Email Configuration Fields**
| **Field** | **Description** |
| :- | :- |
| **Choose Email Provider** | Select your provider: **Gmail**, **Microsoft 365**, or **Others**. |
| **Outgoing SMTP Server** | The SMTP server address. This auto-fills based on the provider you choose. Select **Others** to enter a custom server. |
| **SMTP Port** | The port number. This also auto-fills. You can edit it if needed. |
| **Name** | The display name that appears in your customers’ inboxes. |
| **From Email** | The email address you want to send from. |
| **SMTP Username** | The username your email provider uses to authenticate you. This is often your full email address. |
| **SMTP Password** | The password for your email account. For Gmail and Microsoft 365, this is an app password — see **Setting up Gmail** or **Setting up Microsoft 365**. |
| **Reply To Email** | Optional. Enter a different address if you want replies to go somewhere other than the From Email. |
> [!NOTE]
>
> **Note**: The account shows a **Yet to Verify** status until verification is complete. If the status still shows '**Yet to Verify**' after a few minutes, check your credentials and confirm that you have verified your sending domain in your provider’s dashboard.
> [accordion] Setting up Gmail
>
> ## **Setting up Gmail**
>
> Google blocks third-party tools from logging in with your regular password as a security measure. Gmail requires an app password instead — a 16-character code that gives Zuper access to your account without using your main password. You must have 2-Step Verification enabled before you can generate one.
>
> 1. Go to [myaccount.google.com](http://myaccount.google.com).
>
> 2. Go to **Security** in the left panel.
>
> 3. Under **How you sign in to Google**, select **2-Step Verification**. If prompted, enter your password. The 2-Step Verification settings page opens.
>
> 
>
> 4. Scroll to the bottom of the page and select **App passwords**.
>
> 5. In the **Select app** dropdown, choose **Mail** or **Other (custom name)**. If you choose **Other**, enter **Zuper** as the name.
>
> 6. If you choose **Mail**, also select your device from the **Select device** dropdown. This step only appears for some account types.
>
> 
>
> 7. Select **Generate**. Google displays a 16-character app password.
>
> 
>
> 8. Copy the password.
>
> 9. Go back to Zuper, paste the generated password into the **SMTP Password** field, and select **Create**.
> [accordion] Setting up Microsoft 365
>
> If your Microsoft 365 account has multi-factor authentication (MFA) enabled, you must generate an app password to use with Zuper. Using your regular account password will not work.
>
> ## **Setting up Microsoft 364**
>
> 1. In Zuper, set Outgoing SMTP Server to [smtp.office365.com](http://smtp.office365.com).
>
> 2. Set SMTP Port to 587.
>
> 3. Go to [account.microsoft.com](http://account.microsoft.com) and sign in.
>
> 4. Select Security from the top navigation.
>
> 5. Under Advanced security options, select App passwords.
>
> 6. Select **Create a new app password**. Microsoft generates and displays the password.
>
> 7. Copy the generated password.
>
> 8. Go back to Zuper, paste the generated password into the SMTP Password field, and select Create.
>
> For more details, see [Microsoft’s SMTP guide](https://learn.microsoft.com/en-us/exchange/clients-and-mobile-in-exchange-online/authenticated-client-smtp-submission).
> [accordion] Setting up a custom SMTP provider
>
> ## **Setting up a custom SMTP provider**
>
> If you use a provider other than Gmail or Microsoft 365, such as Mailgun, SendGrid, SMTP2GO, Zoho, Brevo, or any other provider, select **Others** as your email provider.
>
> 1. In the **Outgoing SMTP Server** field, enter your provider’s SMTP server address.
>
> 2. In the **SMTP Port** field, enter the correct port. Usually, this is 587 (TLS, a secure connection type) or 465 (SSL, an older secure connection type).
>
> 3. Enter your SMTP username and password from your provider’s dashboard.
## **Managing outbound email accounts**
### **Edit or delete an account**
1. Go to **Settings → Miscellaneous → Outbound Email Settings**.
2. Find the email account in the listing.
3. Select the three-dot menu (⋮) next to the account.
4. Select **Edit** or **Delete**. Update the details and select **Save**.

## **Set a default account**
The default account is what Zuper uses to send all customer-facing emails, unless a workflow or template specifies otherwise.
1. Select the three-dot menu (⋮) next to the account and select **Edit**.
2. In the panel that opens, select **Set as default**.
3. Select **Update**.

## **Troubleshooting**
> [accordion] Emails not sending after SMTP setup
>
> If your emails are not sending after you have configured your SMTP settings, work through the steps below.
>
> ### **Step 1 — Verify your SMTP configuration**
>
> Check that the following details in Zuper match exactly what your email provider gave you:
>
> * SMTP host
> * SMTP port
> * SMTP username
> * SMTP password
> * Encryption type (TLS or SSL)
>
> Confirm the credentials are still active and that your email provider has enabled sending permissions on the account.
>
> **Gmail users:** Gmail blocks standard password-based SMTP logins. If you see a "**Username and Password not accepted**" error (535 5.7.8), Gmail is rejecting your password because it requires an App Password for third-party tools. Go to **Setting up Gmail** above, generate an App Password, then edit your account in Zuper and replace the password.
>
> **Step 2 — Check your email provider’s dashboard**
>
> Sign in to your provider’s dashboard and look for sending errors, authentication failures, or account restrictions.
>
> If you are using Gmail or Microsoft 365, generate your app password before filling in the SMTP Password field. See **"Setting up Gmail" or "Setting up Microsoft 365"** above.
>
> | **Provider** | **Where to check** |
> | :- | :- |
> | **Microsoft 365 / Outlook** | [Microsoft SMTP guide](https://learn.microsoft.com/en-us/exchange/clients-and-mobile-in-exchange-online/authenticated-client-smtp-submission) |
> | **Gmail** | [Gmail SMTP guide](https://support.google.com/mail/answer/7126229) |
> | **Mailgun** | [Mailgun dashboard](https://app.mailgun.com/app/sending/domains) |
> | **SendGrid** | [SendGrid sender authentication](https://app.sendgrid.com/settings/sender_auth) |
> | **SMTP2GO** | [SMTP2GO verified senders](https://app.smtp2go.com/sending/senders) |
>
> ### **Step 3 — Confirm sender email and domain verification**
>
> Most SMTP providers require you to verify your sending domain before they will send emails on your behalf. In your provider's dashboard, check that:
>
> * Your domain is verified.
> * Your sender email address is verified.
> * ·The From Email you entered in Zuper matches the verified domain.
>
> ### **Step 4 — Check your DNS records**
>
> Your domain needs three types of DNS records. Each one helps email servers trust that your messages are genuine. Add these in your domain provider’s dashboard (GoDaddy, Cloudflare, Namecheap, or Google Domains).
>
> | **Record** | **Purpose** |
> | :- | :- |
> | **SPF** | Tells email servers which servers are allowed to send on behalf of your domain. |
> | **DKIM** | Adds a digital signature to your emails to prove they came from you. |
> | **DMARC** | Use SPF and DKIM together to improve security and deliverability. |
>
> Use a free tool like [MXToolbox](https://mxtoolbox.com) or [DMARC Analyzer](https://dmarcian.com) to check that your DNS records are set up correctly.
>
> To set up these records, log in to your domain provider and add the values provided by your SMTP provider. Most providers — including Mailgun, SendGrid, and SMTP2GO — show the exact records you need under a section called **Domain Verification** or **Sender Authentication** in their dashboard.
>
> **Step 5 — Send a test email**
>
> 1. Send a test email from Zuper.
> 2. Check whether it arrives in the intended inbox.
> 3. Review the outbound email logs in Zuper.
> 4. Check your SMTP provider's logs for delivery details if your plan includes log access.
>
> If the issue continues, contact [support@zuper.co](mailto:support@zuper.co) with your SMTP provider name, sender email address, a screenshot of any error message, and a screenshot of your SMTP configuration (mask your password before sharing).
## FAQs
> [accordion] Why does my email show "Yet to verify" status?
>
> Your account has been saved but has not completed verification yet. This might mean the SMTP credentials are incorrect, or that your provider has not finished processing the connection.
>
> Check your credentials and confirm you have verified your sending domain in your provider's dashboard. See "Setting up Gmail" or "Setting up Microsoft 365" above for the step-by-step process.
> [accordion] Can I add more than one outbound email account?
>
> Yes. You can add as many accounts as you need. Each one appears in the listing. You can set any one of them as the default at any time.
> [accordion] What is the difference between "From Email" and "Reply To Email"?
>
> **From Email** is the address your customers see as the sender. **Reply To Email** is where replies go when a customer selects Reply in their email app.
>
> If you do not fill in Reply To Email, replies go to the From Email address.
> [accordion] What happens if I do not set up outbound email?
>
> Zuper sends all customer-facing emails from [notifications@email.zuperpro.com](mailto:notifications@email.zuperpro.com). Your customers might not recognize this address, which increases the chance of emails going to spam.
>
> We recommend setting up your own SMTP account.
> [accordion] Can I use a shared mailbox or alias as the From Email?
>
> This depends on your email provider. Most providers support shared mailboxes as sending addresses, provided you have verified the address and your SMTP credentials have permission to send from it.
>
> Check your provider's documentation for details.
> [accordion] My emails are going to spam. What should I do?
>
> Check that your SPF, DKIM, and DMARC records are correctly set up for your domain. See Step 4 in the Troubleshooting section above.
>
> Misconfigured or missing DNS records are the most common reason emails land in spam.
> [accordion] Can I configure multiple outbound email addresses for different franchisees or locations?
>
> Yes. In Outbound Email Settings, you can add multiple email accounts — one per franchisee or location. Each account is configured separately with its own SMTP credentials.
>
> Set the most commonly used account as the default, or specify per-account usage through email templates or workflows.
## **Related articles**
* [Set a default sender email in General Job Settings](https://docs.zuper.co/Settings/Modules/Jobs/Configuring_General_Job_settings#general-settings-options)
* [Create and manage email templates](https://docs.zuper.co/Settings/Miscellaneous/Email_Templates)
# Broadcast
Source: https://docs.zuper.co/Settings/Miscellaneous/broadcast
The broadcast message option allows you to send a set of messages to a group of people with a single click. This option is used whenever a specific team or group of members needs to be notified about a message.
**Navigation**: *Settings -> Miscellaneous -> Broadcast*
## Broadcast creation
1. From the settings, select “**Miscellaneous**." Under the "**Broadcast**" section, choose “**+ New Broadcast."**

2. Enter the following details.
A **New Broadcast** dialog box will appear with the following options:
* **Recipient Options**: Choose who will receive the broadcast:
* **Everyone**: Sends the message to all users.
* **Selected Teams**: Sends the message to specific teams.
* **Selected Users**: Sends the message to specific individuals.
* **Broadcast Message**: Enter the message you want to send (e.g., "Training for all employees starts in the next 2 hours").
* **Additional Options**:
* Checkmark **Important** to mark the broadcast as a priority.
* Checkmark **Sticky** to keep the message visible until dismissed.
* Checkmark **Send as SMS** to deliver the message via SMS.
* **Duration**: Select how long the broadcast will be active.
Once you have filled in the details, click the **Create** button to send the broadcast.

## Best Practices
* Use clear and concise messages to ensure recipients understand the broadcast.
* Reserve **Important** and **Sticky** options for critical announcements.
* If using **Send as SMS**, ensure the message is appropriate for SMS delivery.
# PDF Library
Source: https://docs.zuper.co/Settings/Miscellaneous/pdf-library
Store your PDF files in one place, then reuse them across proposal layouts and job documents.
## Overview
You are at a customer's place, and they ask to see your color palette or a financing brochure. You dig through your phone, and the file sits buried between personal photos and other apps.
**PDF Library** gives your whole team one place to store every PDF you use for sales and service. Upload your brochures, warranty documents, and supplier catalogs once, then find and reuse them in Zuper.
Pull a saved file into a proposal layout or a job document. You can also open it on the Zuper mobile app while standing in front of a customer. **PDF Library** stores PDF files only, so the library stays easy to search.
You manage **PDF Library** from the web app. Once your files sit in the library, use them to build proposal layouts and job documents. You can also open them on the Zuper mobile app.
## Access PDF Library
1. Select **Settings** (gear icon) at the top of the screen.
2. Under **Miscellaneous**, select **PDF Library**.
The **PDF Library** page opens, showing every folder and file your team has added, along with the total item count.
[https://player.vimeo.com/video/1220392514?title=0\&byline=0\&portrait=0](https://player.vimeo.com/video/1220392514?title=0\&byline=0\&portrait=0)
## Upload a PDF
Upload a PDF to the top level of your library, or open a folder first to file it there directly.
1. From the **PDF Library** page, select **Upload PDF**.
2. Choose a PDF file from your device, then select **Open**.
3. Review the file name and size, then select **Add to Library**.
> [!NOTE]
>
> The size limit for uploads is 20 MB per file.
>
> PDF Library does not allow two files with the same name in one location. Rename the file on your device, or rename the existing file in Zuper, then try again.
## Create a folder
Group related PDFs into folders, for example, every document for one supplier or one campaign.
1. From the **PDF Library** page, select **New Folder**.
2. Enter a name for the folder.
Folder names must be unique, just like file names. To add a file inside a folder, open the folder first, then select **Upload PDF**.
## Manage your files and folders
The **PDF Library** page lists every folder and file with its name, size, creation date, and creator. Folders do not show a size.
### Rename a file or folder
1. Select the **Actions** icon (⋯) next to the file or folder.
2. Select **Rename**.
3. Enter the new name, then confirm.
### Download a file
1. Select the **Actions** icon (⋯) next to the file.
2. Select **Download**.
Folders do not support download, since they are not a single file.
### Delete a file or folder
1. Select the **Actions** icon (⋯) next to the file or folder.
2. Select **Delete**.
> [!TIP]
>
> To delete several files at once, select the checkbox next to each file, or select **Select All**. Then select **Delete** from the bar at the bottom of the page.
## Search your library
Enter a name, or part of a name, in the **Search** field at the top of the page. Zuper returns every matching file and folder.
If a match sits inside a folder, Zuper also returns that folder in your results. Open the folder to find the file inside.
## Add a PDF from your library to a proposal or job document
Once a PDF is in your library, pull it into any proposal layout or job document you build in Zuper. There is no need to upload it again each time.
[https://player.vimeo.com/video/1220392631?title=0\&byline=0\&portrait=0](https://player.vimeo.com/video/1220392631?title=0\&byline=0\&portrait=0)
> [accordion] Add to a proposal layout
>
> 1. Go to **Settings**, then **Quotes & Invoices**, then **Proposal Layouts**.
> 2. Open the layout you want to edit, then select **Add Page** and choose **Upload PDF**.
> 3. Select **Choose PDF Files**, then select **PDF Library**.
> 4. Open a folder if needed, then select the file you want. Zuper shows a preview.
> 5. Select **Proceed** to add the file to your layout.
>
> A PDF you add from your library becomes a single page in your proposal layout. An uploaded PDF works the same way. Page-level acknowledgment still works, so your customer can acknowledge the page before signing.
>
> For the full range of proposal layout options, see [Proposal Layouts](https://docs.zuper.co/Settings/Modules/Quotes-Invoices/Proposal_Layout_builder).
> [accordion] Add to a job document template
>
> 1. Go to **Settings**, then **Modules**, then **Jobs**, then **Document Templates**.
> 2. Open the template you want to edit, then select **Add Page** and choose **Upload PDF**.
> 3. Select **Choose PDF Files**, then select **PDF Library**.
> 4. Open a folder if needed, then select the file you want, then select **Proceed**.
>
> Zuper converts each page of the PDF into a separate, editable page in your template. An uploaded PDF works the same way. You can then add signature blocks, input fields, and dynamic variables to any page.
>
> For the full range of template options, see [Job document engine](https://docs.zuper.co/Work_Order_Management/Job-detail-page#documents).
> [accordion] Add to a job document or proposal layouts on the fly
>
> You do not have to update the master template to add a one-off document. Add a PDF straight to a specific job document or proposal layout instead.
>
> 1. Open the job or proposal.
> 2. Select **Documents** or **Layouts**, then open the job document or proposal layout you want to edit.
> 3. Select **Add Page**, then choose **Upload PDF**.
> 4. Select **Choose PDF Files**, then select **PDF Library**, then select the file you want.
>
> This works whether you are editing a job document or a proposal layout, at the job or proposal level respectively.
## PDF Library on mobile
[https://player.vimeo.com/video/1220392544?title=0\&byline=0\&portrait=0](https://player.vimeo.com/video/1220392544?title=0\&byline=0\&portrait=0)
> [accordion] PDF Library - Mobile
>
> You are at a customer's place, and they want to see a brochure or a color palette. Open **PDF Library** in the Zuper mobile app and show them right there.
>
> Use **PDF Library** on mobile to view and share any file your team has already saved. You can also add a saved file as a new page to a job document or a proposal.
>
> The mobile app does not support creating folders or uploading new files. See the sections above for the full management experience.
> [accordion] View and share a PDF from your library
>
> 1. From the home screen, select **More**.
>
> 2. Select **PDF Library**.
>
> 3. Select a file, or select a folder, then select a file inside it. Zuper opens a PDF preview so you and your customer can review it together.
>
> 4. To share the file, select **Share**, then choose an app such as WhatsApp.
>
> > [!NOTE]
> >
> > PDF Library on mobile is for viewing and sharing only. You cannot upload, rename, or delete files here. Manage your library from the web app instead.
> [accordion] Add a PDF from your library to a document
>
> Add a saved PDF as a new page in a job document or a proposal, right from your phone.
>
> 1. Open the job or proposal.
>
> 2. Open the job document or proposal layout you want to edit.
>
> 3. Click the **+** icon.
>
> 4. Click **Select from PDF library**.
>
> 5. Select a file, or select **Folders**, then open a folder and select a file inside it.
>
> 6. Confirm your selection to add the file as a new page.
>
> > [!NOTE]
> >
> > If **PDF Library** is not enabled for your account, you see only **Upload from device**. Contact your administrator to enable **PDF Library**.
>
> A multi-page PDF is reduced to one page in a proposal layout. In a job document, each page becomes a separate, editable page. This matches how **PDF Library** behaves on the web app.
## FAQs
> [accordion] What file types can I upload to PDF Library?
>
> PDF Library accepts PDF files only. Upload any other file type outside Zuper.
> [accordion] What is the maximum file size for an upload?
>
> The file size limit is 20 MB per file.
> [accordion] Can I upload a file with the same name as an existing file?
>
> No. PDF Library does not allow duplicate file names in the same location. Rename the file, then upload it again.
> [accordion] Who can access PDF Library?
>
> PDF Library sits inside Settings, so only users with Settings access can upload or delete files and folders. Anyone who builds proposals or job documents can select a file from the library while working on those documents.
> [accordion] Can I use PDF Library on the Zuper mobile app?
>
> Yes. You can view, share, and add files to job documents and proposal layouts. Upload, rename, and delete are only available from the web app. See [PDF Library on mobile](#pdf-library-on-mobile) for more information.
> [accordion] Can I upload a PDF to PDF Library from the mobile app?
>
> No. Upload, rename, and delete are only available from the web app. Use the mobile app to view, share, and add existing files to documents.
> [accordion] Can I create or manage folders from the mobile app?
>
> No. Create and manage folders from the web app. The mobile app only lets you open folders to find a file.
> [accordion] What happens if PDF Library is not enabled for my account?
>
> You see only the **Upload from device** option when you add a new page. Contact your administrator to enable PDF Library for your account.
> [accordion] Can I edit a PDF page after I add it from PDF Library?
>
> Yes. A page you add from PDF Library works the same way as an uploaded PDF page, so you can edit it the same way.
> [accordion] What happens if I cannot find a file in PDF Library?
>
> Check that the file was uploaded from the web app, and that it sits in the folder you expect. Ask a teammate with Settings access to confirm the file exists.
>
> If the issue continues, contact [Support](mailto:support@zuper.co).
## Related articles
* [Proposal Layouts](https://docs.zuper.co/Settings/Modules/Quotes-Invoices/Proposal_Layout_builder)
* [Job document engine](https://docs.zuper.co/Work_Order_Management/Job-detail-page#documents)
# Service Territory
Source: https://docs.zuper.co/Settings/Miscellaneous/service_territory
Zuper’s service territories enable division and management of areas serviced by field teams into smaller, manageable units. Organizing territories and mapping them to the right teams reduces travel and enables better control over teams, leading to optimal utilization. Businesses can create, edit, deactivate, or delete service territories based on their dynamic business environments.
It's flexible with multiple options to create territories: geo radius, custom-drawn geo fences, and zip code. The new visualization helps users avoid overlaps between territories. This helps maintain the right access control on the field teams by team leads/back-office (refer to the service territory-based dispatching [link here](https://docs.zuper.co/Dispatch/Detailed_Overview#service-territory-filter)).
**Navigation**: *Settings -> Miscellaneous -> Service Territory -> Create service territory*
## Service territory creation
1. Select the "**Settings**" module from the left navigation menu, and under the "**Miscellaneous**" section, select "**Service Territory**." Click "**Create New**" to add the new region.

3. Enter the following details to create a new service territory:
* **Territory Color** - Choose a unique color for your region to represent the territory on the map.
* **Name** – Enter the name of the service territory.
* **Description** - Enter the description of the region.
* **Owners** - Add the user(s) who will act as the owner of the respective Service Territory. Only users marked as ‘Owners’ will be able to dispatch jobs (via the dispatch board) whose service address falls within a territory. They can assign jobs to teams that are assigned to the territory.
* **Assigned teams** - Choose the teams responsible for working within this territory. You can assign multiple teams if needed. Dispatchers (Owners) can assign jobs falling within a service territory only to teams assigned to it.
> [!NOTE]
>
> **Note**: We recommend assigning Team Leads as the owners of Service Territories, as they are best positioned to oversee and manage the associated jobs and resources. Refer to Dispatch Board article here
* Territory Type –Choose Zipcodes, Geo-radius, or Geo fence. **Geo-radius** – Define the territory by setting a radius around a central point. The system will automatically create the territory boundary based on the radius entered.  **Zip codes** – Enter specific zip codes to define the territory based on postal codes. 
### International postal code support
The **Zipcodes** territory type supports both US ZIP codes and international postal code formats, including UK postcodes. Jobs are automatically assigned to a service territory when the postal code in the job's service address matches a postal code defined for that territory.
You can add postal codes from multiple countries to the same territory or across different territories in the same workspace. For example, a territory can be defined using US ZIP codes (such as `30301`) while another territory in the same account uses UK postcodes (such as `SW1A 1AA`).
> [!NOTE]
>
> Territory assignment relies on an exact match between the postal code in the customer, organization, or job service address and the postal code entered in the service territory. Ensure the format is consistent in both places — including spacing for UK postcodes (for example, `SW1A 1AA` and `SW1A1AA` are treated as different values).
**Geo-fence** - Draw a custom boundary on the map. Click the "**Save Service Territory**" button to confirm the creation of the new region, and then click the Create button to save the created service territory. 
A new service territory is created successfully.
## More actions
You can perform the following functions on the Service Territory's detail page.
* **Edit Details**: Use this option to edit the existing service territories.
> [!NOTE]
>
> Note: Modifying the service territory radius of the existing service territory will not impact the assigned jobs. For example, if a job is already assigned to a service territory and the territory is edited/marked inactive, it will remain part of the service territory based only on its initial definition. Such extreme business cases must be handled through bulk action of ‘**Assign Service Territory**’ on the jobs listing page.

### Troubleshooting: Territory not assigned when using postal codes
If a job is not being automatically assigned to the expected territory, check the following:
**1. Verify the postal code in the service address**
Open the customer, organization, or job record and confirm the postal code field is filled in and formatted correctly. Territory matching uses the postal code in the service address, not the city or country fields.
**2. Confirm the postal code exists in the territory**
Go to **Settings > Miscellaneous > Service Territory**, open the territory, and confirm the postal code is listed under the Zipcodes territory type. The value must match the service address format exactly, including spaces and letter casing.
**3. Check that Service Territories are enabled**
Ensure **Enable Service Territories** is turned on under **Settings > Modules > Jobs > General Settings**. Territory-based assignment does not run when this setting is disabled.
**4. Review territory conflicts on the job**
If the address falls under more than one territory, the system selects the first matching territory by default. You can manually assign the correct territory from the job detail page.
The new service territory feature makes creating and managing service territories simple, efficient, and intuitive.
# SOS Settings
Source: https://docs.zuper.co/Settings/Miscellaneous/sos_settings
The SOS feature in the Zuper Pro app allows field engineers to trigger an emergency alert quickly. When activated, it sends an SMS with the field engineer's latest location to all mapped users configured in the SOS settings.
**Navigation**: *Settings ->Miscellaneous -> SOS Settings*
## Manage SOS alerts
1. Select the "**Settings**" module from the left navigation menu, and under the "**Miscellaneous**" section, select "**SOS Settings**."
2. Enter the following details.
* Enable SOS Alerts - Enable Save Our Ship alerts. Allow field executives to use SOS. (Yes/No).
* Allow SOS outside business hours - Allow alerts after business hours. (Yes/No).
* Under **SOS SMS Numbers**, you’ll see the list of phone numbers that will receive the SMS alert in an emergency.
* To add a new number, click the **Add New** button.
* Enter the phone number (e.g., 911 or another emergency contact).
* Repeat this step to add multiple numbers as needed.

Click the **Save** button to set the SOS setting.
# Workflows
Source: https://docs.zuper.co/Settings/Miscellaneous/workflows
Workflow Automation is a series of automated actions performed in a business process. When a set of conditions is true, the action is triggered automatically.
In Zuper, the Workflow system enables the automatic execution of a monotonous set of actions or processes based on predefined conditions.
**Navigation**: *Settings -> Miscellaneous ->Workflows*
Follow the steps given below to create a Workflow in Zuper:
1. Select the "**Settings**" module from the left navigation menu, and under the "**Miscellaneous**" section, select "**Workflows**." Click "**+New Workflow**" button.

Enter an appropriate Workflow Name and Workflow Description.
* Under "**Workflow Applicable** **to**", there are 4 options.
-> **Only Me** -The workflow will be applied only for the user who created the workflow.
-> **All Users** - The workflow will be applied to all the users,
-> **Teams** - The workflow will be applied to a team(s) and enter the team names.
-> **Selected Users** - The workflow will be applied to the selected users, and then the names of the different users will be entered.
* Under "**When," select the"Module" and event from the dropdown** menus from which the workflow will be initiated.
* Under "If following conditions are met," click "**Add Condition**.".
* Select Field - Select the name of a field from the drop-down. -> Select type - The condition. -> Enter the value. (Job Category >> Equals To >> Mobile server)
Note: The fields on the first list are based on the event selected from the when section.
* Under "**Then do these actions**," click "**Add Action**". -> Module - Select the module on which the actions is to be performed. -> Action Type - Select the type of action to be performed on the selected module. -> Type of Operation - Select the type of operation, providing more details on the action.
* Click "**Save Workflow**".
* The workflow setup is divided into 3 simple steps. -> WHEN -> IF following conditions are met -> THEN do these Actions
## WHEN
"When" is the base condition for the workflow that determines which event, if selected, should trigger the workflow. To set up the workflow, select the appropriate module and the corresponding event. The following Modules are available from Zuper.
1. Jobs
2. Customers
3. Quotes
4. Invoices
5. Assets
6. Payments
7. Request
8. Project
WHEN a condition is met, the workflow should be triggered. Hence, the event for the module should be chosen. Events serve as triggers for specific actions that span across various modules, including Status Updates, New Customer, Job Updates, and more.
## If the following conditions are met
\
Here, we need to set the condition for the workflow. If the condition(s) are If satisfied, the workflow will be executed.
1. The first one is the Field against which the condition will be validated; it can be a Job Title, a customer’s zip code, or even a custom field.
2. Once you select the base field, the next one will be the conditional field “**Type**.” Under this, we have text-based values: Equal To, Not Equal To, Contains, and Not Contains, as well as number-based values: Greater Than, Less Than, Greater Than or Equal To, and Less Than or Equal To.
3. We will add a value that needs to be checked against the base field value (point number 1). It should be related to the field we select. For example, if the field selected is "**Job Category**," the value we enter should be a valid Job Category name. -> Select Equal To when the base value matches the value entered in the third field. -> Select Not Equal To when the base value doesn't match the value entered in the third field. -> Select Contains if the value entered in the third field is a part of the selected base field type. -> Select Not Contains when the value entered isn't part of the selected base value.
4. We can add multiple conditions to be checked with/against. After adding the first condition, click "**+ New Add Condition**” (available below the fields) and select AND or OR depending on the condition. Upon selecting AND, the system will check both conditions. If both conditions are satisfied, then the workflow will be triggered. If OR is selected, then the system will check both conditions. If either of them is true, then the action will be triggered.
5. Repeat steps 1 - 3.
## Then do these actions
\
This is the post-action for the workflow. When the workflow is triggered, the action setup will take place.
1. **Module**: Select the appropriate module where the action should occur.
2. **Action Type** : Select the action type to **create**, **update**, or **delete**.
3. **Type Of Operation** : Select the type of update that should take place. For eg, Updation of Job Assignment or Updation of Status.
4. Whatever we select under workflow applicability should be reflected in this field. Click the field and select the value. For example, if the workflow applicability is Teams, click on the field and select “**Choose Team**.”
5. In the next field, select the appropriate value(team/user, etc).
6. If required, we can add multiple actions that need to be performed. Click “**+ Add Action**” and repeat steps 1 - 5.

Click "**Save Workflow**" to create the workflow.
### Sample Scenario
To understand the setup better, check the example workflow given below.
Workflow Scenario : Whenever a new job is created in the system, IF the Customer Zip Code is “**70116**” and the customer belongs to “**Michigan**” state, then the Job should be automatically assigned to the user “**Floyd Lawton**”.
Workflow setup : Let us look at the scenario step-by-step.
**WHEN** a new job is created,
**IF** the zip code of the customer is “**70116**” and belongs to the state of **Michigan**
**THEN** assign the job to the user “**Floyd Lawton**”.
Steps to set up the sample workflow :
1. Click on the “**+ New Workflow**”.
2. Enter an appropriate workflow name and description.
3. Under Workflow Applicable To, click on Selected Users, enter “**Floyd Lawton**” and select the user from the dropdown.
4. Under '**When**', select the module as '**JOBS**' and select the event as a new job.
5. Under IF condition, select the base field as customer address - Zip code, select the condition type as "**Equal To**", and then enter the value “**70166**” in the third field.
6. To add the other condition, click on “**+ Add Condition**”.
7. Select AND under the condition type.
8. In the base field, select Customer Address - State.
9. Set the condition to Equals To, and then enter the value “**Michigan**” in the third field.
10. Under "**Do these actions**", select the module as Jobs.
11. Select the Action Type as Update.
12. Under Type of Operation, select Update Job Assignment - Assign.
13. In the next step, select Choose Team, then click on the relevant team name (Idaho Falls, Idaho in this scenario).
14. The final step is to click on the user FLOYD and then click on “**Save Workflow**”.
# Configuring Asset Settings
Source: https://docs.zuper.co/Settings/Modules/Assets/Assets-Settings
The "**Asset Settings**" allows you to manage Asset Settings in Zuper, including categories, templates, custom fields, inspection forms, and general settings.
## General asset settings
General settings allow you to define default behaviors for the Asset.
**Navigation**: *Settings -> Modules -> Assets - > Assets General Settings*
1. Select the "**Settings**" module from the left panel. Under the "**Modules**,"choose the "**Assets**." Select the "**Asset General Settings**."

* **Allow Field Executive to view all Assets?**: Toggle "**Yes**" or "**No**" to allow/disallow the field executive to view all assets.
* **Allow Team Leader to view all Assets?:** Toggle "**Yes**" or "**No**" to allow/disallow the team leader to view all assets.
* **Mandate Serial No?**: Toggle “**Yes**” or “**No**” to enable or disable mandatory serial number entry for asset-linked parts or services in transactions.
* **Mandate asset association to line items?**: Toggle “**Yes**” or “**No**” to enforce asset association for each line item in a quote. If this is enabled and the quote has one or more associated assets, users must assign an asset to each line item; otherwise, an error occurs when saving
* Click **Save** to apply changes.

## Asset category
Asset Categories help classify the assets.
**Navigation**: Settings -> Modules -> Assets - > Assets Category
1. Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the "**Assets**." Select the "**Assets Category**."

2. Under the asset category, click "**+ New Category** " to create the asset category.

3. Enter the category name and description.

4. Click "**Create**."
## **Asset custom fields**
**Navigation**: *Settings -> Modules -> Assets - > Assets Custom Fields*
1. Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the "**Contracts**." Select the "**Assets Custom Fields**."

2. Drag and drop the fields from the right panel.\\
> [accordion] Text
>
> * Single-Line Input: This allows you to create a field to enter a single line of free text.
> * Multi-Line Input: This allows you to create a field to enter multiple lines of free text.
> [accordion] Date
>
> * Date Input: This allows you to create a field to select a specific date from a calendar.
> * Time Input: This allows you to create a field where you can select a specific time.
> * Date Time Input: This allows you to create a field where both date and time can be selected.
> [accordion] Selection
>
> * Single-Selection: This allows you to create a radio input Field where one of the provided options can be selected.
> * Multi-Selection: This allows you to create check boxes where the provided options can be checked.
> * Drop-Down: This allows you to create a drop-down field with the required list of options.
> [accordion] Media
>
> * Upload: This allows you to create a file input field to upload files.
> [accordion] Misc
>
> * Look up: This allows you to create a file input field to look up the products from the parts and services module.
> [!NOTE]
>
> **Note**: You can also control the behavior and visibility of each field using the following options:
>
> * Mark as Required Field - Makes the field mandatory to fill out before submitting the form.
> * Mark as Read Only—This option makes the field non-editable; users can view the value but cannot modify it.
> * Mark as hidden field- This hides the field from all users; it will not appear in the form interface.
> * Hide to FE/Technician- This option makes the field invisible to technicians or front-end users during form access.


3. Click “**Create New**” to create the “**Custom Field**” group.
## **Asset inspection forms**
**Navigation**: *Settings -> Modules -> Assets - > Asset Inspection Forms*
An asset inspection form is a checklist for the field technician to conduct asset inspections and record maintenance activities. These forms also play a crucial role in streamlining the inspection process and improving overall efficiency.
1. **Inspection Form Name** – Enter the inspection form name.
2. **Description** – Enter the form description.


## **Asset templates**
Asset templates allow you to standardize asset formats for consistency.
**Navigation**: Settings -> Modules -> Assets - > Assets Templates\_
1. Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the "**Assets**." Select the "**Asset Templates**."

2. Click "**+ New Template**" to create the new template.

3. Fill in the template details and click "**Save Template**."

4. Click "**Proceed**" to create the template.
By following the outlined steps, you can easily manage the asset categories, templates and permissions.
# Configuring Contract Settings
Source: https://docs.zuper.co/Settings/Modules/Contracts/contracts-settings
The **Contract Settings** allow you to configure and customize contract-related features.
## General contract settings
General settings allow you to define default behaviors for the contract.
**Navigation**: *Settings -> Modules -> Contracts - > Contracts General Settings*
1. Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the "**Contracts**." Select the "**Contract General Settings**."

2. Enter the following details.
Contract Prefix – Define a prefix for the contract number.
Default Remarks for Contract: Add default remarks that will appear on all contracts.
Require Customer/Contact approval?: Toggle "**Yes**" or "**No**" to turn the customer/contact approval on or off.
Allow sending public link to Customers/Contacts?: Toggle "**Yes**" or "**No**" to allow/disallow sending contracts as a public link.
Notify Customer/Contact for Contract Approval?: Toggle "**Yes**" or "**No**" to notify or not notify the customer/contact for contract approval.
Allow Field Executive to view all Contracts?: Toggle "**Yes**" or "**No**" to allow/disallow the field executive to view all contracts.
Allow Team Leader to view all Contracts?: Toggle "**Yes**" or "**No**" to allow/disallow the team leader to view all contracts.
Default Contract PDF FileName: Set the default filename format for contract PDFs.
Choose Contract Component: Select components to include in contracts.

Click **Save** to apply changes.
## Contract billing period settings
Billing periods define how frequently invoices are generated for contracts.
**Navigation**: *Settings -> Modules -> Contracts - > Contracts Billing Period Settings*
1. Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the "**Contracts**." Select the "**Contract Billing Period Settings**."

2. Under billing period settings, click "**+ New Billing Period**" to create the billing period.

3. Fill in the billing period details – Name and Value. Choose the type (Days, Weeks, Months).
Click "**Save Billing Period** ."

## **Contract custom fields**
**Navigation**: *Settings -> Modules -> Contracts - > Contract Custom Fields*
1. Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the "**Contracts.**" Select the "**Contracts Custom Fields**."

Drag and drop the fields from the right panel.
Text
* Single-Line Input: This allows you to create a field to enter a single line of free text.
* Multi-Line Input: This allows you to create a field to enter multiple lines of free text.
Date
* Date Input: This allows you to create a field to select a specific date from a calendar.
* Time Input: This allows you to create a field where you can select a specific time.
* Date Time Input: This allows you to create a field where both date and time can be selected.
Selection
* Single-Selection: This allows you to create a radio input Field where one of the provided options can be selected.
* Multi-Selection: This allows you to create check boxes where the provided options can be checked.
* Drop-Down: This allows you to create a drop-down field with the required list of options.
Media
* Upload: This allows you to create a file input field to upload files.
Misc
* Look up : This allows you to create a file input field to look up the products from the parts and services module.
> [!NOTE]
>
> Note: You can also control the behavior and visibility of each field using the following options:
>
> * Mark as Required Field - Makes the field mandatory to fill out before submitting the form.
> * Mark as Read Only—This option makes the field non-editable; users can view the value but cannot modify it.
> * Mark as hidden field- This hides the field from all users; it will not appear in the form interface.
> * Hide to FE/Technician- This option makes the field invisible to technicians or front-end users during form access.
Click “**Create New**” to create the “**Custom Field**” group.

## **Contract templates**
Contract templates allow you to standardize contract formats for consistency.
**Navigation**: *Settings -> Modules -> Contracts - > Contracts Templates*
1. Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the "**Contracts**." Select the "**Contract Templates**."

2. Click "**+ New Template**" to create the new template.

3. Fill in the template details and click "**Save Template**."

## **Contract approval settings**
Approval settings control how contracts are approved within your organization.
**Navigation**: *Settings -> Modules -> Contracts - > Contracts Approval Settings*
1. Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the "**Contracts**." Select the "**Contract Approval Settings**."

2. Navigate to Timesheet Approval to manage approval hierarchies.
* Add a new hierarchy by clicking + New Approval Hierarchy.

* Assign users and levels for approval (For instance, John McKeever at Level 1).

Click "**Create**" to create the approval hierarchy.
## **Follow-up reminders**
**Navigation**: *Settings -> Modules -> Contracts - > Contracts Follow up reminders*
The users can instantly send follow-up reminders before or after a particular date via SMS or Email.
1. Select the "**Settings**" module from the left panel. Under the "**Module**s," Choose the "**Contracts**." Select the "**Contract** **Follow-up Reminders** ."

2. Click " **+ New Reminder** " to create the follow-up reminder.

3. a) Under "**Remind To**"-The user can send a follow-up reminder to the back office and the customer. The drop-down box lists: "**Customer**," "**Selected Users**," and "**Selected Teams**."
b) Under "**Reminder Name**" - Type the name for the reminder.
c) Under "**Remind After / Remind Before**" -The reminder can be sent "**Before**"\
or "**After**."\
d) **Remind At** – Enter the time of the reminder.\
e) Under "**Reminder Type**" -The reminder type can be either "SMS" or "Email."\
f) **SMS Body** & **Available Components** – Choose the available components and create the SMS body.

Click "**Create**" to create the follow-up reminder.
## Contract packages
Contract packages allow you to bundle multiple contracts, templates, and settings into a single package for streamlined management.
**Navigation**: *Settings -> Modules -> Contracts - > Contract Packages*
Click the "**+ New Contract Package**" button in the top-right corner. A dialog box titled "**Create Contract Package**" will appear.

Fill in the following fields:
* Package Prefix: Define a prefix for the contract.
* Package Name: Enter a name for the package.
* Description: Provide a description.
* Contract Terms: Enter the contract terms in months.
* Contract Templates: Choose the contract templates to associate with this package.
* Click the "**+ Add**" button to add individual parts, products, and services. Alternatively, use the drop-down menu next to the "+ Add" button to:
Add from Group: Select a predefined group of items to add to the package.
Bundle: Add a product or service bundle. Note that bundles added here will not appear as a product type in the filter menu.
* Billing Period: Assign a billing period from the drop-down menu.
* Generate Invoice Before Days: Enter the days before the invoice can be
generated.
* Payment term: Choose the payment term from the drop-down menu.
* Invoice Template: Choose the template from the drop-down menu.
* Automatically Generate Invoice: Toggle "**Yes**" or "**No**" to turn the automatic invoice generation on or off.
* Send Invoice to Contact: Toggle "**Yes**" or "**No**" to turn the automatic invoice sending to the contact on or off.

Click + **Save** **Packag**e to create the package.
# Configuring Customer-Contact Settings
Source: https://docs.zuper.co/Settings/Modules/Customers-Contacts/Customers-Contacts-Settings
Customer and contact settings control how Zuper stores, displays, and manages the people and businesses you work with. From here, you decide which fields are required, who on your team can create or edit records, how billing cycles work, and when automated reminders go out. Getting these settings right saves your team time every day and keeps your customer data consistent across jobs, invoices, and reports.
**Navigation**: *Settings -> Modules -> Customers-Contacts - > Customers-Contacts General Settings*
## **Customer-contact General settings**
General settings control the core behavior of every customer and contact record in Zuper. Use these toggles to set up unique identifiers, debt alerts, payment options, and portal access before your team starts adding records.
Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Customer/Contact**.” Select the “**Customer/Contact General Settings**.”

**Select a unique field for customer/contact**\
Choose the field Zuper uses to identify each customer or contact record uniquely. This prevents duplicate records and helps your team find the right customer quickly.
**Show a bad debt alert upon choosing a customer/contact**\
Toggle to **Yes** to display a warning when a customer with an outstanding bad debt balance is selected on a job or invoice. Toggle to **No** to turn off this alert.
> [!NOTE]
>
> Enable this setting if your team regularly works with customers who have overdue balances. The alert appears at the point of selection, so your team can take action before work begins.
**Allow payment card on file**\
Toggle to **Yes** to let your team store a customer's payment card against their record. Toggle to **No** to turn off this option.
**Enable billing cycle**\
Toggle to **Yes** to activate billing cycle functionality for customers and contacts. Toggle to **No** to turn it off.
**Does customer/contact need an account manager**\
Toggle to **Yes** to allow an account manager to be assigned to each customer or contact record. Toggle to **No** to remove this option.
**Enforce geo-location in address**\
Toggle to **Yes** to require a verified geo-location when an address is entered on a customer or contact record. Toggle to **No** to allow addresses without location verification.
**Enable portal access by default** Toggle to **Yes** to automatically grant new customers and contacts access to your customer portal when their record is created — this also triggers an automatic portal invitation (welcome) email to the customer. Toggle to **No** to require manual setup of portal access and skip the welcome email by default.
> [!NOTE]
>
> This setting controls the default for all new records. To control portal access and the welcome email for a single contact instead, use the **Portal Access** field on that contact's creation form — see [Adding new contact](/Client/Contact/Create_contact#portal-details).
> [accordion] Enable lead source
>
> Lead source tracking lets you record where each new customer or job originates — for example, a website form, a phone call, or a referral. When this setting is on, the **Lead Source** field appears on customer, contact, and job records, and becomes available in filters, reports, and dashboards.
>
> **Navigation**: *Settings → Modules → Customer/Contact → Customer/Contact General Settings*
>
> **Track lead source**\
> Toggle to **Yes** to enable lead source tracking for new and existing customers and contacts. Toggle to **No** to turn off this field across all records.
>
> 
>
> > [!NOTE]
> >
> > You must also create individual lead sources before your team can select them on records. See [Lead sources](#lead-sources) below for steps to add sources.
>
> Select **Save** at the top right of the page to apply your changes.
> [accordion] Auto-create property
>
> [**Automatically create property upon customer/contact creation**](https://docs.zuper.co/Client/Contact/Create_contact#auto-create-property)\
> Toggle to **Yes** to have Zuper automatically create a linked property record each time a new contact is created. Toggle to **No** to turn off automatic property creation.
>
> 
>
> > [!NOTE]
> >
> > This setting must be enabled by your administrator. When it is on, every new contact generates a corresponding property record without any additional steps from your team — useful if your business always associates a service address with each contact.
Click **Save** in the top-right corner.
## **Access / Permissions**
Access and permissions settings control what team leaders and field executives can see and do within the Customers/Contacts module. Review these settings carefully — they affect what your field team can access on the mobile app.
**Navigation**: *Settings → Modules → Customer/Contact → Customer/Contact General Settings*
Configure the following options:
**Can team leader view all customers/contacts**\
Toggle to **Yes** to give team leaders visibility of all customer and contact records. Toggle to **No** to restrict their view.
**Can field executive create new customer/contact**\
Toggle to **Yes** to allow field executives to add new customer and contact records from the mobile app. Toggle to **No** to prevent this.
**Can field executive edit customer/contact details**\
Toggle to **Yes** to allow field executives to update existing customer and contact records. Toggle to **No** to make records read-only for field executives.
**Can field executive view all customers/contacts**\
Toggle to **Yes** to give field executives access to all customer and contact records. Toggle to **No** to limit their visibility.
**Does field executive require facial authentication to view customers/contacts**\
Toggle to **Yes** to require field executives to complete facial authentication before viewing customer or contact records. Toggle to **No** to remove this requirement.
**Can field executive view customers/contacts without punching in**\
Toggle to **Yes** to allow field executives to view records before they punch in to a shift. Toggle to **No** to require a punch-in before access is granted.
Select **Save** at the top right of the page to apply your changes.
> [accordion] Create lead sources
>
> Lead sources are the specific channels you want to track — Website, Phone Call, Instagram, or Referral. Once you create a lead source here, your team can select it on customer, contact, and job records. Lead sources feed into your filters, dashboards, and reports, giving you a clear view of which channels bring in the most business.
>
> **Navigation**: *Settings → Modules → Customer/Contact → Lead Sources*
>
> ### Add a lead source
>
> 1. Select **Settings** from the left navigation panel.
> 2. Under **Modules**, select **Customer/Contact**.
> 3. Select **Lead Sources**.
>
> 
>
> 4. Select + New Source.
>
> 
>
> 5. Enter the source name in the field provided.
>
> 
>
> Select Create. The new lead source appears in the list and is immediately available for selection on customer, contact, and job records.
## **Customer/contact category**
Categories let you group customers and contacts by type — for example, Residential, Commercial, or VIP. Each category can carry its own service level agreement (SLA) duration, so Zuper can track whether jobs for that group are completed on time.
**Navigation**: *Settings → Modules → Customer/Contact → Customer/Contact Category*
1. Select **Settings** from the left navigation panel.
2. Under **Modules**, select **Customer/Contact**.
3. Select **Customer/Contact Category**.

4. Select **+ New Category**.

A dialog box appears. Enter the following details:
* **Category name** *(required)*: Enter a name for the category.
* **SLA duration**: Set the expected time to complete service for customers in this category. Enter a value in days, hours, and minutes.
* **Category description**: Enter a brief description of the type of customers or contacts that belong to this category.
6. Select **Create**. The new category appears in the list and is available for selection on customer and contact records.
> [!NOTE]
>
> Fields marked with an asterisk (\*) are required. You cannot create a category without entering a category name.
## **Billing frequency**
1. Select **Settings** from the left navigation panel.
2. Under **Modules**, select **Customer/Contact**.
3. Select **Billing Frequency**.

4. Select **+ New Billing Frequency**.

5. Enter the following details:
* **Billing frequency name**: Enter a name for this frequency — for example, Monthly or Quarterly.
* **Frequency type**: Select the type that applies.
* **Billing frequency period**: Enter the number of days in the billing period.
3. Enter the billing frequency, choose the frequency type, and the billing frequency period (in days).
Click “**Create**” to create the billing frequency.

> [!NOTE]
>
> The **Enable Billing Cycle** toggle in [General Settings](#customer-contact-general-settings) must be turned on before billing frequencies appear on customer and contact records.
## **Customers-contacts custom fields**
**Navigation**: Settings -> Modules -> Customer-Contact -> Customer-Contact Custom Fields
1. Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the " **Customer-Contact.**" Select the "**Customer-Contact Custom Fields**."

Custom fields let you capture information about customers and contacts that Zuper does not collect by default — for example, a preferred contact time, a contract reference number, or a property type. You build custom fields by dragging field types from the right panel onto the form layout.
**Navigation**: *Settings → Modules → Customer/Contact → Customer/Contact Custom Fields*
### Add custom fields
1. Select **Settings** from the left navigation panel.
2. Under **Modules**, select **Customer/Contact**.
3. Select **Customer/Contact Custom Fields**.
4. Drag a field type from the right panel onto the form layout. The following field types are available:
**Text**
* **Single-line input**: Captures a single line of free text.
* **Multi-line input**: Captures multiple lines of free text — useful for notes or descriptions. **Date**
* **Date input**: Lets the user select a date from a calendar.
* **Time input**: Lets the user select a specific time.
* **Date and time input**: Lets the user select both a date and a time together. **Selection**
* **Single-selection**: Displays radio buttons where only one option can be chosen.
* **Multi-selection**: Displays checkboxes where one or more options can be chosen.
* **Drop-down**: Displays a drop-down list of options. **Media**
* **Upload**: Allows a file to be attached to the record. **Miscellaneous**
* **Look up**: Lets the user search for and select a product from the Parts and Services module.
### Control field behavior
After you add a field, you can adjust how it behaves using the following options:
| Option | What it does |
| - | - |
| **Mark as required field** | Makes the field mandatory before a record can be saved. |
| **Mark as read only** | Displays the field value but prevents users from editing it. |
| **Mark as hidden field** | Hides the field from all users. It does not appear on the form. |
| **Hide to field executive/technician** | Hides the field from field executives and technicians on the mobile app. |
5. Select **Create New** to save the custom field group.
> [!TIP]
>
> Use the **Mark as required field** option for any information your team must collect on every new record. This keeps your data complete from the start.
## **Customer/contact reminder**
Reminders are automated messages sent to customers or your team at a set time before or after a job event. Use them to reduce no-shows, prompt action, or keep customers informed without manual follow-up.
**Navigation**: *Settings -> Modules -> Customer-Contact -> Customer-Contact Custom Notifications*
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” click “**Customer/Contact Notifications**.”

2. Click “**+ New Reminder**.”

3. Fill in the reminder details
* Reminder Name: Enter a name for the reminder.
* Job Category: Select the job category.
* Notification Type: Choose the type of notification.
* Remind Type: Select the reminder type.
* Remind At / Before: Set a specific time for the reminder.
* SMS / Email Body: Enter the message content. Use the Available Components dropdown to insert dynamic fields, such as customer fields or job details (e.g., "The scheduled job starts at...").
* Notify for Unassigned Jobs: Check this box to receive a reminder to apply.

Click “**Save Reminder**” to save the reminder.
## **Customer/contact alerts**
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” click “**Customer/Contact Notifications**.”

2. Click “**+ New Notification**.”

3. Enter the following details:
* **Notification name**: Enter a clear, descriptive name for the alert — for example, "Job completed notification."
* **Notification type**: Select whether the alert is sent by SMS, email, or both.
* **Job category**: Select the job category this alert applies to.
* **Job status**: Select the job status that triggers this alert — for example, Completed or On My Way.
* **SMS/email body**: Enter the message to be sent. Select the **Available components** drop-down to insert dynamic fields and personalize the message automatically.
Click “**Save Notification**” to set the notification.

Click “**Save Reminder**” to save the alert.
# Configuring Job Card Templates
Source: https://docs.zuper.co/Settings/Modules/Jobs/Configuring-job-card-template
In Zuper, administrators can configure job card templates by defining categories, layouts, and content formatting options. The templates can be customized based on business needs, providing flexibility in format, orientation, border settings, and text styling.
This guide explains how to create, edit, and manage job card templates in Zuper.
**Navigation**: *Settings -> Modules -> Jobs -> Job Card Templates*
## Navigating to job card templates
To configure job card templates, follow these steps:
* Select the "**Settings**" module from the left navigation menu.
* Click "**Modules"** and select "**Jobs**" to open the Job Settings page.
* Choose **Job Card Templates**.

* The job card templates listing page will appear, displaying all existing templates.
## Creating a new job card template
To create a new job card template:
* On the job card templates listing page, click **+ New Template**.

* A new job card template dialog box will appear.
* Fill in the following details:
1. **Template Name** (*Mandatory*): Enter a unique name for the job card template.
2. **Job Category** (*Mandatory*): Select the relevant job category from the dropdown menu.
3. **Template Description** (*Mandatory*): Provide a brief description of the template.
4. **Format** (*Mandatory*): Choose the document size from the available options:
* A3
* A4
* A5
* Letter
* Legal
* Tabloid
5. **Orientation** (*Mandatory*): Select either **Landscape** or **Portrait**.
6. **Border Settings** (*Mandatory*): Define the margins for the job card layout:
* Top Border (e.g., 10mm)
* Right Border (e.g., 10mm)
* Bottom Border (e.g., 10mm)
* Left Border (e.g., 10mm)
7. Click **Proceed** to move to the template editor.
**Editing a job card template's content**
Once the template is created, you can customize the content using the Template Editor.
**Template editor customization options**
The Template Editor offers various formatting tools and components to help you design and structure your job card layout with ease.
**Text formatting options**
Basic text formatting options such as font size, font styling (bold, italic, underline, strikethrough), headers, and bullet/numbered lists are available to help you format your content effectively.

**Additional formatting options**
1. **Table**: Add tables to organize and display information in a structured manner.
2. **Field Components** – Easily search for and insert default system fields like:
* Work Order Number
* Job Priority
* Job Description
* Customer Email
* Assigned to FE and more.
Once you have customized the template, click **Save** to successfully create your Job Card Template.

> [!NOTE]
>
> Note: The Template Editor also includes a Code Mode. Switching to code mode allows you to create and edit templates directly using HTML for greater customization.
>
> 
> [!NOTE]
>
> **Note:** Job Card Templates control documents generated from within a **Job** record (work orders, checklists, inspection reports). To customize the PDF used when sending or printing a **Quote**, use [Quote & Invoice Templates](/Settings/Modules/Quotes-Invoices/Quotes-Invoices-Settings#how-to-create-and-customize-a-document-template) instead.
## Editing a job card template
To modify an existing job card template:
* Navigate to the job card templates listing page.
* Click the pencil icon next to the specific template.

* The template editor will open.
* Make the necessary changes.
* Click **Save** to update the template.
## Deleting a job card template
If a job card template is no longer needed, follow these steps to delete it:
* Navigate to the job card templates listing page.
* Click the delete icon next to the template you want to remove.

* A confirmation dialog box will appear.
* Click **Delete** to permanently remove the job card template.
***
## Using dynamic variables in job card templates
**Navigation**: *Settings* → *Document Templates* → *Job Card Templates*
Job card templates in Zuper use dynamic variables to pull live data from a job directly into your document. When Zuper generates a job card, every placeholder in your template is replaced with real values — the customer name, the technician's checklist answers, the job status, and more.
You do not need a technical background to use these patterns. Each one follows the same logic: wrap the data you want in the correct set of tags, and Zuper fills in the rest when the document renders. Think of each pattern as a reusable building block. Copy it into your template, adjust the field names to match your setup, and combine patterns to build more complex layouts.
This article is a reference companion to the Job Card Templates feature. For steps on creating or editing a template, see [Configuring Job Card Templates](#).
> [!NOTE]
>
> Every dynamic variable expression sits between double curly braces: `{{ }}`. Expressions that open a block — such as a loop or a condition — also need a closing tag. For example, `{{#each checklist}}` opens a loop and `{{/each}}` closes it. A missing closing tag is one of the most common causes of a template not rendering correctly.
***
Before you start
Two building blocks appear throughout every pattern in this article.
* A **field** is any piece of job data you want to display — for example, `{{job_title}}` or `{{customer.customer_first_name}}`.
* A **helper** is a built-in function that lets you loop through a list, compare values, split text, or format a date before it renders.
> [!NOTE]
>
> An **array** is a list of items that Zuper stores together — for example, all the checklist questions on a job, or all the assets linked to a work order. When a pattern in this article refers to an array, think of it as a collection you can loop through, one item at a time.
**Helper quick reference**
Use this table as a fast lookup while you build your template.
| Helper | Purpose |
| - | - |
| `{{#each array}}` | Loop any array |
| `{{#eachLastInstance array "key"}}` | Return only the latest entry in an array by key |
| `{{#if field}}` | Render content only if the field has a value |
| `{{#stringEq a "b"}}` | Match strings — loose, not case-sensitive |
| `{{#stringEqStrict a 'b'}}` | Match strings — strict and case-sensitive |
| `{{#split field ','}}` | Split a string and loop each part |
| `{{.}}` | The current value inside a `{{#split}}` or `{{#each}}` loop |
| `{{../field}}` | Access a field from the parent scope |
| `{{formatDateWithTimeZone date "MM/DD/YYYY" timezone}}` | Format a date with a time zone |
***
## Patterns
> [accordion] Pattern 1 — Checklist loop and question matching
>
> Use this pattern when you want to display the answer to a specific checklist question — for example, a pre-work photo or a remarks field. Loop through all checklist items with `{{#each checklist}}`, then use `{{#stringEqStrict question 'Your Question Name'}}` to target the exact question you want. Add one block per question you need to display.
>
> **Key fields:** `checklist`, `question`, `answer`
>
> ***
>
> Example 1 — Display a photo answer
>
> Use this example when your checklist question captures one or more photos. Zuper stores photo answers as a comma-separated list of image links, so the template splits that list and renders each image individually.
>
> ```handlebars theme={null}
> {{#each checklist}}
>
> {{#stringEqStrict question 'Pre-Work Photo'}}
> {{#if answer}}
> {{#split answer ','}}
>
> {{/split}}
> {{/if}}
> {{/stringEqStrict}}
>
> {{/each}}
> ```
>
> > [!TIP]
> >
> > Replace `'Pre-Work Photo'` with the exact name of your photo question. Question names are case-sensitive — the capitalization must match what appears in your checklist exactly.
>
> ***
>
> Example 2 — Display a text remarks answer
>
> Use this example when your checklist question captures a free-text response. Zuper stores multi-line text answers with a line break between each entry, so the template splits on that break and wraps each line in its own paragraph.
>
> ```handlebars theme={null}
> {{#each checklist}}
>
> {{#stringEqStrict question 'Misc. Remarks'}}
> {{#if answer}}
> {{#split answer '\n'}}
> {{.}}
> {{/split}}
> {{/if}}
> {{/stringEqStrict}}
>
> {{/each}}
> ```
>
> > [!TIP]
> >
> > Replace `'Misc. Remarks'` with the exact name of your text question. To display answers for additional questions, copy this block and update the question name for each one.
> [accordion] Pattern 2 — Service task and asset inspection: label field lookup
>
> Use this pattern when you want to display a specific answer from an inspection form — for example, the shingle type recorded during a roof inspection, or the condition noted during an equipment check. Zuper stores inspection answers inside each service task or asset on the job. This pattern finds the answer by its field name and displays it in your document.
>
> Inspection forms can be attached to a job in two ways — through a service task, or directly through an asset. The code you use depends on where the inspection form lives.
>
> **Key fields:** `service_tasks` / `assets`, `label`, `value`
>
> ***
>
> **Service task version**
>
> **What each line does:**
>
> | Expression | What it does |
> | - | - |
> | `{{#each service_tasks}}` | Opens the loop — goes through every service task on the job, one at a time |
> | `{{#stringEqStrict service_task_title "ROOF INSPECTION"}}` | Finds the specific service task you want by matching its title exactly |
> | `{{#if asset_inspection_submission_uid}}` | Checks that an inspection form has been submitted for this service task — skips the task if nothing was filled in |
> | `{{#if asset_inspection_submission_uid.data}}` | Checks that the submitted form contains field data before trying to display anything |
> | `{{#each asset_inspection_submission_uid.data}}` | Opens the inner loop — goes through every field in the inspection form, one at a time |
> | `{{#stringEqStrict label "Shingle Type:"}}` | Finds the specific field you want by matching its label exactly |
> | `{{#if value}}{{value}}{{/if}}` | Displays the field value only if one exists — leaves no blank gap if the field was not filled in |
>
> ```handlebars theme={null}
> {{#each service_tasks}}
> {{#stringEqStrict service_task_title "JOB WALK FORM"}}
> {{#if asset_inspection_submission_uid}}
> {{#if asset_inspection_submission_uid.data}}
>
>
> | Client/contact name: |
>
> {{#each asset_inspection_submission_uid.data}}
> {{#stringEqStrict label "Client/contact name:"}}
> {{#if value}}{{value}}{{/if}}
> {{/stringEqStrict}}
> {{/each}}
> |
> Type of service: |
>
> {{#each asset_inspection_submission_uid.data}}
> {{#stringEqStrict label "Type of service:"}}
> {{#if value}}{{value}}{{/if}}
> {{/stringEqStrict}}
> {{/each}}
> |
>
>
> {{/if}}
> {{/if}}
> {{/stringEqStrict}}
> {{/each}}
> ```
>
> > [!TIP]
> >
> > Replace `"JOB WALK FORM"` with your task title exactly as it appears in Zuper — including capitalization. Replace the label string to pull any field by its name.
>
> ***
>
> **Asset version**
>
> **What each line does:**
>
> | Expression | What it does |
> | - | - |
> | `{{#each assets}}` | Opens the loop — goes through every asset on the job, one at a time |
> | `{{#if asset_inspection_form_submission_uid}}` | Checks that an inspection form has been submitted for this asset — skips the asset if nothing was filled in |
> | `{{#each asset_inspection_form_submission_uid.data}}` | Opens the inner loop — goes through every field in the inspection form, one at a time |
> | `{{#stringEqStrict label "Time Gas Leak Detector Used:"}}` | Finds the specific field you want by matching its label exactly |
> | `{{#if value}}{{value}}{{/if}}` | Displays the field value only if one exists — leaves no blank gap if the field was not filled in |
>
> ```handlebars theme={null}
> {{#each assets}}
> {{#if asset_inspection_form_submission_uid}}
> {{#each asset_inspection_form_submission_uid.data}}
> {{#stringEqStrict label "Time Gas Leak Detector Used:"}}
> {{#if value}}
>
> | Time Gas Leak Detector Used: |
> {{value}} |
>
> {{/if}}
> {{/stringEqStrict}}
> {{/each}}
> {{/if}}
> {{/each}}
> ```
>
> > [!NOTE]
> >
> > The asset version does not need a title match step. Every asset on the job is checked automatically, and the inspection form attached to each one is read in turn. This pattern prints values from every asset inspection form associated with the job. If the job has multiple assets, each with its own inspection form, the document displays a result for each one. Review your output after generating the document to confirm the results are as expected.
> [accordion] Pattern 3 — Asset inspection: pass, fail, and N/A
>
> Use this pattern to display a color-coded visual for each field in an asset inspection form. The template loops through the inspection data and matches each result value to a styled badge.
>
> **Key fields:** `asset_inspection_submission_uid.data`, `label`, `value`
>
> ```handlebars theme={null}
> {{#each asset_inspection_submission_uid.data}}
>
> | {{label}} |
>
> {{#stringEqStrict value "Pass"}}
> Pass
> {{/stringEqStrict}}
> {{#stringEqStrict value "Fail"}}
> Fail
> {{/stringEqStrict}}
> {{#stringEqStrict value "N/A"}}
> N/A
> {{/stringEqStrict}}
> |
>
> {{/each}}
> ```
>
> > [!NOTE]
> >
> > Define `.badge-pass`, `.badge-fail`, and `.badge-na` in your template's CSS section to apply colors to each result badge. Copy the example below into your template's CSS section to get started. Adjust the colors to match your brand.
>
> ```css theme={null}
> /* Pass — green */
> .badge-pass {
> background-color: #e6f4ea;
> color: #2d6a4f;
> padding: 2px 8px;
> border-radius: 4px;
> font-weight: bold;
> }
> /* Fail — red */
> .badge-fail {
> background-color: #fdecea;
> color: #b91c1c;
> padding: 2px 8px;
> border-radius: 4px;
> font-weight: bold;
> }
> /* N/A — gray */
> .badge-na {
> background-color: #f3f4f6;
> color: #6b7280;
> padding: 2px 8px;
> border-radius: 4px;
> font-weight: bold;
> }
> ```
>
> > [!TIP]
> >
> > The colors above are suggestions. Replace the `background-color` and `color` values with your own hex codes to match your company's style. The `padding`, `border-radius`, and `font-weight` values control the badge's shape and size — leave these unchanged to start, then adjust as needed.
> [accordion] Pattern 4 — Job status: render sections by current status
>
> Use this pattern to show or hide sections of your template based on the job's current status. Zuper tracks every status a job passes through, but your document only needs to reflect where the job is right now. The `{{#eachLastInstance}}` helper handles this — it returns only the most recent status entry so the right section renders every time.
>
> **Key fields:** `job_status`, `status_name`
>
> > [!WARNING]
> >
> > Always use `{{#eachLastInstance job_status "status_name"}}` instead of `{{#each job_status}}`. Plain `{{#each}}` renders your content once for every status transition the job has ever had, not just the current one.
>
> ```handlebars theme={null}
> {{#eachLastInstance job_status "status_name"}}
>
> {{#stringEq status_name "Scheduled"}}
> Job is scheduled.
> {{/stringEq}}
>
> {{#stringEq status_name "Work Started Onsite"}}
> Work is in progress.
> {{! Nest Pattern 1 here to show pre-work photos }}
> {{/stringEq}}
>
> {{#stringEq status_name "Work On Hold Onsite"}}
> Work is on hold.
> {{/stringEq}}
>
> {{#stringEq status_name "Completed"}}
> Job completed.
> {{! Nest Pattern 1 here to show completion photos }}
> {{! Nest Pattern 2 here to show inspection results }}
> {{/stringEq}}
>
> {{/eachLastInstance}}
> ```
>
> > [!NOTE]
> >
> > Add more `{{#stringEq status_name "..."}}` blocks for any custom statuses in your workflow.
> [accordion] Pattern 5 — Dynamic checklist: type-based rendering
>
> Use this pattern when you want every checklist item to appear automatically as a two-column row — question on the left, answer on the right — without listing question names individually.
>
> **Key fields:** `checklist`, `question`, `answer`, `type`
>
> | Type value | Renders as |
> | - | - |
> | `HEADER` | Skipped — no row rendered |
> | `IMAGE` | Single image |
> | `MULTI_IMAGE` | Multiple images, split by comma |
> | `MULTI_ITEM` | Multiple paragraphs, split by comma |
> | `MULTI_LINE` | Multiple paragraphs, split by comma |
> | `SIGNATURE` | Signature image, split by comma |
> | `SINGLE_ITEM` | Single paragraph, split by comma |
> | Any other value | Plain text |
>
> ***
>
> Example 1 — Display a specific checklist answer as text
>
> Use this when you want to show the answer to one specific checklist question as plain text in your document. In this example, the question is "Work completed notes."
>
> ```handlebars theme={null}
> {{#eachLastInstance job_status "status_name"}}
> {{#stringEq status_name "Completed"}}
>
> {{#each checklist}}
> {{#stringEq question "Work completed notes"}}
>
> {{question}} |
>
> {{#if answer}}
> {{answer}}
> {{/if}}
> |
>
> {{/stringEq}}
> {{/each}}
>
> {{/stringEq}}
> {{/eachLastInstance}}
> ```
>
> This displays one row — the question on the left, the text answer on the right. All other checklist items are skipped.
>
> ***
>
> Example 2 — Display a specific checklist answer as an image
>
> Use this when the answer to a checklist question is a photo captured by the field executive. In this example, the question is "Site photo."
>
> ```handlebars theme={null}
> {{#eachLastInstance job_status "status_name"}}
> {{#stringEq status_name "Completed"}}
>
> {{#each checklist}}
> {{#stringEq question "Site photo"}}
>
> {{question}} |
>
> {{#if answer}}
>
> {{/if}}
> |
>
> {{/stringEq}}
> {{/each}}
>
> {{/stringEq}}
> {{/eachLastInstance}}
> ```
>
> This displays one row — the question on the left, the photo on the right. Replace `"Site photo"` with the exact question text from your checklist.
>
> > [!NOTE]
> >
> > Use these examples when you need a single specific checklist item. To display all checklist items at once, use the full dynamic loop in Pattern 5 above.
> [accordion] Pattern 6 — Common job variables
>
> Use these placeholders to display the most commonly used job, customer, and organization fields anywhere in your template.
>
> **Job details**
>
> | Field name | Placeholder |
> | - | - |
> | Work order number | `{{work_order_number}}` |
> | Job title | `{{job_title}}` |
> | Job description | `{{job_description}}` |
> | Job category | `{{job_category.category_name}}` |
> | Scheduled start time | `{{scheduled_start_time}}` |
> | Scheduled end time | `{{scheduled_end_time}}` |
>
> **Customer**
>
> | Field name | Placeholder |
> | - | - |
> | First name | `{{customer.customer_first_name}}` |
> | Last name | `{{customer.customer_last_name}}` |
> | Email address | `{{customer.customer_email}}` |
> | Mobile number | `{{customer.customer_contact_no.mobile}}` |
>
> **Address**
>
> | Field name | Placeholder |
> | - | - |
> | Street | `{{customer_address.street}}` |
> | City | `{{customer_address.city}}` |
> | State | `{{customer_address.state}}` |
> | ZIP code | `{{customer_address.zip_code}}` |
>
> **Assigned technician**
>
> | Field name | Placeholder |
> | - | - |
> | First name | `{{user.first_name}}` |
> | Last name | `{{user.last_name}}` |
> | Work phone number | `{{user.work_phone_number}}` |
>
> **Organization**
>
> | Field name | Placeholder |
> | - | - |
> | Organization name | `{{organization.organization_name}}` |
>
> > [!NOTE]
> >
> > Every placeholder above is optional. Wrap any placeholder in `{{#if field}}...{{/if}}` before adding it to your template. This prevents empty gaps in your document when a field has no value on a particular job.
> [accordion] Pattern 7 — Date formatting
>
> Use `formatDateWithTimeZone` to display any date field in a readable format. Always pass `timezone` as the third argument so dates display in the customer's local time zone.
>
> **Syntax:** `{{formatDateWithTimeZone field "FORMAT" timezone}}`
>
> ```handlebars theme={null}
> {{! Short date }}
> {{formatDateWithTimeZone scheduled_start_time "MM/DD/YYYY" timezone}}
>
> {{! Date with time }}
> {{formatDateWithTimeZone scheduled_start_time "MM/DD/YYYY hh:mm A" timezone}}
>
> {{! Full readable date }}
> {{formatDateWithTimeZone scheduled_start_time "dddd, MMMM DD, YYYY" timezone}}
> ```
>
> | Format token | Example output |
> | - | - |
> | `MM/DD/YYYY` | 04/29/2026 |
> | `MM-DD-YYYY` | 04-29-2026 |
> | `MM/DD/YYYY hh:mm A` | 04/29/2026 02:30 PM |
> | `dddd, MMMM DD, YYYY` | Wednesday, April 29, 2026 |
>
> > [!NOTE]
> >
> > `timezone` is a job-level field that Zuper populates automatically. Omitting it causes dates to display in UTC instead of the customer's local time zone.
> [accordion] Pattern 8 — Custom fields
>
> Use this pattern to display job-level custom fields. You can display a single field by its name, display all fields of a specific type, or display fields that belong to a specific group.
>
> **Key fields:** `custom_fields`, `label`, `value`, `type`, `group_name`
>
> ***
>
> **Example 1 — Display a specific custom field by name**
>
> Use this example when you want to display one specific custom field — for example, the invoice amount paid on a job. The template finds the field by matching its exact label and displays its value.
>
> | Expression | What it does |
> | - | - |
> | `{{#each custom_fields}}` | Opens the loop — goes through every custom field on the job, one at a time |
> | `{{#if group_name}}{{else}}` | Skips any fields that belong to a group — targets only standalone fields |
> | `{{#stringEqStrict label "Invoice amount paid"}}` | Finds the specific field by matching its label exactly |
> | `{{#if value}}{{value}}{{/if}}` | Displays the value only if one exists — leaves no blank gap if the field was not filled in |
>
> ```handlebars theme={null}
> {{#each custom_fields}}
> {{#if group_name}}{{else}}
> {{#stringEqStrict label "Invoice amount paid"}}
> {{#if value}}{{value}}{{/if}}
> {{/stringEqStrict}}
> {{/if}}
> {{/each}}
> ```
>
> > [!TIP]
> >
> > Replace `"Invoice amount paid"` with the exact label of your custom field as it appears in Zuper — including capitalization.
>
> ***
>
> **Example 2 — Display all fields of a specific type**
>
> Use this example when you want to display all custom fields of a given type — for example, all time fields or all multi-line text fields. The template loops through every custom field and renders each one that matches the type you specify.
>
> | Expression | What it does |
> | - | - |
> | `{{#each custom_fields}}` | Opens the loop — goes through every custom field on the job, one at a time |
> | `{{#if value}}` | Skips any fields with no value — prevents blank rows in your document |
> | `{{#stringEqStrict type "TIME"}}` | Matches all fields of the TIME type and formats the value as a readable time |
> | `{{formatCustomDate value "hh:mm A" "hh:mm A"}}` | Formats the time value — for example, 02:30 PM |
> | `{{#stringEqStrict type "MULTI_LINE"}}` | Matches all fields of the MULTI\_LINE type and displays the value as a paragraph |
> | `{{#stringEqStrict type "LOOKUP"}}` | Matches all fields of the LOOKUP type and displays the selected value |
>
> ```handlebars theme={null}
> {{#each custom_fields}}
> {{#if value}}
> {{#stringEqStrict type "TIME"}}
> {{label}}: {{formatCustomDate value "hh:mm A" "hh:mm A"}}
> {{/stringEqStrict}}
> {{#stringEqStrict type "MULTI_LINE"}}
> {{label}}: {{value}}
> {{/stringEqStrict}}
> {{#stringEqStrict type "LOOKUP"}}
> {{label}}: {{value}}
> {{/stringEqStrict}}
> {{/if}}
> {{/each}}
> ```
>
> > [!TIP]
> >
> > Add a `{{#stringEqStrict type "..."}}` block for each custom field type you use. Types you do not include produce no output and do not cause errors.
>
> ***
>
> **Example 3 — Display fields from a specific group by label**
>
> Use this example when your custom fields are organized into groups in Zuper — for example, a group called "Payment Details" that contains fields like "Invoice amount paid" and "Payment method." The template finds the group by name, then looks up the specific field you want by its label.
>
> | Expression | What it does |
> | - | - |
> | `{{#each custom_fields}}` | Opens the loop — goes through every custom field on the job, one at a time |
> | `{{#if group_name}}` | Checks whether the field belongs to a group — skips standalone fields |
> | `{{#stringEqStrict group_name "Payment Details"}}` | Finds the specific group by matching its name exactly |
> | `{{#stringEqStrict label "Invoice amount paid"}}` | Finds the specific field within the group by matching its label exactly |
> | `{{#if value}}{{value}}{{/if}}` | Displays the value only if one exists — leaves no blank gap if the field was not filled in |
>
> ```handlebars theme={null}
> {{#each custom_fields}}
> {{#if group_name}}
> {{#stringEqStrict group_name "Payment Details"}}
> {{#stringEqStrict label "Invoice amount paid"}}
> {{#if value}}{{value}}{{/if}}
> {{/stringEqStrict}}
> {{#stringEqStrict label "Payment method"}}
> {{#if value}}{{value}}{{/if}}
> {{/stringEqStrict}}
> {{/stringEqStrict}}
> {{/if}}
> {{/each}}
> ```
>
> > [!TIP]
> >
> > Replace `"Payment Details"` with your group name exactly as it appears in Zuper. Replace `"Invoice amount paid"` and `"Payment method"` with the exact labels of the fields you want to display from that group. Add one `{{#stringEqStrict label "..."}}` block for each additional field you need.
> [accordion] Pattern 9 — Parent scope with ../
>
> Think of a nested loop like a folder inside a folder. The job is the outer folder. The checklist is the inner folder. When you are working inside the inner folder, Zuper can only see what is in that folder — not what is in the outer one.
>
> Use `../` before a field name to step out one level and pull in fields from the job level — for example, the job title or work order number.
>
> ```handlebars theme={null}
> {{#each checklist}}
>
> {{! 'question' and 'answer' come from the checklist scope }}
> {{question}}: {{answer}}
>
> {{! 'job_title' lives on the job (outer scope) — use ../ to access it }}
> Job: {{../job_title}}
>
> {{! Go up two levels with ../../ when nested inside two loops }}
> {{#split answer ','}}
>
> {{../../work_order_number}}
> {{/split}}
>
> {{/each}}
> ```
>
> | Prefix | Accesses |
> | - | - |
> | (none) | Current loop scope |
> | `../` | One level up |
> | `../../` | Two levels up |
>
> > [!WARNING]
> >
> > A missing `../` is one of the most common reasons a field renders blank inside a loop. If a field is showing as empty and you are inside a `{{#each}}` block, check whether it needs a `../` prefix.
> [accordion] Pattern 10 — Line items and Parts & Services
>
> Use this pattern to display the parts and services added to a job directly on your job card. It loops through every line item on the job and prints its name, quantity, and price.
>
> **Key fields:** `line_items`, `name`, `quantity`, `price`
>
> ```handlebars theme={null}
>
>
>
> | Item |
> Qty |
> Price |
>
>
>
> {{#each line_items}}
>
> | {{name}} |
> {{quantity}} |
> {{price}} |
>
> {{else}}
>
> | No parts or services added. |
>
> {{/each}}
>
>
> ```
***
## FAQs
> [accordion] Why is a field showing as blank in my rendered document?
>
> The most likely causes are that the field has no value on that job, or the field is inside a loop and needs a `../` prefix to reach the parent scope. Wrap the field in `{{#if field}}...{{/if}}` to confirm whether it has a value. If you are inside a `{{#each}}` block, add `../` before the field name and test again. If the issue continues, contact [Support](mailto:support@zuper.co).
> [accordion] Why is my job status section repeating multiple times?
>
> Check for two things. First, confirm you are using `{{#eachLastInstance job_status "status_name"}}` and not `{{#each job_status}}`. Plain `{{#each}}` repeats the section for every status the job has ever had. `{{#eachLastInstance}}` shows only the current one. Second, confirm your `{{#stringEq status_name "..."}}` filter is present and the status name matches exactly what appears in Zuper — including capitalization. A missing or mismatched filter causes the section to show nothing or display the wrong content.
> [accordion] What is the difference between \{\{#stringEq}} and \{\{#stringEqStrict}}?
>
> `{{#stringEq}}` performs a loose match and is not case-sensitive. Use it for status name comparisons such as "Completed" or "Scheduled." `{{#stringEqStrict}}` performs an exact, case-sensitive match. Use it when matching question names, inspection labels, or result values such as "Pass," "Fail," or "N/A."
> [accordion] Can I nest patterns inside each other?
>
> Yes. The most common combination is nesting Pattern 1 (checklist loop) or Pattern 2 (inspection results) inside a Pattern 4 job status block. This lets you show checklist photos only when a job reaches a specific status, for example.
> [accordion] How do I display a date in the customer's local time zone?
>
> Use `{{formatDateWithTimeZone field "FORMAT" timezone}}`. Always include `timezone` as the third argument — it is a job-level field that Zuper populates automatically. Omitting it causes dates to display in UTC instead of the customer's local zone. See Pattern 7 for format token examples.
***
## Related articles
* [Configuring Job Card Templates](#) — Create and manage job card document templates
* [Configuring Job Checklist](#) — Set up checklist questions that appear on jobs
* [Configuring Service Tasks](#) — Configure service tasks and attach inspection forms
* [Configuring Inspection Forms](#) — Create and manage asset-level inspection forms
* [Configuring Job Custom Fields](#) — Add and configure job-level custom fields
# Configuring Job Checklist
Source: https://docs.zuper.co/Settings/Modules/Jobs/Configuring-job-checklist
A Job Checklist is a predefined list of questions, instructions, or tasks that technicians must complete while performing a job. It acts as a digital guide to ensure all critical steps are followed, data is captured accurately, and service quality remains consistent across every field visit.
In this article, you will learn how to configure a job checklist associated with specific job statuses or categories to streamline job execution and data collection.
**Navigation:** *Job Categories Listing → Select a Job Category → Job Category Statuses page → Checklist section → +Create*
# Accessing Job Checklists
To create or manage job checklists, follow these steps:
* Select the “**Settings**” module from the left navigation menu.
* Click “**Modules**” and choose “**Jobs**” to open the Job Settings page.
* Click **Job Category Hub** to view all configured job categories.

* Choose the job category for which you want to create or manage a checklist. This opens the **Job Category Statuses** page.

* In the **Checklist** section, click **+Create** to add a new job checklist.

# Create Checklist
When creating a checklist, you can choose how it should appear to best suit your workflow. This determines how fields are displayed to technicians and ensures efficient data capture in the field. Once the checklist view type is selected, you can proceed to add and configure the required fields.
* **Single-Page View:** Displays all checklist fields on a single screen.
* **Multi-Page View:** Displays fields in separate pages for better organization.
**Allow Prefilling Answers**
Toggle ON **Allow Prefilling Answers** if you want technicians to view prefilled values when updating a job status.

## Adding Fields to the Checklist
After selecting the checklist type, the **Checklist Builder** opens. You can add fields by dragging them from the right panel and dropping them into the left panel.

Each field type is designed to capture specific types of information, such as text, selections, media, or digital inputs.
**Available Field Categories and Field Type Descriptions**
| **Category** | **Field Type** | **Description** |
| :-: | :-: | - |
| | **Section Header** | Adds a heading within the checklist to group related fields and organize the layout. |
| **Text** | **Single-Line Text** | Allows users to enter short, free-form text (e.g., customer name, part number). |
| | **Multi-Line Text** | Enables users to enter longer paragraphs or notes (e.g., issue description, comments). |
| **Date** | **Date** | Provides a calendar picker to select a specific date (e.g., inspection date). |
| | **Time** | Provides a clock input to select time (e.g., job start time). |
| | **Date & Time** | Combines date and time inputs for timestamped entries (e.g., check-in/out time). |
| **Selection** | **Single Selection** | Lets users choose one option from multiple predefined values (e.g., Yes/No). |
| | **Multi Selection** | Allows users to select more than one option (e.g., services performed: cleaning, repair). |
| | **Dropdown** | Displays a dropdown list of predefined options to select from. |
| **Media** | **Upload** | Lets users upload files such as PDFs, images, or documents. |
| | **Single Image** | Allows capturing or uploading one image related to the job. |
| | **Multiple Images** | Enables capturing or uploading multiple images (e.g., before and after photos). |
| | **Video** | Allows users to upload or capture a video clip for visual verification. |
| | **Barcode Scan** | Enables scanning barcodes or QR codes for assets or parts. |
| | [**AI Walkthrough Video**](https://docs.zuper.co/Zuper_AI/Record-a-Walkthrough-Video-on-a-Checklist#adding-a-field-in-the-checklist) | Lets technicians record a guided video walkthrough of the job site directly from the checklist. Zuper AI transcribes the audio and produces a written summary alongside the video and any photos captured. Available on the mobile app only. |
| **Miscellaneous (Misc)** | **Lookup** | References data from other Zuper modules such as Products, Users, or Assets. |
| | **Data Table** | Creates a structured table with rows and columns to record multiple related data entries. |
| | **Signature** | Captures a digital signature from a technician or customer to confirm acknowledgment. |
| Scheduling | **Schedule Job** | Allows users to schedule a job directly from the checklist. The field can be configured to use Assisted or Manual scheduling. |
Learn more about: [AI Walkthrough Video field](https://docs.zuper.co/Zuper_AI/Record-a-Walkthrough-Video-on-a-Checklist#adding-a-field-in-the-checklist)
## Set the time interval
The **Time Interval** setting appears in the **Edit Time** panel under the **Configuration** section.
For **Time** and **Date & Time** field:
1. Open the **Edit Time** panel for the time field. To do this, select the edit icon next to the field name in the checklist builder.
2. Scroll to the **Time Interval** dropdown under **Configuration**.
3. Select the interval you want from the list — for example, **15**, **30**, or **60**.
> [!NOTE]
>
> The default value is **30** minutes. This means the time picker shows options in 30-minute increments, such as 9:00, 9:30, 10:00.
4. Select **Save** to apply the change.

## Configuring a Field
When you drag and drop a field into the checklist, an **Edit Field panel** appears on the right side.\
You can define the field’s **information, configuration, and visibility preferences**.
Once configured, click **Save** to add the field to the checklist.
### Information
* **Field Name:** Enter the display name for the field.
* **Description:** Add helpful instructions or notes for the technician.
* **Scheduling**: The **Scheduling** field allows users to schedule a job while completing a checklist. You can configure the scheduling method and, for Assisted scheduling, specify the team to be used for scheduling.
> [!NOTE]
>
> Note: The **Scheduling** field appears in the information section only after you drag and drop the **Schedule Job** field type into the checklist.
> [accordion] To configure the Schedule Job field:
>
> 1. Under **Scheduling**, select one of the following options:
> * **Assisted:** Allows the user to schedule the job using Assisted Scheduling. When selected, the **Teams** dropdown appears.
> * **Manual:** Allows the user to schedule the job manually without configuring a default team.
>
> 2. If you select **Assisted**, select a **Team** from the **Teams** dropdown.
>
> 3. Click **Save** to apply the configuration.
>
> > [!NOTE]
> >
> > **Note:** When **Assisted** Scheduling is selected, the configured team is preselected when the user chooses Assisted Scheduling while scheduling the job from the checklist.
### Configuration
Define how the field behaves during checklist completion:
1. **Mark as Required Field**
This option makes a field **mandatory** during checklist completion.\
Technicians cannot submit the checklist until the required field is filled in.
**To configure:**
1. Toggle **Mark as Required Field** ON.
2. Click **Save** to apply.
> **Example:** For a “Customer Signature” field, enabling this ensures that technicians must collect a signature before job completion.
2. **Mark as Read Only**
This setting restricts technicians from editing the field while completing the checklist.\
Useful when you want to display reference data without allowing modification.
**To configure:**
1. Toggle **Mark as Read Only** ON.
2. Click **Save** to apply.
> **Example:** Use for auto-populated fields like “Job ID” or “Customer Name.”
3. **Update Field**
Automatically copies the entered field value to a linked custom field or standard field in the job record.\
This eliminates duplicate data entry and ensures synchronization between modules.
**To configure:**
1. Toggle **Update Field** ON.
2. Choose the custom field /standard field you want to link.
3. You can choose the module as "**Job**" or "**Customer / Contact**."
4. **Pre-fill:** The Pre-fill answer capability automatically populates checklist questions with values from mapped standard or custom fields. This reduces manual data entry and ensures consistency between checklist responses and system records..
5. Click **Save** to apply.

> **Example:** Prefill: A “**Priority**” field from the Jobs Module is prefilled automatically in the checklist.
**Priority order when determining what value to show**:
1. Existing checklist answer (always takes precedence).
2. Field-based pre-fill (from mapped Job/Contact field).
3. Default value (fallback if no mapped value exists).
* Impact after filling the checklist
Once the job checklist is filled, the prefill option autofills the actual value from the Job / Customer-Contact default or custom field.

4. **Dependent Field (Make Element Dependent on Options)**
Use **conditional display** to automatically show fields based on values selected in other fields. This keeps your checklists focused, context-aware, and free from irrelevant questions for technicians.
> [!NOTE]
>
> **Note**: The **Dependent Field** option appears only when a **Selection Field** (Single Selection, Multi Selection, or Dropdown) with configured options is present in the checklist.
**To configure the dependency fields:**
1. Select the field you want to set as dependent (e.g., *Enter Part Name* (Single Line Text)), then click the Edit icon.
2. Toggle **Dependent Field** to **ON**.
3. Under **Dependent On**, choose whether the dependency is based on **Checklist Fields** or **Custom Fields**.
4. In **Show when**:
* **Trigger Field**: Choose the parent field (e.g., *Do you require additional parts (Single Selection*). \
Zuper automatically displays only the fields linked to the same **Job Category** as the checklist. This ensures that you can select only the relevant checklist fields or custom fields associated with that category.
* **Condition Operator**: Choose the operator (*Equal To, Contains, Not Equal To*, etc.).
* **Value**(s): Pick one or more values that will make the dependent field appear.\
For example, if a technician selects Yes under *Do you require additional parts?*, the fields *Enter Part Name* and *Enter Description* appear automatically.
> [!NOTE]
>
> **Note**: For a *Multi Selection* parent field, you can choose one or more values. If the user selects any one of these values, the dependent (child) field will appear.Under **Show When**, select the controlling field (e.g., *Do you require additional parts?*).
5. To add another dependency, click **Add dependent field**, and choose whether conditions should use **AND** (all conditions must be true) or **OR** (any condition may be true). Define the condition (e.g., *is equal to Yes*). 
6. Click **Save** to apply the configuration.
### Visibility
Control who can view or edit a field:
* **Mark as Hidden Field:** Hide the field from all users.
* **Hide to FE/Technician:** Hide the field only from field technicians on the mobile app.
## Advanced Field Configurations
In addition to the general field settings, Zuper allows you to configure advanced options for specific field types.\
These configurations help ensure accurate data capture, enforce validation, and maintain the authenticity of field submissions.\
Depending on the field category you select (Selection or Media), the available configuration options may vary.
### A. Selection Field Configurations
For **Selection fields** (Dropdown, Single Selection, and Multi Selection), you can configure options, apply restrictions, and set dependencies to control how technicians interact with the checklist.
**Navigation**: Go to the **Selection field category** and choose either **Single Selection**, **Multi Selection**, or **Dropdown** to configure the field.
**1. Options**
Define the list of choices that will appear in the selection field.
**To configure:**
1. In the **Options** section, click **Add Option** to create new choices.
2. Enter the option names (e.g., *Accurate*, *Not Accurate*, *Requested*).
3. Use the **trash icon** to delete any unwanted option.
4. Drag and drop options to reorder them.
5. Click **Save** to apply the changes.
> **Example:** A dropdown field titled *Parts Condition* can include options such as *Good*, *Damaged*, and *Replaced*.
**2. Choose First Option by Default (Dropdown Only)**
Automatically selects the first dropdown value when the checklist loads. This helps standardize default responses.
**To configure:**
1. Toggle **Choose First Option by Default** ON.
2. Ensure your preferred value is listed first in the options.
3. Click **Save** to apply.
> **Example:** In a field titled *Inspection Type*, setting *Routine Check* as the first option makes it the default selection.
**3. Restricted Status Update**
Restricts technicians from changing the job status if certain checklist conditions are not satisfied.
**To configure:**
1. Toggle **Restricted Status Update** ON.
2. Define the field condition that should block the job status update.
3. Click **Save** to apply.
> **Example:** If the technician selects *No* for “Are all parts delivered?”, the system can prevent the job from moving to *In Progress* until all parts are confirmed.

### B. Media Field Configurations
For **Media fields** (Single Image and Multi Images), you can apply additional validation settings to ensure the authenticity and reliability of the photos submitted from the field.
**Navigation**: Go to the **Media field category** and select **Single Image** or **Multi Images** to configure the field.
**1. Restrict to Camera**
Prevents technicians from uploading existing or gallery images, allowing only live photos captured directly from the mobile camera.
**To configure:**
1. Drag and drop a **Single Image** or **Multi Images** field.
2. In the **Configuration** section, toggle **Restrict to Camera** ON.
3. Click **Save** to apply.
> **Example:** When a technician must upload an image of an installed part, *Restrict to Camera* ensures it’s captured live from the site.
**2. Stamp Date & Time and Stamp GPS Coordinates**
These options automatically capture the **date, time, and GPS coordinates** when an image is taken or uploaded.\
They help verify when and where the photo was captured, ensuring data authenticity and audit accuracy.
By default, both **Stamp Date & Time** and **Stamp GPS Coordinates** are enabled.\
You can also **associate tags** with the image using the **+Add Tags** button to help categorize or identify photos more efficiently.
> **Example:**\
> When a technician captures an installation photo, the system automatically records the timestamp and GPS coordinates, confirming that the image was taken at the customer’s site during the job.

3. **Associate Albums**
Link a Single Image or Multiple Images field to one or more master albums. Any photo captured or uploaded through this field is automatically copied into the associated album(s); no manual efforts are required to add the photos to the album from the Job Gallery.
Note: Album auto-copy is supported only for master albums. Job-specific or unique albums created within a single job are not eligible for this configuration.
To configure:
1. Drag and drop a Single Image or Multiple Images field or select the edit icon on an existing one.
2. Under **Associate Albums**, click **Add Albums**.
3. Select one or more master albums from the list.
4. Click Save to apply.

### C. Misc Field Configurations
For Miscellaneous fields (Lookup, Data Table, and Signature), Zuper provides additional configuration options to help capture reference data, structured records, and approvals efficiently. These settings ensure that field data is validated, traceable, and linked to other Zuper entities when needed.
**Navigation**: Go to the **Misc** field category and select **Lookup**, **Data Table**, or **Signature** to configure the field.
1. **Lookup Field**
The Lookup field allows you to reference existing records from other Zuper modules, such as **Products**, **Users**, or **Assets**, directly within the checklist.\
This helps technicians quickly link related entities without switching modules.
**To configure:**
1. Drag and drop the **Lookup** field into the checklist.
2. Under the **Lookup module**, choose the module you want to reference (e.g., Products, Products added in job, Users, Assets).
3. Click **Save** to apply.
> [accordion] When configuring lookup
>
> 1. For Products: Enables selection from existing product categories.
>
> 
>
> 2. For Users: You can filter results by Teams or Roles for targeted user selection.
>
> 
>
> 3. For Assets: Allows linking existing assets related to the job or customer.
> **Example:** In an equipment maintenance checklist, a technician can use the Lookup field to select the specific **Asset** being serviced, ensuring accurate tracking of maintenance history.

2. **Data table Field**
Data table field enables structured data entry in rows and columns, ideal for recording multiple readings or material lists.
To configure:
1. Drag and drop the **Data Table** field into the checklist.
2. Toggle ON **Restrict Rows** to limit the number of rows users can add.
3. Under **Columns**, define each column header (for example, *Part Name*, *Quantity*, *Unit Price*).
4. **Select the appropriate data type** for each column, such as **Text, Number, Date, or Multi-Line**, based on the type of information you want to capture.
* You can also **enable or disable** the **“Mark as Required Column”** option for each column as needed.
5. Under **Default Rows**, add or delete rows as required.
6. Click **Save** to apply.

3. **Signature Field**
The Signature field captures a **digital signature** from the technician or customer to confirm acknowledgment, completion, or approval of the job.\
This ensures compliance and provides a verifiable audit trail for field submissions.
**To configure:**
1. Drag and drop the **Signature** field into the checklist.
2. Specify whether the signature is required from the **Technician** or **Customer**.
3. Toggle **Mark as Required Field** ON if the signature must be provided before job completion.
4. Click **Save** to apply.
> **Example:** Adding a *Customer Signature* field at the end of a checklist ensures that the customer has reviewed and approved the completed work before closing the job.

# **Managing Checklists**
Once the job checklist has been created, you can edit, duplicate, or delete job checklists as needed.
* **Edit a Checklist:**\
Click the **Edit** icon next to the checklist to modify its fields or settings.
* **Duplicate a Checklist:**\
Click the **Clone** icon to create a copy of an existing checklist. Rename and edit it as required.
* **Delete a Checklist:**\
Click the **Delete** icon to remove a checklist that is no longer needed.
> [!NOTE]
>
> If a field technician reports a data parsing error when tapping **Update Status** on the mobile app, the checklist linked to that status has a stale configuration. To fix this, open the affected checklist in the **Checklist Builder**, make no changes, and select **Save**. Ask the technician to close the app fully, reopen it, and retry the status update.

Once configured, these checklists ensure consistency in field operations, enforce compliance, and simplify job verification for technicians and managers.
# Configuring Skillsets
Source: https://docs.zuper.co/Settings/Modules/Jobs/Configuring-skillsets
Skillsets in Zuper allow businesses to define and manage the skills required for various jobs. Skillset can also be assigned to a User or a Job Category. Assigning skillsets helps in job scheduling by ensuring that the right field technicians with the necessary expertise are assigned to specific tasks.
This guide provides a detailed walkthrough on how to create, edit, and manage skills to streamline job allocation and ensure service quality.
**Navigation**: \_Settings -> Modules -> Jobs -> Skillsets \_
## Navigating to job skillsets
To configure skillsets, follow these steps:
* Select the "**Settings**" module from the left navigation menu.

* Click "**Modules"** and select "**Jobs"** to open the **Job Settings** page.
* Choose "**Skillsets**."

* The skillsets listing page will appear, displaying all existing skills for job and team needs.
## Creating a new skillset
To add a new skill:
* On the skillsets listing page, click "**+ New Skill**."

* A **Create New Skill** dialog box will appear.
* Enter the required details:
1. **Skill Name** *(Mandatory)*: Enter a descriptive name for the skill (e.g., Electrical Repair, HVAC Maintenance).
2. **Skill Validity (Years)**: Specify how long the skill remains valid before requiring renewal (e.g., 2 years).
3. **Skill Description** *(Mandatory)*: Provide a brief description of the skill, including its purpose and usage.
* Click "**Create"** to save the new skill.

Once created, the skill will appear in the listing page with details such as:
1. **Skill Name**
2. **Skill Description**
3. **Skill Validity**
4. **Created By** (User who created the skill)
5. **Created On** (Date & time of creation)
## Editing a skillset
To modify an existing skill:
* On the skillsets listing page, click the pencil icon next to the skill you want to update.

* The **Edit Skill** dialog box will open.
* Make the necessary changes.
* Click "**Update"** to save the changes.
## Deleting a skillset
To remove a skill permanently:
* On the skillsets listing page, click the delete icon next to the skill you want to remove.

* A confirmation dialog box will appear.
* Click "**Delete"** to confirm and permanently remove the skill.
# Configuring General Job Settings
Source: https://docs.zuper.co/Settings/Modules/Jobs/Configuring_General_Job_settings
The general job settings page in Zuper allows administrators to define key job-related configurations to streamline operations, improve access control, and enhance communication. These settings help customize how jobs are assigned, managed, and tracked based on business needs.
Within the General Job Settings page, you can configure the following:
1. **General** – Define core job settings such as prefixes, recurring jobs, job card email templates, and timelog tracking.
2. **Access/Permissions** – Set the level of access field technicians and team leaders have for job visibility, editing, and rescheduling.
3. **Assignment** – Control how jobs are assigned, unassigned, and managed across teams.
4. **Route** – Configure routing options, including rescheduling and route optimization.
5. **Chat** – Manage job channel–related configurations, including automatically adding job creators and key users (such as managers or dispatchers) to job chat channels for streamlined communication and visibility.
**Navigation**: Settings -> Modules -> Jobs -> General Job Settings
## Job general settings
To configure general settings related to jobs:
* Select the "**Settings**" module from the left navigation menu.

* Click "**Modules"** and choose "**Jobs**" to open the Job Settings page.
* Select "**General Job Settings**." By default, you will land on the **General** tab.

* Configure job-related preferences to streamline workflows, improve tracking, and enhance customer communication.
### General settings options
* **Job Prefix** Define a custom identifier prefixed to all work order numbers. A job prefix helps categorize jobs systematically, making them easily identifiable.
* **Enable Recurring Jobs** Enabling this option allows jobs to be scheduled on a recurring basis, useful for routine maintenance tasks or service agreements requiring periodic visits.
* **Enable Secondary Contacts** When enabled, additional contacts can be added for a job. Secondary contacts receive job-related notifications, ensuring all relevant stakeholders stay informed. The **Customer** filter on the jobs listing page also matches secondary contacts, so you can find every job where a customer is the primary customer or a secondary contact. For details, see [Managing job listing page](/Work_Order_Management/Jobs/managing_your_jobs#faqs).
* **Allow managing tasks in completed jobs** When enabled, you can create, edit, assign, and manage tasks even after a job status is marked as *Completed*. When disabled, the system requires all tasks to be completed before the job can be marked as Completed.
* **Enable Job Gallery** When enabled, users can upload and view images related to a job. The job gallery serves as a centralized visual reference, helping teams document job progress, capture on-site issues, and maintain visual records for quality assurance.
* **Set Job Gallery as public by default** When **enabled**, every new photo uploaded to any job gallery becomes Public automatically. Your customers can then see it as soon as you share a Gallery or Timeline link. When **disabled**, new uploads default to Internal instead. They stay hidden from customers until the photo’s visibility is manually altered. Turning this setting off later does not change photos that are already Public, and it does not affect links you already shared. Those links continue to show only the photos that were Public when you shared them, even though new photos uploaded afterward still appear in the job gallery. To make a specific photo public again, open it in the gallery and update its **Visibility**, as described in \[[Jobs gallery](https://docs.zuper.co/Work_Order_Management/Jobs/Jobs_gallery)]
* **Enable Job Total**: Enabling this option displays the '*Job Value*' field on each job. Once enabled, an option to choose the "***Job’s Total Calculation Method***" is available, directly below it. This controls the method Zuper uses to calculate the Job Value.\
\
**Job’s Total Calculation Methods**:\
• Sum of Accepted Quote Values Associated with the Job: *Uses the total value of accepted quotes linked to the job as its value.*\
• Sum of Selling Price of Job Line Items: *Uses the sum of selling price of parts, products, and services that are part of the job line-items.*\
\
**Note**: The above calculation method is also used to calculate the total job revenue while calculating the[ job profitability](https://docs.zuper.co/Zuper_for_Roofing/Job_Costing).

* **Auto-stamp images with geo-coordinates** Enabling this will automatically add GPS coordinates to images uploaded in the job gallery. This helps verify the location of work performed and improves accountability and record-keeping.
* **Auto stamp images with date & time** When enabled, automatically add date and time stamps to images uploaded in the job gallery. This ensures accurate documentation of job progress and timelines.
* **Enable Service Territories** Activating this option allows you to assign jobs based on predefined geographic territories. This helps optimize resource allocation, reduce travel time, and improve service delivery by routing jobs to technicians in the relevant area.
* **Enable Switching Timezones** When enabled, users can view and manage job details across different time zones. This is particularly useful for businesses operating in multiple regions, ensuring accurate scheduling and coordination regardless of location.
* **Enable Job Visibility for Technicians** Enabling this option ensures that technicians only see jobs assigned to them or within their access permissions, maintaining data privacy and clarity.
* **Enable Kanban View** Enable the Kanban view for jobs, allowing teams to visualize work progress across different stages. This improves task tracking, prioritization, and workflow management.
* **Default Job Card Email Template** Define a standard email template for job cards sent to customers. A predefined template ensures consistent communication and includes necessary job details.

* **Type of View for FE**
Determines how jobs are displayed for field technicians within the mobile app. Available options:
1. **List View** – Displays jobs in a simple list format.
2. **Route View** – Displays jobs based on location, optimizing route planning.
3. **Both Views** – Allows users to toggle between list and route views.
* **Allow sending public link to Customer** When enabled, customers receive a public link to track job details and updates, enhancing transparency and reducing manual status inquiries.
* **Status for public link to be sent** Select the job status at which the public link will be sent to the customer. This ensures customers are notified at the appropriate stage of job completion.
* **Enable Timelog for Job** When enabled, it activates timelog tracking for jobs.
1. **Choose Status for Automated Clock-In**
Define a job status that automatically triggers a clock-in for field technicians, reducing manual time entry errors and ensuring accurate job start tracking.
2. **Choose Status for Automated Clock-Out**
Define job statuses that will automatically trigger a clock-out when a job reaches the selected statuses. Clock-out also occurs when a job is marked **Closed** or **Completed**, ensuring accurate work-hour tracking.
* **Default Job PDF Filename**
Define the standard naming convention for job-related PDF files to ensure consistency and easy identification when generating and sharing job documents.
> [accordion] Unifying Timestamp and GPS Co-ordinates
>
> Zuper now allows admins to control how timestamps and geo-coordinates are applied to images across the entire platform. This unified configuration provides a single point of control for metadata stamping, ensuring consistency in image evidence across various modules.
>
> This feature simplifies management by enforcing a company-wide rule for when and how images display location and time data, helping teams maintain auditability and compliance standards.
>
> **Who can use this feature:**
>
> * Available for **Admin** users with access to **Company Settings**.
>
> **Prerequisites:**
>
> * The user’s device must have granted **location permissions** for GPS stamping to work.
> * The **Zuper Camera** component must be used to capture images (Images uploaded from the device gallery are excluded from stamping).
>
> ### **Settings Configuration**
>
> 1. Go to **Settings > Jobs > General > Enable Image Geo Stamping and Enable Stamp Image with Date and Time**.
> 2. Toggle the following options:
> * **Enable Image Geo-Stamping:** Adds GPS coordinates to all captured images.
> * **Enable Stamp Image with Date/Time:** Displays the date and time directly on the image as a visual overlay.
> 3. Click the **Save** button to save the settings.
>
> 
>
> 4. Once enabled, image stamping applies to:
> * Checklists
> * Notes Attachments + Images taken in walkthrough notes
> * Attachments (Job and Project)
> * Inspection Forms (Job)
> * Gallery Upload (camera)
>
> ### Mobile App
>
> Once enabled, these settings will automatically apply to all the image applicable areas.
>
> When you add a new image as an attachment, you can view the timestamp and geo-coordinates under the gallery.
>
> 
>
> **Checklist Fallback Logic:**
>
> * **When Company Configuration is ON:**
> * GPS and Date/Time are always stamped, regardless of checklist-level settings.
> * Checklist-level toggles appear **greyed out** (disabled).
> * Existing checklists automatically apply stamping.
> * New checklist questions default to enabled stamping in the company settings applied.
> * **When Company Configuration is OFF:**
> * Individual checklist toggles remain available and can independently control watermarking only in the checklists.
>
> **Precedence Rule:**\
> Company-level configuration always overrides checklist-level settings.
>
> **Edge Cases and Behavior:**
>
> * **Retroactive Stamping:** Not supported — only applies to new images captured after enabling.
> * **Location Permission Denied:** The user will be prompted to enable location permissions before capturing an image.
>
> **Best Practices:**
>
> * Keep both settings enabled for complete audit visibility on field data.
> * Inform field users when stamping is enforced to avoid confusion about overlays.
> * Encourage enabling location services on mobile devices before the job starts.
>
> **Troubleshooting:**
>
> | **Issue** | **Possible Cause** | **Solution** |
> | :- | :- | :- |
> | Image not showing GPS data | Location permission denied | Enable GPS/location access on the device and retake the photo. |
> | Checklist toggle is greyed out | Company-level setting is ON | This is expected behavior; the company configuration takes precedence. |
> | Timestamp missing | “Stamp Image with Date/Time” is disabled at the company level | Re-enable this toggle under Company Settings. |
>
> **Frequently Asked Questions (FAQs)**
>
> **1. What does the “Enable Image Geo-Stamping” option do?**\
> When this option is enabled, Zuper automatically captures the GPS coordinates of where an image was taken and stores them as part of the image metadata.
>
> **2. What does the “Enable Stamp Image with Date/Time” option do?**\
> This setting adds a visible overlay showing the date and time on every image captured using the Zuper Camera. It ensures that image evidence includes a precise timestamp.
>
> **3. Which Zuper modules support image stamping?**\
> Once enabled, image stamping applies to:
>
> * Checklists
> * Notes Attachments + Images taken in walkthrough notes
> * Attachments (Job and Project)
> * Inspection Forms (Job)
> * Gallery Upload (camera)
* **Default From Email**
This setting lets you choose which email address appears as the sender when Zuper sends job-related emails to your customers.
The dropdown lists all SMTP-configured email addresses you have configured in [Outbound Email Settings](/Settings/Miscellaneous/Outbound_email_templates). You can select the address you want customers to see in their inbox.
Choose which email address appears as the sender when Zuper sends job-related emails to your customers. The dropdown lists all SMTP-configured email addresses you have added in Outbound Email Settings. The address you select here automatically appears as the **From ID** when you share a **job**, **quote**, or **invoice** by email.
> [!NOTE]
>
> **Note**: This setting works only with SMTP-configured emails. If you haven't configured any outbound email addresses yet, the dropdown will show no options. Set up your SMTP addresses first, then return here to make your selection.
## Configure Access/Permission settings
To configure access and permission settings:
* On the **General Job Settings** page, go to the **Access/Permissions** tab.

* Control the level of access field technicians and team leaders have over jobs.
### Access/Permission options
* **Team Leader Access to All Field Techs' Jobs Across Teams** **Yes**: A team leader can view and manage jobs assigned to all field technicians, including those outside their team. **No**: A team leader can only view jobs assigned within their own team.
* **Field Technician Access to All Jobs for a Customer** **Yes**: A field technician can view all jobs associated with a specific customer. **No**: The technician can only view their assigned jobs.
* **Field Technician Access to All Jobs of an Organization** **Yes**: A field technician can view all jobs linked to an organization. **No**: The technician is restricted to only their assigned jobs.
* **Field Technician Access to All Jobs of a Property** **Yes**: A field technician can access all jobs related to a specific property. **No**: Access is limited to assigned jobs only.
* **Field Technician Access to All Jobs of an Asset** **Yes**: A field technician can view all jobs performed on a specific asset. **No**: The technician can only view assigned jobs.
* **Allow field techs to access their past unassigned jobs?** **Yes**: A field technician can view and access their previously unassigned jobs, even if they are no longer assigned to them. **No**: Once a job is unassigned from the technician, they will no longer have access to it.
* **Can field technician create new jobs?** **Yes**: A field technician can create new jobs directly from the mobile app or web platform. **No**: Only authorized users, such as team leaders or managers, can create jobs.
* **Can field technician view jobs without punch-in?** **Yes**: A field technician can access job details even if they haven’t punched in for their shift. **No**: The technician must be punched in to view job details.
* **Require facial authentication to view jobs?** **Yes**: The field technician must complete facial authentication before accessing job details. **No**: The technician can view jobs without additional authentication.
* **Can field technician reschedule a job?** **Yes**: The technician can modify job schedules based on availability or customer requests. **No**: Only authorized users, such as dispatchers or team leaders, can reschedule jobs.
* **Can field technician edit a job?** **Yes**: The technician can update job details such as notes, status, or additional information. **No**: Job details can only be modified by a manager or team leader.
* **Can field technician view other assigned users?** **Yes**: The technician can see other team members assigned to the same job for better collaboration. **No**: The technician can only view their own assignments.
* **Can field technician accept/decline the job?** **Yes**: The technician has the option to accept or decline assigned jobs based on availability. **No**: Jobs are automatically assigned, and the technician must follow the schedule.
* **Can Team Leader access jobs based on Service Territory ownership?** **Yes**: The team leader can view and manage jobs that fall within the service territories they own or are assigned to, ensuring focused supervision and efficient territory-based management. **No**: The team leader can access all jobs regardless of service territory ownership, allowing broader visibility across regions.
## Configure Assignment settings
To configure assignment-related settings:
* On the **General Job Settings** page, navigate to the **Assignment** tab.
* Control how field technicians are assigned, unassigned, and notified when handling job allocations. 
### Assignment options
* **Unassign Other Field Techs When One Accepts the Job?** **Yes**: The system automatically unassigns other technicians once one accepts the job. **No**: All assigned technicians remain on the job.
* **Unassign Field Technician Upon Rejection?** **Yes**: The users will automatically be unassigned upon rejection. **No**: The job remains assigned until manually reassigned.
* **Alert Job/Time-Off Conflict Upon Assignment?** **Yes**: The system alerts managers if a job is assigned to a technician with a time-off request. **No**: Job assignments proceed without conflict alerts.
* **Automatically add task assignees to the job** (This setting is enabled by default.) **Yes**: Assigning a user to a task automatically adds them as an assignee on the job as well. **No**: The user is assigned to the task only and is not added to the job.
* **Retain team when users are unassigned from the job?** **Yes**: When users are unassigned from a job, the assigned team remains on the job without changes. The job continues with the existing team structure. **No**: If users are unassigned, the entire team is removed from the job, requiring reassignment if needed.
* **Notify users upon assignment** **Yes**: Automatically sends notifications to users whenever they are assigned to a job, ensuring timely awareness of new assignments. **No**: Users will not receive notifications upon assignment and must manually check for new jobs.
## Configure Route settings
To configure route-related settings:
* On the **General Job Settings** page, navigate to the **Route** tab.

* Configure route optimization and rescheduling permissions for field technicians.
### Route Settings options
* **Enforce sequential execution of jobs in route?**
**Yes**: Field technicians must complete jobs in the specified route sequence, ensuring planned travel efficiency and order compliance.
**No**: Technicians can complete jobs in any order, allowing greater flexibility in managing their routes.
* **Allow Route Rescheduling to Past?**
**Yes**: Field technicians can reschedule routes to past dates.
* **Can Field Technician Optimize Routes?**
**Yes**: Field technicians can optimize their assigned routes
**No**: Route optimization is restricted to managers.
* **Choose Distance metric**: Select the preferred unit of measurement for distance tracking—**Miles** or **Kilometers**—based on regional or organizational preferences.
## Configure Chat settings
To configure chat-related settings:
* On the **General Job Settings** page, navigate to the **Chat** tab.

* Define how job notifications are sent to relevant users.
### Chat options
* **Add Job Creator to Job Channel** – Toggle **Yes** to automatically include the job creator in the associated job chat channel.
* **Add These Users to All Job Channels** – Enter the names of users who should be added by default to every job channel (for example, managers or dispatchers).
# Configuring Measurements
Source: https://docs.zuper.co/Settings/Modules/Jobs/Configuring_Measurements
Measurement tokens define the specific data points (e.g., lengths, areas) that Zuper pulls from external providers. You can enable or disable these to tailor what appears in your job details page.
1. Go to **Job Settings > Measurements > Tokens**.
2. Under **Measurement Tokens**, you'll see a list categorized by type (e.g., Roof Measurement).
3. For each token, toggle the switch to enable or disable the applicable tokens.
4. Search for specific tokens using the search bar.
5. Changes are saved automatically.

## Custom Tokens
Measurement tokens in Zuper allow you to track and quantify job-specific items, such as materials or dimensions, directly within your job estimates and reports. Custom tokens give you flexibility to tailor these to your business needs, like adding roofing-specific items.
### Adding custom category
1. Go to **Job Settings > Measurements > Tokens**.
2. Under **Tokens**, click **+Add Category**.

3. Enter the **Category Name**. Click **Create** to create the new category.

4. The category is created successfully.

5. Click the "**Ellipsis**" icon and click **Edit Category** to modify the custom token details.

6. Modify a category name and click **Update**.

> [!NOTE]
>
> Note: The Delete category option is available only when no custom tokens exist.
### Adding custom tokens
The custom tokens for measurements are customizable data fields used to track and quantify specific job-related items, such as materials, dimensions.
1. Click the "**Ellipsis**" icon and click **+Add Token** to add the custom measurement tokens.

2. An "**Add Token**" dialog box appears. Enter the token name and unit of measure. Click **Create** to create the custom token.

3. The token is created successfully.

4. Click the "**Ellipsis**" icon and click the "**Edit**" icon to modify the token details.

5. Click the "**Delete**" icon to delete the token.

6. You can "**Toggle off**" to disable the token.

## **Connecting to Measurement Providers**
Zuper supports integrations with leading roof measurement services to fetch data like aerial-derived roof specs, 3D visualisations, and high-precision reports.
1. Navigate to **Job Settings > Measurements > Providers**.
2. You'll see a list of available providers: The providers will have a list of measurement providers. Click “**Hover**.”
3. Click “**Connect**” to redirect to the Zuper App Store. Follow the steps to authenticate and link your account.

4. Click “**Notify Me**” to get notified when apps from other providers are launched.

* If your preferred provider isn't listed, scroll to **Request Integration**. To submit the request, you must fill out the form.
* Enter details about the provider.
* Click **Submit Request** for evaluation by the Zuper team.
# Configuring Expenses
Source: https://docs.zuper.co/Settings/Modules/Jobs/Configuring_expense
In Zuper, users can easily upload and record expense receipts against a job. This feature enables seamless expense reporting, allowing you to specify whether the expenses are billable to your customer and reimbursable for your team.
## Prerequisites:
1. Expense is only available on the V3 Web app. If you use V2, you can get started with V3 using the link below. Your login credentials will be the same as those for V2: V3 Live (Production) - [https://web.zuperpro.com/login](https://web.zuperpro.com/login).
2. To enable the Expense for your account, please contact the account admin or email [support@zuper.co](mailto:support@zuper.co).
## User roles and permissions
The actions a user can perform in the Expense feature are determined by their assigned custom roles and permissions. Permissions are set by the admin under **Settings** > **Users & Teams** > **Custom Roles** > **Role's**> **Jobs** and include:
1. Create Expense
2. Edit Expense
3. View Expense

Admins can customize these permissions to meet organizational needs, ensuring appropriate access for each user role.
## Configuring expense categories
Creating expense categories in Zuper streamlines expense management by enabling precise classification, efficient tracking, and accurate reporting. These categories help to enforce your company policies, facilitate seamless reimbursements, and simplify customer billing.
**Navigation**: *Settings -> Modules -> Jobs -> Expense*
Follow these steps to create a new expense category:
1. Log in to Zuper with an admin account.
2. Select the **Settings** module from the left navigation menu.

3. Choose the **Jobs** setting from the **Modules**.

4. Select the **Expense** section.

5. On the **Expense Category** *listing* page, click **+ New Category**.

6. The **Add Category** page opens.
* Enter the **Name** of the expense category.
* Provide a short **Description** for the category.
* Enter the **Default Amount** for the category. This amount will automatically populate when users add an expense item belonging to this category to a job.
* Specify the **Max Capping** for the category, which defines the maximum claimable amount for an expense under this category.
* Configure Expense Policies:
1. Set **Billable** to *Yes* if the expense can be charged to the customer.
2. Set **Reimbursable** to *Yes* if the expense can be reimbursed to the employee/user.
3. Set **Receipt Mandatory** to *Yes* if a receipt is required for the expense.

* Click **Create** to save the new expense category.
The expense category is now successfully created.
### Editing an expense category
1. On the **Expense Category** listing page, click the **kebab** icon next to the specific expense category.
2. Select the **Edit** option.

3. The **Edit Category** dialog box opens.
4. Make the necessary changes.

5. Click **Update** to save the changes.
### Deactivating an expense category
1. On the **Expense Category** listing page, click the **kebab** icon next to the specific expense category.
2. Select the **Disable** option.

3. A confirmation dialog box appears.
4. Click **Disable** to deactivate the expense category.

### Deleting an expense category
1. On the **Expense Category** listing page, click the **kebab** icon next to the specific expense category.
2. Select the **Delete** option.

> [!NOTE]
>
> **Note:** You must deactivate an expense category before deleting it. Active categories cannot be deleted.
3. A confirmation dialog box appears.
4. Click **Delete** to permanently remove the expense category.

## **Report on expenses**
Zuper provides two expense reports to help you view costs from different perspectives:
### Job Expense Report
Go to **Reports > Job > Job Expense Report**
Use this report when you want to view expenses in the context of a job’s schedule. Expenses are grouped based on the **job schedule date**, making it useful for:
* Reviewing costs for jobs planned on a specific day or week
* Matching expenses with technician schedules
* Operational reporting tied to job timelines

### Expense Master Report
Go to **Reports > Expense Master**
Use this report when you want to track expenses based on when they were actually incurred. This report uses the **expense date**, making it useful for:
* Finance and accounting reconciliation
* Tracking monthly or period-based spending
* Auditing expenses independent of job schedules

# Configuring Inspection Forms
Source: https://docs.zuper.co/Settings/Modules/Jobs/Configuring_inspection_form
Inspection forms are essential tools that field technicians use to perform thorough inspections, ensure compliance, and document asset conditions or maintenance activities. These forms streamline the inspection process by standardizing the data collection method, improving accuracy, and ensuring nothing is overlooked during service visits.
In Zuper, administrators can configure job inspection forms by defining field types, organizing form layouts, and setting up rules for field behavior.
This guide walks you through how to create, customize, and manage inspection forms in Zuper.
**Navigation**: *Settings -> Modules -> Jobs -> Inspection forms*
## Navigating to job inspection forms
To configure inspection forms, follow these steps:
* Select the "**Settings**" module from the left navigation menu.
* Click **Modules** and choose **Jobs** to open the Job Settings page.
* Click on **Inspection Forms**. The inspection forms listing page will appear.

* The inspection forms listing page will appear, displaying all existing inspection forms available for the job.
## Creating a new inspection form
To create a new inspection form:
* Click **+ New Form** at the top right of the inspection forms listing page.

* Enter the following details and click **Proceed** to begin customizing the inspection form.

* **Inspection Form Name** (*Mandatory*) – Enter a name for the inspection form.
* **Description** – Provide a brief description of the inspection form.
## **Customizing the inspection form**
To customize the inspection form, simply drag and drop fields from the right panel into the form layout. Arrange them as needed to suit your inspection requirements.
You can also **edit, clone, or delete** fields using the action menu available next to each field.
For more details on how to configure custom fields, check out this [article](https://docs.zuper.co/Settings/Modules/Jobs/Configuring-job-checklist#configuring-a-field).

> [accordion] Available fields
>
> 1. Text
> * Single-Line Input: This allows you to create a field to enter a single line of free text.
> * Multi-Line Input: This allows you to create a field to enter multiple lines of free text.
> 2. Date
> * Date: This allows you to create a field to select a specific date from a calendar.
> * Time: This allows you to create a field where you can select a specific time.
> * Date & Time: This allows you to create a field where both date and time can be selected.
> 3. Selection
> * Single-Selection: This allows you to create a radio input Field where one of the provided options can be selected.
> * Multi-Selection: This allows you to create check boxes where the provided options can be checked.
> * Drop-Down: This allows you to create a drop-down field with the required list of options.
> 4. Media
> * Upload: This allows you to create a file input field to upload files.
> * Single Image: This allows you to upload a single image as input.
> * Multi Images: This allows you to upload multiple images in one field.
> * Barcode Scan: This allows you to scan and capture barcodes using a device camera or scanner.
> * [AI Walkthrough Video](https://docs.zuper.co/Zuper_AI/Record-a-Walkthrough-Video-on-a-Checklist#adding-a-field-in-the-checklist): Lets technicians record a guided video walkthrough of the job site directly from the inspection form. Zuper AI transcribes the audio and produces a written summary alongside the video and any photos captured. Available on the mobile app only.
>
> 
> 5. Misc
>
> * Look up: This allows you to create a file input field to look up the products, products added in job, parts added in asset, users, and assets.
> * Data Table: This allows you to create a dynamic table field to input structured data in rows and columns.
> * Signature: This allows you to sign directly within the form using touch or a mouse input.
## Editing an inspection form
To modify an existing inspection form, follow these steps:
* On the inspection forms listing page, click the pencil icon next to the inspection form you want to update.

* Make the necessary changes and click **Save** to update the inspection form.
## Deleting an inspection form
To remove an inspection form permanently:
* On the inspection forms listing page, click the delete icon next to the inspection form you want to remove.

* A confirmation dialog box will appear.
* Click "**Delete**" to confirm and permanently remove the inspection form.
# Configuring Job Custom Fields
Source: https://docs.zuper.co/Settings/Modules/Jobs/Configuring_job_custom_fields
**Custom fields** allow businesses to capture additional information specific to their jobs. These fields can be used to store details that are not part of the standard job form, helping teams collect and manage data tailored to their processes.
This guide provides a detailed walkthrough on how to **create, edit, and manage custom fields** to ensure jobs are accurately documented and all relevant information is captured.
**Navigation**: Settings -> Modules -> Jobs -> Job Custom Fields
## Navigating to job custom fields
To configure job custom fields, follow these steps:
* Select the “**Settings**” module from the left navigation menu.
* Click “**Modules”** and select “**Jobs”** to open the **Job Settings** page.
* Choose “**Job Custom Fields**.”

* The existing field groups will be displayed on the left of the screen.
## Creating a new custom field group
To create a new field group:
* On the left side of the **Field Groups** listing, click **+ Create New**.

* In the right panel, enter the following details and click **Save** to create a new custom field group:
* **Name:** Provide a name for the field group.
* **Description:** Add a brief description of the group.
* **Associated categories:** Click **Add Category** to select the category to associate with this custom field group. When this category is selected during job creation, the custom fields from this group will automatically appear for that job.

**Job Custom Fields Types**
Below are the custom field types you can **drag and drop from the right panel to the left** to create a custom field.
**Text**
* Single-Line Text: This allows you to create a field to enter a single line of free text.
* Multi-Line Text: This allows you to create a field to enter multiple lines of free text.
**Date**
* Date: This allows you to create a field to select a specific date from a calendar.
* Time: This allows you to create a field where you can select a specific time.
* Date & Time: This allows you to create a field where both date and time cn be selected.
**Selection**
* Single-Selection: This allows you to create a radio input Field where one of the provided options can be selected.
* Multi-Selection: This allows you to create check boxes where the provided options can be checked.
* Drop-Down: This allows you to create a drop-down field with the required list of options.
**Media**
* Upload: This allows you to create a file input field to upload files.
**Misc**
* Look up: This allows you to create a file input field to look up products, users, and assets.

When configuring a Lookup field, you can choose the **module** the field should reference:
1. **Products**
* When selected, the lookup field in the associated job category will allow you to search and select from existing products in Parts and Services.
2. **Users**
* When configuring Users, you may optionally select a Team and Role to filter the list of users.
* Once configured, the lookup field in the associated job category will display only those users who match the selected team and role, ensuring accurate assignment.

After dragging and dropping the custom fields from the right panel, fill in the following sections:
**Information**
* **Field Name:** Enter or update the name of the field.
* **Description:** Provide additional details about the field.
* **Placeholder:** Add placeholder text to guide users when filling the field.
**Configuration**
* **Mark as Required Field:** Toggle to make this field mandatory.
* **Mark as Read Only:** Toggle to prevent edits on this field.
**Visibility**
* **Mark as Hidden Field:** Hide the field from all users.
* **Hide to FE / Technician:** Hide the field from field technicians in the mobile app.
* **Restrict Access by Custom Role:** Limit access to users with specific roles. This means that only users with the specific role will have access to this field. Other users will not be able to see or interact with it based on the access level assigned. When toggled on, you can choose one or more roles from the dropdown using the "**Add Role Access**" button. For each role, you can set an **Access Level**:
* Hidden → The field is completely hidden for this role.
* View Only → The role can see the field but cannot make any changes.
* View & Edit → The role can see and edit the field.
Once you’ve made the required changes, click **Save** to apply the updates.

## Managing Custom Fields
You can **edit, duplicate, or delete custom fields** in Zuper to keep your forms and data structured and up-to-date. Follow these steps:
> [!NOTE]
>
> **How job custom fields are prefilled on creation**
>
> When creating a job from the Jobs module, custom fields are automatically prefilled from matching **Customer** or **Organization** custom fields only. Fields from other entities such as Assets are not used in this flow.
>
> To prefill job custom fields from an Asset, create the job directly from the **Asset record** instead. Alternatively, use the Workflow Builder's [Copy Custom Fields](/Workflow_builder/workflow_builder_nodes) node to copy matching field values automatically after job creation.
>
> Prefill applies only when the field **label matches exactly** across both entities.
### Edit a Custom Field
To update the details of any custom field:
1. Click the \*\*Edit \*\* () icon next to the field you want to modify.
2. The **Edit Field** panel appears on the right. Update the sections as needed.
3. Click **Save** to update the changes.
### Duplicate a Custom Field
Duplicating a field lets you quickly create a new field with the same settings:
1. Click the \*\*clone \*\*() icon next to the field you want to duplicate
2. Update the **Field Name** and other details as needed.
3. Click **Save**.
> Tip: Duplicating is useful when creating similar fields without starting from scratch.
### Delete a Custom Field
To remove fields that are no longer needed, click the Delete () icon next to the field.

# Configuring Non Job Event
Source: https://docs.zuper.co/Settings/Modules/Jobs/Configuring_non_job_events
A non-job event is any activity that a field technician or other employees engage in unrelated to a specific job or work order.
**Navigation**: *Settings -> Modules -> Jobs -> Non Job Event Categories*
## Before you begin
> [!WARNING]
>
> **Warning**: Non-Job Events are only visible and notified on the **Zuper Field Service** mobile app. They do not appear on the legacy Zuper Pro app. Ensure all field users are using the current app before configuring and assigning non-job events. See [Installing Zuper](/Getting_Started/Installing_Zuper) for app download links.
\[existing configuration steps continue here]
## Creating a new non-job event
1. Select the “**Settings**” module from the left navigation menu. Under “**Modules**,” choose “**Jobs**,” and select “**Non-Job Event Categories**" on the Job Settings page.

2. Click "**+ New Non Job Event**" to create the new category.

3. Enter the following details:
* **Category Name**: Enter the category name.
* **Category Color**: Choose the non-job event category color.
* **Category Description**: Enter the description.
> [!NOTE]
>
> **Note**: Check the "**Mark Attendees as busy**" checkbox to block the calendar.

Creating these events informs dispatchers that the technician is unavailable for job assignments during this period, enabling better scheduling and resource management.
## Editing a non-job event category
To modify an existing event category:
* On the non-job event categories listing page, click the edit icon under Actions next to the specific event that you want to update.
* Modify the necessary details in the Edit Non Job Event Category dialog box.
* Click **Update** to save the changes.
## Deleting a non-job event category
To delete a non-job event category:
* On the non-job event categories listing page, click the delete icon under Actions next to the specific event that you want to delete.
* A confirmation dialog box will appear.
* Click **Delete** to remove the category permanently.

# Configuring Task Templates
Source: https://docs.zuper.co/Settings/Modules/Jobs/Configuring_task_templates
## Overview
Every job in your business involves repeatable work — inspections, installations, cleanups, and follow-ups that your team carries out the same way every time. Task templates let you define work once and apply it to any job instantly.
Think of a task template as a reusable blueprint. You build it once in **Settings**, and it is available to apply across your jobs whenever you need it.
**Navigation**: *Settings* → *Job Settings* → *Task Template*
## Before you begin
Make sure you have admin or settings access in Zuper. If you do not see **Job Settings** in your navigation, contact your Zuper administrator.
## View your task templates
1. Go to **Settings** from the left navigation menu.
2. Select **Jobs** to open **Job Settings**.
3. Select **Task Template**. The **Task Templates** listing page opens.
On this page, you can see all existing templates with the following details:
* **Task Template** — the name of the template.
* **EST Duration** — the estimated time to complete the task.
* **Inspection Form** — any linked inspection form.
* **Trade Types** — the trade categories the template applies to.
* **Status** — whether the template is **Active** or inactive.
* **Created By** — the user who created the template.
* **Created At** — the date and time the template was created.
Use the **Status**, **Created User**, **Inspection Form**, and **Trade Types** filters to narrow the list. Use the search bar to find a specific template by name.
## Create a task template
1. On the **Task Templates** listing page, select **+ New Task Template** in the top right corner. The **Create Task Template** panel opens on the right.

1. Enter a name in the **Task Title** field. This field is required.
2. Enter a description in the **Task Description** field. Use this to explain what the task involves so your team has the context they need.
3. Select a **Priority** level for the task.
4. Select one or more **Trade Types** to associate with this template. Trade types help you filter and apply the right templates to the right jobs.
5. Select an **Assignee** if this task is always handled by a specific team member or role.
6. Select a **Task Type** to categorize the task — for example, **Task**.
7. Enter a value in the **Estimated Duration** field to indicate how long this task should take. Use this to help your team plan their time.
8. Select an **Inspection Form** if this task requires your team to complete a form on the job. The form is automatically linked when the template is applied.
9. Select **Create** to save the template.

The new template appears in the **Task Templates** list with an **Active** status.
## Manage existing task templates
From the **Task Templates** listing page, select the context menu (⋮) in the **Actions** column next to any template to access the following options:
* **Edit** — update any of the template's details.
* **Deactivate** — make the template unavailable for use without deleting it.
* **Delete** — permanently remove the template.
# Configuring Service Tasks
Source: https://docs.zuper.co/Settings/Modules/Jobs/configuring-service-tasks
Service tasks in Zuper define specific job-related activities that field technicians must complete. These tasks standardize job execution, improve service efficiency, and help businesses track task completion.
This guide provides a detailed walkthrough for creating, editing, and managing service tasks, ensuring that predefined procedures are followed during job execution.
**Navigation**: Settings -> Modules -> Jobs -> Service Tasks
## Navigating to job service tasks
To configure service tasks, follow these steps:
* Select the "**Settings**" module from the left navigation menu.

* Click **Modules** and choose **Jobs** to open the Job Settings page.
* Click on **Service Tasks**.

* The service tasks listing page will appear, displaying all existing service tasks available for job assignments and team operations.
> [!NOTE]
>
> **Note:** You can filter service tasks based on: **Status** (Active/Inactive), **User** (Task creator), and **Inspection Form** (Tasks linked to an inspection form)
# Creating a new service task
To create a new service task:
* On the service tasks listing page, click **+ New Service Task**.

* A **Create New Service Task** dialog box will appear.
* Enter the required details:
1. **Title** *(Mandatory)*: Enter a title for the service task (e.g., AC Filter Replacement, Electrical Inspection).
2. **Description**: Provide a brief explanation of the task and its purpose.
3. **Estimated Duration** *(Mandatory)*: Specify the estimated completion time of this service task in **days, hours, and minutes**.
4. **Has Inspection Form**: Enable this option if the service task requires an **inspection form**. If enabled, select the appropriate form from the dropdown list.
* Click **Create** to save the new service task.

## Editing a service task
To modify an existing service task:
* On the service tasks listing page, click the kebab icon under **Actions** next to the specific task.
* Select **Edit Task**.

* Update the necessary details.
* Click **Update** to save the changes.
## Deactivating a service task
To deactivate a service task:
* On the service tasks listing page, click the kebab iconunder **Actions** next to the specific task.
* Select **Deactivate Task**.

* A confirmation dialog box will appear.
* Click **Deactivate** to disable the task.
> [!NOTE]
>
> **Note:** Deactivated tasks can be reactivated if required.
## Deleting a service task
> [!NOTE]
>
> **Important:** A service task must be **deactivated** before it can be deleted.
To delete a service task:
* On the service tasks listing page, click the kebab icon under **Actions** next to the Inactive task.
* Select **Delete Task**.
* A confirmation dialog box will appear.
* Click **Delete Task** to remove the task permanently. You can also **activate** the task again, if needed.

# Creating Task Templates
You can create predefined task templates that let you create tasks directly from the dashboard.
# Configuring Job Categories
Source: https://docs.zuper.co/Settings/Modules/Jobs/configuring_Job_categories
The Job Category Hub in Zuper allows administrators to create and manage job categories, ensuring streamlined job classification, tracking, and execution. Within this section, you can also define category-specific job statuses, checklists, service tasks, skill requirements, and time-tracking settings.
**Navigation**: *Settings -> Modules -> Jobs -> Job Category Hub*
## Navigating to job categories
To configure job categories:
* Select the "**Settings**" module from the left navigation menu.

* Click "**Modules"** and choose "**Jobs"** to open the **Job Settings** page.
* Select "**Job Category Hub**." You can view all the configured job categories.

## Creating a new job category
To create a new job category, follow these steps:
* On the job categories listing page, click "**+ New Category**." The **Create New Job Category** dialog box will appear.

* Provide the following details and click "**Create"** to create a new job category:
1. **Category Name** (Mandatory): Enter a unique name for the job category.
2. **Category Color**: Choose a color to represent this category visually.
3. **Estimated Duration** (Mandatory): Define the expected duration in days, hours, and minutes to complete jobs in this category.
4. **Category Description**: Add a brief description of the job category.
5. **Enable/Disable Labor Time**: Toggle labor time tracking on or off.
6. **Enable/Disable Travel Time**: Toggle travel time tracking on or off.
7. **Auto Create Job Status**: Check this option to enable automatic job status creation with predefined statuses for the category.

> [!NOTE]
>
> **Note**: Configuring travel and labor time tracking at the job category level grants you full control over how time is logged according to the specific nature of each job.
>
> For example, while tracking travel and labor time may be essential for field service jobs, it can be disabled for internal tasks such as administrative activities or material planning. This capability allows businesses to tailor time tracking to their operational needs effectively.
### Editing a job category
To modify an existing job category:
* On the job categories listing page, click the icon next to the specific job category.

* The **Edit Job Category** will open.
* Make the necessary changes.
* Click **Update** to save the changes.
### Deleting a job category
If a job category is no longer needed, follow these steps to delete it:
* On the job categories listing page, click the icon next to the specific job category you want to remove.

* A **confirmation dialog box** will appear.
* Click **Delete** to permanently remove the job category.
# Managing job categories
You can create and manage job statuses, checklists, service tasks, and required skill sets for each job category.
## Creating a new job status for a category
To create a new job status:
* Click on any job category from the job categories listing page.
* You will land on the **Job Category Statuses** tab, which displays:
1. **Status Name**
2. **Status Type**
3. **Checklist**. This checklist is associated with the selected status of the job category. Based on the job status update for the category, users are required to complete the checklist. To create a new checklist, refer to the [Configuring Job Checklist](https://docs.zuper.co/Settings/Modules/Jobs/Configuring-job-checklist) article.
* Click **+ New Job Status** to create a new job status for the selected category.

* In the **New Job Status** dialog box, enter the following details and click "**Create**" to save the new job status for the job category.
1. **Status Name** (Mandatory): Enter a clear and descriptive name for the job status (for example, *Started*, *In Progress*, *Completed*).
2. **Status Type** (Mandatory): Select the appropriate status type from the available options. This determines how the status behaves within the job workflow.
3. **Description:** Enter additional information or context about the status to help users understand its purpose.
4. **Status Color** (Mandatory): Choose a color to visually represent the status on the job timeline, status lists, and workflow views.
5. **Dependent Status?** Enable this option to make the new status dependent on another existing status. Once enabled, select the parent status that must occur before this status becomes available.
6. **Track Time in Status?** Enable this option to track how long a job remains in this status.\
Once turned on, enter the **Estimated Duration** using the fields for **Days**, **Hours**, and **Minutes**. This helps set expectations for how long a job should ideally remain in this stage and supports monitoring and performance analysis.

**Location settings:**
Configure location tracking for the job status:
1. **Enable/Disable Geo-Fencing**: When enabled, specify the geo-fence radius in kilometers to restrict status updates to a designated area.
2. **Enable/Disable Capture Geo-Coordinates**: Enable real-time location tracking when this status is used.
**Permissions:**
Control access and visibility for different roles:
1. **Enable for Field Executives**: Allow or restrict field executives from using this status.
2. **Enable for Managers**: Allow or restrict managers from using this status.
3. **Restrict to Custom Roles**: When enabled, select the specific roles permitted to access this status.
**Miscellaneous settings:**
Additional configurations for the job status:
1. **Customer Signature**: Require a customer signature when this status is updated.
2. **Customer Feedback**: Collect customer feedback on the completed job. This option appears only when **Customer Signature** is enabled on the same status, and responses show up in the dashboard statistics.
> [!NOTE]
>
> When Customer Feedback is enabled, the field technician's mobile app displays a **3-point emoji scale** (positive, neutral, negative) after the customer signs off on the job status update. The technician submits the response on the customer's behalf at the job site.
>
> Feedback responses are recorded against the job and reflected in your **Dashboard statistics**. To view aggregated feedback data, navigate to the Dashboard and look for the Customer Feedback widget. You can also export feedback per job using the [Jobs Feedback Report](/Legacy_Reports/Legacy_Reports#job-reports) in Legacy Reports.
>
> **To enable Customer Feedback:**
>
> 1. Enable **Customer Signature** on the job status first.
> 2. The **Customer Feedback** toggle will then appear — enable it.
> 3. Save the status configuration.
3. Show PDF Preview: Display the preview of the PDF.
4. **Facial Authentication**: Enable facial authentication as an additional security step.
5. **Prompt Remarks**: When enabled, choose whether remarks should be:
* **Predefined**: Provide predefined remark options.
* **Free Text**: Allow users to enter custom remarks.

## Importing job statuses from another category
You can also import job statuses from an existing category instead of creating them manually:
* On the job category statuses listing page, click **Import From Other Category**.

* Select the relevant job category from the dropdown menu.
* Click **Import Status** to apply the selected job statuses to the current job category.

### Editing a job status
* On the job category statuses listing page, click the icon next to the specific job status.

* The **Edit Job Status** dialog box opens.
* Make the necessary changes.
* Click "**Update"** to save the changes.
### Deleting a job status
* On the job category statuses listing page, click the icon next to the specific job status.

* A confirmation dialog box appears.
* Click **Delete** to permanently remove the job status from the category.
## Creating service tasks for the job category
You can associate service tasks with job categories to manage and structure them efficiently. You can also assign existing service tasks, create new ones, and configure their execution order for streamlined operations.
### Adding service tasks to a job category
To assign service tasks to a job category:
* Click on any job category from the **Job Categories** listing page.
* Navigate to the **Service Tasks** tab.
* Click **+ Add Task** to add an existing service task to the job category.

* Once added, the list of service tasks will be displayed, including:
1. **Service Task Name**
2. **Description**
3. **Inspection Form**
4. **Estimated Duration**

### Creating a new service task
If a required service task does not exist, you can create a new one from the Add Service Task page. Follow these steps:
* Click **+ New Task** on the **Add Service Task** page.

* Enter the necessary details for the new service task.
* Click **Create** to save the task.
For a detailed guide on creating service tasks, refer to the [**Configuring Service Tasks**](https://docs.zuper.co/Settings/Modules/Jobs/configuring_Job_categories) article.
**Managing Service Task Execution Order**
You can define the sequence in which service tasks should be completed within a job category:
* **Serial Execution**: Tasks must be completed in a predefined order.
* **Parallel Execution**: Tasks can be executed in any order, allowing flexibility in task completion.
To adjust the execution sequence:
1. On the service tasks listing page:
* Click **Serial** to enforce a structured workflow where tasks follow a set order.
* Click **Parallel** to allow tasks to be completed independently in any order.

### Editing a service task
To modify an existing service task:
1. On the **Service Tasks** listing page, click the kebab () icon under the **Actions** column.
2. Select **Edit Task**.
3. In the **Edit Service Task** dialog box, make the necessary changes.
4. Click **Update** to save the changes.
### Deleting a service task
To remove a service task from a job category:
1. On the **Service Tasks** listing page, click the icon under the **Actions** column.
2. Select **Delete Task** next to the specific service task.
3. In the confirmation dialog box, click **Delete** to permanently remove the task.
Additionally, if you need to remove all assigned service tasks from a job category, click **Remove All**.

### Cloning a service task
If you need to duplicate an existing service task for reuse:
* On the **Service Tasks** listing page, click theicon under the **Actions** column.
* Select **Clone Task**.
* In the **Clone Service Task** dialog box, the **Title** field will be prefilled.
* Provide additional details such as:
1. **Description**
2. **Estimated Duration**
3. **Inspection Form**
* Click **Clone** to create a new service task within the job category.
## Creating tasks for the job category
### Add task
From the **Tasks** tab inside a job category, you can add tasks from your existing task templates, control whether tasks run in sequence or in parallel, reorder them by dragging, and manage individual tasks as your needs change.
### Add a task to a job category
1. Go to **Settings** from the left navigation menu.
2. Select **Jobs** to open **Job Settings**, then select **Job Category Hub**.
3. Select the job category you want to update.
4. Go to the **Tasks** tab.
5. Select **+ Add**. A list of your available task templates appears.
6. Select the task you want to add and confirm your selection.


The task appears in the list with the following details:
* **Task** — the name of the task.
* **Description** — a brief summary of what the task involves.
* **Trade Types** — the trade categories associated with the task.
* **Status** — whether the task is **Active**.
* **Inspection Form** — any linked inspection form.
* **EST Duration** — the estimated time to complete the task.

At the bottom of the list, Zuper displays the **Estimated Duration** set for the job category alongside the **Total duration of tasks** — so you can see at a glance whether your task durations align with the overall job estimate.
> [!NOTE]
>
> Tasks added here are drawn from your task templates. If the task you need does not exist yet, create it first in **Settings** → **Job Settings** → **Task Template**, then return here to add it. See [Task templates](/Jobs/Task_Templates) for steps.
### Set the task execution order
Once you have added tasks, you can control how your team works through them.
* Select **Serial** to require tasks to be completed one at a time, in a fixed order. Use this when each step depends on the previous one being done first.
* Select **Parallel** to allow tasks to be completed in any order. Use this when your team can work through tasks independently.
The selected mode applies to all tasks in that job category.

### Reorder tasks
To change the sequence of tasks, select and drag the handle (⠿) on the left side of any task row to move it to the desired position. This is only relevant when the execution order is set to **Serial**.
### Manage individual tasks
Select the three-dot icon (⋮) in the **Actions** column next to any task to access the following options:
* **Edit** — update the task details.
* **Delete** — remove the task from the job category.
To remove every task from the job category at once, select **Remove All** in the top right corner of the Tasks tab.
## Creating skillsets for a job category
Skillsets define the required competencies for a job category, ensuring that only qualified personnel are assigned to specific tasks. By mapping skillsets to job categories, organizations can ensure consistency in skill requirements based on job categories and improve efficiency.
### Adding skillsets to a job category
To add a skillset required for a job category:
* Click on any **job category** from the job categories listing page.
* Navigate to the **Skillset** tab to view the list of skillsets associated with the job category.
* Click **+ Map New Skill** to add a required skillset.

* In the **Map New Skill** dialog box, provide the following details:
1. **Select Skill** (Mandatory): Choose a skill from the available options.
2. **Is Mandatory?** (Mandatory): Select **Yes** or **No** to indicate whether the skill is required.
3. **Minimum Level** (Mandatory): Specify the minimum proficiency level (in numbers).
4. **Preferred Level** (Mandatory): Specify the preferred proficiency level (in numbers).
5. Click **Map** to save the skillset.

### Creating a new skillset
If a required skillset does not exist, you can create a new one:
* Click **+ Create New Skill** on the **Map New Skill** page.

* Enter the necessary details for the new skill.
* Click **Create** to save the skill.
For a detailed guide on creating skillsets, refer to the [**Configuring Skillsets**](https://docs.zuper.co/Settings/Modules/Jobs/Configuring-skillsets) article.
### Editing a skillset
* On the **Skillsets** listing page, click the icon next to the specific skill.

* The **Edit Skill** dialog box opens.
* Make the necessary changes.
* Click **Update** to save the changes.
### Deleting a skillset
* On the **Skillsets** listing page, click the icon next to the specific skill.

* A confirmation dialog box appears.
* Click **Delete** to permanently remove the skill from the job category.
By configuring job categories effectively, businesses can improve job management efficiency and ensure consistent service execution tailored to operational needs.
# Configuring Job Notifications
Source: https://docs.zuper.co/Settings/Modules/Jobs/configuring_job_notifications
Job notifications in Zuper help ensure seamless communication and timely updates regarding job schedules, delays, and status changes. By configuring job notifications, users can set up reminders, alerts, and status updates to keep field technicians, team leaders, and other stakeholders informed in real-time.
This guide provides a detailed walkthrough on how to configure and manage job notifications effectively.
**Navigation**: Settings -> Modules -> Jobs -> Job Notifications
> [!WARNING]
>
> **Note:** Templates in Job Reminders, Job Delay Alerts, and Job Status Alerts only recognize dynamic expressions from the **Jobs module**. If a template includes an expression from a different module (for example, Quotes), that field will not populate, it renders as raw template syntax instead of the expected value, with no error shown. When building these templates, use only Jobs-module fields via the **Available Components** dropdown.
## Navigating to job notifications
* Select the "**Settings"** module from the left navigation menu.

* Click **Modules** and select **Jobs** to open the **Job Settings** page.
* Choose **Job Notifications**.

* The **Job Notifications Page** will appear, displaying all existing notifications, including **Job Reminders**, **Job Delay Alerts**, and **Job Status Alerts**.
## Job Reminders
## Creating a new job reminder
To create a job reminder:
* On the job notifications listing page, click **+ New Job Reminder** next to the **Job Reminder** section.

* A **New Job Reminder** dialog box appears.
* Fill in the following details:
1. **Reminder Name** (*Required*): Enter a name for the reminder.
2. **Job Category**: Select job categories from the dropdown menu.
3. **Notification Type** (*Required*): Choose from Push Notification, SMS, or Email.
4. **Send Reminder To** (*Required*): Select the recipients from options such as:
* All assigned users
* Only assigned team members
* Only assigned field technicians
* Assigned field technician’s team leaders
* Selected users
* Selected teams
5. **Remind Type** (*Required*): Choose from options like:
* Scheduled Start Time
* Relative to Start Time
* Relative to End Time
* Relative to Due Date
6. **Remind Before/Remind At**: Enter the timing or days for the reminder.
7. **Alert Template/SMS Body/Email Body** (*Required*): Compose the message using available components.
8. Click **Save Reminder** to finalize.

The job reminder will be listed with details such as Reminder Name, Remind At, Remind To, and Status (Active/Inactive).
### Editing a job reminder
After creating a job reminder, you can edit, delete, or deactivate it. To update a job reminder's details, follow these steps:
* On the job reminders listing page, click the icon under **Actions** and select **Edit Job Reminder** next to the specific reminder.

* Modify the necessary details.
* Click **Update Reminder** to save changes.
### Clone job reminder
If you'd like to create a new job reminder based on an existing one, you can quickly do so using the **Clone Job Reminder** option. Follow these steps:
* On the job reminders listing page, click the icon under **Actions** and select **Clone Job Reminder**.

* The **Clone Job Reminder** dialog appears with existing details.
* Update the necessary fields and click **Clone Reminder**.
### Deactivate/Activate job reminder
To deactivate or activate an existing job reminder:
* On the job reminders listing page, click the icon under **Actions** and select **Deactivate/Activate Job Reminder**

* A confirmation dialog box will appear.
* Click **Deactivate** or **Activate** to confirm your changes.
### Delete job reminder
To delete an existing job reminder:
* On the job reminders listing page, click the icon under **Actions** and select **Delete Job Reminder** next to the specific reminder that you want to delete.

* A confirmation dialog box will appear.
* Click **Delete** to permanently remove the job reminder.
## Job Delay Alerts
### Creating a new job delay alert
To create a new job delay alert:
* On the job notifications listing page, click **+ New Delay Alert** next to the **Job Delay Alerts** section.

* A **New Job Delay Alert** dialog appears.
* Fill in the following details:
* **Alert Name** (*Required*): Enter a name for the alert.
* **Notification Type** (*Required*): Choose from Push Notification, SMS, or Email.
* **Delay Alert Type** (*Required*): Select from:
1. Based on Job Start Time
2. Based on Job End Time
3. Based on Job Due Date
4. Based on Status (Requires selecting "From Job Status" and "To Job Status")
* **Alert If Job Delayed By**: Specify time or days.
* **Send Reminder To** (*Required*): Select recipients as described in job reminders.
* **Flag Job as Delayed?**: Check/uncheck the box as needed.
> [!NOTE]
>
> **Note**: icon will indicate the delay in the jobs modules.
* **Alert Template/SMS Body/Email Body** (*Required*): Compose the message.
* Click **Save Alert**.

The job delay alert is added with details such as Alert Name, Job Category, Alert If Delayed By, Remind To, and Status (Active/Inactive).
### Editing a Job Delay Alert
* On the job delay alerts listing page, click theicon under **Actions** and select **Edit Delay Alert**.
* Modify necessary details.
* Click **Update Alert** to save changes.
### Clone Job Delay Alert
* On the job delay alerts listing page, click the **icon** under **Actions** and select **Clone Delay Alert**.
* The **Clone Job Delay Alert** dialog appears with existing details.
* Update the necessary fields as needed.
* Click **Clone Alert** to clone the alert.
### Deactivate/Activate Job Delay Alert
To deactivate or activate an existing job delay alert:
* On the job delay alerts listing page, click the icon under **Actions** and select **Deactivate/Activate Delay Alert** next to the specific alert that you want to deactivate or activate.
* A confirmation dialog box will appear.
* Click **Deactivate** or **Activate** to confirm your changes.
### Delete Job Delay Alert
To delete an existing job delay alert:
* On the job delay alerts listing page, click the icon under Actions and select **Delete Delay Alert** next to the specific delay alert that you want to delete.
* A confirmation dialog box will appear.
* Click **Delete** to permanently remove the job delay alert.
## Job Status Alerts
### Creating a new Job Status Alert
* On the job notifications listing page, click **+ New Status Alert** next to the **Job Status Alerts** section.

* A **New Job Status Alert** dialog box appears.
* Fill in the following details:
1. **Alert Name**(*Required*): Enter a name for the alert.
2. **Notification Type**(*Required*): Choose from Push Notification, SMS, or Email.
3. **Send Reminder To**(*Required*): Select recipients as described in job reminders.
4. **Job Category**: Choose from the dropdown menu.
5. **Job Status**: Select a status.
6. **Alert Template/SMS Body/Email Body**(*Required*): Compose the message.
* Click **Save Notification**.

The job status alert is added with details such as Alert Name, Job Category, Job Status, and Status (Active/Inactive).
### Editing a Job Status Alert
* On the job status alerts listing page, click the icon under **Actions** and select "**Edit Status Alert**" next to the specific job status alert.

* The Edit Job Status Alert will open.
* Make the necessary changes.
* Click **Update Notification** to save the changes.
### Clone Job Status Alert
To clone an existing job status alert:
* On the job status alerts listing page, click the icon under **Actions** and select "**Clone Status Alert"** next to the specific alert that you want to clone.

* The Clone Job Status Alert dialog box will open with existing alert details.
* Update the necessary changes as needed
* Click **Clone Notification** to clone the alert.
### Deactivate/Activate Job Status Alert
To deactivate or activate an existing job status alert:
* On the job status alerts listing page, click the icon under **Actions** and select **Deactivate/Activate Status Alert** next to the specific alert that you want to deactivate or activate.

* A confirmation dialog box will appear.
* Click **Deactivate** or **Activate** to confirm your changes.
### Delete Job Status Alert
To delete an existing job status alert:
* On the job status alerts listing page, click the icon under **Actions** and select "**Delete Status Alert**" next to the specific status alert that you want to delete.

* A confirmation dialog box will appear.
* Click **Delete** to permanently remove the job status alert.
> [!NOTE]
>
> When manually sharing a job card via email, the template must be selected manually each time — Zuper does not auto-select based on job category or customer type. To send automated job completion emails, set up a Job Status Alert in Settings → Modules → Jobs → Job Notifications.
>
> This means:
>
> If you have created a '**Maintenance Visit Completed**' email template, it will not be pre-selected when you click '**Share via Email**' on a maintenance job — you must choose it manually from the dropdown.
>
> Only the default Job Completion Email template is pre-populated by default
## **Customer / contact reminder**
**Navigation**: *Settings -> Modules -> Customer-Contact -> Customer-Contact Custom Notifications*
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” click “**Customer/Contact Notifications**.”

2. Click “**+ New Reminder**.”

3. Fill in the reminder details
* Reminder Name: Enter a name for the reminder.
* Job Category: Select the job category.
* Notification Type: Choose the type of notification.
* Remind Type: Select the reminder type.
* Remind At / Before: Set a specific time for the reminder.
* SMS / Email Body: Enter the message content. Use the Available Components dropdown to insert dynamic fields, such as customer fields or job details (e.g., "The scheduled job starts at...").
* Notify for Unassigned Jobs: Check this box to receive a reminder to apply.

Click “**Save Reminder**” to save the reminder.
## **Customer /Contact Status Alerts**
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” click “**Customer/Contact Notifications**.”
2. Click “**+ New Notification**.”
3. Enter/Select the details:
* Notification Name: Enter a descriptive name for the alert.
* Notification Type: Select the type of notification. Choose the type of notification.
* Job Category: Select the relevant job category.
* Job Status: Choose the status that will trigger the notification.
* SMS /Email Body: Enter the message to be sent. You can use dynamic components to personalize the message.
* Use the Available Components dropdown to insert dynamic fields, such as customer fields or job details.
Click “**Save Notification**” to set the notification.
> [!NOTE]
>
> **One job category per alert:** Each customer/contact status alert applies to a single job category. Selecting multiple job categories within one alert is not supported. To notify customers across multiple job categories for the same status change (for example, an SMS when the status changes to "**On My Way**"), create a separate status alert for each job category.
>
> To speed this up, use the **Clone Status Alert** option: create the alert once, then clone it and change only the Job Category field for each additional category. This ensures the trigger works correctly for every category while keeping the message content consistent.
### FAQs
> [accordion] Why do older job notes appear in new notifications?
>
> When a new note is added to a job, the Zuper mobile app notification
> banner displays **all unread job notes collectively** — not just the
> newest one. This means if previous note notifications have not been
> opened or cleared, they will reappear alongside the new note in the
> banner.
>
> This is expected behaviour based on how mobile operating systems group
> app notifications, and is not a bug.
>
> **To resolve this:**
>
> * Open the Zuper app to mark all pending notifications as read, or
> * Clear the notification banner on your device manually.
>
> Once existing notifications are cleared, only new notes will appear
> going forward.
# Configuring organization settings
Source: https://docs.zuper.co/Settings/Modules/Organization_Settings/Organization_Settings
The Organization settings section allows you to configure and manage organization-related preferences, including general settings and custom fields.
**Navigation**: *Settings -> Modules -> Organization -> Organization General Fields*
## Organization general settings
Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Organizations**.” Select the “**Customer/Contact General Settings**.”

* Allow Field Executive to view all Organization?
Yes: Toggle to Yes will enable viewing all organization access for field executives.
No: Toggle to No will disable viewing all organization access for field executives.
* Allow Team Leader to view all Organization?
Yes: Toggle to Yes will enable viewing all organization access for Team Leaders.
No: Toggle to No will disable viewing all organization access for Team Leaders.

To save changes, click the **Save** button at the top right.
## Organization custom fields
Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Organizations**.” Select the “**Organization custom fields**.”

Drag and drop the fields from the right panel.
Text
* Single-Line Input: This allows you to create a field to enter a single line of free text.
* Multi-Line Input: This allows you to create a field to enter multiple lines of free text.
Date
* Date Input: This allows you to create a field to select a specific date from a calendar.
* Time Input: This allows you to create a field where you can select a specific time.
* Date Time Input: This allows you to create a field where both date and time can be selected.
Selection
* Single-Selection: This allows you to create a radio input Field where one of the provided options can be selected.
* Multi-Selection: This allows you to create check boxes where the provided options can be checked.
* Drop-Down: This allows you to create a drop-down field with the required list of options.
Media
* Upload: This allows you to create a file input field to upload files.
Misc
* Look up : This allows you to create a file input field to look up the products from the parts and services module.
> [!NOTE]
>
> Note: You can also control the behavior and visibility of each field using the following options:
>
> * Mark as Required Field - Makes the field mandatory to fill out before submitting the form.
> * Mark as Read Only—This option makes the field non-editable; users can view the value but cannot modify it.
> * Mark as hidden field- This hides the field from all users; it will not appear in the form interface.
> * Hide to FE/Technician- This option makes the field invisible to technicians or front-end users during form access.


Click “**Create New**” to create the “**Custom Field**” group.

By following the outlined steps, you can easily organize the organization settings.
# Configuring Parts & Services Settings
Source: https://docs.zuper.co/Settings/Modules/Parts-Services/Parts-Services-Settings
The Parts & Services module in Zuper is designed to streamline your organization’s management of parts and services. It allows you to configure and customize settings related to pricing and the organization of parts and services.
## Parts and Services General Settings
**Navigation**: *Settings -> Modules -> Parts & Services -> Parts & Services General Settings*
* Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Parts & Services**.” Select the “**Parts & Services General Settings**.

* **Part Prefix**: Set a prefix for parts.
* **Update Purchase Cost to?**: Select an option to determine how purchase price differences are handled.
> [accordion] Latest Purchase Cost
>
> When you receive a part or product, the most recent purchase price is saved to the part or product master record.
> [accordion] Weighted Average Purchase Cost
>
> Each time you receive stock, Zuper recalculates the weighted average cost across all units on hand and the receiving cost and quantity using this formula: Each time you receive stock, Zuper recalculates the weighted average cost across all units on hand using this formula: ((Existing Cost × Existing Quantity) + (Receiving Cost × Receiving Quantity)) ÷ (Existing Quantity + Receiving Quantity) The result replaces the previous cost in the part or product master record.
> [accordion] Highest Purchase Cost
>
> Zuper compares the existing cost against the latest receiving cost and saves the higher of the two to the part or product master record.
* **Choose module to track Part Consumption**: Select a module for tracking part consumption. You can choose the job, quote, invoice, or none.
* **Choose Job Status type to trigger Consumption** (This will be visible only if you choose the option as a job in the previous option): Select a status to trigger part consumption.
* **Notify if stock is running below the threshold quantity?**: Toggle **Yes** to enable notifications for low stock. Add email addresses to receive notifications. Toggle No to disable notifications for low stock.
* **Allow negative stock balance?**: Toggle **Yes** to allow negative stock balances. Toggle No to disable stock notifications.
* **Enable markup?**: Toggle to **Yes** to enable markup on parts.
* **Default Markup Type?**: Select the markup type. You can choose flat, percentage, or Multiplier.
* **Default Pricing level for Bundle?**: Select the pricing level. You can choose Bundle or Roll up.
* **Enable** **[Options](https://docs.zuper.co/Inventory_Management/Parts_Services/Create_New_Part_Service#3-options)?** Toggle to **Yes** enables adding configurable attributes to the product system-wide.
* **Mandate Serial No?**: Set this to **Yes** if you want the user to select a serial number while using the material in transactions such as Jobs, Quotes, and Invoices.
* **Enable Purchase Tax?**: Toggle to **Yes** to track purchase tax separately from cost on parts, purchase orders, and inward transactions. See [Purchase Tax](/Inventory_Management/Parts_Services/Purchase-Tax) for how this affects your parts.
* Click **Save** to apply changes.

## Category Settings
The **Category** **Settings** page allows you to organize parts, products, and services into logical groups for better inventory management and assignment to jobs, quotes, invoices, etc.
### Adding a New Category
* Navigate to **Settings** from the left navigation.
* Choose **Parts & Services** from the module and click “**Category Settings**” to create or manage a category or subcategory.

**To create a new category:**
* Click **+ New Category** at the top right.

* The **New Category** dialog opens.
* **Category Name**: Enter a unique name.
* **Icon for Product Category**: Upload an image file (optional).
* **Trade Type(s)**: Select one or more trade types from the dropdown (e.g., Plumbing, Electrical, HVAC).
* **Category Description**: Provide a brief description (optional).
* Click **Create** to save the category.

* A new category will be successfully created.
### Adding a New Sub-Category
Sub-Categories allow you to create a second level of classification under a parent category. This is useful when you want to further organize items within a broader category (e.g., “Installation”, “Maintenance”, “Spare Parts” under HVAC).
1. In the **Category Settings** listing page, click the **Context** menu for a category and select + **Add Sub-Category**. \

2. In the **New Sub-Category for \[Category Name]** dialog (e.g., New Sub-Category for HVAC):
* **Category Name**: Enter the sub-category name.
* **Icon for Product Category**: Upload an image file (optional).
* **Trade Type(s)**: This will be inherited from the parent category.
* **Category Description**: Provide a brief description (optional).
* Click **Create** to add the sub-category. \

3. The parent category will show a count of sub-categories (e.g., HVAC (1)).
### Managing a category or Sub-Category
After creating categories and sub-categories, you can edit or delete them as your business needs evolve.

#### Editing a Category or Sub-Category
1. On the **Category Settings** page, locate the category or sub-category you want to modify.
2. Click the **context menu** (⋮) and select **Edit**.
3. In the edit dialog, make the necessary changes.
4. Click **Update** to apply changes.
#### Deleting a Category or Sub-Category
1. On the **Category Settings** page, click the **context menu** (three dots ⋮) for the category or sub-category.
2. Select **Delete**.
3. A confirmation dialog appears:
* **If the category has no sub-categories:** Simple confirmation prompt.
* **If the category has sub-categories**: Warning message: “This will also delete \[n] sub-categories.”
4. Review the warning carefully.
> [!NOTE]
>
> Note: Deleting a parent category automatically removes all its sub-categories.
5. If certain, click **Delete**. Otherwise, click **Cancel**.
#### Searching and Filtering Categories
* Use the search bar at the top to filter by name.
* Expand all categories using the **Expand all** link to view sub-categories inline.
* Reorder by dragging and dropping is the preferred location for the subcategory.
## **Parts and services locations**
Locations help organize parts and services tracking for easier management.
**Navigation**: *Settings -> Modules -> Parts & Services -> Parts & Services Locations*
Adding a new location
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Parts & Services**.” Select the “**Parts & Services Location Settings**.”

2. Click the + New Location button.

3. Fill in the following details.
* Location Name (Mandatory): Enter a name for the location. Maximum 26 characters.
* Location Type ( Mandatory): Select from the dropdown (Site, Warehouse, Van, Others).
* Can FE access this location? (Mandatory): Choose an option
* Location Description: Add a brief description.
* Address: Use “**Pick from map**” to select an address. A map preview will display the selected location.
* Street Address ( Mandatory): Automatically filled based on the selected address but can be edited.
* Landmark: Add a nearby landmark (optional).
* City (required): Automatically filled but editable.
* State/Province: Automatically filled but editable.
* ZIP code: Automatically filled but editable.

* Click **Create** to save the location.
## **Product - parts custom fields**
**Navigation**: *Settings -> Modules -> Parts & Services - > Parts & Services Custom Fields*
1. Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the "**Parts & Services**" Select the "**Parts & Services Custom Fields**."

> [accordion] Text
>
> * Single-Line Input: This allows you to create a field to enter a single line of free text.
> * Multi-Line Input: This allows you to create a field to enter multiple lines of free text.
> [accordion] Date
>
> * Date Input: This allows you to create a field to select a specific date from a calendar.
> * Time Input: This allows you to create a field where you can select a specific time.
> * Date Time Input: This allows you to create a field where both date and time can be selected.
> [accordion] Selection
>
> * Single-Selection: This allows you to create a radio input Field where one of the provided options can be selected.
> * Multi-Selection: This allows you to create check boxes where the provided options can be checked.
> * Drop-Down: This allows you to create a drop-down field with the required list of options.
> [accordion] Media
>
> * Upload: This allows you to create a file input field to upload files.
> [accordion] Misc
>
> * **Look up** : This allows you to create a file input field to look up the products from the parts and services module.


> [!NOTE]
>
> Note: You can also control the behavior and visibility of each field using the following options:
>
> * Mark as Required Field - Makes the field mandatory to fill out before submitting the form.
> * Mark as Read Only—This option makes the field non-editable; users can view the value but cannot modify it.
> * Mark as hidden field- This hides the field from all users; it will not appear in the form interface.
> * Hide to FE/Technician- This option makes the field invisible to technicians or front-end users during form access.
2. Click “**Create New**” to create the “**Custom Field**” group.

Zuper’s Parts and Services settings let you manage your inventory and offerings effortlessly, ensuring accurate pricing and availability.
# Configuring Project Settings
Source: https://docs.zuper.co/Settings/Modules/Projects/Project_Settings
The Project Settings module in Zuper allows you to configure and customize project-related settings to streamline workflows. This module includes options to manage general settings, project categories, and custom fields for projects.
**Navigation:** *Settings -> Modules -> Projects - > Project General Settings*
## **Project general settings**
* Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the "**Projects**." Select the "**Project General Settings**."

* **Project Prefix**
Define a custom identifier prefixed to all projects. A project prefix helps categorize jobs systematically, making them easily identifiable.
* **Enable Timelog for Projects?**
Toggle to Yes will enable the time log for projects. Toggle to No will disable the time log for projects.
* **Enable Secondary Contacts**
Toggle the Enable option to enable adding secondary contacts to projects. Toggle the Disable option to restrict projects to primary contacts only.
* **Enable Kanban View**
Enable the Kanban view for projects, allowing teams to visualize work progress across different stages. This improves task tracking, prioritization, and workflow management.
* **Automatically add task assignees to the project**
When toggle to Yes, assigning a user to a task automatically adds them as an assignee on the project. When toggle to No, the user is assigned to the task only and is not added to the project.
* **Enable Project Value** Enable to view the project value.
Users can now associate secondary contacts with their projects, both during project creation and after the project has been created. This enhancement ensures that all relevant contacts can be linked to projects for better collaboration and communication.
Click the "**Save**" button to save the project's general settings.

## **Project category**
**Navigation:** *Settings -> Modules -> Projects - > Project Category*
1. Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the "**Projects**." Select the "**Project Category**."

2. Click the "**+ New Category**" to create a new project category.

3. A dialog box appears. Enter the following details
* **Category Name\***: The name of the project category.
* **Category prefix**: This optional prefix can be used as a shorthand or identifier for the project category.
* **Category color**: Choose a color to represent the category visually. This color can help quickly distinguish between different categories when viewing project lists.
* **Estimated Duration\***: Provide an estimated duration that a project might take to complete.
* **Category description**: Briefly explain the purpose or scope of projects within this category.
Click "**Create**" to save the new project category.
> [!NOTE]
>
> **Note**: The symbol "\*" indicates that the field is mandatory.

## Project status
**Navigation**: *Settings -> Modules -> Projects - > Project Categories - > Project Status*
Project status refers to a project's current state or condition, including its goals, timeline, and milestones. In Zuper, the project status types include Open, In-progress, Closed, On Hold, and Cancelled, which can be tailored to your specific preferences.
1. Select any one of the project categories to view the project listing page.

2. The list of Job statuses is displayed. If needed, click "**+ New Status**" to add a status for the selected project category. Click "**Edit Project Category** " to modify the project category.

3. A dialog box appears. Enter the following details to create a project status.
* **Status Name\***: Assign a unique name to the status within the project category.
* **Status Type\***: Select the appropriate type for the status from the dropdown menu.
* **Description**: Enter a brief explanation of the status's purpose in the category.
* **Status Color**: Pick a color to represent the status visually. This helps quickly identify and differentiate project statuses in lists.
* **Dependent Status**: o Toggle the Enable option to allow the dependent status. o Toggle the Disable option to disable the dependent status.
* **Restrict to Custom Roles**: o Toggle the Enable option to restrict the status to custom roles. o Toggle the Disable option to assign the status to custom roles.
* **Prompt Remark**s: o Toggle the Enable option to allow the user to enter the remarks. o Toggle the Disable option to restrict the user from entering the remarks.
* Click the "**Add Status**" button.
> [!NOTE]
>
> Note: The symbol "\*" indicates that the field is mandatory.
4. You can edit/delete the status as needed by clicking the edit or delete icon available next to the status name.

## Project Custom fields
> [!NOTE]
>
> Navigation: Settings -> Modules -> Projects - > Project Custom Fields
Select the "**Settings**" module from the left panel. Under the "**Modules**," choose the "**Projects**." Select the "**Project Custom Fields**."

**Text**
* Single-Line Input: This allows you to create a field to enter a single line of free text.
* Multi-Line Input: This allows you to create a field to enter multiple lines of free text.
**Date**
* Date Input: This allows you to create a field to select a specific date from a calendar.
* Time Input: This allows you to create a field where you can select a specific time.
* Date Time Input: This allows you to create a field where both date and time can be selected.
**Selection**
* Single-Selection: This allows you to create a radio input Field where one of the provided options can be selected.
* Multi-Selection: This allows you to create check boxes where the provided options can be checked.
* Drop-Down: This allows you to create a drop-down field with the required list of options.
**Media**
* Upload: This allows you to create a file input field to upload files.
**Misc**
* **Look up** : This allows you to create a file input field to look up the products from the parts and services module.

> [!NOTE]
>
> Note: You can also control the behavior and visibility of each field using the following options:
>
> * Mark as Required Field - Makes the field mandatory to fill out before submitting the form.
> * Mark as Read Only—This option makes the field non-editable; users can view the value but cannot modify it.
> * Mark as hidden field- This hides the field from all users; it will not appear in the form interface.
> * Hide to FE/Technician- This option makes the field invisible to technicians or front-end users during form access.
Click “**Create New**” to create the “**Custom Field**” group.

Click "**Save**" button to save the custom field group.

By following the outlined steps, you can easily organize project statuses and categories, ensuring clarity and coherence in project management.
# Configuring Properties Settings
Source: https://docs.zuper.co/Settings/Modules/Properties/Properties_Settings
The Organization settings section allows you to configure and manage properties-related preferences, including general settings and custom fields.
**Navigation**: *Settings -> Modules -> Properties -> Property General Fields*
## **Properties general settings**
Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Properties**.” Select the “**Property General Settings**.”
* Allow Field Executive to view all Property?
Yes: Toggle to Yes will enable viewing all property access for field executives.
No: Toggle to No will disable viewing all property access for field executives.
* Allow Team Leader to view all Property?
Yes: Toggle to Yes will enable viewing all property access for Team Leaders.
No: Toggle to No will disable viewing all property access for Team Leaders.

To save changes, click the **Save** button at the top right.
## Properties custom fields
Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Properties**.” Select the “**Property custom fields**.”

Drag and drop the fields from the right panel.
Text
* Single-Line Input: This allows you to create a field to enter a single line of free text.
* Multi-Line Input: This allows you to create a field to enter multiple lines of free text.
Date
* Date Input: This allows you to create a field to select a specific date from a calendar.
* Time Input: This allows you to create a field where you can select a specific time.
* Date Time Input: This allows you to create a field where both date and time can be selected.
Selection
* Single-Selection: This allows you to create a radio input Field where one of the provided options can be selected.
* Multi-Selection: This allows you to create check boxes where the provided options can be checked.
* Drop-Down: This allows you to create a drop-down field with the required list of options.
Media
* Upload: This allows you to create a file input field to upload files.
Misc
* Look up : This allows you to create a file input field to look up the products from the parts and services module.
> [!NOTE]
>
> Note: You can also control the behavior and visibility of each field using the following options:
>
> * Mark as Required Field - Makes the field mandatory to fill out before submitting the form.
> * Mark as Read Only—This option makes the field non-editable; users can view the value but cannot modify it.
> * Mark as hidden field- This hides the field from all users; it will not appear in the form interface.
> * Hide to FE/Technician- This option makes the field invisible to technicians or front-end users during form access.


Click “**Create New**” to create the “**Custom Field**” group.

Following the outlined steps, you can easily organize property settings.
# Configuring Purchasing Settings
Source: https://docs.zuper.co/Settings/Modules/Purchasing/Configure-PO
Purchasing settings in Zuper allow you to configure and customize how purchase-related processes work across your organization. From approval hierarchies to custom fields and templates, these settings help standardize purchasing workflows, improve compliance, and ensure consistency in purchase orders and material requests.
You can use Purchasing settings to:\
• Define approval flows for purchase orders and material requests\
• Customize vendor, material request, and purchase order forms\
• Create reusable purchase order templates
**Navigation**: *Settings → Modules → Purchasing*
## General Settings
General settings control approval workflows and default behaviors for purchase orders and material requests.
**Navigation**: *Settings → Modules → Purchasing → General Settings*

> [tab] Purchase Orders
>
> When you open General Settings, you'll land on the **Purchase Orders** tab by default. This allows you to configure general purchase order settings.
>
> 1. **Choose Approval Hierarchy**: Select how purchase orders are approved within your organization. This defines the approval flow before a purchase order is finalized.
>
> For more information on creating and managing hierarchies, refer to this [article](https://docs.zuper.co/Purchasing/Material-Requests/Material-request-status#create-and-manage-hierarchies).
>
> 2. **Default Email Template**: Choose the default email template that will be used when sending purchase orders to vendors.
>
> For more information on creating and managing Email Templates, refer to this [article](https://docs.zuper.co/Settings/Miscellaneous/Email_Templates).
>
> 3. **Require Vendor Approval?**: Enable this option if vendor approval is required before a purchase order can proceed. This helps ensure vendor confirmation and accuracy.
> [tab] Material Requests
>
> This allows you to configure general material requests settings.
>
> 1. **Choose Approval Hierarchy**: Select the approval hierarchy for material requests. This determines who must approve a request before materials can be purchased or allocated. The hierarchy you configure here applies automatically when a material request is submitted. To learn how material requests are created and submitted, see [Creating a Material Request](https://docs.zuper.co/Purchasing/Material-Requests/Creating-material-request).
>
> 
>
> For more information on creating and managing hierarchies, refer to this [article](https://docs.zuper.co/Purchasing/Material-Requests/Material-request-status#create-and-manage-hierarchies).
4. **Automatically send PO to Vendor after Approval?**: When this option is enabled, Zuper automatically sends the purchase order to the vendor by email immediately after approval. If you disable this option, you must send the email to the vendor manually.
> [!NOTE]
>
> By default, the **Automatically send PO to Vendor after Approval** toggle is set to on.

## Vendor Custom Fields
Vendor custom fields allow you to capture additional information specific to vendors, beyond the standard fields.
**Navigation**: *Settings → Modules → Purchasing → Vendor Custom Fields*
* Select the **Setting**s module from the left navigation menu.
* Under **Modules**, choose **Purchasing**.
* Select **Vendor Custom Fields**.

* Drag and drop custom fields from the right panel into the form layout.
* Configure field properties as needed.
* Click **Create New** to create a Custom Field group.
## Material Request Custom Fields
Material request custom fields let you collect additional details when users create a material request. Any fields you configure here appear in the **Other Details** section of the material request form. See [Creating a Material Request — Other Details](https://docs.zuper.co/Purchasing/Material-Requests/Creating-material-request#other-details).
**Navigation**: *Settings → Modules → Purchasing → Material Request Custom Fields*

Follow the same steps used for Vendor Custom Fields to add and configure fields for material requests.
## Purchase Order Custom Fields
Purchase order custom fields help you customize purchase order forms with additional information required by your business.
**Navigation**: *Settings → Modules → Purchasing → Purchase Order Custom Fields*

Follow the same drag-and-drop process to add and configure fields for purchase orders.
### Custom Field Types Available
You can drag and drop the following types of custom fields across Vendor, Material Request, and Purchase Order forms.
**Text**
1. Single-Line Input: Allows users to enter a single line of free text.
2. Multi-Line Input: Allows users to enter multiple lines of free text.
**Date**
1. Date Input: Allows users to select a specific date from a calendar.
2. Time Input: Allows users to select a specific time.
3. Date Time Input: Allows users to select both date and time.
**Selection**
1. Single-Selection: Creates a radio button field where only one option can be selected.
2. Multi-Selection: Creates checkbox fields where multiple options can be selected.
3. Drop-Down: Creates a drop-down list with predefined options.
**Media**
1. Upload: Allows users to upload files as part of the form.
**Misc**
1. Look Up: Allows users to look up and select products, users, invoices, and quotes.

### Configuring Field Types
After dragging and dropping the custom fields from the right panel, fill in the following sections:
**Information**
* **Field Name:** Enter or update the name of the field.
* **Description:** Provide additional details about the field.
* **Placeholder:** Add placeholder text to guide users when filling the field.
**Configuration**
* **Mark as Required Field:** Toggle to make this field mandatory.
* **Mark as Read Only:** Toggle to prevent edits on this field.
**Visibility**
* **Mark as Hidden Field:** Hide the field from all users.
* **Hide to FE / Technician:** Hide the field from field technicians in the mobile app.
* **Restrict Access by Custom Role:** Limit access to users with specific roles. This means that only users with the specific role will have access to this field. Other users will not be able to see or interact with it based on the access level assigned. When toggled on, you can choose one or more roles from the dropdown using the “**Add Role Access**” button. For each role, you can set an **Access Level**:
* Hidden → The field is completely hidden for this role.
* View Only → The role can see the field but cannot make any changes.
* View & Edit → The role can see and edit the field.
Once you’ve made the required changes, click **Save** to apply the updates.

## Purchase Order Templates
Purchase order templates allow you to standardize purchase order formats for consistency and professionalism.
**Navigation**: *Settings → Modules → Purchasing → Purchase Order Templates*

1. Select the **Settings** module from the left navigation menu.
2. Under **Modules**, choose **Purchasing**.
3. Select **Purchase Order Templates**.
4. Click **+ New Template**.
5. Fill in the template details.
6. Click **Save Template**.

Templates help ensure that all purchase orders follow the same structure and include required information.
## Best Practices
* Define approval hierarchies carefully to avoid delays in purchasing
* Use required fields only when necessary to keep forms user-friendly
* Hide internal-only fields from technicians to reduce confusion
* Use templates to maintain consistent branding and information across purchase orders
# Custom financing configuration
Source: https://docs.zuper.co/Settings/Modules/Quotes-Invoices/Financing
Zuper allows you to add and manage your own financing plans based on the providers with which your business is registered. Once these plans are configured in Zuper, they can be included in proposal templates, allowing customers to compare upfront payments with available financing options directly during the quoting process.
[https://drive.google.com/file/d/1056e6gmp5bnr2uoqjXNPfuiYOL63wxZ\_/preview](https://drive.google.com/file/d/1056e6gmp5bnr2uoqjXNPfuiYOL63wxZ_/preview)
**Prerequisite**: Ensure that the **Financing** feature is enabled for your organization. If it is not enabled, contact our support team at [support@zuper.co](mailto:support@zuper.co) to have it enabled.
## Adding a Financing Plan
1. Navigate to the **Settings** module from the left navigation menu and select **Module** → **Quotes & Invoice** → **Proposal Templates and Service Packages** → **Financing Options**.

2. On the **Financing Options** page, click **New Provider**.

3. Enter the provider details, including:
1. **Provider Name**
2. **Logo** (optional, recommended for branded display)
3. **Plans** you are approved to offer through that provider
4. New (Optional) Check **Additional Charges** if your business needs to apply an extra charge on top of the financed amount.
Once enabled, select a **Charge Type** from the dropdown:
* **Dealer Fee**: A separate, taxable charge that appears below the Sub-Total on the transaction. Customers can see this amount.
* **Dealer Markup**: A financing margin that is embedded into the Unit Selling Price of every line item. Customers see only the final adjusted price, not the dealer markup charge.
4. Add multiple plans per provider by clicking the **+Add Plan** button.
5. Click the **copy** icon to duplicate a plan and make minor changes.
6. Click the **red trash can** icon to delete a plan from this provider.
7. Once your plans are added, click **Create**.

> [accordion] How Each Charge Type Works
>
> #### Dealer Fee
>
> A Dealer Fee appears as a separate line item below the Sub-Total on the transaction. It is taxable. Customers can see this charge clearly on the document.
>
> **Example:** If your Sub-Total is \$1,000 and you apply a \$50 Dealer Fee, the taxable amount becomes \$1,050.
>
> #### Dealer Markup
>
> A Dealer Markup embeds a financing markup directly into the Unit Selling Price of every line item. Zuper calculates the margin on top of each line item's unit cost to arrive at the final selling price. Customers see only the adjusted selling price; the dealer markup charge is not shown to them.
>
> **Example:** If the unit cost of a line item is \$500 and the Dealer Markup is 5%, the Unit Selling Price shown to the customer is \$525.
>
> **Important behaviors to know:**
>
> If you update the **Unit Purchase Price / Unit Cost** of a line item, Zuper automatically recalculates the selling price using the new cost and the original Dealer Markup percentage. The Dealer Markup percentage remains unchanged.
### Editing and Managing Providers
You can update or manage financing plans at any time by hovering over the plan:
* **Edit** – Change provider name, logo, or financing terms.
* **Delete** – Remove inactive or expired plans.
> [!NOTE]
>
> **Note**: Changes apply only to newly created proposals. Existing proposals will not be updated retroactively.

## Enabling Financing in Proposal Templates
Once financing providers are configured, you can enable financing for individual package options. This allows customers to compare cash and financed payment options directly within the proposal.
1. Open the **Proposal Template** you want to edit.
2. Navigate to **Package Configuration**.
3. Select a package options tab, such as **Good**, **Better**, or **Best**.
4. Scroll to the bottom of the page to locate the **Financing** section for the selected option.
5. Toggle **Enable Financing** to **ON**.
6. Click **Select Financing** to choose which provider and plan to display for this option.

When your team creates a new proposal, these plans appear automatically, allowing customers to compare payment options during the quoting process easily.
## Frequently asked questions
> [accordion] Q: How is the Financing Markup applied?
>
> When a customer selects a financing plan where the fee is configured, Zuper automatically adds the financing margin at the line-item level. The margin is calculated on top of each line item’s unit cost to determine the final selling price. *Example:* If the unit cost is \$500 and a 5% financing margin is configured, the selling price becomes \$525.
> [accordion] What happens if I change the unit cost of a line item after selecting a financing plan?
>
> Zuper will automatically recalculate the sell price using the new unit cost and the original financing margin percentage or multiplier. The margin value itself remains unchanged.
> [accordion] Where does the Dealer Fee appear in a transaction?
>
> The Dealer Fee is shown as a separate line item below the Sub-Total. It is taxable, meaning applicable taxes are calculated on the total that includes the Dealer Fee.
> [accordion] Is the Additional Charge applied if the customer chooses to pay cash?
>
> No. Additional charges (Markup or Dealer Fee) are applied **only** when the customer selects a financing option.
> [accordion] How can an Admin or Team Lead view the Dealer Markup after a proposal is accepted?
>
> Once the customer accepts a financing plan and the proposal or quote is converted to an invoice or Job, you can see the Dealer Markup field on the right side of the **Edit Line Item dialog**.
\\
\
\\
# Proposal Layouts
Source: https://docs.zuper.co/Settings/Modules/Quotes-Invoices/Proposal_Layout_builder
## Overview
Zuper’s Proposal Layouts enables you to create professional, fully customizable proposal PDFs tailored to your customers. You can start from scratch or use templates and combine editable text pages with uploaded PDFs to build multi-page proposals. This feature enables teams to present quotes, inspection data, and terms in a professional format, facilitating faster approvals.
> [!NOTE]
>
> **Note: Proposal Layouts** is currently in Private Beta. To request access, please email our support team at [**support@zuper.co**](mailto:support@zuper.co).
## **Prerequisites**
* Ensure you have admin access to the Zuper workspace.
* Prepare any supporting files, such as company logos, cover images, or PDF sections (e.g., terms PDFs limited to 5MB each).
* Familiarize yourself with Zuper's Quotes & Invoices module.
### **Step 1: Access Proposal Layouts Management**
Before building a proposal, manage your layouts to create or edit reusable layouts.
1. Log in to your Zuper. Click **Settings** (gear icon) at the top.
Under Quote & Invoice Settings, select **Proposal Layouts**.

This opens the Proposal Layouts library, displaying existing layouts with details such as name, status (e.g., Active), created by, created on, and available actions.
### **Step 2: Create a New Proposal Layout**
1. In the Proposal Layouts screen, click **+ New Proposal Layout** (top right).
2. Choose your starting point:
* **Start from Scratch**: Begins with a blank canvas for full customization.
* **Choose from Template**: Select a pre-built template from the library.

3. Enter a name for your layout (e.g., "Standard Roofing Proposal").
4. Click **Create** to open the editor.
By default, the new proposal layout includes seven pages:
**1. Cover Page**
**2. About Us**
**3. Scope of Work**
**4. Estimate Options**
**5. Terms & Conditions**
**6. Signature**
* You can add, rename, or reorder pages as needed (Cover page reordering is not possible).
* If you prefer not to use the default pages, you can hide the page, which will skip rendering it in the final PDF.
You can also add the custom pages:
**Add Pages**: Click **+ Add Page** and select a type (e.g., New Text Page or PDF Upload).
Types of pages supported:
* **Text Page:** Create and edit content using rich text formatting.
* **Upload PDF:** Upload and display pre-designed PDF documents from local storage or select an existing PDF from the [PDF Library](https://docs.zuper.co/Settings/Miscellaneous/pdf-library).
* **Job Checklist:** Pull associated checklists from the job.
* **Job Gallery:** Showcase images related to the job in a visual gallery.
* **Custom Page:** Advanced drag-and-drop page builder.
### **Step 3: Customize Pages in the Proposal Layouts**
**Editing Tips**
* **Rename Pages**: Double-click the page name in the sidebar or use the More icon and select Rename.
* **Reorder Pages**: Drag pages up or down in the sidebar. Cover Page cannot be reordered.
* **Duplicate Pages**: Duplicating pages is allowed except for the Cover Page and Estimate Options.
* **Hide Pages**: Hiding pages is allowed for all pages.
* **Locked Pages**: In the Proposal Layouts section, you'll find a "**Lock**" page option. When enabled (locked), it locks the editing of the page's functionality both in the Master proposal layout and proposal-level edit. Preventing ad-hoc edits during the quoting process.

Lock and unlock options are only available under the settings and are not accessible in the proposal-level layout edit. To prevent Field Executives or Sales Representatives from making changes to the proposal pages while sending. The locked pages cannot be renamed, hidden, edited, or deleted.
Now, customize each default page:
### **Cover Page**
* We currently support only one cover page.
* On the cover page, you include branding (e.g., logo, company information) and proposal basics (e.g., title, client name, date).
* The page can be hidden or renamed, but it cannot be deleted or reordered.
* The cards will show company or sales rep information; it will be prefilled automatically, and it allows editing the same with the fixed content or dynamic content.
* The customer information can be hidden.
* If the cover page image is not added, the default image set by us will be displayed.
> [!TIP]
>
> We also support using a Cover image tailored to the proposal, so that you can set the customer's home as a cover image to personalize the proposal. You can add a cover image with the two options:
>
> **1. From the associated job's image gallery.**
>
> **2. Upload from local.**
>
> You can use any one of the options.
1. Click **Cover Page** in the sidebar.
2. Select a layout style from the right panel: **Classic**, **Executive**, **Split Screen**, or **Cinematic**.
3. Upload a cover image via the placeholder (click the image icon) or from the right panel.
4. Edit fields: **Proposal Title**: Enter a descriptive name for your proposal.\
Example: `Proposal for {{ customer.customer_first_name }}` **Date**: Auto-fills with proposal date. **Company /Sales Rep Info**: Add logo, name (e.g., ACME Corporation), and contact details. The primary logo uses the company logo, and the secondary logo is used to upload a certificate or badge. You can use the place holders to fetch the information. **Customer Info**: Pulls from the service address (e.g., John Doe’s service address)


### **About Us**
Introduce your company with text, images, or uploaded PDFs.
1. Click **About Us**.
2. Use the text editor to add paragraphs about your services, history, or team (or) Toggle to **Upload PDF** for a pre-formatted section.


### **Scope of Work**
Outline project details, timelines, or requirements.
1. Click **Scope of Work**.
2. Add text descriptions, bullet points, or tables via the editor, or upload PDF for detailed specs.


### **Terms & Conditions**
Legal essentials: Use text or upload for compliance.
1. Click **Terms & Conditions**.
2. Edit standard terms in the text editor or upload a PDF (e.g., your master terms document).
3. Ensure key clauses, such as payment terms, warranties, and liabilities, are clearly defined.


For the **Scope of Work** and **Terms & Conditions**, users can edit them on the go by using the text editor to adjust each specific proposal before sharing it with the customer.
### **Estimate Options**
Show pricing breakdowns with line items, taxes, and totals (pulls from proposal estimate options).
1. Click **Estimate Options**.
2. View sample content (actual data populates on generation):
* Line items (e.g., Roofing System: \$4,855.84).
* Subtotals, taxes (10%), discounts, and grand total.
3. Toggle display options in the right panel:
* Show/hide images, descriptions, quantities, and taxes.
* Line Item vs. Transaction view.
* Unit prices, subtotals, deposits, or financing totals.
4. Enable **Bundle Options** for grouping.
5. Enable **Add-Ons** to display add-ons for each available estimate option.
For each proposal option, it will be shown on a single page, one by one.


> [!NOTE]
>
> The **Estimate options** page supports the **Custom Layout** style, so you can design your own page view using HTML and CSS.
### Signature
Capture customer approval with e-signature fields.
1. Click Signature. You can edit the title from the right panel. Space below the signature in the center pane is a text editor that allows the user to add any additional content required
2. The Primary Signature block is displayed by default and static (includes date and signature).
3. Set layout: Stacked (vertical fields) or Side by Side (horizontal).
4. Customize display: Show company logo, address, phone (e.g., ACME Corporation, [Zuper@zuper.co](mailto:Zuper@zuper.co), 822-10380).


### **Multi-Signer (Co-Signer & Counter Signer)**
Zuper [Proposal Layout](https://docs.zuper.co/Accounting/Proposal#multi-signer) allows **multiple signers** on the proposal (primary customer + up to 3 co-signers + company authorization signer).
**Navigation**: *Settings → Quotes & Invoices → Proposal Layouts → Signature*
1. **Primary Signer (Customer)**
* Automatically set as the customer associated with the proposal.
* This appears in the **Signature** section in the proposal details.
2. **Add Co-Signers (Additional Signers)**
* Right sidebar → **Signer Details** section.
* Click **+ Add Co-Signer**.
* Repeat the click for every extra signer you need (**You can add up to 3 signers**).
> [!NOTE]
>
> **Note**: To templatize specific signers, such as manufacturers or warranty.
3. **Fill Details for Each Co-Signer.** Each co-signer block has two required fields:
* **Full Name.**
* **Email address** (this is where the signature request will be sent).
4. **Company Authorization (Counter Signer)**
* Toggle **Company Authorization** ON.
* Choose:
* **Created By** (The person who created the proposal) or
* **Select User** (Pick any other specific user in your Zuper account).

### **Custom Pages**
The custom page allows you to add four different pages. **Text Page, Upload PDF, Job Checklist, and Job Gallery**.
**Text Page** – Add additional text pages, add your content, and modify the title. (It is a block editor.)
**PDF Upload**
* **Your device**: Upload a PDF from your computer. The file must be 5 MB or smaller.
* **PDF library**: Select a PDF that is already saved in your [PDF library](/Settings/Miscellaneous/pdf-library).
* **Job documents**: Select a completed document from the job linked to the proposal. For more information, see [Job documents](/Work_Order_Management/Job-detail-page#documents).
> [!TIP]
>
> PDF and Text pages supports page-level acknowledgment. When you share a proposal with your customer, they must select the checkbox on each page to acknowledge it. After acknowledging, the customer selects the required estimate option and **Sign the Proposal to Accept**, and their signature is automatically applied to every acknowledged page.
> [!NOTE]
>
> **Note**: You can create up to 10 pages, combining both the Text editor and PDF.
**Job Image Gallery**
* Here, you can set whether mandatory images should be enabled or not and configure the layout.
* If the Mandatory Images option is enabled, sending or generating the proposal PDF without images will be restricted.
* It is recommended to add at least one image while editing the proposal PDF layout within the Proposal details page.

**Job Checklist**
* This settings option enables you to select multiple checklists, each mapped to a single job category per page.
* For each checklist page, you can select multiple checklist statuses from that specific job category and choose the various checklist questions to pick the ones you need.
* If you need to include statuses from another job category, add a new page.
* The selected checklists will automatically render when the proposal is sent.

## Present Proposal & Options
You can present or share the proposal with your customer and enable them to select the available options/attributes for each item within the chosen estimate option, as long as the item has options configured and **Customer Selection** is enabled in the Part/Product configuration.
Before signing and accepting the proposal, customers can choose their preferred [options](https://docs.zuper.co/Inventory_Management/Parts_Services/Create_New_Part_Service#3-options) for each applicable line item.
The selected options are recorded in the accepted quote and automatically carried forward to any Invoice or Purchase Order (PO) created from it, ensuring accurate tracking and reducing manual errors.

## Edit Proposal Layout
**Navigation**: Quotes --> Proposal --> Edit Proposal Layout
* The edit proposal layout opens the proposal layout edit page. Here, you can edit the proposal layout specific to this current proposal and send it directly to the customer.
* While sending the proposal PDF, it will be sent as an attachment.
* The customer will accept the proposal, and you have the option to view the quote PDF or proposal PDF from the quote module.

**Send Email**
• You will have the option to switch between the Quote and Proposal templates.
• If the Proposal is chosen, the Proposal PDF will be sent with just the accepted estimate option.
> [!NOTE]
>
> **Note**: You can choose the “**Default Proposal Layout**” from Quote and Invoices General Settings.

### **Add-ons**
**Add-ons** let you include optional products or services specific to each proposal option that are not part of the primary items. These are displayed under the **Additional Items** section of the proposal.
When the proposal is presented to the customer, they can select their preferred estimate option. Based on the selected option, the relevant Add-ons will be displayed. The customer can choose the Add-ons they would like to include, and the total proposal value will be recalculated in real time accordingly.
Once finalized, the customer can review the updated estimate and provide their approval by signing the proposal.
**When to Use Add-ons**
Use add-ons when you want to:
* Include optional or supplementary items.
* Add accessories or warranty or AMC packages.

## **Limitations**:
1. The PDF upload size should not exceed **5 MB**.
2. You can create up to **20** proposal layouts only.
3. For custom pages, text pages, or PDF pages, you can create up to 10 pages only as a combined limit.
## FAQs – Zuper Proposal Layouts
> [accordion] What are Proposal Layouts used for?
>
> **Proposal Layouts** help you build professional, multi-page proposals for your clients. Each layout brings together editable text, uploaded PDFs, pricing details, inspection summaries, and electronic signatures in a single document.
> [accordion] What is the maximum size for uploaded PDF files?
>
> Each PDF you upload must be 5 MB or smaller. If your file is larger, the upload fails. Compress the file or save it as a standard PDF, then try again.
> [accordion] How many proposal layouts can I create?
>
> You can create up to 20 proposal layouts in your Zuper workspace.
> [accordion] How many custom pages can I add?
>
> You can add up to 10 custom pages in total, and this limit applies per proposal layout. To add more pages, delete or merge existing pages first.
> [accordion] Can I reorder or rename pages in a proposal layout?
>
> Yes, you can rename or reorder any page except the **Cover Page**. You can rename or hide the **Cover Page**, but you cannot delete or reorder it.
> [accordion] Why are my job-related pages or data not showing in the proposal?
>
> This usually happens when the proposal is not linked to a job, or when required job fields are incomplete. Confirm that the proposal is linked to the correct job, and that all required job fields are complete. If the issue continues, contact [Support](mailto:support@zuper.co).
> [accordion] Can I include inspection forms and job photos?
>
> Yes, add job photos with a **Job Image Gallery** page. Add inspection forms or checklists with a **Job Checklist** page.
> [accordion] What happens if I do not add a cover image?
>
> If you do not add a custom cover image, Zuper displays a default cover image automatically.
> [accordion] How can I edit a proposal layout for a specific proposal?
>
> Go to **Quotes → Proposal → Edit Proposal Layout** to update the layout for that specific proposal without changing your master layout.
> [accordion] What file formats are supported for uploads?
>
> PDF pages accept only standard PDF files, while the text editor also accepts image uploads.
> [accordion] Can I preview how the proposal looks on mobile devices?
>
> Yes, use the **Preview** option to check formatting on both desktop and mobile views before you send the proposal.
> [accordion] Are e-signatures legally binding?
>
> Yes, Zuper's e-signature feature complies with digital signature standards. Signed proposals become legally valid agreements once your clients accept them.
> [accordion] How can I reuse an existing layout for new proposals?
>
> Open the layout you want to reuse in **Proposal Layouts**. Duplicate it, rename the copy for your new job, and make any edits you need. This keeps your original layout unchanged.
### Best Practices
1. **Keep PDFs Lightweight and Optimized**
* Compress uploaded PDFs before adding them (file size must be ≤ 5MB).
* Avoid embedding unnecessary images or scanned pages that inflate file size.
* When possible, use the text editor instead of uploading large sections of PDF.
2. **Use Merge Tags for Dynamic Content**
* Incorporate merge tags like `\{{ customer.customer_first_name }}` or `\{{ quote.quote_number }}` to automatically populate customer and quote details.
* This ensures data accuracy and reduces the time required for manual editing.
3. **Structure Information Logically**
* Follow the recommended sequence: Cover → About Us → Inspection → Scope → Estimate → Terms → Signature.
* Keep technical or detailed documents in uploadable PDF sections rather than long text blocks.
* Use bullet points and tables to improve readability.
4. **Test Before Sending**
* Use the Preview option to confirm layout, image quality, and text alignment across devices.
* Double-check for placeholder text (e.g., “No inspection forms imported”) and replace it with actual content.
* Validate that totals and taxes display correctly in the Estimate Options section.
5. **Maintain Legal and Compliance Standards**
* Keep your Terms & Conditions page updated with your latest legal clauses.
* Include payment terms, warranty details, and liability disclaimers clearly.
* Use e-signature fields appropriately, and only authorized signers should be listed.
6. **Optimize for Customer Experience**
* Keep proposals concise, limit to 8–10 pages for easy client review.
* Add visual elements such as inspection photos and job galleries to enhance inspection photos and job galleries for credibility.
* Use the Cinematic or Split Screen cover layout for modern, professional visuals.
# Configuring Quotes and Invoices
Source: https://docs.zuper.co/Settings/Modules/Quotes-Invoices/Quotes-Invoices-Settings
The "**Quote & Invoice Settings**" allows you to configure and customize features related to quotes and invoices.
**Navigation**: *Settings -> Modules -> Quotes and Invoices - > Quotes and Invoices General Settings*
## Quotes and invoices general settings
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Quotes & Invoices**.” Select the “**Quote and Invoice General Settings**.”

### General tab
The General tab allows you to configure settings for quotes and invoices.
* Maximum Digits for Round-off: Set the number of decimal places for rounding off amounts.
**Discount Options:**
* Discount Type: Choose the default discount type (Fixed Amount or Percentage).
* Apply Discount at: Select the level at which discounts are applied (Transaction Level or Line-Item Level).
> [!NOTE]
>
> The **Transaction Level** option is only available when every part, product, and service on the quote is either fully taxable (without custom tax) or fully non-taxable. If any line item carries a custom tax, **Transaction Level** will not be selectable until that line item's tax is changed or removed. See [Create a new quotation](/Accounting/Create_New_Quote) for details.
**Tax Settings:**
* Choose Address Type for Adding Taxes: Specify which address type to use for tax calculations (Billing Address or Service Address).

### Quote tab
The Quote tab lets you customize settings specific to quotes.
* Quote Prefix: Define a prefix for quote numbers.
* Default Remarks for Quote: Add default remarks that will appear on all quotes.
* Allow Contact to Accept Quote?: Enable or disable the option for contacts to accept quotes directly (Yes/No).
* Auto-convert Quote to Invoice?: Choose whether to automatically convert a quote to an invoice upon acceptance (**Yes, Save as Draft | Yes, Save and Send, or No**).
* Choose Invoice Payment Term: Set the default payment term for invoices generated from quotes (e.g., 10-day term).
* Choose Invoice Template: Select a default invoice template for quotes converted to invoices.
* Default Expiry Period (in days): Specify the default validity period for quotes.
* Get Contact Sign on Approval?: Decide if a contact’s signature is required upon quote approval.
* Can Field Executive Create Quote?: Allow field executives to create quotes. (Yes/No).
* Can Field Executive Access All Quotes?: Allow field executives to access all quotes (Yes/No).
* Allow FE to View Quotes Only in Job?: Restrict field executives to view only quotes associated with their assigned jobs (Yes/No).
* Allow Payment Collection?: Enable payment collection for quotes (Yes/No).
* Allow Sending Payment Link to Contact?: Allow sending payment links to contacts for quotes (Yes/No).
* Mandate Contact to Pay Deposit on Quote Approval?: Require contacts to pay a deposit upon approving a quote (Yes/No).
* Payment Mode Facilitating the Payment: Select the default payment mode.
* Allow Field Executive to Collect Payment?: Allow field executives to collect payments for quotes (Yes/No).
* Notify Created User on Status Updates?: Notify the user who created the quote about status updates (e.g., Accepted/Rejected/Requested for Changes) (Yes/No).
* Default Quote PDF Filename: Set the default filename format for quote PDFs.
* Choose Quote Component: Select components to include in quotes.
### Receipt settings
* Auto Send Receipt to Customer / Contact?: Enable automatically sending receipts to contacts after payment (Yes/No).
* Default Deposit Payment Receipt Template: Select a template for deposit payment receipts.
* Default Quote Email Template: Choose a default email template for sending quotes.

### Add-ons
Settings → Quotes & Invoices → Quote and Invoice General Settings → Quote tab
**Step 1: Enable Add-ons**
1. Locate **Enable Add-ons?**
2. Toggle the setting to **Yes**
Once enabled, add-ons become available in the Proposal (Quote) module.
**Step 2: Set Add-ons Display Label**
1. In the **Add-ons Display Label**, enter the label you want customers to see
* Example: Add-ons, Optional Services.
2. This label will appear in the proposal PDF presentation.

### Invoice tab
The Invoice tab allows you to configure settings specific to invoices.
* Invoice Prefix: Define a prefix for invoice numbers.
* Default Remarks for Invoice: Add default remarks that will appear on all invoices.
* Can Field Executive Create Invoice?: Allow field executives to create invoices (Yes/No).
* Can Field Executive Access All Invoices?: Allow field executives to access all invoices (Yes/No).
* Allow FE to View Invoices Only in Job?: Restrict field executives to view only invoices associated with their assigned jobs (Yes/No).
* Allow Sending Public Link to Customers?: Allow sending public invoice links to customers (Yes/No).
* Allow Payment Collection?: Enable payment collection for invoices (Yes/No).
* Allow Sending Payment Link to Contact?: Allow sending payment links to contacts for invoices (Yes/No).
* Payment Mode Facilitating the Payment: Select the default payment mode.
* Allow Field Executive to Collect Payment?: Allow field executives to collect invoice payments (Yes/No).
* Default Invoice PDF Filename: Set the default filename format for invoice PDFs.
* Choose Invoice Component: Select components to include in invoices.
* Enable Automatic Payments?: Enable automatic payment processing for invoices (Yes/No).
> [!NOTE]
>
> **Note:** The invoice template controls PDF layout, including where totals appear. Invoices with many line items may display the total close to the page header on the last page. Contact [support@zuper.co](mailto:support@zuper.co) for template changes. Changes apply to all invoices using that template.
### Receipt settings
* Auto Send Receipt to Customer / Contact?: Enable automatically sending receipts to contacts after payment (Yes/No).
* Default Deposit Payment Receipt Template: Select a template for deposit payment receipts.
* Default Invoice Email Template: Choose a default email template for sending invoices.

**Tip Settings:**
* Allow Tipping?: Enable invoice tipping (Yes/No).
* Tip Amount Percentages (%): Set predefined tip percentage options (e.g., 10%, 15%, 20%).
* Allow Custom Tip Amount?: Customers can enter a custom tip amount (Yes/No).

### Financing tab
The Financing tab lets you set up financing options for quotes and invoices.
* Enable Financing?: Turn financing options on or off (Yes/No).
* Payment Mode: Facilitating the Payment: Select the payment mode for financing.
* Amount Range to Facilitate Financing Option (in USD): Define the amount range for financing.

Click the “**Save**” button to save the quote and invoice general settings.
## **Service packages**
Before providing an official price quote or estimate, a business or service provider may send a preliminary document or communication to a potential client. This is called a "Proposal." It is usually used when the project or service scope needs clarification or definition before determining a specific price.
**Navigation**: *Settings -> Modules -> Quotes and Invoices -> Service Packages*
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Quotes & Invoices**.” Select the “**Service Packages**.”

2. Select the “**Service Package**s” and click the “**+ New Package**.”

3. Under the “**Service Package Details**” section:
* Name – Enter the name of the service package.
* Description – Enter the description of the service package.
* Remarks - Enter the remarks.
* Click the "**+ Add**" button to add individual parts, products, and services.
* Alternatively, use the dropdown menu next to the "**+ Add**" button to: o Add from Group: Select a predefined group of items to add to the package.
* **Bundle**: Add a product or service bundle. Note that bundles added here will not appear as a product type in the filter menu.
* Adjust the [margin percentage](/Accounting/Profit_Margin) to instantly recalculate markup % and the total sell price for all line items.

Click “**+ Save Package**” to save the service package.
## **Tax settings**
**Navigation**: *Settings -> Modules -> Quotes and Invoices - > Tax Settings*
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Quotes & Invoices**.” Select the “**Tax Settings**.”

2. Click “**+ New Tax.**”

a. To add the Tax details:
* Tax Name – Enter the tax name.
* Tax Rate – Enter the %
* Is this a Regional tax – You can choose either “**Yes**” or “**No**” to enable/disable regional tax.
* Associate tax to tax group – Add a checkmark to link tax to the tax groups.

Click “**Create**” to create the new tax.
b. To add the Tax group
Click the "**+ New Tax Group**" option to add the appropriate tax options under a single category.
* Tax Group Name – Enter the tax group name.
* Taxes – Toggle on the required taxes.

Click “**Create**” to create the new tax group.
## Discount and fees
**Navigation**: *Settings -> Modules -> Quotes and Invoices -> Discount & Fees*
Zuper makes it easy to manage discounts, fees, and rebate templates, helping you configure pricing adjustments and customer incentives in one place.
NewFor complete information about enabling rebates, adding them to quotes or proposals, and how Net Investment is calculated, see [**Rebates**](/Accounting/Rebates).
**Adding a new discount/fee**
Use this setting to create reusable templates for discounts, fees, and rebates that your team can apply to supported transactions.
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Quotes & Invoices**.” Select the “**Discount & Fees Settings**.”

2. Click the **+ New Discount/Fee**.
3. Select the appropriate **Type**.

4. Enter a **Name**.
5. Configure the value:
* For discounts and fees, use the supported percentage or fixed amount options.
> [!NOTE]
>
> For a percentage discount, you can enter a **Min \$ amount** and **Max \$ amount**. When your team applies the discount, the calculated amount must fall within this range.
* For rebates, enter a fixed **Amount**.
6. Optional: Select the applicable **Trade Types**.
7. Optional: In **Restrict to Custom Roles**, select the roles that can use the item.
8. Click **Create**.

\
The item is now available to eligible users wherever that type is supported in Zuper.
> [!NOTE]
>
> For details about rebate-specific setup and behavior, see [**Rebates**](/Accounting/Rebates).
## **Payment modes & terms**
Zuper allows you to create multiple payment modes that users can select when collecting invoice payments or quote deposits. You can also control the visibility of each payment mode by assigning access roles. Only users with the assigned role can view and select that payment mode.
**Navigation**: *Settings -> Modules -> Quotes and Invoices - > Payment Modes & Terms*
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Quotes & Invoices**.” Select the “**Payment Modes & Terms**.”

2. In the **Payment Mode** section, click “**+ New Payment Mode** .”

3. Select the **Type** of payment.
4. In the **Choose Access Role** field, select one or more roles that should have access to this payment mode. This prevents payment type from appearing for users without a matching role.
5. Enter a **Description** to help your team understand when to use this payment mode.
6. When finished, click **Create**. \

### Payment term
Zuper also lets you create multiple payment terms that define when an invoice payment is due. Each term has a set number of days, which Zuper adds to the invoice date to calculate the due date. You can select the appropriate payment term while creating an invoice or quote.
1. Under “ **Payment Term**,” Click “**+ New Payment Term**.”

2. Enter the name of the payment term and the number of days.

3. Click “**Create**” to create the payment term.
## **Follow up reminders**
The users can instantly send follow-up reminders before or after a particular date via SMS or Email.
**Navigation**: *Settings -> Modules -> Quotes and Invoices -> Follow up reminders*
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Quotes & Invoices**.” Select the “**Follow-up Reminders** .”

2. Click “**+ New Reminder**” to create the follow-up reminder.

3. a) Under Choose Module - Select the Module: Quotes or Invoice.
b) Under “**Remind To**”- The user can send a follow-up reminder to the back office and the customer. The dropdown box list: “**Customer**,” “**Selected Users**,” and “**Selected Teams**.”
c) Under “**Reminder Name**” - Type the name for the reminder.
d) Under “**Remind After / Remind Before**” - The reminder can be sent “**Befor**e” or “**After**.”
e) Under “**Reminder Type**” -The reminder type can be either “**SMS**” or “**Email**.”
f) **SMS Body** & **Available Components** – Choose the available components and create the SMS body.
Click “**Create**” to create the follow-up reminder.

## **Quotes & invoices templates**
The users can instantly send follow-up reminders before or after a particular date via SMS or Email.
**Navigation**: *Settings -> Modules -> Quotes and Invoices -> Quotes & Invoices Templates*
1. Select the “**Settings**” module from the left panel. Under the “**Modules**,” choose the “**Quotes & Invoices**.” Select the “**Quotes & Invoice Templates**.”

2. Click “**+New Template**” and you can choose either “**Quote**” or “**Invoice** .”

3. Fill in the template details and click “**Save Template** .”

> [accordion] How to create and customize a document template
>
> ## Step 1 — Set template properties
>
> Template properties control the global appearance of the PDF: its name, page size, orientation, margins, and font.
>
> 1. Go to **Settings**, then select **Accounting**, then select **Document Templates**.
>
> 2. Select **+ New Template**. The **Create Template** dialog opens with the **Template** tab selected.
>
> 3. Enter a name in the **Template Name** field. This field is required.
>
> 4. Enter an optional description in the **Description** field to help you identify the template later.
>
> 5. Under **Page Size**, select **A4**, **Legal**, or **Letter**.
>
> 6. Under **Orientation**, select **Portrait** or **Landscape**.
>
> 7. Under **Margin (in mm)**, enter values for **Top**, **Bottom**, **Left**, and **Right**. The default is 10 mm on all sides.
>
> 8. Under **PDF Font**, select a font from the dropdown. The default is **Inter**.
>
> > [!TIP]
> >
> > Use the **Preview** pane on the right to see how your page size and margins affect the layout. Select the refresh icon in the preview header after making changes to reload the preview.
>
> ***
>
> ## Step 2 — Configure the header
>
> The header appears at the top of every page of your PDF. Use it to display your logo, company name, and address.
>
> 1. Select **Header** in the left sidebar.
>
> 2. Select the **Show Organization Logo** checkbox to display your logo.
>
> 3. Select **Upload Your Logo** to add or replace the logo image.
>
> 4. Select the **Show Organization Name** checkbox to display your company name in the header.
>
> 5. Select the **Show Organization Address** checkbox to display your organization's address in the header.
>
> 6. Under **Logo Position**, select **Left**, **Center**, or **Right** to control where the logo appears.
>
> > [!NOTE]
> >
> > The customer's "Quote To" address always appears on the left side of the PDF. When you enable **Show Organization Address**, your organization's address appears alongside the customer's address on the same document.
>
> ***
>
> ## Step 3 — Customize the item table
>
> The **Item Table** section controls which columns appear in the line items table, what each column is called, how wide it is, and what order the columns appear in.
>
> 1. Select **Items** in the left sidebar. The **Label** sub-tab is shown by default.
> 2. For each column row, select the checkbox to show that column in the PDF, or clear it to hide it.
> 3. Enter a number in the **Width (%)** field for each visible column. The widths of all visible columns should total 100%.
> 4. Edit the **Label** field to rename a column heading appears on the PDF.
> 5. Select and drag the handle (≡) on the left of any row to change the column order.
>
> The available columns are:
>
> | Column | Default label | Width (%) | Shown by default |
> | - | - | - | - |
> | Line Item Number | ID | 10 | No |
> | Item | Item | 35 | Yes |
> | Rate | Price | 25 | Yes |
> | Quantity | Qty | 20 | Yes |
> | Discount | Discount | 20 | No |
> | Amount | Total | 20 | Yes |
>
> > [!TIP]
> >
> > If you want to hide pricing from the customer, clear the **Rate** checkbox. See [Creating a no-pricing variant](#creating-a-no-pricing-variant) below for the full process.
>
> ***
>
> ## Step 4 — Set up the totals section
>
> The **Total** section controls what appears in the summary block below the line items table — the subtotal, discounts, taxes, grand total, currency symbol position, and payment history.
>
> 1. Select **Total** in the left sidebar.
> 2. Select the **Show Total Section** checkbox to include the totals block on the PDF. Clear it to hide the totals block entirely, which is useful for internal job cards.
> 3. Select the **Discount** checkbox to show the discount line. Clear it to hide it.
> 4. Select the **Show Tax Details** checkbox to show individual tax lines.
> 5. Edit the **Sub Total** label field to rename the subtotal line as it appears on the PDF.
> 6. Edit the **Total** label field to rename the grand total line.
> 7. Under **Currency Symbol**, select **Before Amount** or **After Amount** to control where the currency symbol appears.
> 8. Select the **Show Payment History** checkbox to include a payment history block on the PDF.
>
> ***
>
> ## Step 5 — Add footer content
>
> The footer appears below the totals section. Use it to include remarks, payment instructions, terms and conditions, and a signature block.
>
> ### Remarks
>
> 1. Select **Footer** in the left sidebar.
>
> 2. Select the **Remarks** checkbox to enable the remarks section.
>
> 3. Edit the **Label** field to set the heading for the remarks section. The default label is "Important Note".
>
> 4. Enter a font size in the **Font Size** field.
>
> > [!NOTE]
> >
> > The remarks text that appears on the PDF comes from the **Remarks** field on the individual quote or invoice record — not from the template itself. If the PDF shows static text instead of the remarks you entered on the quote, the template might be using a fixed text variable. Contact [support@zuper.co](mailto:support@zuper.co) to switch the template to a dynamic remarks variable.
>
> ### Payment options
>
> 1. Under **Payment Options**, select the **Payment Options** checkbox to enable this section.
> 2. From the **Online Payment Link** dropdown, select **Yes** to include an online payment link on the PDF, or **No** to hide it.
> 3. In the **Add your bank details** field, enter offline payment instructions.
>
> ### Terms and conditions
>
> 1. Select the **Terms and Conditions** checkbox to enable the terms section.
> 2. Edit the **Label** field to set the section heading. The default label is "Terms and Conditions".
> 3. Enter a font size in the **Font Size** field.
> 4. Use the rich text editor in the **Message** field to enter your terms and conditions content. The editor supports bold, italic, and bullet lists.
>
> ### Signature
>
> 1. Scroll to the bottom of the **Footer** tab.
> 2. Select the **Signature** checkbox to include a signature block on the PDF.
>
> ***
>
> ## Save your template and set it as the default
>
> 1. Select **Save Template** in the top right corner of the builder.
> 2. To make this the default template for all new quotes and invoices, go back to the **Document Templates** listing page.
> 3. Find your template in the list, select the three-dot context menu icon next to it, and select **Set as Default**.
>
> Once a template is set as the default, Zuper pre-fills the **Document Template** field each time you create or send a quote. You can still select a different template at the time of sending.
>
> > [!TIP]
> >
> > Setting a default template does not lock you in. You can always choose a different template from the **Document Template** field in the send dialog before you send.
> [accordion] Troubleshooting Invoice PDF Formatting Issues
>
> ## Common causes at a glance
>
> | Cause | Symptom | Fix |
> | - | - | - |
> | **Footer / header HTML** | Text overflows, overlaps, or disappears at page edges | Simplify or remove custom HTML from the template footer/header |
> | **Copy-paste from Word** | Random fonts, odd spacing, invisible characters | Re-type content directly in the Zuper template editor |
> | **Oversized or broken images** | Image stretches across columns or pushes content off-page | Re-upload images within Zuper; keep width under 600 px |
> | **Non-web-safe fonts** | Characters replaced by boxes or question marks | Use Arial, Helvetica, or Times New Roman only |
> | **Custom CSS / inline styles** | Layout shifts unpredictably between browsers and PDF | Remove all inline style attributes from template HTML |
> | **Platform rendering bug** | Issue persists after all above steps | Escalate to Zuper Support with reproduction steps |
>
> ***
>
> ## Step-by-step troubleshooting tree
>
> Work through each step in order. Stop at the step that resolves the issue.
>
> #### Step 1 — Confirm the issue is reproducible
>
> 1. Open the affected invoice in **Accounting → Invoices**.
>
> 2. Click the **PDF** button (top right) to download.
>
> 3. Open the downloaded file in a standard PDF viewer (Adobe Acrobat or a browser).
>
> 4. Note exactly what is wrong: overlapping text, missing sections, images out of place, blank pages.
>
> > [!NOTE]
> >
> > If the issue appears only in a specific PDF viewer, try another viewer before proceeding. Some viewers render PDFs differently.
>
> ***
>
> #### Step 2 — Try a different invoice template
>
> 1. Open the invoice and click **Edit**.
>
> 2. In the **Invoice Template** field, switch to the **Default Invoice Template** (or any other template).
>
> 3. Save the invoice.
>
> 4. Download the PDF again and check if the layout is correct.
>
> * If the PDF renders correctly with a different template → the problem is in the original template. Continue to **Step 3**.
> * If the PDF is still jumbled with any template → skip to **Step 6** (platform bug).
>
> ***
>
> #### Step 3 — Inspect and simplify footer and header HTML
>
> **Navigation**: *Settings → Modules → Quotes & Invoices → Document Templates*
>
> 1. Locate the Default Invoice Template (or the template in use) and open it for editing.
>
> 2. Navigate to the **Footer** section.
>
> 3. Switch to the HTML / source view if available.
>
> 4. Look for and remove:
> * Nested `` tags inside the footer
> * Inline `style=` attributes with fixed widths, floats, or `position: absolute`
> * Empty `` or `` tags with no content
> * `