This page explains the different steps to configure a new Zuora tenant.
General information
Zuora has 2 datacenters :
EU and US
Hotel-Spider CH is hosted in the US Datacenter
Hotel-Spider DE is hosted in the EU Datacenter
We use the REST interface. Previously the code was based on SOAP but it is not available in the EU Datacenter !
The REST documentation can be found at https://www.zuora.com/developer/api-reference/
REST endpoints
...
We authentify the system using the HTTP Headers apiAccessKeyId and apiSecretAccessKey.
Prequired
An access to the Zuora extranet with a user that has administrator role.
Note : If we want to use the same email on different tenants, we need to use an "alias". Example : firstname.lastname+de@hotel-spider.com
Every steps in this page supposes you are logged as an administrator in the corresponding Zuora extranet.
Make sure Zuora has activated all same modules as our Swiss account. Example : Owner Transfer Amendment
Data synchronisation
API User
User role
Go to Settings > Administation > Manage User Roles
Add new role :
IP Restriction
Add the staging and production IP
User API
Go to Settings > Administration > Manage Users
Click on Add single user.
For the user email, user an alias with a + :
example : dev+germany@hotel-spider.ch
For the work email, do not add the +alias
Store password and secret in Lastpass !
DO NOT ENABLE TWO-FACTOR AUTH!
To setup the password, you need to allow tempoarly your current IP for API USERS or you won't be able to set the passsword!
Security Policies
go to Settings > Administration > Setting Security Policies
Billing Settings
Default Subscription Settings
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Customize Units Of Measure (UOM)
Go to Settings > Billing > Customize Unit of Measures
Carefull to not add any space or tabulation !
...
Active
...
Name
...
Displayed As
...
DecimalPlaces
...
Rounding Mode
...
Usage Log File Label
YES |
...
Booking Channels
...
Booking Channels
...
0
...
Up
...
Booking Channels
YES |
...
Rooms
...
Rooms
...
0
...
Up
...
Rooms
YES |
...
Additional Booking Channels
...
Additional Booking Channels
...
0
...
Up
...
Additional Booking Channels
YES |
...
Room Stay Amount
...
Room Stay Amount
...
2
...
Up
...
Room Stay Amount
YES |
...
Reservation Amount
...
Reservation Amount
...
2
...
Up
...
Reservation Amount
YES |
...
FAX A4 Page
...
FAX A4 Page
...
0
...
Up
...
FAX A4 Page
YES |
...
Reservations
...
Reservation Count
...
0
...
Up
...
Reservation Count
YES |
...
Callback
...
Callback
...
0
...
Up
...
Callback
YES |
...
SMS
...
SMS
...
0
...
Up
...
SMS
Customize Currencies
Go to Settings > Billing > Customize Currencies
Tourisoft Sàrl:
- CHF (default)
- EUR
Tourisoft GmbH:
- EUR (default)
Manage Custom Fields
Go to Settings > Billing > Manage Custom Fields
Note: when configuring the fields, This page explains the different steps to configure a new Zuora tenant.
General information
Zuora has 2 datacenters :
EU and US
Hotel-Spider CH is hosted in the US Datacenter
Hotel-Spider DE is hosted in the EU Datacenter
We use the REST interface. Previously the code was based on SOAP but it is not available in the EU Datacenter !
The REST documentation can be found at https://www.zuora.com/developer/api-reference/
REST endpoints
Tenant | base endpoint | Extranet |
---|---|---|
US Production | https://rest.zuora.com | https://www.zuora.com/ |
US API Sandbox | https://rest.apisandbox.zuora.com | https://apisandbox.zuora.com |
EU Production | https://rest.eu.zuora.com | https://eu.zuora.com |
EU Sandbox | https://rest.sandbox.eu.zuora.com | https://sandbox.eu.zuora.com |
We authentify the system using the HTTP Headers apiAccessKeyId and apiSecretAccessKey.
Prequired
An access to the Zuora extranet with a user that has administrator role.
Note : If we want to use the same email on different tenants, we need to use an "alias". Example : firstname.lastname+de@hotel-spider.com
Every steps in this page supposes you are logged as an administrator in the corresponding Zuora extranet.
Make sure Zuora has activated all same modules as our Swiss account. Example : Owner Transfer Amendment
Data synchronisation
API User
User role
Go to Settings > Administation > Manage User Roles
Add new role :
IP Restriction
Add the staging and production IP
User API
Go to Settings > Administration > Manage Users
Click on Add single user.
For the user email, user an alias with a + :
example : dev+germany@hotel-spider.ch
For the work email, do not add the +alias
Store password and secret in Lastpass !
DO NOT ENABLE TWO-FACTOR AUTH!
To setup the password, you need to allow tempoarly your current IP for API USERS or you won't be able to set the passsword!
Security Policies
go to Settings > Administration > Setting Security Policies
Billing Settings
Default Subscription Settings
Default Term Type | Termed |
Default Initial Term (months) | 12 |
Default Renewal Term (months) | 12 |
Default Subscriptions to Auto-Renew? | Yes |
Require Customer Acceptance of Orders? | No |
Require Service Activation of Orders? | No |
Enable Subscriptions to be Invoiced Separately? | Yes |
Enable Automatic Price Change when Subscriptions are Renewed? | No |
Enable subscription auto-renew when there's no product in subscription? | No |
Subscription Auto Renew Job Type | System Default |
Customize Units Of Measure (UOM)
Go to Settings > Billing > Customize Unit of Measures
Carefull to not add any space or tabulation !
Active | Name | Displayed As | DecimalPlaces | Rounding Mode | Usage Log File Label | |
---|---|---|---|---|---|---|
| Booking Channels | Booking Channels | 0 | Up | Booking Channels | |
| Rooms | Rooms | 0 | Up | Rooms | |
| Additional Booking Channels | Additional Booking Channels | 0 | Up | Additional Booking Channels | |
| Room Stay Amount | Room Stay Amount | 2 | Up | Room Stay Amount | |
| Reservation Amount | Reservation Amount | 2 | Up | Reservation Amount | |
| FAX A4 Page | FAX A4 Page | 0 | Up | FAX A4 Page | |
| Reservations | Reservation Count | 0 | Up | Reservation Count | |
| Callback | Callback | 0 | Up | Callback | |
| SMS | SMS | 0 | Up | SMS |
Customize Currencies
Go to Settings > Billing > Customize Currencies
Tourisoft Sàrl:
- CHF (default)
- EUR
Tourisoft GmbH:
- EUR (default)
Manage Custom Fields
Go to Settings > Billing > Manage Custom Fields
Note: when configuring the fields, DO NOT ADD the __c at the end, Zuora will do it after saving.
...
Billing period
Billing Rules
Enable credit back for removing or canceling one time charges? | Yes |
Bill recurring charges for partial month (with monthly based billing periods)? | No |
Bill recurring charges for partial week (with weekly based billing periods)? | No |
Bill usage charges for partial month (with monthly based billing periods)? | No |
Bill usage charges for partial week (with weekly based billing periods)? | No |
When prorating a month, assume 30 days in a month or use actual days? | Use actual number of days |
When prorating periods greater than a month, prorate by month first, or by day? | Prorate by month first |
Support bill run auto-post? | Yes |
Default bill run to auto-post? | No |
Include invoices with negative totals in the Account Balance (included associated Debit Memos)? | Yes |
Include usage from child accounts when billing? | No |
How should errors be handled when generating multiple invoices for a single account via bill run? | Terminate processing of all invoices |
Preserve snapshot of bill-to and sold-to contacts when billing documents are posted? | No |
Invoice Past End-of-Term when Auto-Renew is OFF? | Yes: deprecated |
Invoice Past End-of-Term when Auto-Renew is ON? | Yes: deprecated |
Calculate taxes using information from Customer Account of: | Invoice owner |
Zuora Tax rounding rule for inclusive tax calculation | Round net amount |
When service period of an invoice item crosses multiple tax rate period, it will generate: | Multiple Tax Items |
...
Enable Charge Types / Models
Enable Charge Types
|
Enable Charge Models
|
Manage Billing Document Configuration
Manage Invoice Rules and Templates
Go to Settings > Billing > Manage Invoice Rules and Templates
The templates are setup in the following way:
- Per tenant (different template for Sàrl vs. GmbH)
- template for Hotels
- template for Whitelabels
- Per language:
- Sàrl:
- EN (default)
- DE
- ES
- FR
- NL
- GmbH:
- DE
- Sàrl:
To modify a template, click on the template name to download the existing word file (make sure to save a copy of the original and save the modified version under the latest version number, i.e. _v6). A folder with all templates exists under C:\Tourisoft\Accounting and Finance - General\Zuora. Make sure to save latest modifications there as backup.
Add the corresponding templates by clicking on "edit", select the template and save it. Use the preview function with existing customer data (to reflect reality) to make sure the latest modifications do not return errors.
The templates IDs will then need to be extracted from this page. Click on show ID:
Refer to the database section to store the template IDs in the v4.
Invoice prefix & Numbering
Go to Settings > Billing > Prefix & Numbering
Tourisoft Sàrl: INV
Tourisoft GmbH: RE
Customize Payment terms
Go to Settings > Billing > Customize Payment Terms
Add and activate the following payments : net10 and net30. (do not write Net30 !!!)
As per request of certain customers, net0 has been added (upon receipt)
Setup Taxation Code
use the import file (CSV) TaxRates_Import_File.csv
One separate file for each tenant
Tourisoft Sàrl:
- Swiss VAT (7.7%) - as of 01.01.2018 - insert 0.077 in column G under Switzerland
Tourisoft GmbH:
- German VAT (19%) - insert 0.19 in column G under Germany
Payment Settings
Customize Payment Methods
Define the payment methods that your organization accepts
...
ACH
...
Cash
...
Check
...
Credit Card
...
PayPal
...
Wire Transfer
...
Debit Card
...
CC Reference Transaction
...
Bank Transfer
...
Other
...
. Click on show ID:
Refer to the database section to store the template IDs in the v4.
Invoice prefix & Numbering
Go to Settings > Billing > Prefix & Numbering
Tourisoft Sàrl: INV
Tourisoft GmbH: RE
Customize Payment terms
Go to Settings > Billing > Customize Payment Terms
Add and activate the following payments : net10 and net30. (do not write Net30 !!!)
As per request of certain customers, net0 has been added (upon receipt)
Setup Taxation Code
use the import file (CSV) TaxRates_Import_File.csv
One separate file for each tenant
Tourisoft Sàrl:
- Swiss VAT (7.7%) - as of 01.01.2018 - insert 0.077 in column G under Switzerland
Tourisoft GmbH:
- German VAT (19%) - insert 0.19 in column G under Germany
Payment Settings
Customize Payment Methods
Define the payment methods that your organization accepts
Active | Name | Accounting Code | ||||||||||||||||||||
| Accounting Codes for Payments and Refunds can be configured inFinance Settings: Configure Accounting Codes. |
Payment Gateways
Tourisoft Sàrl:
Name | Gateway | Active | Actions |
---|---|---|---|
Adyen Gateway | Adyen | ||
My Hateway | Test Gateway | ||
AdyenCHF | Adyen |
At Adyen, specific API user accounts must be created and connected with to Zuora (to create Adyen doc)
Tourisoft Gmbh (to be completed)
Setup profiles, Notifications and Email Templates
define as needed (to develop)
Configure Payment Retry Rules
Enable the functionality.
A good standard is 2 retries per 24 hours interval
Setup Payment Method Updater
not used at the moment
Setup Hosted Pages
not used at the moment
Manage Custom Fields
No Payment custom fields at the moment
Configure Reason Codes
By default all active for the moment. To be developed
Finance Settings
Manage Custom Fields
no finance custom fields at the moment
Configure Aging Balance Settings
Bucket | Name | From (days past due) | To (days past due) | |
---|---|---|---|---|
1 | ||||
2 | ||||
3 | ||||
4 | ||||
5 |
Configure Accounting Codes
Make sure each item has the corresponding debit/ credit accounting code. Very specific to the situation
Configure Accounting Rules
Accounting Rules
Allow blank Accounting Codes | ||
Allow Subscription and Amendments to be created in a closed Accounting Period | ||
Allow Usage to be created in a closed Accounting Period | ||
Allow Revenue Schedules to have negative amounts in the Open-Ended Accounting Period |
Setup Profiles, Notifications and Email Templates
setup accordingly (for finance email by default)
Set Revenue Automation Start Date
Enable once revenue recognition may be started (make sure all settings are set-up)
Configure Revenue Event Types
|
Manage Revenue Recognition Rules
Revenue Recognition Rule | Recognition Model | Active | Actions | ||
---|---|---|---|---|---|
Billing - Monthly recognition over time | [Edit] [Deactivate] | ||||
Billing - Full recognition upon invoicing | [Edit] [Deactivate] |
To be elaborated as we connect to potential ERPs?
Configure Segments
Segments
Object | Field | Segment Name | System ID | Actions |
---|---|---|---|---|
Account | Market__c | Account Market | AccountMarket__s | [Edit] [Remove] |
Additional Configurations
Discount segment value | ||
Invoice owner segment value | ||
Revenue owner segment value |
Configure GL Segmentation Rules
by default AccountMarketSegment
to be furhter developped
Manage Chart of Accounts
Accounting Code Name | Accounting Code Type | Active | Actions |
---|---|---|---|
Accounts Receivable | Assets: Accounts Receivable | ||
Bank | Assets: Cash | ||
Cash | Assets: Cash | ||
Credit Card | Assets: Cash | ||
Customer Cash on Account | Liabilities: Customer Cash on Account | ||
Deferred Revenue | Liabilities: Deferred Revenue | ||
Sales Tax Payable | Liabilities: Sales Tax Payable | ||
Callback Authentication Revenue | Revenue: Sales Revenue | ||
Central Reservation System Revenue | Revenue: Sales Revenue | ||
Direct Subscription Revenue | Revenue: Sales Revenue | ||
Discounts | Revenue: Sales Discounts | ||
FAX Notification Revenue | Revenue: Sales Revenue | ||
Negotiated Contracts Revenues | Revenue: Sales Revenue | ||
SMS Authentication Revenue | Revenue: Sales Revenue | ||
White Label Revenue | Revenue: Sales Revenue | ||
Write Off | Expenses: Bad Debt |
Batch
Bill runs
Charge types
...