ECI Spruce ERP Integration

Spruce Sync App for EvolutionX with details about setup, use cases, how customer sync works and more.

Pedro Pinto avatar
Written by Pedro Pinto
Updated over a week ago

What is Spruce ERP?

Spruceยฎ ERP software is a end-to-end business management software solution specifically for home lumber and building materials suppliers.

Contents

Install from the App Store

Enable the ECI Spruce ERP App from the App Store under the ERP category. Go to the EvolutionX Admin and click App Store โ†’ ECI Spruce ERP Integration.

  • ECI API Endpoint URL: Set the API endpoint provided by ECI

  • ECI SOAP Endpoint URL: Set the SOAP endpoint provided by ECI

  • API Key: Set the API Key provided by ECI

  • Shipping Country Code: Sets the country code for all shipping user addresses when synchronising Spruce customers with EvolutionX. ISO Alpha-2 code must be used

  • Guest Customer Account: Sets the Account number that is going to be used for guest users

  • ERP Order Discount Product SKU : Sets the SKU that will be used for order level discount

  • Auto Process Account Balance/Invoice payment In Spruce: The toggle determines if account balance and invoice payments are to be auto processed in Spruce. The default setting is true

  • Auto Process Orders In Spruce: The toggle determines if orders placed on the storefront are to be auto processed in Spruce. Below are the options available:

    • Auto Process Orders: Select this option to always auto process all orders in Spruce

    • Do Not Auto Process Orders: Select this option to not auto process any order in Spruce

    • Only Auto Process Orders With No Order Notes: Select this option to only auto process orders in Spruce if the order does not have an order note

  • Map checkout order notes to Spruce delivery note field: The toggle determines if checkout order notes are mapped to Spruce delivery notes. If toggled on, the checkout order notes will have a character limit to avoid the notes being cut off in Spruce Order and Invoices PDFs.

  • Spruce order notes (Sent along with the Order id): Sets the value to show under the Order ID in Spruce Order and Invoice PDFs. Read More Here

  • Error notification e-mail Sender: SES E-mail address to be used as sender (FROM) for emails sent when an integration error occurs.

  • Error notification e-mail Receiver: E-mail address to receive (TO) information when an integration error occurs.

Customer Account, Job(Child Account), and Address Sync

Each night a one-way sync of all accounts, Jobs(child accounts in EvoX), and Addresses is pulled from Spruce customers tables and will create or update customers on EvolutionX.

๐Ÿ‘ Important: Any Account or Address in EvoX that has an Account code and Seller reference will be updated by the sync process. Any existing data will be overwritten with the Spruce data, as Spruce is the owner of those records.

You can also trigger a one-way sync of all accounts and child accounts from the ECI Spruce ERP App Store in EvolutionX.

Customer Field Mapping

Here are some important EvolutionX fields and how they are mapped with data from Spruce.

  • Customer Account Number โ€” EvolutionX sets this value as the Spruce Customer Account Number.

  • Customer Seller Reference โ€” EvolutionX sets this value as the Spruce Customer Job value.

  • Customer Account Name โ€” EvolutionX sets this value as the Spruce Customer Name.

  • Customer Branch โ€” EvolutionX sets this value as the Spruce Customer.

  • Customer Address โ€” EvolutionX sets this value as the Spruce Customer Address.

  • Pricing Override AddToCart โ€” All accounts with Spruce Status "On Hold" won't see the "Add to Cart" button in the Storefront.

  • Account Status โ€” All parent and children account with Spruce Status "Active", "Inactive" and "On Hold" will be enabled on the EvoX, but the ones with "Disabled" or "Closed" status will be disabled.

  • Credit Status โ€” All accounts with Spruce Account Type "Charge" will have the Credit Status enabled in EvoX. The child accounts inherit the credit status of the parent.

N.B - Accounts disabled through the sync process can only be enabled from the admin

Payments Methods

Credit Card Payments with Spruce Card On File

On Spruce ERP installations that support credit card payments, including US and UK customers, some card on file payment features can be supported on EvolutionX.

  • Card on File for Payment of Storefront Orders โ€” Available if the user role enables it and a card is already stored on Spruce for the customer's account.

    • The card on file is selected at checkout as the payment method and Spruce will charge the card at the normal time during the order processing steps in Spruce.

  • Card on File for Invoice Payments โ€” Available if the user role enables it and a card is already stored on Spruce for the customer's account.

    • The card on file is selected after the invoices have been chosen for payment. The card is either charged immediately or when processed by staff based on the

UK Credit Card Payments with Bluesnap

EvolutionX Payment integration with Bluesnap is in development. This includes tokenizing credit cards on the storefront, authorizing the amount of the order, and passing the token to Spruce for capturing the payments.

US Credit Card Payments with Cayan using Global Payments

EvolutionX Payment integration with Global Payments is in development. This includes tokenizing credit cards on the storefront, authorizing the amount of the order, and passing the token to Spruce for capturing the payments.

Invoice Payments and Paying Balances

The storefront customers have the ability to pay invoices if they have their roles allowing to view Invoices. This can be done in the Roles.

If the storefront user has access to the Invoices or Account Balance screens, they will be allowed to pay using the card on file in Spruce.

View ERP Cards on File allows the customer to use the card on file in checkout.

Invoice Payments - Two types of Spruce Accounts

Balance Forward: These accounts will only be allowed to make bulk payments against the account.

Open Item: These accounts will be allowed to pay individual invoices through the store.

Orders

Make sure to tick "Require Cart Verification" for orders to be successfully sent to Spruce.

Delivery Taxes

You can setup the taxes for delivery in the following screen in Spruce system.

Sales >> Database >> Adjustment codes

Spruce Order Notes

Enabling the "Map checkout order notes to Spruce delivery note field" toggle will set a character limit in EvoX checkout order notes, to prevent the notes being cut in Spruce PDFs (green box) and will show a field to insert the "Spruce order notes". This text inserted in this field will be presented in Spruce Order and Invoices PDFs (red box).

FAQs

Totals not matching in Orders error

The "Require Cart Verification" parameter and the "Allow zero price on items" should be set on the system. Check this section to more details.

Orders without delivery taxes

All taxes are calculated in Spruce. To have delivery taxes in Orders, they need to be defined in Spruce. Check this section to more details.

Did this answer your question?