Table of Contents
- Table of Contents
- Introduction
- Available Accounting Systems
- Initial Setup
-
Data Types & Sync Criteria
- Overview
- Assay
- Customer
- Invoice
- Invoice Item
-
Payment
- Sync Direction
- Sync Trigger Criteria
- Existing Payment Link Criteria
- How to Create a New Payment in the Accounting System from QBench
- How to Update a Payment in the Accounting System from QBench
- How to Delete a Payment in the Accounting System from QBench
- How to Create a New Payment in QBench from the Accounting System
- How to Update a Payment in QBench from the Accounting System
- How to Delete a Payment in QBench from the Accounting System
- Advanced Behaviors
-
Invoice Payment
- Sync Direction
- Sync Trigger Criteria
- Existing Invoice Payment Link Criteria
- How to Create a New Invoice Payment in the Accounting System from QBench
- How to Update an Invoice Payment in the Accounting System from QBench
- How to Delete an Invoice Payment in the Accounting System from QBench
- How to Create a New Invoice Payment in QBench from the Accounting System
- How to Update an Invoice Payment in QBench from the Accounting System
- How to Delete an Invoice Payment in QBench from the Accounting System
-
Use Cases
- Creating an Invoice and Applying Payments from QBench
- New QBench Implementation with a Pre-Existing Accounting System
- Existing QBench Implementation with a Pre-Existing Accounting System
- New QBench Implementation with no Pre-Existing Accounting System
- Existing QBench Implementation with no Pre-Existing Accounting System
- Accounting Systems Unique Specifications
Introduction
Purpose
This integration exists to integrate QBench with a wide range of popular Accounting Systems, creating a seamless experience keeping important Accounting information up-to-date.
Audience
Target audience is for anyone setting up and using the integration system in QBench.
Prerequisites
- You have created an Integration in QBench.
- You must have the Billing System enabled in QBench.
- You must have the Integration Module enabled in QBench.
- You must have one of the following Accounting Systems listed in the Available Accounting Systems section.
Overview
This article will describe the various requirements for the Accounting Sync to run in QBench, as well as describe any behaviors the Integration may have.
Available Accounting Systems
- QuickBooks Online
Initial Setup
- Have a Payment Template configured and active in QBench.
- Navigate to the "Configurations" tab on the Integration detail page and make sure all the fields have been filled out.
Data Types & Sync Criteria
Overview
QBench Data Type | Normalized Accounting Data Type | Sync Direction | Sync Time |
Assay | Item | QBench → Accounting System | Hourly |
Customer | Contact | QBench → Accounting System | Hourly |
Invoice | Invoice | QBench → Accounting System | Hourly |
Invoice Item | Invoice Item | QBench → Accounting System | Hourly |
Payment | Payment | QBench ↔ Accounting System | Hourly |
Invoice Payment | Invoice Payment | QBench ↔ Accounting System | Hourly |
Assay
Sync Direction
Assays will only sync from QBench to the Accounting System.
Sync Trigger Criteria
To trigger an Assay to be synced by the Integration System, the Assay must be related to an Invoice Item on an Invoice that has been updated/created since the last Integration run.
Existing Assay Link Criteria
- Assay must be associated to an Invoice.
- Assay must exist in both QBench and the Accounting System.
- Assay must have the same name.
- Assay name must be unique.
The Assay in QBench will be linked to the Item in the Accounting System next time the Integration runs.
How to Create a new Assay in the Accounting System from QBench
Not currently supported. You must create the Assay manually in QBench and the Accounting System and follow the Existing Assay Link Criteria to link them.
How to Update an Assay in the Accounting System from QBench
Not currently supported. You must manually update the Assay in QBench and the Accounting System.
How to Delete an Assay in the Accounting System from QBench
Not currently supported. You must manually delete the Assay in the Accounting System.
Customer
Sync Direction
Customers will only sync from QBench to the Accounting System.
Sync Trigger Criteria
To trigger a Customer to be synced by the Integration System, the Customer must be related to an Order with an Invoice that has been updated/created since the last Integration run.
Existing Customer Link Criteria
- Customer must be related to an Order that has an Invoice.
- Customer must exist in both QBench and the Accounting System.
- Customer must have the same name.
- Customer name must be unique.
- Customer must have a Primary Billing Contact in QBench.
- The Customer's Primary Billing Contact must have an email.
- Account in the related Accounting System must have a valid email saved.
The Customer in QBench will be linked to the Account in the Accounting System the next time the Integration runs.
How to Create a new Customer in the Accounting System from QBench
- Customer must be related to an Order that has an Invoice.
- Customer must have a unique name.
- The Customer's Primary Billing Contact must have an email.
- Customer must have a Primary Billing Contact in QBench.
- Customer must meet the Sync Trigger Criteria
The Customer in QBench will be created in the Accounting System the next time the Integration runs.
How to Update a Customer in the Accounting System from QBench
Not currently supported. You must manually update the Customer in QBench and the Accounting System.
How to Delete a Customer in the Accounting System from QBench
Not currently supported. You must manually delete the Customer in the Accounting System.
Invoice
Sync Direction
Invoices will only sync from QBench to the Accounting System.
Sync Trigger Criteria
To trigger an Invoice to be synced by the Integration System, the Invoice must have been updated/created since the last Integration run.
Existing Invoice Link Criteria
Not currently supported.
How to Create a New Invoice in the Accounting System from QBench
- Invoice must be related to a Customer that has been synced.
- Invoice must have at least one Invoice Item.
- Invoice must be in the `INVOICED` state.
- All Invoice Items must be associated to an Assay that has been synced.
How to Update an Invoice in the Accounting System from QBench
- Invoice must have been created by the Integration.
- Invoice must be related to a Customer that has been synced.
- Invoice must have at least one Invoice Item.
- Invoice must be in the `INVOICED` state.
- All Invoice Items must be associated to an Assay that has been synced.
- Invoice must have been saved since the last time the Integration was run.
How to Delete an Invoice in the Accounting System from QBench
Not currently supported. You must manually delete the Invoice in the Accounting System.
Limitations
- We do not support Multi-Order Invoices as of now.
Invoice Item
Sync Direction
Invoices Items will only sync from QBench to the Accounting System.
Sync Trigger Criteria
To trigger an Invoice Item to be synced by the Integration System, the related Invoice must have been updated/created since the last Integration run.
Existing Invoice Item Link Criteria
Not currently supported.
How to Create a New Invoice Item in the Accounting System from QBench
- Add a new Invoice Item to an Invoice that has been synced.
How to Update an Invoice Item in the Accounting System from QBench
- Save the Invoice in QBench.
How to Delete an Invoice Item in the Accounting System from QBench
- Delete the Invoice Item from the Invoice in QBench that has been synced.
- Save the Invoice in QBench.
Limitations
- We currently do not support the following Invoice Items:
- Flat Surcharge
- Percent Surcharge
- Sub-Total
- Flat Discount
- Percent Discount
- Invoice Items must have a positive value.
Payment
Sync Direction
Payments are bidirectional and will sync from QBench to the Accounting System and vice versa.
Sync Trigger Criteria
To trigger a Payment to be synced by the Integration System, the Payment must have been updated/created since the last Integration run or an Invoice Payment must have been added/removed from the Payment.
Existing Payment Link Criteria
Not currently supported.
How to Create a New Payment in the Accounting System from QBench
- Create a new Payment in QBench.
- Payment must be related to a Customer that has been synced.
- The Accounting System "Transaction Date" field must be set.
- Note: This is defaulted to the Payment "Date" field.
- Payment must have at least 1 Invoice Payment applied to a previously synced Invoice.
How to Update a Payment in the Accounting System from QBench
- Save the Payment in QBench.
How to Delete a Payment in the Accounting System from QBench
Not currently supported.
How to Create a New Payment in QBench from the Accounting System
- Payment must be related to a synced Customer.
- Template ID must be configured in the Integration settings.
How to Update a Payment in QBench from the Accounting System
- Save the Payment in the Accounting System.
How to Delete a Payment in QBench from the Accounting System
Not currently supported.
Advanced Behaviors
- Since Payments are a bidirectional sync, the sync will update the payment using the most recently updated data. That is, if I update the Payment in QBench, and then later on the same day I update the Payment in the Accounting System, when the sync runs that night, it will use the data from the Accounting System to save.
Invoice Payment
Sync Direction
Invoice Payments are bidirectional and will sync from QBench to the Accounting System and vice versa.
Sync Trigger Criteria
To trigger an Invoice Payment to be synced by the Integration System, the related Payment must have been updated/created since the last Integration run or an Invoice Payment must have been added/removed from the Payment.
Existing Invoice Payment Link Criteria
Not currently supported.
How to Create a New Invoice Payment in the Accounting System from QBench
- Invoice Payment is created on a new or existing syncable Payment.
- Invoice that the Invoice Payment is being applied to must be synced.
- Invoice Payment amount cannot exceed the related Invoice's outstanding amount.
How to Update an Invoice Payment in the Accounting System from QBench
Not currently supported.
How to Delete an Invoice Payment in the Accounting System from QBench
Not currently supported.
How to Create a New Invoice Payment in QBench from the Accounting System
- Related Payment must be syncable.
- Related Invoice must be syncable.
How to Update an Invoice Payment in QBench from the Accounting System
Not currently supported.
How to Delete an Invoice Payment in QBench from the Accounting System
- Delete the Invoice Payment in the Accounting System.
The next time the Integration runs, the related Invoice Payment will be deleted in QBench.
Use Cases
Creating an Invoice and Applying Payments from QBench
- Create an Order in QBench
- The Order must be associated to a Customer that has been synced or are syncable with the Integration System.
- The Order must consist of Tests with Assays that has been synced or are syncable with the Integration System.
- Create a new Invoice and add the Order you created to the Invoice.
- Ensure that you have allowed QBench to auto create line items based on the Tests from the Order.
- Update the Invoice status to "INVOICED" and save the Invoice.
At this point, the next time the Integration System runs, the Invoice will be created in your Accounting System.
- Create a new Payment in QBench and make sure to select the same Customer you created the Order with.
- Add an applied payment to the Invoice you created.
The next time the Integration System runs, the Payment and the Invoice Payment will be created in your Accounting System.
New QBench Implementation with a Pre-Existing Accounting System
In this tutorial, we will go over how to get started with the Accounting System Integration given you have a pre-existing Accounting System that you would like to start using with a new QBench Instance.
Assays
- In QBench, navigate to the Assays list page and download the Assays Import Template excel file.
- In your Accounting System, export all the Service Items (or equivalent data type) that should map to an Assay in QBench.
- Combine the data exported from your Accounting System into the Assays Import Template.
- In QBench, using the Assays Import Template, import your Assays into QBench.
Customers
- In QBench, navigate to the Customers list page and download the Customers Import Template excel file.
- This file can be used to import Customers as well as Contacts into QBench.
- In your Accounting System, export all the Accounts (or equivalent data type) that should map to a Customer and Contact in QBench.
- Combine the data exported from your Accounting System into the Customers Import Template.
- In QBench, using the Customers Import Template, import your Customers into QBench.
- In QBench, navigate to each Customer and select which related Contact you would like to be your "Primary Billing Contact" on the "Contacts" tab.
Invoices
- Create an Order, Sample, and Test in QBench using one of the Assays you imported and one of the Customers you imported.
- Create a new Invoice in QBench and associate it to the Order you created.
- Set the Invoice status to "INVOICED" and save.
Payments
- Create a new Payment in QBench.
- Ensure you select the same Customer that was used to create your Order earlier.
- Apply some of the Payment to the Invoice you created earlier.
Done! The next time the Integration sync runs, your Customer, Assay, Invoice and Payments will be synced with your Accounting System.
Existing QBench Implementation with a Pre-Existing Accounting System
In this tutorial, we will go over how to get started with the Accounting System Integration given you have a pre-existing Accounting System that you would like to start using with an existing QBench Instance.
Assays
Follow the Existing Assay Link Criteria to ensure your pre-existing Assays and related Accounting System Items meet the link criteria.
Customers
Follow the Existing Customer Link Criteria to ensure your pre-existing Customers and related Accounting System Accounts meet the link criteria.
Invoices
- Create an Order, Sample, and Test in QBench using one of the Assays that meets the Assay Link Criteria and one of the Customers that meets the Customer Link Criteria.
- Create a new Invoice in QBench and associate it to the Order you created.
- Set the Invoice status to "INVOICED" and save.
Payments
- Create a new Payment in QBench.
- Ensure you select the same Customer that was used to create your Order earlier.
- Apply some of the Payment to the Invoice you created earlier.
Done! The next time the Integration sync runs, your Customer, Assay, Invoice and Payments will be synced with your Accounting System.
New QBench Implementation with no Pre-Existing Accounting System
In this tutorial, we will go over how to get started with the Accounting System Integration given you have a new Accounting System that you would like to start using with a new QBench Instance.
Assays
- Create an Assay in QBench.
- Create a matching Item (or equivalent data type) in your Accounting System with the exact same name.
Customers
- Create a Customer in QBench.
- Create a Contact in QBench and make sure the Contact has an email.
- Associate the Contact to the Customer in QBench.
Invoices
- Create an Order, Sample, and Test in QBench using the Assay you created.
- Create a new Invoice in QBench and associate it to the Order you created.
- Set the Invoice status to "INVOICED" and save.
Payments
- Create a new Payment in QBench.
- Ensure you select the same Customer that was used to create your Order earlier.
- Apply some of the Payment to the Invoice you created earlier.
Done! The next time the Integration sync runs, your Customer, Assay, Invoice and Payments will be synced with your Accounting System.
Existing QBench Implementation with no Pre-Existing Accounting System
In this tutorial, we will go over how to get started with the Accounting System Integration given you have a new Accounting System that you would like to start using with an existing QBench Instance.
Assays
- Export all Assays you plan to have synced with your Accounting System from the Assays list page in QBench.
- Import the Assays into your Accounting system.
Customers
- Ensure that your Customer's that you plan to have synced to your Accounting System have a "Primary Billing Contact" assigned on the Customer detail page > Contacts tab.
Invoices
- Create an Order, Sample, and Test in QBench with one of the Assays you imported into your Accounting System and one of the Customers you assigned a "Primary Billing Contact" for.
- Create a new Invoice in QBench and associate it to the Order you created.
- Set the Invoice status to "INVOICED" and save.
Payments
- Create a new Payment in QBench.
- Ensure you select the same Customer that was used to create your Order earlier.
- Apply some of the Payment to the Invoice you created earlier.
Done! The next time the Integration sync runs, your Customer, Assay, Invoice and Payments will be synced with your Accounting System.
Accounting Systems Unique Specifications
QuickBooks Online
- Invoice Items must have a positive value.
- Payment Account Type must be one of the following types:
- "Bank"
- "Other Current Asset"
Comments
0 comments
Please sign in to leave a comment.