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
...
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 |
...
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 Settomgs 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)
...
Field Label | API Name | Data Type | Required | Default value | Possible values | Description |
---|---|---|---|---|---|---|
isviewable | isviewable__c | Picklist | YES | 1 | 0 1 | Define if a rateplan can be seen in the V4 |
Subscription Rate Plan Fields (Non-Indexed)
...
This field is used for limitations and usage calculation.
its purpose is to define which bookingChannelId from the v4 is attached to the rateplan.
This value is then used to idenfy reservation source in the v4.
Amendment Fields (Non-indexed
...
This field identifies an amendment from the v4
Usually it is the current version with "d" prefix
...
Identify the destination invoice owner id.
We can't read the destination owner id from Zuora query so we need to have a duplicate field for that
...
Identify the previous invoice owner id.
We can't read the previous owner id from Zuora query so we need to have a duplicate field for that
...
Define Billing Periods
Customize Billing Periods
Tourisoft Sàrl:
- Month (default)
- Quarter
- Semi-Annual
- Annual
all Tourisoft Sàrl products are to be defined prioritarily in monthly, as customers are required to pay monthly fees. The quarter, semi-annual, annual are active for specific products, for swiss clients until direct debit is made available. Some African customers also may optionally benefit from this as they have high banking fees and very slow and complicated banking transactions.
Tourisoft GmbH:
- Month (default)
Customize Billing Day
Default from Customer Account
Customize Billing Period Start Days
1st of the month
Customize List Price Base
Billing period
Batch
Bill runs
Charge types
Go to Settings > Billing > Enable Charge Types / Models
Check all charge models
UOM
Go to Settomgs > Billing > Customize Unit of Measures
...
c | Picklist | YES | 1 | 0 1 | Define if a rateplan can be seen in the V4 |
Subscription Rate Plan Fields (Non-Indexed)
Field Label | API Name | Data Type | Required | Default value | Possible values | Description |
---|---|---|---|---|---|---|
bookingChannelId | bookingChannelId__c | Text (5) | This field is used for limitations and usage calculation. its purpose is to define which bookingChannelId from the v4 is attached to the rateplan. This value is then used to idenfy reservation source in the v4. |
Amendment Fields (Non-indexed
Field Label | API Name | Data Type | Required | Default value | Possible values | Description |
---|---|---|---|---|---|---|
AmendmentVersionId | AmendmentVersionId__c | Text (15) | This field identifies an amendment from the v4 Usually it is the current version with "d" prefix | |||
NumberOfAmendments | NumberOfAmendments__c | Text (5) | This field identifies how many amendment were sent together | |||
DestinationInvoiceOwnerId | DestinationInvoiceOwnerId__c | Text (32) | Identify the destination invoice owner id. We can't read the destination owner id from Zuora query so we need to have a duplicate field for that | |||
OldInvoiceOwnerId | OldInvoiceOwnerId__c | Text (32) | Identify the previous invoice owner id. We can't read the previous owner id from Zuora query so we need to have a duplicate field for that | |||
AmendmentNumber | AmendmentNumber__c | Text (5) | This field identifies the amendment position in the group of amendment |
Define Billing Periods
Customize Billing Periods
Tourisoft Sàrl:
- Month (default)
- Quarter
- Semi-Annual
- Annual
all Tourisoft Sàrl products are to be defined prioritarily in monthly, as customers are required to pay monthly fees. The quarter, semi-annual, annual are active for specific products, for swiss clients until direct debit is made available. Some African customers also may optionally benefit from this as they have high banking fees and very slow and complicated banking transactions.
Tourisoft GmbH:
- Month (default)
Customize Billing Day
Default from Customer Account
Customize Billing Period Start Days
1st of the month
Customize List Price Base
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)? | Yes |
Bill usage charges for partial month (with monthly based billing periods)? | No |
Bill usage charges for partial week (with weekly based billing periods)? | Yes |
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: | One Tax Item |
Define Numbering and SKU Formats
Account Number Prefix | A |
SKU Prefix | SKU- |
Subscription Number Prefix | A-S |
Charge Number Prefix | C- |
Amendment Number Prefix | A-AM |
Enable Charge Types / Models
Enable Charge Types
|
Enable Charge Models
|
Manage Invoice Rules and Templates
Invoice 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
Batch
Bill runs
Charge types
Go to Settings > Billing > Enable Charge Types / Models
Check all charge models
Payment terms
Go to Settings > Billing > Customize Payment Terms
...