CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of...

55
CashBox® for Salesforce User Guide Version 14.0 @Vindicia Last updated: February 13, 2016

Transcript of CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of...

Page 1: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox® for Salesforce User Guide Version 14.0

@Vindicia

Last updated: February 13, 2016

08

Fall

Page 2: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

2

Copyright © 2006—2016 by Vindicia, Inc. All rights reserved.

Restricted Rights

Build Online Revenue, CashBox, CashBox DataBridge, CashBox Insight, CashBox Select, CashBox StoreFront, ChargeGuard, Marketing and Selling Automation for the Digital Economy, Vindicia, Your Chargebacks. Our Problem., and all related logos are trademarks or registered trademarks of Vindicia, Inc. All other company and product names may be trademarks of their respective owners.

This document may contain statements of future direction concerning possible functionality for Vindicia's software products and technology. All functionality and software products will be available for license and shipment from Vindicia only if and when generally commercially available. Vindicia disclaims any express or implied commitment to deliver functionality or software unless or until actual shipment of the functionality or software occurs. The statements of possible future direction are for information purposes only, and Vindicia makes no express or implied commitments or representations concerning the timing and content of any future functionality or releases.

This document is subject to change without notice, and Vindicia does not warrant that the material contained in this document is error-free. If you find any problems with this document, please report them to Vindicia in writing.

No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose without the express written permission of Vindicia, Inc.

The information contained in this document is proprietary and confidential to Vindicia, Inc.

February 13, 2016

© 2016 Vindicia, Inc.

Page 3: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

3

CONTENTS

CONTENTS...........................................................................................................................................3

OVERVIEW...........................................................................................................................................5

WHAT’SINCLUDED...............................................................................................................................6CASHBOXDATA...........................................................................................................................................6CASHBOXREPORTSDASHBOARDS..................................................................................................................6

WORKINGWITHCUSTOMERCAREFEATURES....................................................................................11CREATINGACCOUNTS.................................................................................................................................11CREATINGANDMODIFYINGTHEPAYMENTMETHOD.......................................................................................11CREATINGPURCHASES................................................................................................................................11MODIFYINGANDCANCELINGPURCHASES......................................................................................................12REPLACINGPAYMENTMETHODS..................................................................................................................12MANAGINGCREDITS..................................................................................................................................12MANAGINGREFUNDS.................................................................................................................................13

IMPORTINGDATA..............................................................................................................................15IMPORTINGDATA,AUTOMATICANDCONTINUOUS..........................................................................................15

TROUBLESHOOTINGCASHBOXAPPLICATIONS...................................................................................17MONITORINGIMPORT/EXPORTJOBS............................................................................................................17

ImportLogs.......................................................................................................................................17ExportLogs........................................................................................................................................17

DATACORRECTION.....................................................................................................................................17STOPSCHEDULEDJOBS...............................................................................................................................18DISABLECASHBOXTRIGGERS.......................................................................................................................18DATAIMPORTCATCH-UP............................................................................................................................18MANUALDATAIMPORT..............................................................................................................................19

APPENDIXA:INSTALLINGANDUPGRADINGCASHBOXAPPLICATIONS...............................................21PREREQUISITES..........................................................................................................................................21INSTALLING...............................................................................................................................................21INSTALLATIONSCREENS..............................................................................................................................22UPGRADINGCASHBOXFORSALESFORCE........................................................................................................25

APPENDIXB:CONFIGURINGCASHBOXAPPLICATIONS.......................................................................26CASHBOXADMINTAB................................................................................................................................26

CashBoxAPICredentials...................................................................................................................26CashBoxObjectPrefixes....................................................................................................................26

CASHBOXIMPORTSETTINGS........................................................................................................................27ViewImportErrors............................................................................................................................28SetupStatus......................................................................................................................................28

CUSTOMSETTINGS.....................................................................................................................................30ApplicationProperties.......................................................................................................................31CashBoxTriggers...............................................................................................................................31DataImportLog................................................................................................................................32DataImportObject...........................................................................................................................33

Page 4: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

4

DebugSettings..................................................................................................................................34CashBoxOpportunitySettings...........................................................................................................34HOASettings.....................................................................................................................................34PaymentMethodTypeSettings........................................................................................................34ServiceDefaults.................................................................................................................................35

PAGELAYOUTS..........................................................................................................................................35Accounts............................................................................................................................................36Purchases..........................................................................................................................................38Opportunities....................................................................................................................................38

APPROVALFLOWS.....................................................................................................................................39

APPENDIXC:DATAMAPPING............................................................................................................42

Page 5: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

5

Overview

Vindicia CashBox for Salesforce applications are native applications, built on the force.com platform, that allow you to bring key CashBox billing data into your Salesforce.com organization. You can import CashBox Account, Product, Subscription and Transaction information into Salesforce.com, and have that data continuously updated at intervals you specify. CashBox for Salesforce applications allow you to manage CashBox billing data from your Salesforce environment, and to take advantage of Salesforce reporting capabilities to analyze that data to give you information and critical statistics on your business processes.

Vindicia offers two Salesforce applications:

• CashBox (Basic)

• CashBox (Premium) CashBox (Basic) is essentially a reporting application and comes with a full set of standard reports and dashboards. CashBox (Basic) allows you to import all your CashBox data into Salesforce. Once imported, you can leverage the Salesforce reporting software to build your own customized reports based on your CashBox data. If you choose to use just the CashBox (Basic) application, you also have full visibility into your billing data.

CashBox (Premium), in addition to bringing all your CashBox data into Salesforce, enables you to run full customer care functions. You can create and edit subscriptions and one time purchases, manage credits, refunds, and so on.

NOTE: In pre 14.0 versions, the CashBox (Basic) application may be referenced by the name of CashBox Reporting for Salesforce, and the CashBox (Premium) may be referenced by the name of CashBox for Salesforce (Quote to Cash).

Page 6: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

6

What’s included

CashBox Data The following data objects from CashBox are mapped to native and custom objects in your Salesforce instance. Table 1: List of Data objects

CashBox Salesforce

Objects

Salesforce

Custom

Salesforce

Tabs

Account Account Native Yes

Payment Method Payment Method Custom No

Entitlement Entitlement Custom No

Credit Credit Custom No

Billing Plan Billing Plan Custom Yes

Rate Plan Rate Plan Custom Yes

Product Product Native Yes

Product Currency Product Currency Custom Yes

Transaction Transaction

(for one-time Tx: Transaction, Billing & Purchase)

Custom Yes

Transaction Item Transaction Item Custom Yes

N/A Billing Custom Yes

AutoBill Purchase Custom Yes

CashBox Reports Dashboards The following reports and dashboards are included with the CashBox (Basic) reporting application.

Page 7: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

7

Table 2: List of Standard Reports

Standard Reports Name Description

Active Plan Subscriptions by Country

A variation on the Active Subscriptions by Country report, which breaks down the counts by Billing Plan

Active Plan Subscriptions by State (US)

A variation on Active Subscriptions by State (US), which breaks down the counts by Billing Plan

Active Subscribers by Billing Plan

Counts of currently active Subscribers (count of Accounts with an active AutoBill) by Billing Plan. Only active subscriptions (AutoBill Status = Active) are included. In most cases this will be the same as counting active subscribers

Active Subscribers by Product

Counts of Currently active Subscribers (count of Accounts with an active subscription) by Product. Only active subscriptions (AutoBill Status = Active) are included. In most cases this will be the same as counting active subscribers

Active Subscription by State (US)

Counts of active Subscriptions by Account/Shipping State (US Only)

Active Subscriptions by Billing Plan

A variation on the Active Subscribers by Billing Plan report (which counts Accounts with active subscriptions for particular plans); this report counts the number of active subscriptions (Purchases of type = AutoBill) by plan

Active Subscriptions by Country

Counts of active Subscriptions by Account/Shipping Country Code

Billings in Retry Cycle Billings from active Purchases (Subscriptions = AutoBills) that are currently in the retry cycle, with Transaction detail for each Billing

Cohort Retention by Billing Cycle

Counts of active subscriptions (Purchase Type = AutoBill; Purchase Status = Active) by Billing Cycle. Indicates how long customers remain on specific plans for specific cohorts

Daily Revenue Captured and refunded revenue amounts by day—based on successful Transactions, using the Transaction date

Failed Transactions Details on Transactions that failed to successfully collect

Purchased Products Purchased Products by Account

Refunded Transaction Detail

Refunded Transaction details

Page 8: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

8

Standard Reports Name Description

Retention Logic Summary Summary of Revenue collected and Transactions processed by Retention Class (Initial versus Retry)

Revenue By Plan Revenue to-date by recurring Billing Plan

Revenue by Product Total/cumulative revenue to-date by Product (excluding tax)

Revenue: Captured versus Refunded

Comparison of successfully captured revenue versus refunded amounts

Subscription Activity: All Plans

A Cohort view of the subscription-related Billings activity for the specified time periods. Counts all successful Transactions (completed billings) for recurring plans

Transaction Activity by Status

Transaction Activity by Status for each Billing Plan—weekly view

Transaction Counts: All Plans

Transaction counts by Billing Plan for all plan terms, and all plans

Transaction Detail Detailed information on all Transactions, captured, refunded, and cancelled

Transaction Details by Retention Status

Breakdown of successful recurring Transactions by retry attempt

Transaction Response Code Summary

Summary of Transaction Counts by Processor Response Code (by Current Transaction Status)

Transactions by Plan To-Date Transaction count using Purchase-level summarized Transaction information for successfully completed Transactions, grouped by Billing Plan

Transactions by Product To-Date Transaction count using Purchase-level summarized Transaction information for successfully completed Transactions, grouped by Product

The following advanced reports are provided, but must be configured to your specific CashBox naming standards.

Table 3: List of Advanced Reports

Page 9: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

9

Advanced Reports Name Description

Subscription Activity: Annual Plans

A Cohort view of the subscription-related Billings activity for the specified time periods. Counts all successful Transactions (completed billings) for recurring plans

Subscription Activity: Monthly Plans

A Cohort view of the subscription-related Billings activity for the specified time periods. Counts all successful Transactions (completed billings) for recurring plans

Subscription Activity: Daily Plans A Cohort view of the subscription-related Billings activity for the specified time periods. Counts all successful Transactions (completed billings) for recurring plans

Subscription Activity: Weekly Plans

A Cohort view of the subscription-related Billings activity for the specified time periods. Counts all successful Transactions (completed billings) for recurring plans

Transaction Counts: Annual Plans Transaction counts for Annual Plans

Transaction Counts: Monthly Plans

Transaction counts for Monthly Plans

Transaction Counts: Weekly Plans

Transaction counts for Weekly Plans

Transaction Counts: Daily Plans Transaction counts for Daily Plans

The following dashboard is included (see Figure 1: Dashboard view below), pre-populated with graphs based on several of the Basic Reports:

• Subscribers by Plan

• Revenue by Plan

• Daily Revenue—Past Week

• Subscribers by Product

• Revenue by Product

• Daily Revenue by Plan—Past Week

• Transactions by Plan

• Transactions by Product

Page 10: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

10

• Processor Response Code Summary. You can customize all graphs using standard Salesforce dashboard tools.

Figure 1: Dashboard view

Page 11: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

11

Working with Customer Care features

All available customer care functionality described in this chapter is available only to CashBox (Premium) customers. Customer care actions will trigger data export from Salesforce and update your CashBox instance.

Creating Accounts Users can create Accounts in Salesforce but accounts do not integrate with CashBox (synchronize Purchase, Payment Methods, Credits, and so on) until the account (customer) makes a purchase. Once the account is integrated, a link is established (either by Vindicia ID or Customer ID) and, going forward, any changes on the CashBox side are reflected in Salesforce. Some changes to Account in Salesforce will export and update CashBox, such as: billing address, payment method, email, or name-value pairs.

Creating and Modifying the Payment Method The Payment Method is a CashBox custom object. Any changes to a payment method will trigger an update to CashBox, including creation of a new payment method. The following payment method types are available:

• Credit Card

• Electronic Check

• Merchant Accepted Payment Any modification or creation of payment method uses the Vindicia Hosted Order Automation (HOA), removing any PCI compliancy burden on the merchant or Salesforce.

Creating Purchases With CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create a new Opportunity and select the Account, Currency and Billing plan, then add the Opportunity products you want to sell. Only the products from the Pricebook for the currency you selected will be available. If you discount any of the products you might have to go through a pricing Approval Flow, if you have one enabled—by default, CashBox does not enable any price approval flows. If you want to quote the customer before creating a purchase, use the Create Quote button on the Opportunity. CashBox will return an amount, an expected first bill date, first bill amount and other quote-related fields. Confirm the quote, and click the Create Purchase button on the Opportunity. This generates an API call to CashBox

Page 12: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

12

and creates the purchase. When the call completes, you are redirected to the newly created purchase. A custom flag, Overwrite CashBox Account Shipping, allows you to use the billing address from the payment method as the shipping address for a particular purchase. This does not change the shipping address on the Account in CashBox, it only affects the purchase shipping address.

Modifying and Canceling Purchases To make changes to an existing Purchase, use the following custom buttons:

• Cancel Purchase

• Modify Purchase

• Replace Payment Method

• Refresh Purchase Each of these buttons takes you to a custom flow to complete the action. The Refresh Purchase button can take some time (usually less than 10-15 seconds) but keeps you on the Purchase, after it refreshes, with the latest data from CashBox. To modify a Purchase, use the dedicated custom button, Modify Purchase. When you click this button, a new opportunity is created with all the information from the purchase. You can change products, add, remove or even modify existing products, or you can change the Billing Plan. From the Opportunity, CashBox (Premium) provides two custom buttons: Create Quote and Create Purchase. Create Quote shows you what the purchase will look like if you make the changes. The Create Purchase button submits the changes to the purchase to CashBox.

Replacing Payment Methods A dedicated custom button enables you to change the payment method on a Purchase. Click this button to open a custom page listing eligible payment methods for that account, and select a new payment method. When you save your changes a call to CashBox updates the payment method, and you are sent back to the Purchase, which now shows the new payment method on the account.

Managing Credits CashBox supports Credits at the account level and at the Purchase level. To manage Credits click the custom button, Manage Credits, for Accounts or Purchases. A custom page opens listing all credits in two sections: Credits with a balance, Credits with a zero balance (fully consumed). From this page you can issue new Credit, or fully or partially revoke existing credit. Each of the Account issued Credits contains the full history of the credit as shown in Figure 3: Error! Reference source not found., with details such as granted, consumed, revoked, and so on.

NOTE: Only currency credits are supported.

Page 13: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

13

Figure 2: Manage Credits

Figure 3: Credit Details

Managing Refunds CashBox for Salesforce enables Customer Care representatives to manage refunds when needed. A custom button, on each Transaction record of captured funds, enables you to issue a full Transaction refund or an individual Transaction item refund. Each refund can be set to Full, Partial (percentage), or Partial (amount). On the custom page of Refund Transaction, under Refund Type, the following options appear:

• Full

• Partial - Specify %

• Partial – Specify Amount

• Line Item When you select Full or either of the Partial refund types, the refund is issued at the Transaction level. This means the amount you refund will not be distributed per line item. Any consecutive refund for this Transaction also must be at the Transaction level. When you select Line Item, you are directing CashBox to refund for individual products. You have the same Full and Partial options for Line Item refunds that you

Page 14: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

14

have for refunds at Transaction level. Once you issue a line item refund, consecutive refunds can also be at the line item level. Each refund object in Salesforce is linked to the original Transaction; each Line Item refund is linked to its corresponding Transaction Item. This allows you to build custom reports at the Line Item level.

NOTE: If a transaction is paid by a Credit (fully or partially), a refund at the transaction level is supported and line item refunds are not available.

NOTE: If you perform a refund at the transaction level, the refund amount is NOT distributed to each line item, and any consecutive refund stays at transaction level.

NOTE: For every line item refund, the sales taxes are always refunded for the amount you specify for the line item.

Figure 4: Managing Refunds

Figure 5: Issue Refund

Page 15: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

15

Importing Data

Requires Administrative privileges.

Importing Data, Automatic and Continuous After a successful installation and configuration of the CashBox applications, you are ready to start your data import into Salesforce. By default, the start date for the initial import is set to 1/1/2010 12:00am. If you have data in CashBox prior to this date, go to Custom Settings > Import Log and set your Next Extract Start variable to the earliest date you would like to import data—this can be a date earlier than the default 2010 date. You can also adjust the initial start date to the first date of created data in CashBox you would like to import into Salesforce. After setting the start date, go to the CashBox Admin tab, and at the bottom of the page click Start Data Import. This button starts a continuous import job that runs across all objects defined above, in the following order: 1. Import ALL Products 2. Import ALL Billing Plans 3. Import ALL Rate Plans 4. Import Accounts [created: since -> to]

NOTE: this job will run only if you have checked the Import Accounts Separately checkbox on the CashBox Admin tab. If this flag is set to False, job #4 will not run, and only Accounts that have Purchases will be imported as part of the AutoBill import job #5.

5. Import AutoBills [last modified: since -> to] 6. Import Transactions [last modified: since -> to] 7. Import Credits [last modified: since -> to] 8. Import Refunds [last modified: since -> to] 9. WAIT [as defined by Default Refresh Interval on the CashBox Admin tab]

After all 8 jobs complete, there is a wait period (in minutes) defined by the Default Refresh Interval variable on the CashBox Admin tab. When the wait period ends, the import process resumes with job #1. The since -> to timestamps vary depending on how long one full import sequence, including the wait period, lasts. The window used for [since -> to] on the next import sequence is set as follows: new since = previous to and the new to = NOW, unless NOW is later than the Max Import Period from the start time, in which case the new to = new since + Max Import Period (hours. This allows for an elastic time window during which the data is fetched, and can accommodate large data imports during peak times while catching up during off peak times.

Page 16: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

16

Each of the 8 import jobs leverages pagination. You configure pagination by setting the Page Size variable in: Custom Settings > Import Log. The default page size is 100. If your CashBox environment is configured such that it uses a large number of name-value pairs and the objects are data-heavy, you might want to set the Page Size to a smaller value. Because of the integration limitation Salesforce imposes, page size settings can vary widely from one organization to another.

Page 17: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

17

Troubleshooting CashBox applications

Requires Administrator privileges.

Monitoring Import/Export Jobs Two custom tabs have been added to help you monitor continuous sync jobs:

• CashBox Import Logs

• CashBox Export Logs. If you notice any discrepancies between CashBox and Salesforce data, you can reference the import/export tabs and backtrack in time to see if there are any import errors. You can then do a Refresh on Account or Purchase. This will do a targeted import. Note that, in order to avoid taxing your Salesforce org with data, all logs are retained for only seven days.

Import Logs Import Logs is a custom tab where you can track all import logs. A record is being created for each page of each import job. When the import is running in continuous/auto mode, you can track the sequence of import jobs and verify that all data makes it into Salesforce. There is an error flag on which you can build a list view and an error message for each of the import log records. Note that all logs are kept in your Salesforce organization for seven days. Older import logs are deleted daily. If you run a manual import job, the import log also tracks all records.

Export Logs The Export Log is a custom tab where all export logs can be tracked. This includes updates to an account or payment method for CashBox (Basic). For CashBox (Premium) this includes all customer care functionality, such as Accounts, Payment Methods, Purchases, and Credits. Note that all logs are kept in your Salesforce org for seven days. Older export logs are deleted daily.

Data correction At any time, if your CashBox data does not conform to your Salesforce validation (as of release 14.0), all import problems due to the Salesforce database or validation issues are placed in a retry queue. Each failed record is logged with its Vindicia ID (accessible from the CashBox Admin tab > View Import Errors) and the reason for failure. You can then correct the data in CashBox or adjust the validation constrains in Salesforce, and either manually run a reimport for the failed record or, if it is not urgent, wait for the nightly retry job to make another import attempt for all failed records.

Page 18: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

18

Stop scheduled Jobs When you start the auto scheduled data import with the Start Data Import button on the CashBox Admin tab, the following jobs are scheduled, as shown in Figure 6: Custom Settings—CashBox Scheduled Jobs below.

• Data Import Bulk Exception Cleanup Scheduler—runs daily and deletes exceptions logs older than seven days

• Data Import Exception Digest Job

• Data Import Log Cleanup Scheduler—deletes all import logs older than seven days

• Vindicia Data Import Scheduler—controls the continuous data import sequence, described in the Importing Data, Automatic and Continuous section

Figure 6: Custom Settings—CashBox Scheduled Jobs

If for any reason you need to stop the current import job or any of the other jobs described here, click DEL in the Custom Settings > Data Import Log.

Disable CashBox Triggers When an additional custom code is being deployed in your Salesforce organization, you might need to disarm CashBox triggers for certain test classes. During debug or test mode, you can disable the triggers for CashBox and get the rest of your test coverage to an acceptable point. Be sure to enable all CashBox triggers before launching and resuming application data integration.

Data Import Catch-up Under the CashBox Admin tab, a section called Data Import Shortcuts enables you to import specific object data manually. For the following objects, all available records from CashBox will be imported into Salesforce:

• Products

• Billing Plans

• Rate Plans

Page 19: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

19

For the following objects, a from/to timestamp from Custom Settings > Import Log is used:

• Accounts

• Purchases

• Transactions

• Credits

• Refunds This manual import of data is most useful during an initial data import that requires manual interaction, or when your integration has been turned off and you are performing a catch-up.

Manual Data Import In cases where manual import is needed, the administrator can control the data import by stopping jobs currently scheduled and restarting them. This is useful when a retroactive import of changes is desired, especially if an existing CashBox customer is new to Salesforce and is instantiating the applications for the first time. Use the following procedure to manually control data import: 1. Navigate to Setup > Administration Setup > Monitoring > Scheduled Jobs. 2. Delete the Scheduled Jobs by clicking the Del link to the left of each scheduled

job in the Action column, then Confirm.

• Typically there will be two or three jobs running—occasionally some are one-off jobs to fetch rated usage—but any job related to the CashBox applications can be safely deleted and restarted. But in this case, target

• VindiciaDataImportScheduler (might have a V# at the end if versioned)

• DataImportLogCleanupScheduler

• DataImportExceptionCleanup

• DataImportExceptionDigestJob 3. Reset the start and end dates of your import:

a. Navigate to Setup > App Setup > Develop > Custom Settings > [Manage] Data Import Log > [Edit] Next Start

b. Edit the Next Extract Start value to a time and date before you made the change. The further back you go, the longer the import will take—and the greater the risk of SFDC failing due to enforced timeouts.

NOTE: SFDC does not allow jobs that take more than two minutes or return more than 6MB of data. To avoid these SFDC limitations, keep the Page Size setting at 100 or lower. If you must pull data from a long time in the past, use the optional Next Extract End and manually move the import window until the end

Page 20: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

20

date or use Max Import Period (Hours) to limit your import range, in which case the import window will automatically move to the next and will keep the maximum period fixed. If you use the Max Import Period (Hours) setting, no manual intervention is needed, the import job will automatically move to the next window until it reaches current date/time. If you want to leverage the Max Import Period (Hours), the recommended value varies depending on the volume of data you expect to import. You can start with a max window of one week, and adjust it to a higher or lower number if the import is successful, or it times out.

4. Restart the full import jobs by navigating to the CashBox Admin tab, and click the Start Data Import button at the bottom.

5. (Optional) Monitor the jobs and import logs. You can use the CashBox Import Log tab to watch each import log. Each log is recorded at completion. There can be a short delay before you see the new entries.

Page 21: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

21

APPENDIX A: Installing and upgrading CashBox Applications

CashBox (Basic) and CashBox (Premium) are native force.com applications offered as a Managed Package for installation in your Salesforce.com organization.

Prerequisites To install or upgrade CashBox for Salesforce, you must be running Salesforce.com Enterprise Edition (or greater), you must be a CashBox customer, and you must have administrative privileges in your Salesforce instance. This Guide assumes you have a working knowledge of the Salesforce environment.

Installing If you are installing the CashBox (Basic) or (Premium) applications for the first time, Vindicia strongly recommends that you install them in a sandbox organization and connect that organization to the CashBox PRODTEST or STAGING environments. This will give you an opportunity to become familiar with the CashBox applications in a controlled environment, and applies only if your Sandbox does not contain your production data (which can be the case if you refresh your Sandbox with full production schema and data). If your Sandbox gets refreshed with your production data, you might need to wipe all CashBox data, connect to Cashbox PRODTEST or STAGING, and reimport your test data. This is necessary because your billing data has unique IDs in PRODUCTION, PRODTEST, and STAGING. Follow this procedure to install CashBox (Basic), and then use the procedure again to install CashBox (Premium). Refer to the Installation Screens at the end of this procedure if necessary. 1. Obtain the installation link.

You can request the installation link from your Vindicia representative. Alternatively, you can request the installation link from the AppExchange. To request the link from the AppExchange, go to: http://appexchange.salesforce.com and search for CashBox, click on the application name and then click Get it now. This action alerts Vindicia of your interest and a representative will reach out to you with the install link. The link you receive will be in the following format: https://login.salesforce.com/packaging/installPackage.apexp?p0=04aB01243567CDE

If you are installing into a sandbox organization, replace the initial portion of the URL with: http://test.salesforce.com. For example, the link should look like this: http://test.salesforce.com/packaging/installPackage.apexp?p0=04aB01243567CDE

Page 22: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

22

2. Log in to your Salesforce instance and go the provided install link. You are prompted to select your CashBox application access.

3. Select Install for All Users. (If you select Install for Specific Profiles there is an additional step, in which you provide access to the desired user profiles.) The installation process begins and you are prompted to acknowledge that the CashBox application will be connecting to a third party system (the CashBox APIs).

4. Grant access and continue the installation process.

The installation process normally takes a few minutes. If it takes longer, Salesforce will alert you that a notification email will be sent to you upon completion of the installation. Click to accept the alert message. You can proceed with other activities while you wait for the email notification informing you that the installation has finished.

If you have purchased the CashBox (Premium) application, repeat this installation procedure for CashBox (Premium), using the link and other information provided to you by your Vindicia representative.

When installation is complete, you must configure the CashBox applications before you can start using them. Proceed to Configuring CashBox for Salesforce.

Installation Screens The section contains the main screens you encounter during the installation process.

Page 23: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

23

Figure 7: Dashboard view

Figure 8: Dashboard view

Page 24: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

24

Figure 9: Dashboard view

Page 25: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

25

Upgrading CashBox for Salesforce When Vindicia releases a new version of the CashBox for Salesforce applications, you can upgrade to it by following the same installation steps described in Installing. If you have an integration running at the time you perform the upgrade, you do not need to stop or delete any of the scheduled apex jobs managed by the CashBox application.

Figure 10: Upgrade to a newer version view

Page 26: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

26

APPENDIX B: Configuring CashBox Applications

Requires Administrative privileges.

CashBox (Basic) allows you to import data from CashBox to Salesforce, and to integrate your CashBox data with your Salesforce reporting and other processes. All relevant standard Cashbox data automatically populates into Salesforce after the initial installation. This chapter describes how to configure your initial installation, and how to map and import custom CashBox data to the application at any time. Before you use your newly installed CashBox for Salesforce applications, you must configure it to work with your CashBox merchant and custom settings. To configure CashBox, select the CashBox application and click the CashBox Admin tab. (Select the tab from the All Tabs screen, or enter the CashBox Reporting for Salesforce application using the Application Selector in the upper right of your Salesforce.com screen.)

The first time you access this page, you will be prompted to identify whether this Salesforce instance will be connecting to a CashBox PRODUCTION, PRODTEST, or STAGING environment. Depending on this selection, the endpoint URL will be automatically set. The login credentials must correspond to the Cashbox environment to which you are connecting

WARNING: A production Salesforce instance is intended to connect to PRODUCTION Cashbox, and a Sandbox Salesforce instance is intended to connect to either CashBox PRODTEST or STAGING. It is very important that you do not change environments once you have connected and imported data from one environment—doing so can potentially corrupt your CashBox data.

CashBox Admin Tab Select the CashBox Admin tab to configure the application to best serve your business needs. The Admin page is shown below in Figure 11: CashBox Admin tab 1 and Figure 12: CashBox Admin tab 2.

CashBox API Credentials Configure your SOAP credentials for the CashBox environment you are connecting to. Enter an API username and password and select an API Environment. When you click Save and Validate, your credential are verified. A green Icon with a check mark indicates success. You cannot start data import synchronization until your credentials have been validated.

CashBox Object Prefixes (Optional) You can define a prefix for each record that originates in Salesforce. This enables you to identify the source of each record in CashBox.

Page 27: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

27

CashBox Import Settings The import settings allow you to configure your application according to your needs.

1. Import next anticipated billing: This box, when checked, will create a record of a future billing to represent the next billing, including the date and amount. By default, this box is checked.

2. Timestamp adjustment for PST: This box affects how timestamps from Salesforce are converted for CashBox. You should set this to the opposite of your Merchant Settings flag USE_TIMEZONE_IN_SOAP in CashBox. By default, this box is unchecked.

3. No New Accounts: When this box is unchecked, the CashBox integration updates your existing Accounts if it finds a match, otherwise it creates a new Account record. When you check this box, the CashBox integration does not create a new Account and updates existing Accounts only if they match the one that is integrating. A match is identified by either of these two fields: Customer ID (cashbox__Customer_Id__c), or Account VID (cashbox__VID__c) in that order. This box is unchecked by default.

4. Admin Email: Enter an email address if you want to receive notification of import and export log errors. Limited to one email address.

5. Exception Recipient Email: Enter an email address if you want to receive exceptions digests. Limited to one email address.

6. Default Refresh Interval: Enter a numerical value to specify the number of minutes to wait between import cycles. If you enter no value, the system defaults to a refresh interval of 30 minutes.

7. Execute Rated Unit Summary: Check this box to enable execution of a rated unit summary at the end of an import batch. By default, this box is unchecked.

8. Sync Affiliate ID and SubAffiliate ID with CashBox: Check this box to synchronize the Affiliate ID and SubAffiliate ID field values with CashBox. By default, this box is unchecked.

9. Import Accounts Separately: Check this box to enable import of Accounts separately from Purchases using import batch. If checked, accounts from CashBox are imported regardless of whether they have billing activity in CashBox. By default, this box is checked.

See the Troubleshooting CashBox Applications chapter for details about Data Import Shortcuts.

Page 28: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

28

View Import Errors When a record fails to import due to technical problem in Salesforce, a timeout, Database problem, or data validation issue, it is placed in a retry queue. It can be viewed on the links seen in this section of the CashBox Admin tab. From there, you can retry them manually (in the case where a data problem causing the error was fixed), otherwise they will be automatically retried during the retry jobs, which run daily at midnight Pacific Time).

Setup Status This section of the CashBox Admin tab enables you to map any custom field from Salesforce to a name-value pair (NVP) in CashBox. With these mappings, the integration between Salesforce and CashBox becomes bi-directional—that is, you can edit a NVP in Salesforce or CashBox and it will be synchronized automatically. The custom fields you create in Salesforce must be of type: text, because all NVP fields in CashBox are text fields. NOTE: When you edit the content of a field in Salesforce that is mapped to a NVP in CashBox, the update in Cashbox is immediate. For the reverse, when you update the content of a NVP in CashBox, the update in Salesforce will occur during the next data import cycle.

Page 29: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

29

Figure 11: CashBox Admin tab 1

Page 30: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

30

Figure 12: CashBox Admin tab 2

Custom Settings Figure 13: Custom Settings shows the Custom Settings included in the CashBox application. Do not edit or manage custom settings during normal operation. A few custom settings, however, might need to be changed or managed as part of the initial

Page 31: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

31

manual data import, such as managing access for the ability to create Payment Methods by user profile, or disabling one or more CashBox triggers for debugging or testing your custom apex code in your instance.

Figure 13: Custom Settings

Application Properties This section of Custom Settings is where CashBox (Basic) stores certain customer-specific CashBox information. This information is maintained and automatically updated by the CashBox package. Do not edit or delete any fields.

CashBox Triggers For the CashBox applications to work properly you must set triggers to ON. This is the default. If you have custom code running in your organization, however, you might need to turn off CashBox triggers during testing or debugging. You can disable one or more of the CashBox triggers from the Custom Settings. Click Manage CashBox Triggers to see a list of all triggers. Each trigger has a flag Not Run Trigger that you can set to True during your testing.

WARNING: You must uncheck any flags you check before resuming normal CashBox operation.

Page 32: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

32

Figure 14: Custom Settings—CashBox Triggers

Data Import Log Click Manage Data Import Log to adjust the start and end time stamps for manual data import. If you are running a continuous Data Import job, the start and end timestamps are automatically updated according to the import job start time plus the wait period set on the CashBox Admin tab. The Max Import Period (hours) setting enables you to control the maximum window of time during which you can import data. This setting impacts the Next Extract End, setting it to the Next Extract Start plus the Max Import Period (hours).

Page 33: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

33

Figure 15: Custom Settings—Data Import Log

Data Import Object This custom setting is for disabling the scheduled import jobs. By default, all import jobs are enabled. If you do not want to integrate Products, Billing Plans or Rate Plans in every import cycle, and you don’t intend to create or modify them in CashBox, you can use these settings to turn them off after the initial import into Salesforce. By disabling selected import jobs, you enhance data import performance for the remaining imports. WARNING: Do not edit the order in which import jobs run, even when you disable some of them. Because of data dependencies, import jobs must run in a specific order.

Figure 16: Custom Settings—Data Import Object

Page 34: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

34

Debug Settings This section of Custom Settings is where CashBox-specific settings and debugging information is stored. Debug settings are automatically updated by the CashBox (Basic) application. Do not edit or delete any of its fields.

CashBox Opportunity Settings This section of Custom Settings is where CashBox (Premium) stores Opportunity-related customer settings. By default, only one record is inserted for the Account shipping address override. If you are using custom Opportunity record types, this is where you map all your customer record types to either AutoBill or One-Time Charge record types.

HOA Settings This section of the Custom Settings is where CashBox (Premium) stores Hosted Order Automation settings. This information is used in the custom Visual Force page, where you create Payment Methods. Do not edit or delete any of fields.

Payment Method Type Settings Having configured the full site with access to all users, by default all Payment Methods (Credit Card, ECP, Merchant Accepted Payment) are available to all users in your Salesforce instance. However, if you have a business requirement to allow only certain users access to creating Payment Methods, click CashBox Payment Type Permissions tab, and assign the payment methods that you want to allow by profile. This action creates an entry in the Custom Settings > Manage Payment Method Type Settings as shown in Figure 17: CashBox Payment Type Permissions tab

Figure 17: CashBox Payment Type Permissions tab

Page 35: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

35

Figure 18: Custom Settings—Payment Method Type Settings

Service Defaults This section of the Custom Settings is where all the defaults are stored for your Purchase modification and Payment Method validation policies. You can modify your defaults to suite your business needs. The defaults are set as shown on the following figure.

Figure 19: Custom Settings—Service Defaults

Page Layouts After initial installation of the CashBox for Salesforce applications, some page layout customization of fields, buttons and related lists is needed to allow users visibility into their functionality. Vindicia recommends the following page layout adjustments on the

Page 36: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

36

standard Salesforce objects (Accounts, Products, Opportunity) as well as on some custom CashBox objects (Purchases).

Accounts Custom Buttons: Each of the custom buttons below is available for the Account record, and can be added to the account page layout based on your business needs and company access policy.

• Refresh Account—calls CashBox and refreshes the account and all account-related records with the latest data from CashBox.

• Add Payment Method—allows users who have access to Payment Methods to take credit cards, electronic checks, or merchant accepted payments for your order management or directly from your customers, and to create the Payment Method directly in CashBox via PCI-compliant processes.

• Manage Credits—available only for CashBox (Premium), allows you to view all credits that have been issued to an account or for an individual Purchase. Each of the Credits contains its history; you can create new and revoke existing Credits directly from Salesforce.

• Manage Refunds—available only for CashBox (Premium), this button allows you to view all fully refunded transactions as well as all transactions that are eligible for refund. From here you can issue a new refund.

Custom Fields:

• Customer ID

• Vindicia ID

• Account Email

• Optional: Do not sync with CashBox

• Optional: Protect Account Address Related Lists:

• Payment Methods. Vindicia recommends that you hide the standard New button and add a New Payment Method button to this related list. This enables users you’ve allowed access to Payment Methods to leverage PCI-compliant hosted order automation (HOA) technology to create credit cards and other Payment Methods. The custom button Add Payment Method—discussed in Accounts above—provides the same capability.

Page 37: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

37

• Purchases. This related list can display all CashBox purchases—recurring/AutoBill or one time Transaction. Recommended columns (fields) include:

• Purchase Name

• Purchase Status

• Billing Plan

• Subscription Start Date

• Entitlement End Date

• Type You can customize columns to accommodate your business needs.

• Opportunities. This related list shows users what stage the opportunity is in, and whether an opportunity has resulted in a Purchase. Recommended columns (fields) include:

• Opportunity Name

• Stage

• Amount

• Related Purchase

• Close Date You can customize the columns to align with your business needs.

• Account Entitlements (Optional). If you require visibility into Entitlements, this related list enables you to see all account entitlements. NOTE: Any entitlements granted from the Purchase will not be part of this list. If you want to see purchase-granted entitlements, you need to build a custom report on the Purchased Products object.

• Credits (Optional). If you use Credits and need to view them in Salesforce, this related list enables you to see all Credits regardless of whether they are granted at the Purchase or Account level. If you are a CashBox (Premium) customer, you also have access to a custom New Credit button, which you can add to the related list, where you grant new Time or Currency Credits.

• Tax Exemptions (Optional). If you are configured to calculate sales tax in CashBox, you can add this related list to Accounts in Salesforce, where you can monitor account Tax Exemptions. NOTE: This object is read only in SFDC and cannot be used to create new records intended for integration into CashBox.

• Usage Summaries (Optional). If you have usage-based products configured in CashBox and are feeding CashBox with the usage information; you can view each usage in Salesforce from this object.

Page 38: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

38

NOTE: This object is read only in SFDC and cannot create new records intended to integrate with CashBox.

Purchases If you are a CashBox (Premium) customer, Vindicia recommends the following Purchase page layout adjustments, which you can set in accordance with your business needs and company access policy. Custom Buttons:

• Refresh Purchase—allows the user to make a dedicated call to CashBox to fetch the latest data. This button is also available in CashBox (Basic).

• Modify Purchase—takes the user to an Opportunity where the starting point is the current purchase. From here the user can modify the purchase and add new products.

• Cancel Purchase—opens a custom page where the user can configure settlement of a cancellation, which is then sent to CashBox.

• Replace Payment Method—enables the user to change the payment method on a particular purchase.

• Manage Credits—opens a custom page, where the user can grant or revoke credits for the particular purchase.

• Manage Refunds —enables the user to issue refunds for all eligible transactions for the purchase.

Opportunities If you are a CashBox (Premium) customer, Vindicia recommends the following Opportunity page layout adjustments, which you can make based on your business needs and company access policy. Custom Buttons:

• Create Quote—This custom button initiates a purchase dry run call to CashBox and returns a calculation of the purchase that includes sales tax (if configured in CashBox), first bill amount, next bill date, and so on.

• Create Purchase—This custom button calls CashBox and creates a Purchase. If you are on an Opportunity due to Purchase modification, this button sends your changes to CashBox, and the initial Purchase is updated.

Custom Fields:

• Product Currency

• Billing Plan

• Payment Method

• Quote Amount

Page 39: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

39

• Quote Date

• First Bill Amount

• Expected First Bill Date Related Lists:

• Opportunity Products—This is a custom-related list that is required for the CashBox (Premium) application to work properly. Hide the standard New button and include the custom Add Opportunity Products button to this related list. Recommended columns (fields) include:

• Opportunity Product Name

• Quantity, Added Price

• Currency Code

• Related Purchase Product. You can customize the columns in accordance with your business needs.

Approval Flows CashBox (Premium) allows you to use approval flows for your opportunity generation. Approval flows enable you to regulate the process by which a discount is offered and approved. To use Approval Flows, you must:

• Define the roles that will be included in the flow • Define the order in which approval requests will be escalated through these roles • Define the discount that each defined role will be allowed to approve

To do this, go to: App Setup > Create > Workflow and Approvals > Approval Processes. Then, click Create New Approval Process > Jump Start Wizard.

Page 40: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

40

Figure 20: Approval Flow setup wizard

Follow the standard Salesforce Approval Flow setup process, with these two additional requirements:

• Under Specify Entry Criteria, you must set Field: Opportunity: Required Approval Process to Operator: equals the name you wish to use in the Approval Thresholds setting (the process name you will use with this and/or other applications or processes within Salesforce)

• Under Select Approver, you must select Automatically assign to approver(s), and select Related User and Required Approver.

To use the Approval Thresholds function (setting pricing customization limits by Role), you must either create a new approval process for your org, or modify an existing process to use CashBox (Premium) settings.

Page 41: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

41

Configure your Sales Approval Setup using the CashBox Sales Approvals tab.

The Sales Approval Setup allows Salesforce Administrators to automatically find all defined Roles and their hierarchy for the Salesforce instance. For each Role in your approval processes, set the Approval Threshold and Approval Process Label to the percentage of list price within which members of that Role may modify the price.

EXAMPLE: If a Sales Rep can offer a discount of up to 5% on their own authority, set their Approval Threshold to 5.00. NOTE: The top-level Role (typically CEO) must be set to 100.

Figure 21: Sales Approval setup wizard

Page 42: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

42

APPENDIX C: Data Mapping

The following table lists all CashBox (Basic) and CashBox (Premium) objects, custom Salesforce fields/API names and their corresponding CashBox fields and their descriptions.

Page 43: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

43

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App

Account Account Email cashbox_Account_Email__c Account emailAddress The email address specified on the CashBox account; populated as a custom field in Salesforce to avoid overwriting any existing email fields.

Basic

Account Customer ID cashbox_Customer_Id__c Account merchantAccountId The merchant-specified Customer Identifier from CashBox. As this is an optional field in CashBox the application does not treat it like a unique key within the Salesforce account, but it is provided so that it can be used as such if it fits your business model.

Basic

Account Do Not Sync with CashBox

cashbox_Do_Not_Sync_with_CashBox__c N/A N/A A flag (checkbox) that can be used to designate that the account should not be synchronized between Salesforce and CashBox. Future updates from CashBox will be ignored, and any changes made to the updateable address fields in Salesforce will not export to CashBox.

Basic

Account Primary Contact cashbox_Primary_Contact__c N/A N/A The name specified on the CashBox account. Basic Account Protect Account

Addresses cashbox__Suppress_Address_Change__c N/A N/A Setting on the Account to prevent overriding the Address Basic

Account Vindicia Record ID cashbox_VID__c Account vid The global identifier assigned to the account by CashBox. Used by the applications processes to uniquely identify the Account. Note - all CashBox objects have a "VID" - which will be globally unique meaning no Account will have the same VID as a Payment Method or a Transaction, so they can be truly used as a global ID.

Basic

Account_Entitlement__c Account cashbox__Account__c N/A N/A The reference to the associated Account. Basic Account_Entitlement__c Active cashbox__Active__c Entitlement active Indicator for whether or not the Entitlement is currently

Active for this Account Basic

Account_Entitlement__c Description cashbox__Description__c Entitlement description The "Description" of the Entitlement as defined within CashBox

Basic

Account_Entitlement__c End Timestamp cashbox__End_Timestamp__c Entitlement endTimestamp The Date/Time at which the Entitlement ceased to be effective/active.

Basic

Account_Entitlement__c Merchant ID cashbox__Merchant_ID__c Entitlement merchantEntitlementId The Entitlement identifier assigned to a particular service/entitlement as defined within CashBox

Basic

Account_Entitlement__c Start Timestamp cashbox__Start_Timestamp__c Entitlement startTimestamp The Date/Time for which the Entitlement became effective/active.

Basic

API_Settings__c Value Value__c N/A N/A Value for the custom setting Premium Application_Properties__c Completed? cashbox__Completed__c N/A N/A NOT USED Basic Application_Properties__c Customer Id Field cashbox__Customer_Id_Field__c N/A N/A NOT USED Basic Application_Properties__c Customer Id Object cashbox__Value__c N/A N/A NOT USED Basic Approval_Threshold__c Can Change Rate Tier

Ranges cashboxq2c__Can_Change_Rate_Tier_Ranges__c N/A N/A Setting for being able to change the tier ranges for the

approval threshold Premium

Approval_Threshold__c Parent Role Id cashboxq2c__Parent_Role_Id__c N/A N/A the parent role for the existing user role id Premium Approval_Threshold__c Can Create New Tiers cashboxq2c__Can_Create_New_Tiers__c N/A N/A Setting for being able to create new tiers for the approval

threshold Premium

Approval_Threshold__c Approval Process cashboxq2c__Approval_Process__c N/A N/A The approval process associated to this threshold Premium Approval_Threshold__c User Role Id cashboxq2c__User_Role_Id__c N/A N/A The user role for this threshold Premium Approval_Threshold__c Approval Threshold cashboxq2c__Approval_Threshold__c N/A N/A The threshold amount for this approval threshold Premium Approval_Threshold__c Level cashboxq2c__Level__c N/A N/A Level of the Approval Threshold Premium Autobill_Settings__c Value cashbox__Value__c N/A N/A Value for the custom Setting Premium Autobill_Settings__c Record Types cashbox__Record_Types__c N/A N/A which record types this setting is valid for. Premium Billing_Plan__c # of Indefinite Periods cashbox__Num_of_Indefinite_Periods__c N/A N/A A count of the number of indefinitely recurring Billing

Periods defined for this Plan. Any number above 0 will indicate that the plan is an indefinitely auto-renewing subscription.

Basic

Billing_Plan__c Active cashbox__Active__c N/A N/A A true/false flag indicating whether this Billing Plan is set to Active in CashBox

Basic

Billing_Plan__c Billing Plan Currencies cashbox__Billing_Plan_Currencies__c BillingPlanPrice currency_x A concatenated list of currency related to this Billing Plan period prices

Basic

Billing_Plan__c Billing Plan ID cashbox__Billing_Plan_ID__c BillingPlan merchantBillingPlanId The merchant-specified Billing Plan Identifier from CashBox. As this is an optional field in CashBox the application does not treat it like a unique key within the Salesforce account, but it is provided so that it can be used as such if it fits your business.

Basic

Billing_Plan__c Billing Statement Identifier

cashbox__Billing_Statement_Identifier__c BillingPlan billingStatementIdentifier The Billing Statement Identifier string associated with this Billing Plan for use in template communications and downstream Payment Processors.

Basic

Page 44: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

44

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App Billing_Plan__c Description cashbox__Description__c BillingPlan description The Description provided for this Billing Plan as defined in

CashBox Basic

Billing_Plan__c End of Life cashbox_End_of_Life_c BillingPlan endOfLifeTimestamp The Plan's scheduled "End of Life" as defined in CashBox Basic Billing_Plan__c Indefinite cashbox__Indefinite__c N/A N/A A true/false flag indicating whether this Billing Plan has one

or more "indefinite" periods (and is therefore an infinitely recurring plan).

Basic

Billing_Plan__c Plan Duration cashbox__Plan_Duration__c N/A N/A The total duration of this Plan in days. If the plan is "Indefinite" this value will be 0.

Basic

Billing_Plan__c Pre-notify # of Days cashbox__Pre_notify_of_Days__c BillingPlan prenotifyDays The plan length: The # of days configured for Pre-notification as defined in CashBox

Basic

Billing_Plan__c Product Manager cashbox__Product_Manager__c N/A N/A NOT USED - This fields purpose has been replaced by the use of Merchant Data (custom name-value pairs)

Basic

Billing_Plan__c Vindicia Record ID cashbox__VID__c BillingPlan VID The global identifier assigned to the Billing Plan by CashBox. Used for reference.

Basic

Billing_Plan_Entitlement__c Active cashbox__Active__c N/A N/A Indicator for whether or not the Entitlement is currently Active for this Account

Basic

Billing_Plan_Entitlement__c Billing Plan cashbox__Billing_Plan__c N/A N/A The specific Billing Plan Identifier granting this Entitlement. Basic Billing_Plan_Entitlement__c Description cashbox__Description__c MerchantEntitlementId description The "Description" of the Entitlement as defined within

CashBox Basic

Billing_Plan_Period__c # of Cycles cashbox__Num_of_Cycles__c BillingPlanPeriod cycles The # of Cycles which will occur for this Period Basic Billing_Plan_Period__c Active cashbox__Active__c N/A N/A A true/false flag indicating whether this Billing Plan is set to

Active in CashBox Basic

Billing_Plan_Period__c Billing Plan cashbox__Billing_Plan__c N/A N/A The specific Billing Plan Identifier to which this Period belongs.

Basic

Billing_Plan_Period__c Cycle Duration cashbox__Cycle_Duration__c BillingPlanPeriod quantity The specified duration value (a number) for which the Period occurs.

Basic

Billing_Plan_Period__c Cycle Duration cashbox__Cycle_Duration_formula__c N/A N/A This field is a version of the "Cycle Duration" used for calculating various formulae in the application.

Basic

Billing_Plan_Period__c Cycle Period cashbox__Cycle_Period__c BillingPlanPeriod type_x The time measure (Day, Month, etc.) for the Period. Basic Billing_Plan_Period__c Do Not Notify Before

First Bill cashbox__Do_Not_Notify_Before_First_Bill__c BillingPlanPeriod doNotNotifyFirstBill The "Do Not Notify Before First Bill" Setting as defined in

CashBox Basic

Billing_Plan_Period__c Duration (calc) cashbox__Duration__c N/A N/A A field used for calculating various formulae in the application.

Basic

Billing_Plan_Period__c Expire Warning # of Days

cashbox__Expire_Warning_of_Days__c BillingPlanPeriod expireWarningDays The "Expire Warning # of Days" Setting as defined in CashBox

Basic

Billing_Plan_Period__c Free cashbox__Free__c BillingPlanPeriod free A true/false flag indicating whether this Billing Plan Period is designates as FREE.

Basic

Billing_Plan_Period__c Sort Order cashbox__Sort_Order__c N/A N/A The sequence defining the order in which Billing Periods occur.

Basic

Billing_Plan_Period_Price__c Amount cashbox__Amount__c BillingPlanPrice amount The price amount for the specified Currency Code (or Token ID) for this specific Period of the Billing Plan.

Basic

Billing_Plan_Period_Price__c Billing Plan Period cashbox__Billing_Plan_Period__c N/A N/A Lookup to the Billing Plan Period for this object. Basic Billing_Plan_Period_Price__c Currency/Token cashbox__Currency_Token__c BillingPlanPrice currency_x The Currency Code or Token ID associated with this

specific Price. Basic

Billing_Plan_Period_Price__c Price List Name cashbox__Price_List_Name__c BillingPlanPrice priceListName NOT USED - This fields purpose has been replaced by the use of Merchant Data (custom name-value pairs)

Basic

Billing_Plan_Period_Price__c Price Type cashbox__Price_Type__c N/A N/A NOT USED - This fields purpose has been replaced by the use of Merchant Data (custom name-value pairs)

Basic

Cashbox_API_Setting__c Value Value_c N/A N/A Custom Setting field that defines which different API settings for Salesforce

Basic

CashBoxTriggers__c Not Run Trigger NotRunTrigger__c N/A N/A Custom setting to determine whether or not to make the Salesforce triggers disabled

Basic

Contact Address VID cashbox__VID__c N/A N/A NOT USED Basic Contact Customer ID cashbox__Customer_ID__c N/A N/A NOT USED Basic Credit__c Account cashbox__Account__c N/A N/A The Account to which the Credit has been granted. Basic Credit__c Credit

Amount(Deprecated) cashbox__Credit_Amount__c N/A N/A The current balance of the Credit. When initially granted

this will be the full amount of the Credit. As it is consumed within CashBox this value will update to show the remaining balance. NOTE: Once a particular Credit has been completely Consumed the record will be retained in Salesforce but the Amount will be 0.00.

Basic

Credit__c Credit Balance cashbox__Credit_Balance__c N/A N/A Rollup Summary field that calculates the sum of the Credit_History__c Amount __c

Basic

Credit__c Credit Currency cashbox__Credit_Currency__c CurrencyAmount currency_x Currency of the Credit Basic Credit__c Credit Description cashbox__Credit_Description__c CurrencyAmount description Description of the Credit Basic Credit__c Credit Granted Date cashbox__Credit_Granted_Date__c N/A N/A The Date that the Credit was granted. This is a rollup Basic

Page 45: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

45

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App summary field that pulls the Min Date for Action Type of Granted

Credit__c Credit Note cashbox__Credit_Note__c N/A N/A Text field that holds note details of the credit Basic Credit__c Credit Reason cashbox__Credit_Reason__c CurrencyAmount reason Text field to hold the Reason for the Credit Basic Credit__c Currency/Token cashbox__Currency_Token__c N/A N/A The Currency Code or Token ID associated with this

specific Price. Basic

Credit__c Last Modified Date cashbox__Last_Modified_Date__c N/A N/A Rollup Summary field that calculates the max timestamp for the credit history

Basic

Credit__c Original Credit Amount cashbox__Original_Credit_Amount__c N/A N/A Rollup Summary field that calculates the initial amount of the credit

Basic

Credit__c Purchase cashbox__Purchase__c N/A N/A The specific Purchase (AutoBill) to which the Credit has been granted. This field is blank for a specific Credit if it is issued directly at the Account-Level only.

Basic

Credit__c Type cashbox__Type__c N/A N/A Type of Credit, can be either Currency or Time-Based. Currency is the only value that is supported currently

Basic

Credit__c VID cashbox__VID__c CurrencyAmount VID The global identifier assigned to the account by CashBox. Used by the applications processes to uniquely identify the Credit. Note - all CashBox objects have a "VID" - which will be globally unique meaning no Credit will have the same VID as a Payment Method or a Transaction, so they can be truly used as a global ID.

Basic

Credit_History__c Action Type cashbox__Action_Type__c CreditEventLog type_x This holds the credit history action. The value for this field could be granted, consumed, revoked.

Basic

Credit_History__c Amount cashbox__Currency_Amount__c CreditEventLog timestamp This is the amount of the credit history action. Basic Credit_History__c Credit cashbox__Credit__c N/A N/A Master Detail Relationship to the Credit. Basic Credit_History__c Note cashbox__Note__c CreditEventLog note Note of the History event item. Basic Credit_History__c Timestamp cashbox__Timestamp__c CreditEventLog timestamp Timestamp of when the credit action took place Basic Data_Export_Entry__c Key cashbox__Key__c N/A N/A This is the Key that is used to do the data export to

cashbox. this value is typically the VID. Basic

Data_Export_Entry__c Key Type cashbox__Key_Type__c N/A N/A This is the type that is used in Parallel with the Key to determine how to synch to cashbox

Basic

Data_Export_Entry__c Log Timestamp cashbox__Log_Timestamp__c N/A N/A The timestamp for which the data export was initiated Basic Data_Export_Entry__c Message cashbox__Message__c N/A N/A The return message for the from the data export response Basic Data_Export_Entry__c Object cashbox__Object__c N/A N/A The type of object that is being exported to cashbox, this

value is the Cashbox Object name and not the Salesforce one.

Basic

Data_Export_Entry__c SOAP Id cashbox__SOAP_Id__c N/A N/A The soap id from the data export request. Basic Data_Export_Entry__c Status cashbox__Status__c N/A N/A The status of the export to cashbox Basic Data_Import_Log__c Beginning Of Time cashbox__Beginning_Of_Time__c N/A N/A This setting sets the initial timestamp for which your imports

start. This would usually be configured as part of your initial setup.

Basic

Data_Import_Log__c Import Exception Cleanup Job Id

cashbox__Import_Exception_Cleanup_JobId__c N/A N/A Job id for the automatic import exception job cleanup Basic

Data_Import_Log__c Max Import Period(Hours)

cashbox__Max_Import_Period_Hours__c N/A N/A Max Time that import should be run for. This setting is good for helping prevent timeout issues due to large periods being imported at once.

Basic

Data_Import_Log__c Next Extract End cashbox__Next_Extract_End__c N/A N/A The next End Date for the import period. If this value is null the import job will take the current time as the end date when the job runs

Basic

Data_Import_Log__c Next Extract Start cashbox__Next_Extract_Start__c N/A N/A The next Start Date for the import period. Basic Data_Import_Log__c Page Size cashbox__Page_Size__c N/A N/A Page size of the cashbox request Basic Data_Import_Object__c Enabled cashbox__Enabled__c N/A N/A Custom Setting field that denotes whether the import

process will import this object as part of the continues import job

Basic

Data_Import_Object__c Order cashbox__Order__c N/A N/A Custom Setting field that defines which order this object should be imported in the process.

Basic

Debug_Settings__c Propagation Enabled cashbox__Propagation_Enabled__c N/A N/A Custom setting field that determines whether to throw message from processing errors

Basic

Debug_Settings__c Trace Enabled cashbox__Trace_Enabled__c N/A N/A Custom setting field that determines whether or not to report to the Log__c object

Basic

Exception_Digest__c Admin Email cashbox__Admin_Email__c N/A N/A Email for which to send the exception digest to. Basic Exception_Item__c CashBox Exception Log cashbox__CashBox_Exception_Log__c N/A N/A The details of the Exception Digest log Basic Exception_Item__c Exception Digest cashbox__Exception_Digest__c N/A N/A Lookup to the Exception Digest Basic Future_Rebill__c Amount cashbox__Amount__c Transaction_x amount The expected charge Amount based upon the current Billing

Plan definition. Basic

Future_Rebill__c Purchase cashbox__Order__c N/A N/A The Purchase that owns this Future Billing. Basic

Page 46: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

46

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App Future_Rebill__c Rebill Date cashbox__Rebill_Date_Time__c Transaction_x timestamp The expected date of the Future Billing. Basic Future_Rebill__c Rebill Date

(Deprecated) cashbox__Rebill_Date__c Transaction_x timestamp The expected date of the Future Billing. Basic

HOA_Settings__c Value cashboxq2c__Value__c N/A N/A Custom Setting used for the HOA setup. Premium Import_Exception__c Message cashbox__Message__c N/A N/A Import Exception Message for the associated record Basic Import_Exception__c ReImporting cashbox__ReImporting__c N/A N/A Flag showing if the record is currently being reimported Basic Import_Exception__c SOAP Id cashbox__SOAP_Id__c N/A N/A SOAP Id for the request that error Basic Import_Exception__c VID cashbox__VID__c N/A N/A Vindicia Record ID for this import exception that occurred. Basic Import_Exception__c Vindicia Object Name cashbox__Vindicia_Object_Name__c N/A N/A The object for which an error occurred as part of the

processing Basic

Import_Log__c Errored? cashbox__Errored__c N/A N/A Flag highlighting if this import had erred. If this flag gets set it will manually need to be modified to allow the processing to continue. It will repeat until this has been unset. This is for situations that the error handling built in does not catch the error

Basic

Import_Log__c Log Timestamp cashbox__Log_Timestamp__c N/A N/A The timestamp of when the log was executed. Basic Import_Log__c Message cashbox__Message__c N/A N/A A message that was returned. This could be a derived

message with the list of the errors that came back as part of the processing

Basic

Import_Log__c Object Name cashbox__Object_Name__c N/A N/A The object that was requested. Rate Plan, Billing Plan, Refund, Credit, Autobill, Account, Transaction, Product are all options for this field

Basic

Import_Log__c Processed Page Size cashbox__Processed_Page_Size__c N/A N/A The size of what got processed out of the received page size. will always be equal or less than the requested page size

Basic

Import_Log__c Received Page Size cashbox__Received_Page_Size__c N/A N/A The pages size that was returned as part of the response back from cashbox

Basic

Import_Log__c Request Page Size cashbox__Requested_Page__c N/A N/A The page number for which is being requested. For large periods of time the number of pages will increase

Basic

Import_Log__c Requested Page # cashbox__Request_Page_Size__c N/A N/A The size of page requested as part of the soap request Basic Import_Log__c Return Code cashbox__ReturnCode__c N/A N/A The return code for the request made to cashbox. Basic Import_Log__c Return String cashbox__ReturnString__c N/A N/A The return string for the request made to cashbox Basic Import_Log__c Since cashbox__Since__c N/A N/A the start date period for which the request is trying make a

call to cashbox. Important for the FetchDeltaSince calls and FetchCreatedSince calls

Basic

Import_Log__c SOAP Id cashbox__SOAP_Id__c N/A N/A this is the resulting SOAP Id from the request made to cashbox

Basic

Import_Log__c To cashbox__To__c N/A N/A this the end date for the import period Basic Import_Log__c VID cashbox__VID__c N/A N/A Vindicia Record ID for this import request Basic Item__c Adhoc Product Name cashbox__Adhoc_Product_Name__c TransactionItem sku For "ad-hoc" products created on the fly when creating

stand-alone transactions, the SKU provided will be used for this alternate name field.

Basic

Item__c Current License Count cashbox__Current_License_Count__c N/A N/A if the AutoBIll item is license based, this will be updated as part of the usage summary

Basic

Item__c End Date cashbox__End_Date_Time__c AutoBillItem removedDate The effective End Date of the AutoBill Item or Transaction Item, if it has a planned end date.

Basic

Item__c End Date (Deprecated) cashbox__End_Date__c AutoBillItem removedDate The effective End Date of the AutoBill Item or Transaction Item, if it has a planned end date.

Basic

Item__c Number of Cycles cashbox__Number_of_Cycles__c AutoBillItem cycles The total number of Billing Cycles for which the Product is assigned to be effective on the AutoBill (only applies to AutoBill Purchases). This will be blank for Products that do not have a specified limit to the # of Cycles.

Basic

Item__c Price Basis cashbox__Price_Basis__c AutoBillItem priceBasis The "Price Basis" by which the AutoBill charges for this particular item. Possible values include: "Included" (the charge will be solely determined but the Billing Plan), "Added" (the base price of the Product will be added to the price of the Billing Plan), or "Rated" (the Product is a usage-based service which will be rated and billed in arrears according to its specified Rate Plan).

Basic

Item__c Price Override cashbox__Price__c AutoBillItem amount The price of the Product/Item that is to be added to the Billing Plan price (used when the Price Basis is Added).

Basic

Item__c Product cashbox__Product__c N/A N/A A link to the catalog version of the Product (if not an ad-hoc product).

Basic

Item__c Purchase cashbox__Order__c N/A N/A The Purchase by which the Product was purchased. Basic Item__c Quantity cashbox__Quantity__c AutoBillItem quantity The quantity of this line item Basic Item__c Rate Plan cashbox__Rate_Plan__c N/A N/A Lookup to the Rate Plan for this Autobill Line Item Basic Item__c Remaining Cycles cashbox__Remaining_Cycles__c AutoBillItem cyclesRemaining For items with a defined limit to the # of cycles they're Basic

Page 47: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

47

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App effective, this represents The remaining number of Billing Cycles for which the Product is to be effective on the AutoBill (only applies to AutoBill Purchases). This will be blank for Products that do not have a specified limit to the # of Cycles.

Item__c Sort Order cashbox__Sort_Order__c AutoBillItem index When multiple product items are present on a given AutoBill or Transaction, each is assigned an increasing integer "sort order" number starting at 0.

Basic

Item__c Start Date cashbox__Start_Date_Time__c AutoBillItem startDate The date in which the product/item became effective for the Purchase. Typically this will be the same as the Purchase Start Date (or Subscription Start Date), but for Products that were added to an existing AutoBill it may be different.

Basic

Item__c Start Date (Deprecated) cashbox__Start_Date__c AutoBillItem startDate The date in which the product/item became effective for the Purchase. Typically this will be the same as the Purchase Start Date (or Subscription Start Date), but for Products that were added to an existing AutoBill it may be different.

Basic

Item__c Vindicia Created Date cashbox__Vindicia_Created_Date_Time__c AutoBillItem addedDate The date for which this AutoBIll item was created in Cashbox

Basic

Item__c Vindicia Record ID cashbox__VID__c AutoBillItem VID The Vindicia Record ID assigned to this particular AutoBill Item

Basic

Log__c End cashbox__End__c N/A N/A The end time for the import period that causes this log entry Basic Log__c Message cashbox__Message__c N/A N/A The message returned as part of the response from the

import request Basic

Log__c Page cashbox__Page__c N/A N/A The requested page for which caused this Log Entry to be created

Basic

Log__c Return Code cashbox__Return_Code__c N/A N/A The return code from the request’s response Basic Log__c Return String cashbox__Return_String__c N/A N/A The return string from the request’s response Basic Log__c SOAP Id cashbox__SOAP_Id__c N/A N/A The SOAP Id for the request that was made that caused this

Log Entry Basic

Log__c Start cashbox__Start__c N/A N/A The start time for the import period that caused this log entry

Basic

Opportunity Subscription Start Date cashboxq2c__Subscription_Start_Date_Time__c AutoBill startTimestamp Premium Opportunity Convert to Purchase cashboxq2c__Convert_to_Purchase__c N/A N/A Flag used by application logic - indicates to certain app

processes that an Opportunity is ready for conversion into a live Purchase.

Premium

Opportunity Overwrite CashBox Account Shipping

cashboxq2c__Overwrite_CashBox_Account_Shipping__c

N/A N/A Flag indicating whether to overwrite the cashbox account shipping address

Premium

Opportunity Required Approval Level

cashboxq2c__Highest_Approval_Level__c N/A N/A The designate Role level required for approval of the Opportunity.

Premium

Opportunity Billing Plan cashboxq2c__Billing_Plan__c N/A N/A Lookup to the Billing Plan Premium Opportunity Approved cashboxq2c__Approved__c N/A N/A Flag indicating the Approval Status Premium Opportunity Subscription Start

Date(Deprecated) cashboxq2c__Subscription_Start_Date__c AutoBill startTimestamp Start Date for the subscription Premium

Opportunity # of Lines Requiring Approval

cashboxq2c__Num_of_Lines_Requiring_Approval__c

N/A N/A The number of products on the Opportunity requiring approval

Premium

Opportunity Quote Generated Timestamp

cashboxq2c__Quote_Generated_TimeStamp__c N/A N/A Date the quote was generated for this opportunity Premium

Opportunity Expected First Bill Date cashboxq2c__Expected_First_Bill_Date__c Autobill originalActivityDate The expected first bill date for this opportunity Premium Opportunity Auto Bill VID cashboxq2c__Auto_Bill_VID__c Autobill VID Once an AutoBill or Transaction (One-Time) has been

created as a result of this Opportunity - its VID will be recorded here.

Premium

Opportunity Ship To cashboxq2c__Ship_To__c N/A N/A Lookup to contact Premium Opportunity Merchant Autobill Id cashboxq2c__Merchant_Autobill_Id__c AutoBill merchantAutoBillId A merchant's unique identifier Premium Opportunity Affiliate ID cashboxq2c__Affiliate_ID__c AutoBill merchantAffiliateId Merchant's ID for the affiliate that submitted this AutoBill Premium Opportunity Required Approval

Process cashboxq2c__Highest_Approval_Process__c N/A N/A The relevant "Approval Process" name to be used for the

current approval requirements of this opportunity. Premium

Opportunity Quote Amount cashboxq2c__Quote_Amount__c Transaction amount The amount of the projected first bill for the currently configured Purchase. This will be overwritten each time "Create Quote" is used.

Premium

Opportunity Related Purchase cashboxq2c__Related_Purchase__c N/A N/A This will be the lookup to the purchase when the opportunity is converted to a purchase

Premium

Opportunity # of Line Items cashboxq2c__Num_of_Line_Items__c N/A N/A The number of products on the Opportunity Premium Opportunity FutureStartDate cashboxq2c__FutureStartDate__c N/A N/A Calculated formula field indicating that opportunity setup for

the future Premium

Opportunity First Bill Amount cashboxq2c__First_Bill_Amount__c Transaction amount The amount of the expected first bill amount Premium Opportunity Product Currency cashboxq2c__ProductCurrency__c N/A N/A The currency for which this purchase will be created. Premium Opportunity Billing Contact cashboxq2c__Customer__c N/A N/A The Customer/Account associated with the Opportunity Premium

Page 48: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

48

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App Opportunity Billing Currency Code cashboxq2c__Billing_Currency_Code__c Autobill currency_x The currency for the opportunity Premium Opportunity Subscription End

Date(Deprecated) cashboxq2c__Subscription_End_Date__c AutoBill endTimestamp The time till entitlements offered by this AutoBIll should be

considered valid Premium

Opportunity Subscription End Date cashboxq2c__Subscription_End_Date_Time__c AutoBill endTimestamp The time till entitlements offered by this AutoBIll should be considered valid

Premium

Opportunity Payment Method cashboxq2c__Payment_Method__c N/A N/A The particular Payment Method to be used for any Purchase resulting from this Opportunity. If not specified, CashBox will use the 'default' Payment Method on file for this Account -- if there is no valid active Payment Method defined, the Purchase will not complete and an error will be presented.

Premium

Opportunity Customer Autobill ID cashboxq2c__Customer_Autobill_ID__c AutoBill customerAutoBillName Customer-defined, optional name Premium Opportunity Affiliate Sub ID cashboxq2c__Affiliate_Sub_ID__c AutoBill merchantAffiliateSubId Merchant's sub-ID for the affiliate that submitted this

AutoBill Premium

Opportunity Approval Status cashboxq2c__Approval_Status__c N/A N/A Description of the Approval Status Premium Opportunity Quote Date cashboxq2c__Quote_Date__c Transaction timestamp The effective date and expected billing date for the first bill

for the currently configured Purchase. This will be overwritten each time "Create Quote" is used.

Premium

Opportunity Required Approver cashboxq2c__Required_Approver__c N/A N/A The specific user designated currently as the approver for this Opportunity.

Premium

Opportunity Start Date cashboxq2c__Start_Date__c AutoBill startTimestamp Start Date for the subscription Premium Opportunity Expected Renewal Date cashboxq2c__Expected_Renewal_Date__c Transaction timestamp Expected Renewal Date for this Opportunity Premium Opportunity_Product__c Related Purchased

Product cashboxq2c__Related_Purchased_Product__c N/A N/A A link to the formal Product definition (does not apply to

Taxes and other non-product items). Premium

Opportunity_Product__c Rate Plan cashboxq2c__Rate_Plan__c N/A N/A The Rate Plan used for this items metered rating. Premium Opportunity_Product__c Approval Status (mirror) cashboxq2c__Approval_Status_mirror__c N/A N/A Internal field used by application - Not for user display. Premium Opportunity_Product__c Approved Price cashboxq2c__Approved_Price__c N/A N/A The top price currently approved for offer on the line item.

Represents the top of the currently approved tier level. Premium

Opportunity_Product__c List Price cashboxq2c__List_Price__c N/A N/A The default or standard Price for the item. Premium Opportunity_Product__c Currency Code cashboxq2c__CurrencyCode__c N/A N/A Currency code for the opportunity product Premium Opportunity_Product__c Price Basis cashboxq2c__Price_Basis__c N/A N/A The rule governing how this item is priced (same definition

in CashBox). Added items are charged their "Added Price" in ADDITION to any charges from the Billing Plan; Included products are not charged individually - only the Billing Plan charges apply; Rated products are charged according to a Rate Plan (usage-based and licensed-based rated products).

Premium

Opportunity_Product__c Quantity cashboxq2c__License_Quantity__c TransactionItem quantity Applies only to license-based rated products -- used to denote how many licenses are purchased.

Premium

Opportunity_Product__c Added Price cashboxq2c__Sale_Price__c TransactionItem price The price to be charged for the line item in addition to any charges at the Billing Plan level - if using the "Added" Price Basis.

Premium

Opportunity_Product__c Approval Status cashboxq2c__Approval_Status__c N/A N/A Current Approval status of the individual line item. Premium Opportunity_Product__c Opportunity cashboxq2c__Opportunity__c N/A N/A Lookup to the Opportunity object Premium Opportunity_Product__c Approved cashboxq2c__Approved__c N/A N/A True/False indicator of approval at the line item level Premium Opportunity_Product__c Number of Cycles cashboxq2c__Number_of_Cycles__c N/A N/A The # of billing cycles for which the line item's product is

active on the AutoBill (starting from the first cycle). A '0' or blank indicates the product is active for the life of the AutoBill.

Premium

Opportunity_Product__c Edit Tier Pricing cashboxq2c__Edit_Price__c N/A N/A A link presented for RATED PRODUCTS that allows viewing and customizing of individual tier prices/rates.

Premium

Opportunity_Product__c Related Purchased Product

cashboxq2c__Related_Purchased_Product__c N/A N/A A link to the formal Product definition (does not apply to Taxes and other non-product items).

Premium

Opportunity_Product__c Process Label cashboxq2c__Process_Label__c N/A N/A Internal field used by application - Not for user display. Premium Opportunity_Product__c Replaced Purchased

Product cashboxq2c__ReplacedPurchasedProduct__c N/A N/A Field used for application processing of the Purchase Detail

History Premium

Opportunity_Product__c Approval Level cashboxq2c__Level__c N/A N/A The designated Role level for which the line item must receive approval.

Premium

Opportunity_Product__c Product cashboxq2c__Product__c N/A N/A Lookup to the Product Premium Order__c # of Successful

Transactions cashbox__Num_of_Payments_Received__c N/A N/A The current count of Transactions associated with this

Purchase that are in a "Captured" Status. Note: Refunded Transactions are not counted in this total.

Basic

Order__c Account cashbox__Account__c N/A N/A The Account to which the Purchase belongs. Basic Order__c Affiliate ID cashbox__Affiliate_ID__c Autobill merchantAffiliateId The "Affiliate ID" associated with this Purchase (from

CashBox) Basic

Order__c Affiliate Sub ID cashbox__Affiliate_Sub_ID__c Autobill merchantAffiliateSubId The "Affiliate 'Sub' ID" associated with this Purchase (from CashBox)

Basic

Page 49: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

49

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App Order__c AutoBill Age cashbox__AutoBill_Age__c N/A N/A The length of time (in days) since the Purchase (i.e. the

subscription or AutoBill) was started. This is stored as a text string in this field with a numerical-only value in "AutoBill Age (num)" for use in calculations.

Basic

Order__c AutoBill Age (num) cashbox__AutoBill_Age_num__c N/A N/A The length of time (in days) since the Purchase (i.e. the subscription or AutoBill) was started. This is stored as a numerical-only value with no specific indication of the time-units, which can be found in the text-version in "AutoBill Age" for use in display and communication.

Basic

Order__c AutoBill Duration (num) cashbox__AutoBill_Duration_num__c N/A N/A The overall length of the AutoBill's service as defined in its Billing Plan; in Days. For example, a non-indefinite annual plan will show as 365-days. This is stored as a numerical-only value with no specific indication of the time-units, which can be found in the text-version in "Plan Duration" for use in display and communication.

Basic

Order__c Billing Contact cashbox__Customer__c N/A N/A Lookup to Contact Basic Order__c Billing Day cashbox__Billing_Day__c Autobill billingDay The numerical day of the month designated as the standard

"Billing Day" for this AutoBill Purchase. NOTE: for plans with period lengths in Days this can change often and will represent the "next" billing day (i.e. a value of 21 indicates the 21st of the relevant month).

Basic

Order__c Billing Plan cashbox__Billing_Plan__c N/A N/A The Billing Plan currently in effect on this Purchase. This only applies to AutoBills, so will be blank for Purchases of Type "One-Time."

Basic

Order__c Billing Statement Identifier

cashbox__Billing_Statement_Identifier__c Autobill billingStatementIdentifier The Billing Statement Identifier string associated with this Purchase for use in template communications and downstream Payment Processors.

Basic

Order__c Cohort ID cashbox__Cohort_ID__c N/A N/A An application-assigned value representing the Month and Year in which the Customer signed up for the subscription - based upon the Start Date of the AutoBill/Purchase. All related Billings and Transactions will share this value so the "Cohort" analysis based on sign-up month can be performed easily.

Basic

Order__c Customer Purchase Name

cashbox__Customer_Order_Name__c Autobill customerAutoBillName Similar to the "Purchase Name" but this version is based upon the Merchant-specified name assigned to this Purchase - typically a Customer-facing identifier as opposed to the internal ID's used in the other version.

Basic

Order__c Entitlement End Date cashbox__Billing_End_Date_Time__c Autobill endTimestamp The date on which any Entitlements granted from this Purchase will end if there is no renewal payment made. This equates to the "AutoBill End Date" in CashBox. Note - Entitlements will end at midnight ending the indicated day.

Basic

Order__c Entitlement End Date (Deprecated)

cashbox__Billing_End_Date__c Autobill endTimestamp The date on which any Entitlements granted from this Purchase will end if there is no renewal payment made. This equates to the "AutoBill End Date" in CashBox. Note - Entitlements will end at midnight ending the indicated day.

Basic

Order__c Eradication Note cashbox__Eradication_Note__c N/A N/A The "Eradication Note" (if any) for the AutoBill or Transaction as defined in CashBox.

Basic

Order__c Is One-Time Purchase cashbox__IsOneTimePurchase__c N/A N/A Formula field calculating if this is a one-time purchase. Basic Order__c Merchant ID cashbox__Order_ID__c Autobill merchantAutoBillId The merchant-specified AutoBill or Transaction Identifier

from CashBox. Basic

Order__c Minimum Commitment cashbox__Minimum_Commitment__c Autobill minimumCommitment The minimum commitment time for the AutoBill as defined in CashBox

Basic

Order__c Net Revenue to Date cashbox__Order_Revenue__c N/A N/A The 'net' amount collected for this Purchase to-date. This is the sum of all Transaction Amounts for Transactions in "Captured" Status. Note: All refund amounts are included in the net revenue calculation. Ex. If a Transaction was captured for $10, and then it was refunded for $4, only $6 will be counted for Net Revenue.

Basic

Order__c Next Billing Amount cashbox__Next_Future_Billing_Amount__c Transaction amount The next billing amount Basic Order__c Next Billing Date cashbox__Next_Future_Billing_Date_Time__c Transaction timestamp The next billing date/time Basic Order__c Next Billing Date

(Deprecated) cashbox__Next_Future_Billing_Date__c Transaction timestamp The next billing date Basic

Order__c Next Transaction Bill Date(Deprecated)

cashbox__Next_Transaction_Billing_Date__c N/A N/A This is a version of "Next Transaction Billing Date" used for internal calculations. This field is not intended for use in reporting or display on a typical Page Layout.

Basic

Order__c Next Transaction Bill Date(Deprecated)

cashbox__Next_Billing_Date_Time__c N/A N/A Formula field that is now deprecated Basic

Order__c Next Transaction Bill cashbox__Next_Transaction_Billing_Date_Time__c N/A N/A Formula field that is now deprecated Basic

Page 50: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

50

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App Date(Deprecated)

Order__c Next Transaction Billing Date(Deprecated)

cashbox__Next_Billing_Date__c N/A N/A Formula field that is now deprecated Basic

Order__c Notify Before Expiration cashbox__Notify_Before_Expiration__c Autobill warnOnExpiration The "Notify Before Expiration" flag defined for this AutoBill in CashBox.

Basic

Order__c Payment Method cashbox__Payment_Method__c N/A N/A The specific Payment Method currently assigned to this Purchase.

Basic

Order__c Plan Duration cashbox__AutoBill_Duration__c N/A N/A The overall length of the AutoBill's service as defined in its Billing Plan; in Days. For example, a non-indefinite annual plan will show as 365-days. This is stored as a text string in this field with a numerical-only value in "AutoBill Duration (num)" for use in calculations.

Basic

Order__c Purchase Currency Code

cashbox__PurchaseCurrencyCode__c Autobill currency_x Currency code for the purchase Basic

Order__c Purchase Source cashbox__Purchase_Source__c N/A N/A NOT USED Basic Order__c Purchase Status cashbox__Status__c Autobill status The current status of the Purchase. This will correspond to

the API-level Status presented from CashBox (Active, Suspended, etc. ) rather than the AutoBill Status displayed in the CashBox web portal. For One-Time purchases, this will be representing the status of the one-time transaction at purchase; for AutoBills this will represent the current status of the AutoBill.

Basic

Order__c Source cashbox__Source__c N/A N/A NOT USED - This fields purpose has been replaced by the use of Merchant Data (custom name-value pairs)

Basic

Order__c Source IP Address cashbox__Source_IP_Address__c Autobill source The IP Address of the Customer as provided to CashBox when establishing the AutoBill or Transaction.

Basic

Order__c Statement Format cashbox__Statement_Format__c Autobill statementFormat The value of the field of the same name in CashBox. Basic Order__c Statement Offset cashbox__Statement_Offset__c Autobill statementOffset The value of the field of the same name in CashBox. Basic Order__c Statement Template ID cashbox__Statement_Template_ID__c Autobill statementTemplateId The value of the field of the same name in CashBox. Basic Order__c Subscription Start Date cashbox__Billing_Start_Date_Time__c Autobill startTimestamp The start-date of the subscription - corresponds to the

official sign-up or start of the AutoBill. Basic

Order__c Subscription Start Date (Deprecated)

cashbox__Billing_Start_Date__c Autobill startTimestamp The start-date of the subscription - corresponds to the official sign-up or start of the AutoBill.

Basic

Order__c Type cashbox__Type__c N/A N/A The Type of the Purchase: either AutoBill or One-Time. Basic Order__c Upgraded From cashbox__Upgraded_From__c Autobill upgradedFromVid For AutoBills where were created as the result of an

upgrade action on a prior AutoBill, the Merchant-Specified ID of that previous AutoBill is stored in this field.

Basic

Order__c Upgraded To cashbox__Upgraded_To__c Autobill upgradedToVid For AutoBills where were cancelled as the result of an upgrade action to a new AutoBill, the Merchant-Specified ID of that new AutoBill is stored in this field.

Basic

Order__c Vindicia Record ID cashbox__VID__c Autobill VID The Vindicia Record ID assigned to this particular AutoBill or Transaction.

Basic

Order_Entitlement__c Active cashbox__Active__c N/A N/A NOT USED. Checked code and we are not setting this anywhere and the value is not defaulted. Triggers would prevent you from updating this item as well.

Basic

Order_Entitlement__c Purchase cashbox__Order__c N/A N/A Lookup to the Related Purchase Basic Payment_Method__c Contact cashboxq2c__Contact__c N/A N/A NOT USED Premium Payment__c Billing Amount cashbox_Captured_Amount__c N/A N/A The total currency amount of the charges associated with

this Billing. Basic

Payment__c Billing Cycle cashbox_Billing_Cycle__c N/A N/A The numerical value representing the Billings place in the sequence of Billings for a specific Purchase (AutoBill). The first Billing for a Purchase will be Billing Cycle 0, the next will be Billing Cycle 1, and so on.

Basic

Payment__c Billing Plan Period End cashbox__Billing_Plan_Period_End_Date_Time__c Transaction servicePeriodEndDate The End date of the Billing Period covered by the charges on this Billing and its Transactions.

Basic

Payment__c Billing Plan Period End (Deprecated)

cashbox_Billing_Plan_Period_End_c Transaction servicePeriodEndDate The End date of the Billing Period covered by the charges on this Billing and its Transactions.

Basic

Payment__c Billing Plan Period Start cashbox__Billing_Plan_Period_Start_Date_Time__c

Transaction servicePeriodStartDate The Start date of the Billing Period covered by the charges on this Billing and its Transactions.

Basic

Payment__c Billing Plan Period Start (Deprecated)

cashbox_Billing_Plan_Period_Start_c Transaction servicePeriodStartDate The Start date of the Billing Period covered by the charges on this Billing and its Transactions.

Basic

Payment__c Billing Status cashbox__Status__c N/A N/A The current status of the Billing. "Cancelled" indicates the LATEST Transaction has failed and the Billing may or may not be waiting another retry depending on your merchant configuration in CashBox (you can use the Purchase Status to confirm whether the overall Purchase is still Active meaning there will be a retry or they are still in the grace

Basic

Page 51: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

51

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App period). "Captured" indicates the LATEST Transaction succeeded and the Billing is complete. "Refunded" indicates the LATEST Transaction succeeded and the Billing is complete but there has been a Refund processed against the Transaction.

Payment__c Last Transaction Date cashbox__Capture_Date__c N/A N/A The date of the LATEST Transaction associated with this Billing.

Basic

Payment__c Payment Method cashbox__Payment_Method__c N/A N/A The Payment Method used for the LATEST Transaction associated with this Billing.

Basic

Payment__c Purchase cashbox__Order__c N/A N/A The Purchase that owns this Billing. Basic Payment_Method__c Accepted Payment ID cashbox__Accepted_Payment_ID__c PaymentMethod merchantAcceptedPayment.paym

entId The merchant-specified Payment Method Identifier from CashBox for a method of type "Merchant Accepted Payment"

Basic

Payment_Method__c Account cashbox__Account__c N/A N/A The Account to which the Payment Method is assigned. Basic Payment_Method__c Account Holder Name cashbox__Account_Holder_Name__c PaymentMethod accountHolderName The "Account Holder Name" associated with the Payment

Method as defined in CashBox. Basic

Payment_Method__c Active cashbox__Active__c PaymentMethod active A true/false flag indicating whether this Payment Method is set to Active in CashBox

Basic

Payment_Method__c Allowed ECP Type cashbox__Allowed_ECP_Type__c PaymentMethod ecp.accountType The designated ECP Type from CashBox for a method of type "ECP"

Basic

Payment_Method__c Billing Address Name cashbox__Billing_Address_Name__c PaymentMethod billingAddress.name The "Billing Address Name" associated with the Payment Method's Billing Address as defined in CashBox.

Basic

Payment_Method__c Billing City cashbox__Billing_City__c PaymentMethod billngAddress.city The "Billing City" associated with the Payment Method's Billing Address as defined in CashBox.

Basic

Payment_Method__c Billing Country cashbox__Billing_Country__c PaymentMethod billngAddress.country The "Billing Country" associated with the Payment Method's Billing Address as defined in CashBox.

Basic

Payment_Method__c Billing Postal Code cashbox__Billing_Postal_Code__c PaymentMethod billngAddress.postalCode The "Billing Postal Code" associated with the Payment Method's Billing Address as defined in CashBox.

Basic

Payment_Method__c Billing State/Province cashbox__Billing_State_Province__c PaymentMethod billngAddress.district The "Billing State/Province" associated with the Payment Method's Billing Address as defined in CashBox.

Basic

Payment_Method__c Billing Street cashbox__Billing_Street__c PaymentMethod billngAddress.addr1 The "Billing Street" associated with the Payment Method's Billing Address as defined in CashBox.

Basic

Payment_Method__c Card Prefix cashbox__Card_Prefix__c PaymentMethod creditCard.bin The "Card Prefix" associated with the Payment Method's Billing Address as defined in CashBox.

Basic

Payment_Method__c Card Type cashbox__Card_Type__c PaymentMethod customerSpecifiedType The "Customer Specified Card Type" associated with the Payment Method as defined in CashBox (applies to Credit Card type).

Basic

Payment_Method__c Customer Description cashbox__Customer_Description__c PaymentMethod customerDescription The "Customer Specified Card Description" associated with the Payment Method as defined in CashBox (applies to Credit Card type).

Basic

Payment_Method__c Default Payment Method

cashbox__Default_Payment_Method__c N/A N/A A true/false flag indicating whether or not this Payment Method is considered the "Default" Payment Method for the Account. NOTE: This field’s value is automatically calculated by Salesforce using the same logic as CashBox by selecting a Payment Method when one is not provided for the Account.

Basic

Payment_Method__c Expiration Date cashbox__Expiration_Date__c PaymentMethod creditCard.expirationDate The "Expiration Date" associated with the Payment Method as defined in CashBox.

Basic

Payment_Method__c Fax cashbox__Fax__c PaymentMethod billingAddress.fax The "Fax" associated with the Payment Method's Billing Address as defined in CashBox.

Basic

Payment_Method__c Last 4 Digits cashbox__Last_4_Digits__c PaymentMethod ecp.lastDigits creditCard.lastDigits directDebit.lastDigits merchantAcceptedPayment.lastDigits

The "Last 4 Digits" associated with the Payment Method as defined in CashBox (applies only to specific Payment Method Types such as Credit Card and ECP).

Basic

Payment_Method__c Merchant Accepted Type

cashbox__Merchant_Accepted_Type__c PaymentMethod paymentType The type of payment accepted my merchant Basic

Payment_Method__c Payment Method ID cashbox__Payment_Method_ID__c PaymentMethod merchantPaymentMethodId The merchant-specified Payment Method Identifier from CashBox. As this is an optional field in CashBox the application does not treat it like a unique key within the Salesforce account, but it is provided so that it can be used as such if it fits your business.

Basic

Payment_Method__c PayPal Email cashbox__PayPal_Email__c PaymentMethod paypal.paypalEmail The Payer ID associated with this Payment Method (applies only to Type "PayPal")

Basic

Payment_Method__c PayPal Payer ID cashbox__PayPal_Payer_ID__c PaymentMethod paypal.payerId NOT USED - This fields purpose has been replaced by another field.

Basic

Payment_Method__c Permitted Transaction cashbox__Permitted_Transaction_Types__c PaymentMethod ecp.allowedTransactionType The designated Permitted Types from CashBox for a Basic

Page 52: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

52

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App Types method of type "ECP"

Payment_Method__c Phone cashbox__Phone__c PaymentMethod billingAddress.phone The "Phone" number associated with the Payment Method's Billing Address as defined in CashBox.

Basic

Payment_Method__c Sort Order cashbox__Sort_Order__c PaymentMethod sortOrder The Sort Order (order of precedence) assigned to this Payment Method in CashBox.

Basic

Payment_Method__c Type cashbox__Payment_Type__c PaymentMethod type_x The Payment Method Type as defined in CashBox. Basic Payment_Method__c Vindicia Record ID cashbox__VID__c PaymentMethod VID The Vindicia Record ID assigned to this particular Payment

Method. Basic

Payment_Transaction__c Account cashbox__Account__c N/A N/A Custom field that has a link back to the account Basic Payment_Transaction__c Account Id cashbox__AccountId__c N/A N/A Field used for setting formula field id for linking back to

account Basic

Payment_Transaction__c Account Name cashbox__Account_Name__c N/A N/A Field used for setting formula field name for linking back to account

Basic

Payment_Transaction__c Amount cashbox__Amount__c amount The total currency amount of the charges associated with this Transaction.

Basic

Payment_Transaction__c Available Refund Amount

cashbox__Available_Refund_Amount__c N/A N/A Calculated field that displays the available amount of refund available for this transaction

Basic

Payment_Transaction__c Billing cashbox__Payment__c N/A N/A The Billing to which this Transaction belongs. Basic Payment_Transaction__c Cohort ID cashbox__Cohort_ID__c N/A N/A An application-assigned value representing the Month and

Year in which the Customer signed up for the subscription - based upon the Start Date of the AutoBill/Purchase. All related Billings and Transactions will share this value so the "Cohort" analysis based on sign-up month can be performed easily. NOTE: On the Transaction, the Cohort ID is based on the Purchase NOT the Transaction's date.

Basic

Payment_Transaction__c Credited Amount cashbox__Credited_Amount__c N/A N/A Amount credited to this transaction Basic Payment_Transaction__c Currency Code cashbox__Currency_Code__c Transaction currency_x The Currency Code (or Token ID) associated with this

Transactions "Amount." Basic

Payment_Transaction__c Cycle # cashbox__Billing_Cycle__c N/A N/A A number representing for which cycle in the Billing Plan's 'life' this Transaction charges. One-Time Transactions will always have a cycle # of -1. For an AutoBill's Transaction, it will depend on how many successful cycles have completed - this also corresponds to the order of the Billing within the Purchase. Example: The cycle is counted from 0, so the first billing's Transaction for an AutoBill will be in Cycle 0, the second Billing's Transactions will be in Cycle 1, and so on.

Basic

Payment_Transaction__c Description cashbox__Description__c Transaction note NOT USED - This fields purpose has been replaced by the use of Merchant Data (custom name-value pairs)

Basic

Payment_Transaction__c Payment Method cashbox__Payment_Method__c N/A N/A The specific Payment Method used for this Transaction. Basic Payment_Transaction__c Purchase cashbox__Purchase__c N/A N/A Custom field that has a link back to the purchase Basic Payment_Transaction__c Purchase Id cashbox__PurchaseId__c N/A N/A Field used for setting formula field id for linking back to

purchase Basic

Payment_Transaction__c Purchase Name cashbox__Purchase_Name__c N/A N/A Field used for setting formula field name for linking back to purchase

Basic

Payment_Transaction__c Refunded Amount cashbox__Refunded_Amount__c N/A N/A Amount Refunded to the Account Basic Payment_Transaction__c Response Code cashbox__Response_Code__c TransactionStatus creditCardStatus.authCode

directDebitStatus.authCode ecpStatus.authCode payPalStatus.authCode

The Response Code returned from the Payment Processor for this Transaction.

Basic

Payment_Transaction__c Retry # cashbox__Retry_Number__c A number representing which attempt within a particular Billing this Transaction represents. One-Time Transactions will always have a Retry # of 0. For an AutoBill's Transaction, it will depend on how many failed Transactions have been processed for a given Billing within the Purchase. Example: The retry is counted from 0, so the Billing's first Transaction will be retry #0, the if that fails, the second Transaction will be retry #1, and so on.

Basic

Payment_Transaction__c Tax Exemptions cashbox__Tax_Exemptions__c TaxExemption exemptionId The "Tax Exemptions" defined for this Transaction. Basic Payment_Transaction__c Transaction Date cashbox__Transaction_Date__c Transaction_x timestamp The date/time at which the Transaction was initiated. Basic Payment_Transaction__c Transaction ID cashbox__Transaction_ID__c Transaction_x merchantTransactionId The unique identifier for the Transaction. This is determined

either through the automatic Transaction naming for CashBox-generated transactions (or one-time Transactions for which no alternate ID was provided), or by the Merchant Transaction Identifier specified when the one-time Transaction was created.

Basic

Payment_Transaction__c Transaction Status cashbox__Status__c TransactionStatus status The latest status (disposition) for this Transaction. NOTE: Basic

Page 53: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

53

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App only Transactions in Status "Captured" "Canceled" or "Refunded" are imported into Salesforce.

Payment_Transaction__c Vindicia Record ID cashbox__VID__c Transaction VID The Vindicia Record ID assigned to this particular AutoBill or Transaction.

Basic

Payment_Transaction__c Vindicia Timestamp cashbox__Vindicia_Timestamp__c Transaction_x timestamp The date/time at which the Transaction was initiated. Basic PaymentMethodTypeSettings__c

Allowed Payment Method Type

N/A N/A Premium

Price Book CurrencyCode cashbox__CurrencyCode__c Currency code for the Pricebook. Used to handle multi currency for the Q2C

Basic

Price Book IsCashbox cashbox__IsCashbox__c N/A N/A Checkbox field used to hold whether Pricebook is Cashbox Basic Product Billing Statement

Identifier cashbox__Billing_Statement_Identifier__c Product billingStatementIdentifier The Billing Statement Identifier string associated with this

Billing Plan for use in template communications and downstream Payment Processors.

Basic

Product Bundled Products cashbox__Bundled_Products__c Product bundledProducts Listing of all the Bundle Products for this Product Basic Product Default Billing Plan cashbox__Default_Billing_Plan__c N/A N/A Lookup to Billing Plan Basic Product Default Rate Plan cashbox__Default_Rate_Plan__c N/A N/A Lookup to Rate Plan Basic Product End of Life cashbox__End_of_Life__c Product endOfLifeTimestamp Time at which product will go to end of life Basic Product Product ID cashbox__Product_ID__c Product merchantProductId Merchant's unique ID for this item (e.g., SKU). Basic Product Tax Classification cashbox__Tax_Classification__c Product taxClassification Product type for tax purposes as string Basic Product Vindicia Record ID cashbox__VID__c Product VID Vindicia's Globally Unique Identifier (GUID) for this object Basic Product_Entitlement__c Active cashbox__Active__c N/A N/A Indicator for whether or not the Entitlement is currently

Active for this Product. Basic

Product_Entitlement__c Description cashbox__Description__c MerchantEntitlementId description The "Description" of the Entitlement as defined within CashBox

Basic

Product_Entitlement__c Product cashbox__Product__c N/A N/A The specific Product (SKU) granting this Entitlement. Basic ProductCurrency__c IsActive cashbox__IsActive__c N/A N/A This is a field used for the multi currency of cashbox

purchases Basic

Purchase__c Subscription End Date cashboxq2c__Billing_End_Date__c N/A N/A NOT USED Premium PurchaseDetailHistory__c Action cashbox__Action__c AutoBillItemHistoryRecord action The type of AutoBIll item history action that occurred Basic PurchaseDetailHistory__c Action Date cashbox__ActionDate__c AutoBillItemHistoryRecord actionDate The date the history action occurred Basic PurchaseDetailHistory__c Billing Plan cashbox__BillingPlan__c N/A N/A The associated Billing Plan for Bill plan history changes Basic PurchaseDetailHistory__c Effective Date cashbox__EffectiveDate__c AutoBillItemHistoryRecord effectiveDate The effective date of the history action Basic PurchaseDetailHistory__c End Date cashbox__EndDate__c AutoBillItemHistoryRecord autoBillItem.removedDate The end date of the AutoBIll item that the history action is

associated to Basic

PurchaseDetailHistory__c Price cashbox__Price__c AutoBillItemHistoryRecord autoBillItem.amount The price of the AutoBIll item related to this history action Basic PurchaseDetailHistory__c Product cashbox__Product__c N/A N/A The associated product of the auto bill item that this history

record is associated to Basic

PurchaseDetailHistory__c Purchase cashbox__Purchase__c N/A N/A Lookup to the related purchase for this history action Basic PurchaseDetailHistory__c Quantity cashbox__Quantity__c AutoBillItemHistoryRecord autoBillItem.quantity The quantity amount related to the line item for this history

action Basic

PurchaseDetailHistory__c Replaced By cashbox__ReplacedBy__c N/A N/A This is Lookup to the History Line item that replaced this item. This is for an add/remove scenario as part of the AutoBIll modify

Basic

PurchaseDetailHistory__c Replaced By Purchase History

cashbox__ReplacedByPurchaseHistory__c N/A N/A Lookup to another ReplacedByPurchaseHistory item. This is for when the item was replaced was then replaced by another item.

Basic

PurchaseDetailHistory__c Start Date cashbox__StartDate__c AutoBillItemHistoryRecord autoBillItem.startDate Start Date of the AutoBill Item for this history line item Basic PurchaseDetailHistory__c VID cashbox__VID__c N/A N/A NOT USED Basic Rate_Plan__c Opportunity Product cashboxq2c__Opportunity_Product__c N/A N/A The Opportunity Product that the Rate plan is associated to. Premium Rate_Plan__c Process Label cashboxq2c__Process_Label__c N/A N/A Field used for internal processing of rate plan approvals Premium Rate_Plan__c Level cashboxq2c__Level__c N/A N/A Field used for internal processing of rate plan approvals Premium Rate_Tier__c Private cashboxq2c__Private__c N/A N/a Used to determine if this Rate Tier is related to a private

rate plan created in cashbox Premium

Rate_Tier__c Process Label cashboxq2c__Process_Label__c N/A N/A Field used for internal processing of rate plan approvals Premium Rate_Tier__c Level cashboxq2c__Level__c N/A N/A Level of the tier Premium Rate_Plan__c # of Tiers Requiring

Approval cashbox__Num_of_Tiers_Requiring_Approval__c N/A N/A Calculated field that looks at the Rate Tiers who don’t have

a status of Approved Basic

Rate_Plan__c Approval Status cashbox__Approval_Status__c N/A N/A Calculated field that looks at the number of Rate Tiers requiring approval

Basic

Rate_Plan__c Charge Option cashbox__Charge_Option__c N/A N/A Flat Fee or Per Unit Basic Rate_Plan__c Description cashbox__Description__c RatePlan description An optional description for this RatePlan. Basic Rate_Plan__c Included Units cashbox__Included_Units__c RatePlan includedUnits NUM units included as part of the plan. Basic Rate_Plan__c Maximum Fee cashbox__Maximum_Fee__c RatePlan maximumFee Prices of the MAXIMUM charge for this plan, per billing

cycle Basic

Rate_Plan__c Merchant Rate Plan ID cashbox__Merchant_Rate_Plan_ID__c RatePlan merchantRatePlanId Merchant's unique ID for this RatePlan. Basic

Page 54: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

54

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App Rate_Plan__c Minimum Fee cashbox__Minimum_Fee__c RatePlan minimumFee Prices of the minimum charge for this plan, per billing cycle Basic Rate_Plan__c Model cashbox__Model__c RatePlan ratePlanModel Usage Based or Licensed Based Basic Rate_Plan__c Multiply Rated Units By cashbox__Multiply_Rated_Units_By__c RatePlan multiplyRatedUnitsBy refers to the scheme whereby this RatePlan uses its tiers to

calculate a price. Basic

Rate_Plan__c Parent AutoBill cashbox__Parent_AutoBill__c N/A N/A For private purchases this is the purchase that is related to the specific rate plan

Basic

Rate_Plan__c Private cashbox__Private__c N/A N/A Checkbox determining whether this is a private rate plan per a specific purchase

Basic

Rate_Plan__c Rated Unit cashbox__Rated_Unit__c RatePlan ratedUnit.nameSingular The unit that this RatePlan refers to. Basic Rate_Plan__c Rounding Decimals cashbox__Rounding_Decimals__c RatePlan roundingDecimals Number of digits to round unit return values in Basic Rate_Plan__c Tier Pricing Option cashbox__Tier_Pricing_Option__c N/A N/A Multiply units by each tier or Multiply units by highest tier

pick list values Basic

Rate_Plan__c VID cashbox__VID__c RatePlan vid Vindicia Record ID for this rate plan Basic Rate_Tier__c Approval Status cashbox__Approval_Status__c N/A N/A Approval Status for this Rate Tier Basic Rate_Tier__c Approved cashbox__Approved__c N/A N/A Check box determining if this Rate Tier is approved or not Basic Rate_Tier__c Approved Max Qty cashbox__Approved_Max_Qty__c N/A N/A The max quantity for this Rate Tier that is approved Basic Rate_Tier__c Approved Min Qty cashbox__Approved_Min_Qty__c N/A N/A The min quantity for this Rate Tier that is approved Basic Rate_Tier__c Charge Customer cashbox__Charge_Customer__c N/A N/A Flat Fee or Per Unit Basic Rate_Tier__c Minimum Qty cashbox__Minimum_Qty__c RatePlanTier beginsAtLevel The minimum value for this tier. Basic Rate_Tier__c Rate Plan cashbox__Rate_Plan__c N/A N/A Lookup to the Rate Plan object Basic Refund__c Amount cashbox__Refund_Amount__c Refund amount The amount of the refund Basic Refund__c Status cashbox__Status__c Refund status Status of the refund Basic Refund__c Timestamp cashbox__Timestamp__c Refund timestamp Timestamp of when the refund occurred Basic Refund__c Transaction cashbox__Transaction__c N/A N/A Lookup to the related transaction of the refund Basic Refund__c VID cashbox__VID__c Refund VID The Vindicia Record ID assigned to this particular Refund Basic Refund_Item__c Amount cashbox__Amount__c RefundItem amount The amount of refund for the refund line item Basic Refund_Item__c Description cashbox__Description__c RefundItem description The description of the refund line item Basic Refund_Item__c Refund cashbox__Refund__c N/A N/A Lookup to the refund object that the refund item is related Basic Refund_Item__c Tax Amount cashbox__Tax_Amount__c N/A N/A Tax amount refunded as part of this refund item Basic Refund_Item__c Refund VID Index

External cashbox__Refund_VID_Index_External__c N/A N/A Internal Id used to determine if refund item has been

processed already

Refund_Item__c Transaction Item cashbox__Transaction_Item__c N/A N/A Lookup to the related transaction item for this refund item Basic Service_Defaults__c Value cashboxq2c__Value__c N/A N/A Custom Setting to store the default settings for the

Salesforce app Premium

Tax_Exemption__c Account cashbox__Account__c N/A N/A Lookup to Account Basic Tax_Exemption__c Active cashbox__Active__c TaxExemption active checkbox indicating if tax exemption is active Basic Tax_Exemption__c ExemptionId cashbox__ExemptionId__c TaxExemption exemptionId ID that documents the exemption Basic Tax_Exemption__c Region cashbox__Region__c TaxExemption region Region the exemption applies to Basic Tier_Price__c Private cashboxq2c__Private__c N/A N/A Checkbox indicating if this is a private tier price. Premium Tier_Price__c Approval Status cashbox__Approval_Status__c N/A N/A Approval Status for the Tier Price Basic Tier_Price__c Approved cashbox__Approved__c N/A N/A Checkbox indicating if Tier Price is approved Basic Tier_Price__c Approved Price cashbox__Approved_Price__c N/A N/A The Approved Price for this Tier Price Basic Tier_Price__c Currency ISO Code cashbox__Currency_ISO_Code__c RatePlanPrice currency_x Currency code for the Tier Price Basic Tier_Price__c Level cashbox__Level__c N/A N/A Approval Threshold Level Basic Tier_Price__c List Price cashbox__List_Price__c RatePlanPrice amount List Price for this Tier Price Basic Tier_Price__c Process Label cashbox__Process_Label__c N/A N/A Internal field used by application - Not for user display. Basic Tier_Price__c Rate Tier cashbox__Rate_Tier__c N/A N/A This is a lookup to the Rate Tier Object that this tier price

belongs to Basic

Tier_Price__c Sale Price cashbox__Sale_Price__c RatePlanPrice amount Price for this Tier Basic Tier_Price__c Token cashbox__Token__c N/A N/A NOT USED Basic Token_Price__c Amount cashbox__Amount__c N/A N/A NOT USED Basic Token_Price__c Product cashbox__Product__c N/A N/A NOT USED Basic Token_Price__c Token cashbox__Token__c N/A N/A NOT USED Basic Token_Price__c Unique Key cashbox__Unique_Key__c N/A N/A NOT USED Basic Transaction_Product__c Amount cashbox__Amount__c N/A N/A Calculated field that takes the price * the quantity Basic Transaction_Product__c Description cashbox__Description__c TransactionITem name The description of the product provided on the Transaction

(if a One-Time Transaction) or defined for the Product in CashBox (for AutoBill Items).

Basic

Transaction_Product__c Discount Amount cashbox__Discount_Amount__c TransactionItem discount This is a field that keeps the discount amount for a transaction item

Basic

Transaction_Product__c Index cashbox__Index__c TransactionItem indexNumber This is a field that stores the index number of the transaction item. This helps for processing of the refunds

Basic

Transaction_Product__c Price cashbox__Price__c TransactionItem price The price or charge amount for the specific line item (in the Currency Code defined on the Transaction).

Basic

Transaction_Product__c Quantity cashbox__Quantity__c TransactionItem quantity The quantity of the specific line item purchased by this Basic

Page 55: CashBox for Salesforce User Guide 8 - Vindicia CashBox (Premium) users can create two types of purchases: One-Time and Subscription. To create a new purchase in Salesforce, create

CashBox for Salesforce 14.0 User Guide

55

SFDC Parent Object SFDC Filed Name SFDC API Name Cashbox Object Cashbox Field Description App Transaction. NOTE: The Price represents the unit price (not shown) multiplied by this quantity field to result in the total price.

Transaction_Product__c Tax Amount cashbox__Tax_Amount__c TaxItem amount Amount of tax for this transaction line item Basic Transaction_Product__c Tax Classification cashbox__Tax_Classification__c TransactionItem taxClassification The "Tax Classification" for this Product as defined in

CashBox Basic

Transaction_Product__c Transaction cashbox__Payment_Transaction__c N/A N/A The Transaction for which these items are associated. Basic Usage_Summary__c Account cashbox__Account__c N/A N/A Lookup to the Account object for this usage summary. Basic Usage_Summary__c Autobill Item Id cashbox__Autobill_Item_Id__c Event merchantAutoBillItemId Merchant's unique ID for this Event. Basic Usage_Summary__c Autobill Item VID cashbox__Autobill_Item_VID__c Event autobillItemVid The Autobill Item VID for this usage summary Basic Usage_Summary__c Billed Rated Unit Total cashbox__Billed_Rated_Unit_Total__c Event amount Bill rated Unit total amount Basic Usage_Summary__c Event Count cashbox__Event_Count__c N/A N/A Count of Events that make up this usage summary Basic Usage_Summary__c Product cashbox__Product__c N/A N/A Lookup to the related product for this usage summary Basic Usage_Summary__c Purchase cashbox__Purchase__c N/A N/A Lookup to the related purchase for this usage summary. Basic Usage_Summary__c Purchased Product cashbox__Purchased_Product__c N/A N/A Lookup to the related purchased product for this usage

summary. Basic

Usage_Summary__c Rate Plan cashbox__Rated_Unit__c N/A N/A The unfilled rated unit total Basic Usage_Summary__c Rated Unit cashbox__Rate_Plan__c N/A N/A Lookup to the related rate plan for this usage summary Basic Usage_Summary__c Unbilled Rated Unit

Total cashbox__Unbilled_Rated_Unit_Total__c Event amount The unfilled rated unit total Basic

Vindicia_Field_Mapping__c Salesforce Field API Name

cashbox__Salesforce_Field_API_Name__c N/A N/A This is the Salesforce API Field that we want to map for the name value pairs

Basic

Vindicia_Field_Mapping__c Salesforce Object API Name

cashbox__Salesforce_Object_API_Name__c N/A N/A This is the Salesforce API Object Name for the object that we want to setup for the name value pair mappings

Basic

Vindicia_Field_Mapping__c Salesforce Object Label cashbox__Salesforce_Object_Label__c N/A N/A This is the display name of the Salesforce object. Basic Vindicia_Field_Mapping__c Vindicia Field Name cashbox__Vindicia_Field_Name__c N/A N/A This is the field in the Vindicia Object that you want to

set/get for the Name Value Pairs Basic

Vindicia_Field_Mapping__c Vindicia Object Name cashbox__Vindicia_Object_Name__c N/A N/A This is the Vindicia Object that you want to map the Name Value Pairs for

Basic