Emersion - User contributions [en]

Payment Plans V2

2018-05-30T23:48:13Z

CMichaels:

= Payment Plans =

This suite of articles is exclusively written for the optional module of Payment Plans that is offered ''in addition'' to the standard Emersion offering for an additional fee. '''This is not related to the payment plans functionality that is available in the standard Emersion offering'''.

If you are interested in subscribing to Payment plans V2 or any of our additional modules, please raise a new sales ticket in the [http://support.emersion.com.au Emerson Support Portal].

== Overview ==
Payment plans are used to transfer a customer's debt into a repayment process. Payment Plans can be set with a complete flexible and customisable payment arrangement and handles both regular and off-cycle payments. Users can also customise the number of payments, the amount per payment and payment period length.

=== Prerequisites ===

The following prerequisites apply in order to use payment plans.

# The service provider must use a credit card or direct debit payment gateway facility integrated with Emersion so that payments are automatically deducted from customers.
# The customer must have an automated payment method enabled. If the customer's payment method is not set and the user attempts to create a payment plan, the system will take the user to the '''Customer > Payment Methods''' screen and prompt the user to configure an automated payment method.
# Payment plans are invoice-based and can only be made for '''approved''' invoices with an amount owing. A single payment plan can be created spanning multiple invoices with unpaid amounts owing.
# Service providers must have an automated payment gateway configured.
# Disputed invoices cannot be part of a payment plan. Invoices with a dispute are required to be resolved before including it with a payment plan.

== Service Provider Global Default Settings ==

The following default settings can be used to define the behaviour of all payment plans for a service provider. Emersion can set or adjust these for you upon request.

* Days Retry - If a scheduled payment is unable to be collected for any reason (e.g. insufficient funds or expired card), the system will record this as a failed transaction attempt. This setting defines for how many days the system will retry taking the payment. If the payment attempt continues to fail by the time the limit is exhausted, the payment plan will automatically be cancelled and the amount remaining will be added to the customer's account

== Creating Payment Plans ==

To create and configure a payment plan, see the article on [[Payment_Plans_V2/Create_Payment_Plan | creating and configuring a payment plan]].

== Payment Plan Purchase Statuses ==

The statuses of a payment plan and their definition are below.

* '''Active''' - The payment plan is currently in progress.
* '''Complete''' - The payment plan is complete and the customer has made all payments owing
* '''Cancelled''' - The payment plan has been cancelled by a user or because the payment was unable to be collected.

== Viewing All Payment Plans ==
You can view a list of all payment plans via the following path. Payment plans cannot be created from this page.

Nav: '''Finance > Accounts Receivable > Payment Plans'''

A list of Payment Plans will be displayed. You can use the search fields to retrieve a list of payment plans:

* based on status
* for a customer by searching on the name or account ID.

[[file: finance-payment-plans-list.png]]

Open any payment plan by clicking the ID.

[[file: finance-payment-plan-open.png]]

== Payment Plan V2 Events ==

Four notification events are available to use with the payment plans module. You will need to set up templates for each event and '''enable''' them before they can be used. The events are:

* Payment plan has been created
* Payment plan transaction has failed
* Payment plan has been completed
* Payment plan has been cancelled

= See Also =
* [[Events|Events]]
* [[SystemEvents/Templates | Event Templates]]

Payment Plans V2

2018-05-30T23:47:41Z

CMichaels:

= Payment Plans =

This suite of articles is exclusively written for the optional module of Payment Plans that is offered ''in addition'' to the standard Emersion offering for an additional fee. '''This is not related to the payment plans functionality that is available in the standard Emersion offering'''.

If you are interested in subscribing to Payment plans V2 or any of our additional modules, please raise a new sales ticket in the [http://support.emersion.com.au Emerson Support Portal].

== Overview ==
Payment plans are used to transfer a customer's debt into a repayment process. Payment Plans can be set with a complete flexible and customisable payment arrangement and handles both regular and off-cycle payments. Users can also customise the number of payments, the amount per payment and payment period length.

=== Prerequisites ===

The following prerequisites apply in order to use payment plans.

# The service provider must use a credit card or direct debit payment gateway facility integrated with Emersion so that payments are automatically deducted from customers.
# The customer must have an automated payment method enabled. If the customer's payment method is not set and the user attempts to create a payment plan, the system will take the user to the '''Customer > Payment Methods''' screen and prompt the user to configure an automated payment method.
# Payment plans are invoice-based and can only be made for '''approved''' invoices with an amount owing. A single payment plan can be created spanning multiple invoices with unpaid amounts owing.
# Service providers must have an automated payment gateway configured.
# Disputed invoices cannot be part of a payment plan. Invoices with a dispute are required to be resolved before including it with a payment plan.

== Service Provider Global Default Settings ==

The following default settings can be used to define the behaviour of all payment plans for a service provider. Emersion can set or adjust these for you upon request.

* Days Retry - If a scheduled payment is unable to be collected for any reason (e.g. insufficient funds or expired card), the system will record this as a failed transaction attempt. This setting defines for how many days the system will retry taking the payment. If the payment attempt continues to fail by the time the limit is exhausted, the payment plan will automatically be cancelled and the amount remaining will be added to the customer's account

== Creating Payment Plans ==

To create and configure a payment plan, see the article on [[/Payment_Plans_V2/Create_Payment_Plan | creating and configuring a payment plan]].

== Payment Plan Purchase Statuses ==

The statuses of a payment plan and their definition are below.

* '''Active''' - The payment plan is currently in progress.
* '''Complete''' - The payment plan is complete and the customer has made all payments owing
* '''Cancelled''' - The payment plan has been cancelled by a user or because the payment was unable to be collected.

== Viewing All Payment Plans ==
You can view a list of all payment plans via the following path. Payment plans cannot be created from this page.

Nav: '''Finance > Accounts Receivable > Payment Plans'''

A list of Payment Plans will be displayed. You can use the search fields to retrieve a list of payment plans:

* based on status
* for a customer by searching on the name or account ID.

[[file: finance-payment-plans-list.png]]

Open any payment plan by clicking the ID.

[[file: finance-payment-plan-open.png]]

== Payment Plan V2 Events ==

Four notification events are available to use with the payment plans module. You will need to set up templates for each event and '''enable''' them before they can be used. The events are:

* Payment plan has been created
* Payment plan transaction has failed
* Payment plan has been completed
* Payment plan has been cancelled

= See Also =
* [[Events|Events]]
* [[SystemEvents/Templates | Event Templates]]

API

2018-02-12T01:37:45Z

CMichaels: /* Testing APIs */

{{DISPLAYTITLE:SOAP APIs}}
= Overview =

Emersion provides programmatic access to your organisation’s information using simple, powerful and secure application programming interfaces. Most APIs have been created as a result of collaborative efforts with our clients. Emersion is happy to consider extending or add new functionality on a case by case basis.

The Emersion SOAP API lets you integrate applications that can create, retrieve, update records managed by Emersion. Records such as accounts, services, package and service plans and other objects. With more than 70 different calls with the numbers predicted to climb, SOAP API also lets you to maintain passwords, perform searches and much more. You can use the SOAP API with any programming language that supports Web services.

Access to the APIs is via subscription only. For a quote to fit your requirements, please raise a Quote Request ('QR') ticket in the Emersion Support Portal or contact our Sales department.

API calls are broken into sets with set up and monthly access / usage fees applying per set.

There are two authentication methods Emersion currently used to provide access to the APIs.

* '''SSL certificate''' - Emersion users authentication via SSL certificate to perform administrative functions
* '''Username / Password Authentication''' - End users of can authenticate via a username and password to perform end user tasks. This can be used to build custom interfaces, and give end users the ability to retrieve their information and self-manage their accounts such as via smart phones apps.

== Testing APIs ==
Emersion does not provide a sandbox environment for APIs. To gain experience and guidance on the operations contained within an API, [[https://confluence.emersion.com/display/EKB/Testing+the+APIs+using+SoapUI |refer to this article]].

== Use Case Scenarios ==
These articles aim to assist developers understand various workflows and corresponding dependencies when using the APIs to perform tasks for a process.

* [[API/UseCases/ServiceOrders| Onboarding a new customer & ordering services]]

== Provider Based API Functionality (Certificate Based) ==
Fees may apply to have these configured, activated and maintained. If you are interested in subscribing to an optional module, please raise a new sales ticket by email to sales@emersion.com.au

For clarification on what is covered in your contract please contact Emersion.

== Security and Access Controls ==
To integrate with Emersion’s API Framework, clients will need to implement a SOAP client that utilises an SSL certificate as security.
The SSL certificates for provider-based APIs are provided by Emersion.

=== Provider-level APIs ===
For Production, use; https://external.emersion.com.au/
For UAT, use; https://uat1-external.emersion.com.au/

=== End-User APIs ===
Please contact the Emersion Sales department for the URLs to use for end user APIs.

= APIs for Service Providers =
These APIs use an SSL certificate to authenticate.

* [[API/Minimal|Minimal - Basic introductory methods]]
* [[API/Reference|Reference data for use within API calls]]

== Advanced APIs for Service Providers ==
* [[API/Account|Account - Account based methods]]
* [[API/RetailServices|Retail services - User based information including payment integration]]

== Customer Signup APIs for Service Providers ==
* [[API/Services|Services - Service centric based methods]]
* [[API/Orders|Orders - Order based methods]]

== Products APIs ==
* [[API/Products|Products - Product based methods]]

== Package Plan APIs ==
* [[API/Plans|Plans - Package plan based methods]]

== End User Portal APIs ==
* [[API/UserPortal|User Portal based methods]]

== Service Category-Specific APIs ==
* [[API/AAPT|AAPT Specific Integration functions]]

= End User APIs =
These APIs use a username and password to authenticate.

* [[API/EndUser|End User API]]

= Code Samples =
You can use these samples as a starting point in you implementation.

Please note that certificate files are placeholders.

They need to be replaced by real certificates to make the code work.

* [[Media:Api_Sample_C_Sharp.zip|C#]]

API

2018-02-12T01:34:33Z

CMichaels: /* Testing APIs */

{{DISPLAYTITLE:SOAP APIs}}
= Overview =

Emersion provides programmatic access to your organisation’s information using simple, powerful and secure application programming interfaces. Most APIs have been created as a result of collaborative efforts with our clients. Emersion is happy to consider extending or add new functionality on a case by case basis.

The Emersion SOAP API lets you integrate applications that can create, retrieve, update records managed by Emersion. Records such as accounts, services, package and service plans and other objects. With more than 70 different calls with the numbers predicted to climb, SOAP API also lets you to maintain passwords, perform searches and much more. You can use the SOAP API with any programming language that supports Web services.

Access to the APIs is via subscription only. For a quote to fit your requirements, please raise a Quote Request ('QR') ticket in the Emersion Support Portal or contact our Sales department.

API calls are broken into sets with set up and monthly access / usage fees applying per set.

There are two authentication methods Emersion currently used to provide access to the APIs.

* '''SSL certificate''' - Emersion users authentication via SSL certificate to perform administrative functions
* '''Username / Password Authentication''' - End users of can authenticate via a username and password to perform end user tasks. This can be used to build custom interfaces, and give end users the ability to retrieve their information and self-manage their accounts such as via smart phones apps.

== Testing APIs ==
Emersion does not provide a sandbox environment for APIs. To gain experience and guidance on the operations contained within an API, [[https://confluence.emersion.com/display/EKB/Testing+the+APIs+using+SoapUI|refer to this article]].

== Use Case Scenarios ==
These articles aim to assist developers understand various workflows and corresponding dependencies when using the APIs to perform tasks for a process.

* [[API/UseCases/ServiceOrders| Onboarding a new customer & ordering services]]

== Provider Based API Functionality (Certificate Based) ==
Fees may apply to have these configured, activated and maintained. If you are interested in subscribing to an optional module, please raise a new sales ticket by email to sales@emersion.com.au

For clarification on what is covered in your contract please contact Emersion.

== Security and Access Controls ==
To integrate with Emersion’s API Framework, clients will need to implement a SOAP client that utilises an SSL certificate as security.
The SSL certificates for provider-based APIs are provided by Emersion.

=== Provider-level APIs ===
For Production, use; https://external.emersion.com.au/
For UAT, use; https://uat1-external.emersion.com.au/

=== End-User APIs ===
Please contact the Emersion Sales department for the URLs to use for end user APIs.

= APIs for Service Providers =
These APIs use an SSL certificate to authenticate.

* [[API/Minimal|Minimal - Basic introductory methods]]
* [[API/Reference|Reference data for use within API calls]]

== Advanced APIs for Service Providers ==
* [[API/Account|Account - Account based methods]]
* [[API/RetailServices|Retail services - User based information including payment integration]]

== Customer Signup APIs for Service Providers ==
* [[API/Services|Services - Service centric based methods]]
* [[API/Orders|Orders - Order based methods]]

== Products APIs ==
* [[API/Products|Products - Product based methods]]

== Package Plan APIs ==
* [[API/Plans|Plans - Package plan based methods]]

== End User Portal APIs ==
* [[API/UserPortal|User Portal based methods]]

== Service Category-Specific APIs ==
* [[API/AAPT|AAPT Specific Integration functions]]

= End User APIs =
These APIs use a username and password to authenticate.

* [[API/EndUser|End User API]]

= Code Samples =
You can use these samples as a starting point in you implementation.

Please note that certificate files are placeholders.

They need to be replaced by real certificates to make the code work.

* [[Media:Api_Sample_C_Sharp.zip|C#]]

PackagePlans/Advanced/Product Order Map

2017-12-06T23:52:02Z

CMichaels:

This feature provides the ability for service providers to offer products inside an order for a service. Using this feature can give you suggestive selling options like the examples below.

A new modem, or choice of modems can be offered along with new ADSL orders.
Offer a selection of phone cases and other accessories to go with a new mobile service order.
You decide to give a $10 gift card to customers who order a service in the month of July.
Offer a discounted 12 month maintenance contract to any customer who purchases from you business grade internet.

The options for grouping products and services together is as endless as your imagination. To configure the system to offer products within an order you will need to:

* Store these items you are offering in the [[Products]] module.
* Map the package plan and the product via the '''Package Plan > Product Order Map''' tab
* Ensure all plans and products are saleable

Once your products and packages are mapped, then the ordering process will include them no matter where the order originates from (Cumulus or the [[End_User_Portal_and_Customer_Sign_Up_Portal | Sign up Portal]]). Please note this is an inclusive list that says what products _can_ be made available, it isn't a list which then _forces_ each of these to be sold with the service. For further information on how this process works and how to configure the Product Order Map of a package plan, please see the below video.

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">https://wiki.emersion.com/wiki/media/productMapping.mp4</mediaplayer>

Emersion Videos

2017-12-06T23:51:49Z

CMichaels:

== Introductory Videos ==

{|class="wikitable"
! style="text-align:left;" |Category
! style="text-align:left;" |Name
! style="text-align:left;" |Description
! style="text-align:left;" |Audience
|-

|General
|[[Emersion System Overview]]
|This video will take you through a high level look of Emersion as a platform, and a look through the customer details section within.
|All users
|-

|Accounts
|[[Account/ServiceProviderAccountCreation|Creating a Retail Service Provider]]
|Set up a new service provider under your wholesale account in Cumulus
|Wholesale Service Providers
|-

|Packages & Plans
|[[Plan Definition Overview and Creation Walk Through]]
|This video will introduce you to each of the basic elements required to create a saleable package within the Emersion eco-system. This covers Packages, Service Plans, Rate Cards, Product Rate Cards and Bolt Ons.
|Product managers, staff responsible for plan configuration
|-

|Packages & Plans
|[[PackagePlans/LinkingPackageAndServicePlans|Managing your Package Catalogue]]
|How to manage a package catalogue so your downstream/retail service providers can use the plans you sell them.
|Wholesale Service Providers
|-

|Ordering Services
|[[Services/Orders/NewOrder|Ordering a Service]]
|How to use Emersion to add a new service.
|All users
|-

|Ordering Services
|[[Services/Orders/Address-based_Service_Qualification|Address based ordering]]
|If you have access to Emersion's Address based ordering platform, you have the ability to have Emersion import geographical locations into the system for you, and assign what services are accessible against them.
|Systems Administrators
|-

|Packages & Plans
|[[PackageSubscriptions/Chains|Using Package Chains]]
|How to use Package Chains to give discounts to a specific customer. Discounts for either access fees or usage can be given to a single service, or for a package.
|All Users
|-

|User Management
|[[Basic Permissions]]
|How to create and manage basic permission sets, and apply them to users.
|Systems Administrators
|-

|Customer management
|[[Main Page/Provisioning/BulkSuspend/Telstra|Bulk suspend & unsuspend]]
|How to suspend and unsuspend services in Emersion in bulk. This will place limitations and restrictions on a customer's service. This is only available for Telstra Mobile.
|Systems Administrators
|-

|Products
|[[Products|Importing an inventory]]
|If you have been given the ability to manage your inventory, you may need to use the bulk upload feature.
|Systems Administrators
|-

|Finance
|[[InvoiceCardlineManagement|Managing invoices and cardlines]]
|How to manage invoices and cardlines - relevant for you billing your customers and, if applicable, your downstream service providers billing theirs.
|Accounts staff, Finance users
|-

|Finance
|[[Bulk_Imports|Payment Import]]
|How to import payments into Emersio using the Bulk Import function. This allows you to import payment details received from external sources, e.g. BPAY etc
|Accounts staff, Finance users
|-

|Products
|[[PackagePlans/Advanced/Product Order Map|Mapping Products]]
|In order for products to be sold along with subscription-based services, they must be linked together. This guide hows you how to map products to package plans so that subscription based services and products can be sold together in bundles or packages.
|Systems Administrators
|-
|Events
|[[Introduction_to_Events_Video|Introduction to Events]]
|This video will introduce you to Events in Emersion, and how Events work within the rest of the Emersion system.
|All users
|-
|Agent Management
|[[Agent_Management|Agent Management]]
|This video will introduce you to the Agents module in Emersion. It covers concepts related to Agents in Emersion and steps through the end-to-end set up of an Agent in Cumulus.
|Retail Service Providers, users who have access to create and maintain Agents
|-
|Xero Integration
|[[Integrations/Xero|Xero Integration]]
|This video will introduce you to the xero integration with Emersion and provide a guide on how to configure the system with your Xero application.
|-
|}

Agent Management

2017-12-06T23:41:34Z

CMichaels:

== Agents and Agent Management ==

The Agents module (Agent Management module) provides for a way for Agents (or other parties) to place orders for products and services on behalf of a Service Provider, without giving them a login to the Service Provider's account in Emersion. This module is tightly integrated with the [[Commissions|Commissions module]], although it is not mandatory to subscribe to Commissions.

Service Providers with Agent Management will set up each Agency with their own instance of Cumulus, under which individuals who work for that Agency can be given their own staff account. From here, the Agent can place orders on behalf of the Service Provider and manage that client. An Agent, depending on preferences, can be granted access to entire customer base of the Service Provider, limited access to some customers, or be restricted to only customers that they create. These access privileges are controlled by the powerful and flexible [[Account/Account_Groups|Account Groups]] feature in Emersion allowing for granular control over which Agents can see and edit customers and customer information.

The Service provider retains the ownership of that client and can see, process and manage customers and orders created by the Agent. If Commissions is enabled, the Service Provider can view and process commissions made for orders placed by it's Agents.

=== Agents Overview ===

Agents, or staff of agencies, that undertake sales activities on behalf of a service provider are implemented through a specific set of accounts, org units and roles organised & configured in a way that allows information to be shared appropriately across Emersion’s multi-tier hierarchy.

The structure of the set up is represented in the following diagram.

[[file:Agent-Hierarchy.png]]

Once the Agents module is enabled for your Service Provider account, you will be required to configure the module for your use and create an Agent account for your existing Agents. Please watch the training video below to assist you set up and configure Agents.

== Agents Module Video Training ==

Need training in Agents? This 20 minute video tutorial will:

* introduce you to the Agents module in Emersion
* covers concepts related to Agents in Emersion
* steps through the end-to-end set up of an Agent in Cumulus
* gives a look at the Agent's view in Cumulus.

<mediaplayer MWPlayerConfig="MyCustomConfig" height="800" width="1200">https://wiki.emersion.com/wiki/media/agent-management.mp4</mediaplayer>

== Managing Agents (Optional) ==

Managing Agents also have an Account Group added to the configuration. When properly configured, this account group will:

1. Govern which end user customers the Agent can access

2. Add new customers created by the Agent to the account group automatically.

NB 1. If a Service Provider is happy for an Agent to be able to view all end users, no account group needs to exist.

NB 2. If a Service Provider wants to use Account Groups to limit access to Agents, the following needs to be done for each Agent:

1. Create a new account group. For each agent, you will need an account group.

* Set the account group as a '''security''' group, then set ''Allow Some'' as the '''group access code'''.
* Add any customers the Agent should be able to access to the new account group.
* Add the Organisation Unit of the Agent to the account group.

More information on account groups can be found [[Account/Account_Groups|at this article]]

= See Also =
* [[Commissions|Commissions]]
* [[Account/Account_Groups|Account Groups]]
* [[Signup/Populating Signup Addresses|Pre-populate the address in the Sign Up Portal based on an Agent]]

InvoiceCardlineManagement

2017-12-06T23:40:55Z

CMichaels:

==Invoice Cardline Management==

'''Note: For a brief video on pending cardlines and the manage invoice section, please see the bottom of this article!'''

Cardlines are the individual charges, credits, or items that are presented on customer invoices, such as service fees, usage, products etc. A cardline may either summarise or itemise a service’s usage records as applicable to the specific service type. The Billing and Rating engine creates cardlines automatically, based on package plan’s and service plan’s setup fees, access fees, service usage, service features, bolt-ons and other service fees and equipment. In addition, cardlines are created by the system for product purchases and installment plans. Cardlines can also be manually created for ad hoc charges.

----
Cardlines are the items related to charges and credits that are presented on customer invoices.
----

===Pending Invoice Cardlines===

Pending invoice cardlines are cardlines that have been created against an account for charges and credits (e.g. purchases, package fees, plan fees etc), but have not yet been included on, or allocated to, an invoice. The Billing and Rating engine creates pending cardlines throughout the billing period, based on the attributes of the package plans and accounts (such as pro-rata, billing in advance/arrears, align package period to account period etc).

Pending cardlines are also created when a charge or credit is raised when there is an existing pending Invoice against the account (e.g. when a product purchase is made after the bill run but before the pending invoice was approved). Pending cardlines may be also created manually against an account for ad hoc charges or credits using the [[InvoicePendingLedgerCardlines|''Pending Ledger Cardlines'']] function.

Any pending cardlines held against an account, which are not allocated to the current pending invoice, will be available on the ''Manage Invoice'' page. They can then be allocated to the invoice as required.

===Managing Cardlines on Pending Invoices===

The ''Manage Invoice'' page allows various invoice cardline management operations, as follows:

* Modify an existing Cardline
* Allocate Pending Cardlines to the Invoice
* De-allocate a Cardline from an Invoice
* Delete a Cardline
* Add a New Cardline to an Invoice

===To Modify an Existing Cardline===

Cardlines that are the result of an aggregate calculation, such as system generated usage charges, cannot be modified. These cardlines will appear on the ''Manage Invoice'' page greyed out. Only the cardlines that appear in enabled, active fields will be enabled for editing. Cardlines on Approved invoices will appear inactive and cannot be modified.

----
'''Note:''' Cardlines on Approved invoices cannot be modified.
----

# In the ''Allocated Cardlines'' section of the ''Manage Invoice'' page, locate the required cardline.
# Update the cardline date by clicking on the cardline’s ''Date'' field. A calendar tool will appear to allow you to select the required cardline date. This date will appear on the Invoice as the date the cardline charge was incurred.
# Edit the cardline ''Description'' by entering and / or overtyping text as required. This description will appear on the Invoice against the cardline charge.
# If required, enter an updated amount in the ''Amnt'' field. Note that the cardline amount is exclusive of tax.
# Update the ''Tax'' amount as applies to the updated cardline amount. Note that the system will not automatically re-calculate the cardline’s tax amount when you update the cardline amount.
# Select a different ''Ledger Code'' using the drop list if required. The cardline will be recorded against the selected ledger in the system for accounting purposes.
# Update the ''Covers From'' and ''Covers To'' dates as required. These reflect the period that particular charge applies to, such as a service access fee that covers from the 1st to the 31st of the month.
# Update the ''Vanity'' ''Covers From'' and ''Vanity'' ''Covers To'' dates as required. These dates will appear on the invoice, which you may update to be different dates than the actual ''Covers From'' and ''Covers To'' dates i.e. to assist the customer understand their invoice and charges.
# Click the '''Save''' button below the ''Allocate Cardlines'' section. The system will update the cardline information on the current pending invoice.
# Click the [[InvoiceReRender|'''Re-render''']] button to re-create the invoice .PDF to reflect the changes made to the cardlines.

The system usually re-renders the invoice immediately (or within 10 minutes at most). The updated invoice .PDF file will then be available to download, review and approve as required.

===To Allocate a Pending Cardline to an Invoice===

Allocating a pending cardline to an invoice adds the selected charge to the current pending invoice. Once you allocate the pending cardline to the invoice, it will appear in the ''Allocated Cardlines'' section of the ''Manage Invoice'' page.

# In the ''Pending Ledger Cardlines'' section of the ''Manage Invoice'' page, locate the required pending cardline.
# Tick the check box beside each pending cardline you wish to allocate to the current invoice. Multiple cardlines can be selected.
# Click the '''Add Pending Cardlines''' button. A message will display at the top of the screen informing that the cardline was allocated successfully.
# The selected cardline(s) will appear in the ''Allocated Cardlines'' section of the ''Manage Invoice'' page.
# Click the [[InvoiceReRender|'''Re-render''']] button to re-create the invoice .PDF to reflect the allocated cardlines.

===The Difference between ‘Deleting’ and ‘De-Allocating’ a Cardline===

Deleting a cardline simply removes the charge from the system. The charge cannot be restored. De-Allocating a cardline removes the cardline from the current invoice, but it will remain on the account to be picked up and allocated to a subsequent invoice.

===To De-Allocate a Cardline from an Invoice===

De-Allocating a cardline removes the charge associated with the cardline from the invoice, but not from the customer’s account. Once you de-allocate the cardline from the invoice, it will appear in the ''Pending Ledger Cardlines'' section of the ''Manage Invoice'' page. The pending cardline can be allocated to a subsequent invoice as required.

----
'''Note:''' Cardlines on Approved invoices and cardlines that are the result of an aggregate calculation cannot be de-allocated.
----

# In the ''Allocated Cardlines'' section of the ''Manage Invoice'' page, locate the required cardline.
# Click the '''De-Allocate''' link beside the required cardline entry. A message will display at the top of the screen informing that the cardline was de-allocated successfully.
# The selected cardline will appear in the ''Pending Ledger Cardlines'' section of the ''Manage Invoice'' page.
# Click the [[InvoiceReRender|'''Re-render''']] button to re-create the invoice .PDF to reflect the de-allocated cardline.

===To Delete a Cardline from an Invoice===

Deleting a cardline removes the charge from the system, not just the current invoice. The cardline charge cannot be restored. If the cardline is deleted in error, you will need to either create a new cardline, or contact Emersion Billing Support to assist, which will considered as chargeable work for which you may be invoiced.

----
'''Note:''' Cardlines on Approved invoices and cardlines that are the result of an aggregate calculation cannot be deleted.
----

# In the ''Allocated Cardlines'' section of the ''Manage Invoice'' page, locate the required cardline.
# Click the '''Delete''' link beside the required cardline entry. A message window will appear prompting you to confirm that you want to delete the cardline.
# Click the '''Yes''' button to delete the cardline. A message will display at the top of the screen informing that the cardline was deleted successfully. Click the '''No''' button to cancel the cardline deletion and return to the ''Manage Invoice'' page.
# Click the [[InvoiceReRender|'''Re-render''']] button to re-create the invoice .PDF to reflect the Deleted cardline.

===To Add a New Cardline to an Invoice===

From time to time you may need to manually create a charge on an invoice (e.g. for a service fee or charge that has not been automatically created by the system etc). The system allows you to create and add a new cardline to the current pending invoice. The cardline will appear in the ''Miscellaneous Charges'' section of the invoice, and the charge will be added to the invoice total. If the cardline is a credit (i.e. a negative cardline amount) the amount will appear in the Adjustments section of the invoice, and the amount will be deducted from the invoice total.

----
'''Note:''' Cardlines entered for a negative amount will appear as a credit against the account.
----

# In the ''Add new cardline to invoice'' section of the ''Manage Invoice'' page, update the ''Transaction Date'' as required. A calendar tool will appear to allow you to select the required date. This date will appear on the Invoice as the date the cardline charge was incurred.
# Enter the charge amount including tax in the ''Total (inc. Tax) ''field. The system will automatically calculate the ''Actual Value (ex Tax)'' and the ''Tax Amount'' and display in the corresponding fields''.''
#:Alternately, enter the cardline amount in the ''Actual Value (ex. Tax)'' field. The system will automatically calculate the ''Total (inc Tax) ''and the ''Tax Amount''.
# Select the ''Tax Type'' applicable to the cardline in the drop list. By default, this is set to ‘Australian GST’.
# If you need to enter a manual tax amount, tick the ''Manually enter tax'' check box. The ''Tax Amount'' field will re-display enabled for editing. Enter the tax amount required.
# Enter the description to show on the invoice in the ''Description'' field.
# Select the ''Ledger Code'' in the drop list. The cardline will be recorded against the selected ledger in the system for accounting purposes.
# Click the '''Save''' button. A message will display at the top of the screen informing that the cardline was created and allocated to the invoice successfully.
# The created cardline will appear in the ''Allocated Cardlines'' section of the ''Manage Invoice'' page.
# Click the [[InvoiceReRender|'''Re-render''']] button to re-create the invoice .PDF to reflect the added cardline.

For a brief video on pending cardlines and the manage invoice section, please see the below;

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">https://wiki.emersion.com/wiki/media/PendingCardlinesManageInvoice.mp4</mediaplayer>

===See also===
* [[InvoicePendingLedgerCardlines|Pending Ledger Cardlines]]
* [[InvoiceImmeditateInvoice|Immediate Invoices]]
* [[InvoiceReRender|Re-Render Invoices]]
* [[InvoiceReRate|Re-Rate Invoices]]

Basic Permissions

2017-12-06T23:40:18Z

CMichaels:

= Basic Permissions =
How to create and manage basic permission sets, and apply them to users.

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">https://wiki.emersion.com/wiki/media/basicPermissions.mp4</mediaplayer>

= See Also =

* [[Admin/PermissionManagement |Permissions Management]] - a comprehensive article on managing permissions

PackageSubscriptions/Chains

2017-12-06T23:40:12Z

CMichaels:

= Introduction =

Package Plans allow you to bundle components together into a sellable product, which can then be onsold to a customer. In some situations, you may wish to create a single plan, and provide a discount to only a small selection of your customers, without having to build a new package plan each time.

To assist in managing this issue, there is a concept of a 'Package Subscription Chain'. This is an identifier which exists over the lifetime of a Package 'Sale', and will persist even when a customer migrates to other packages.

Within the Package Chain information, you are able to configure discount amounts, and as such gives you the ability to manage on a per package basis, who receives this discount information.

= Use =

By clicking on the 'Edit Package Chain Info' this will allow you to add the discount to the package access fee or the usage. The discount can be either added as a dollar($)- the dollar amount figure is EX GST - amount or as a percentage(%) by making the appropriate selection from the drop down menu.

To save the discount once the appropriate values have been entered, click the 'Save Chain Configuration' button.

[[Category:PackageSubscriptions]]

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">https://wiki.emersion.com/wiki/media/UsingPackageChains.mp4</mediaplayer>

== Detailed Discount Setting Information ==

*Package Discounts

** The “Package Access Discount” (see Figure 1 ) permits you to apply a discount to the “Access Fees” only, on either a percentage basis or a dollar value. Note that if the Access fee is set to 0, this setting will have no effect. When the invoice becomes due in relation to the package, the actual fee itself will simply be reduced, there not be a separate cardline with a credit amount indicating a reduction. Note that if your fees are set at service plan level rather than package plan, then it would be better to set your discounts within the Service Discount sections.

** If you would like it to be made known to the customer that you are specifically adding a credit or debit in relation this package, you may specify a credit or surcharge amount that will apply per period (Figure 2). The effect of this is that on the invoice generated from the package, a cardline for the access fee will be created according to the plan settings. In addition there will be another separate cardline added for the credit or surcharge amount. If you populate the “Surcharge Description” field, whatever you state here will be written next to the cardline added. For example, you might wrote “Bonus Offer – Credit”, or a message of that nature, indicating to the customer you are issuing them a discount.
*** Note that the amount will be credited or debited even if the package access fee is set to 0. Customers sometimes use this option when they cannot apply a Package Access Discount because the overall package fee is 0, but they need to set a discount for the package regardless for a particular dollar value.
*** Note that if the period is pro rata (for example, from the 15th of November to the 30th of November), the credit or surcharge will not be prorate. Meaning you populate this field with a figure of $5, it will not credit $2.50 for this period.

* Service Discounts

There will be times when you need to apply discounts to services within a package. You may globally discount all service subscriptions within a package, or set discounts for specific services subscriptions within a package.

** You may apply a global service discount to either access fees or usage (See figure 3). This will be displayed as a separate cardline in the invoice generated. Note that if specific discounts have applied to specific services (as described later), the global setting will be ignored for the particular service in question. If Service Plans have access fees set to 0, no discount will apply.
** If you wish to apply discounts to specific services within a package, this is also possible (See figure 4). Keep in mind as previously mentioned this will override global service access discounts set. If Service Access fees are set to 0, a discount will not apply.
 
Figure 1:
 
[[File:Figure_1.png]]
 
Figure 2:
 
[[File:Figure_2.png]]
 
Figure 3:
 
[[File:Figure_3.png]]
 
figure 4:
 
[[File:Figure_4.png]]

Services/Orders/Address-based Service Qualification

2017-12-06T23:40:07Z

CMichaels:

== Orders That Use Address-Based Qualification ==

Service qualifications (SQ) are a step in the Ordering process for some automated service types in the telecommunications industry. This step is designed to ascertain if the service is available and can be used by End User.

Some service types such as:
* AAPT National Wholesale Broadband Layer 2 / Layer 3
* NBN Wireless

Watch our short tutorial video that will take you through the process of ordering a service that uses the address-based SQ infrastructure.

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">https://wiki.emersion.com/wiki/media/AddressBasedOrdering.mp4</mediaplayer>

PackagePlans/LinkingPackageAndServicePlans

2017-12-06T23:39:57Z

CMichaels:

{{DISPLAYTITLE: Linking Package and Service Plans}}
[[Category:PackagePlans]]
[[Category:ServicePlans]]
= Linking Packages and Service Plans =

== Introduction ==

[[PackagePlans/PackagePlans|Package Plans]] and [[ServicePlans/ServicePlans|Service Plans]] need to be linked together before they are sold.

[[File:PackagePlans_relationship.jpg|500px|thumb|right]]
Cumulus was built from the ground up to support a multi-tiered customer relationship. IE The Wholesaler, Service Provider and End User can all exist inside Cumulus. Further, it is assumed that what the Wholesaler sells to the Service Provider is not provided to the End User at the same rate. Services are ''bought'' from the upstream provider, and ''sold'' downstream. As part of representing this relationship, Cumulus has the concept of ''Buy'' and ''Sell'' Plans.

* A ''Buy Plan'' represents the service being sold ''to'' the Wholesaler/Service Provider. Any pricing contained within the Buy Plan should reflect the rate at which the service is being ''bought''.

* A ''Sell Plan'' is the package actually being sold to downstream. A Wholesaler will sell Package Plans to a Service Provider, who then on sells these Package Plans to their End Users with their own Pricing.

When a Package Plan is sold to an End User, the system will create Package Subscriptions and Service Subscriptions at the Wholesaler Level (if the Wholesaler exists in Cumulus), the Service Provider Level as well as the End User. As such, Cumulus requires that Buy Package Plans be linked with Buy Service Plans, but also that downstream Sell Package Plans (linked with Sell Service Plans) are linked with respective Buy Plans.

When a Wholesaler is involved, The Wholesaler will create a 'Buy' Package Plan and Service Plan and then create various Sell Package Plans and Service Plans. The Service Provider will then create their own 'Sell' Package Plans and Service Plans, and these will link with the 'Sell' Plans of the Wholesaler.

If no Wholesaler is involved (or the Wholesaler is outside of the Cumulus network), the Service Provider themselves will create the Buy Package Plans and Service Plans and map them together as required, as well as the Sell Package Plans and Service Plans - and there will be direct links between the Buy Packages and Sell Packages.

 

== Concepts ==

There are various Cumulus specific concepts that need to be explained prior to actually linking a Package and Service plan.

=== Service Allowance and Mandatory Services ===

In creating a link between a Package Plan and Service Plan, Cumulus will set the ''Allowance'' and also whether or not the service is ''Mandatory''. Note that you can only set these variables when creating the initial ''Buy'' Package.

When you create the Sell Package and Service Plans, then link these together, the system will inherit the Allowance from the Buy Package plan you are linking to.

==== Allowance ====
[[File:PackagePlans_Link_Qty.jpg|450px|thumb|When creating ''Buy'' Plans and linking Service Plans, you can set the Quantity and whether or not the Service is Mandatory]]
The Allowance essentially is the number of Service Subscriptions that get created for that service plan. For example, you may have a Package with an ADSL service and 5 Additional Mailboxes. In Cumulus, you are not required to link the Email Mailbox Service Plan 5 times. Rather, you link the Service Plan only once and specify that there are 5 services.

[[File:PackagePlans_Link_Diagram.jpg|400px|center]]
==== Mandatory Services ====

A mandatory service is one that is required to be Qualified by the Service Qualification (SQ) process explicitly and configured before the Package Subscription will be active.

A non-mandatory service is considered an optional service that can be configured after the Package has already been activated. When a Package subscription is created that has non-mandatory services, the system will create Service Subscriptions for the non-mandatory services that are 'initialised'. These can then be activated and configured at will.
 

=== Package Catalogues and Package Groups ===
[[File:PackagePlans Link PackageGroups.jpg|300px|thumb|right|Click on this thumbnail for a diagram of Package Catalogues and Package Groups]]
''Package Catalogues'' and ''Package Groups'':

* allow users of Wholesale Service Providers the power to sell only specific packages to specific Service Providers.
* allow users of Retail Service Providers the power to sell only specific packages to specific Agents.

This section and video pertains to Wholesale Service Provider use of the package catalogue only. If you wish to learn more about use of the Package Catalogue for Retail Service Providers, [[http://wiki.emersion.com.au/wiki/index.php/PackagePlans/PackageCatalogue|see this article]].

A wholesaler may use Package Catalogues and groups if different downstream Service Providers are buying different service types, or if they offered a Tiered structure.

From the Wholesale level, 'Sell' Packages are placed into Package Groups. A Package Group (or indeed multiple Package Groups) is then placed into Package Catalogue, which is then mapped to the downstream Service Provider.

Please note that even if every Sell Package in a Wholesaler account is being offered to all Service Providers, these Packages must still be placed in a Package Group and a Catalogue created for each downstream Service Providers.

For a video which demonstrates the package catalogue configuration, see below;

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">https://wiki.emersion.com/wiki/media/packageCatalogue.mp4</mediaplayer>

= See Also =

* [[PackagePlans/PackageCatalogue|Package Catalogue for Retail Service Providers]]

Plan Definition Overview and Creation Walk Through

2017-12-06T23:39:46Z

CMichaels:

This video will introduce you to each of the basic elements required to create a saleable package within the Emersion eco-system. This covers Packages, Service Plans, Rate Cards, Product Rate Cards and Bolt Ons.

<mediaplayer MWPlayerConfig="MyCustomConfig" height="800" width="1200">https://wiki.emersion.com/wiki/media/plancreation.mp4</mediaplayer>

Account/ServiceProviderAccountCreation

2017-12-06T23:39:40Z

CMichaels:

=== Setting up a Retail Service Provider Account in Emersion===

This short help video will take you through the steps to set up a new service provider under your wholesale account in Cumulus.

<mediaplayer MWPlayerConfig="MyCustomConfig" height="800" width="1200">https://wiki.emersion.com/wiki/media/CreatingRetailAndNonRetailBillers.mp4</mediaplayer>

Emersion System Overview

2017-12-06T23:39:36Z

CMichaels:

This video will take you through a high level look of Emersion as a platform, and a look through the customer details section within.

This is the first video in the introductory training program for new clients.

<mediaplayer MWPlayerConfig="MyCustomConfig" height="800" width="1200">https://wiki.emersion.com/wiki/media/EmersionSession1_IntroToSystem.mp4</mediaplayer>

Integrations/Xero

2017-12-06T23:39:27Z

CMichaels:

{{DISPLAYTITLE:Xero Integration}}
= Overview =
Emersion integrates seamlessly with the Xero Billing Platform found at www.xero.com.

Emersion and Xero features:
* Linking Emersion Accounts with Xero Contacts
* Synchronizing invoices created in Emersion with Xero.
* Breaking down of ledger card lines within Emersion by ledger code
* Receiving payments and credit notes from Xero and reflecting them in Emersion
* Pushing payments received in Emersion to Xero
 

Before you can configure the Xero Emersion integration, you are required to have the feature enabled on your service provider account. Please contact [mailto:sales@emersion.com.au sales@emersion.com.au] if you are interested in this feature.

You will know when the Xero integration is enabled when you have access to '''Admin > Xero'''. Please also ensure you follow the First Time Setup guidelines below.

Note: Only a single Xero Company can be linked to the Emersion platform.

== First Time Setup ==
You have had the Xero Integration module activated and would like to know how to initially configure Emersion to integrate with Xero. Apart from watching the short video below, the basic steps for you to now complete are as follows:

Nav: '''Admin > Xero''' 
On this page, link your Xero company to Emersion by clicking on the '''Connect to Xero''' button and following the on-screen prompts. With a connection is established, users can add the default bank account.

Nav: '''Admin > Xero > Xero Payments''' 
On this page:

# Set a default Bank Account
# If appropriate, create a payment mapping between alternate Xero bank accounts and Emersion's payment methods. Once this is done, the user can move into mapping Emersion's ledger codes with Xero's account codes.

Nav: '''Admin > Ledger Mapping''' 
On this page, users can map Emersion ledger codes to Xero account codes. This step is optional.

'''''! IMPORTANT ! By default, Emersion's ledger codes will map to Xero's default revenue code 200 "Sales". For this reason, Emersion strongly advises not to archive or delete this code.'''''

4. Assign the Xero Account to the Customer's account in Emersion. 
To do this;
Nav: [[Account_Management/Customer_Screen/Details#Xero_Integration|'''Customer > Detail > Xero Integration''']]. Click the link to go to this page's help page.

== Overview of Supported and Non Supported Transactions ==

'''Supported Transactions'''
 
a) We only push across payments once allocated to an invoice, and positive balance invoices to Xero.
 
b) We only pull payments and credits from Xero to Emersion, provided they apply to invoices that have come across from Emersion to Xero in the first instance.
 
 
'''Non Supported Transactions'''
 
a) Refunds do not go from Emersion to Xero.
 
b) Debit Write offs and normal Write Offs do not go from Emersion to Xero.
 
c) Credits applied to invoices in Emersion do not go across to Xero (Note: Credits coming from the other direction - Xero to Emersion will work).
 
d) Invoices in credit balance do not go across to Xero, however, once the credit is converted to a payment and applied to the next invoice, the resulting Payment will go to Xero.
 
f) Transactions reversing or voiding Payments in Xero are not reflected in Emersion.
 
g) Transactions reversing or voiding Credits are not reflected in Emersion.
 
h) Any kind of general credit or debit adjustment made in Xero does not go across to Emersion.
 
i) Deleting or modifying any invoice or payment does not go across to from Xero to Emersion.
 
 
 
Additionally, transactions are only synced as far as a month prior in terms of transactions going to Xero or from Xero.

== Credits ==
Do not use the [[Credits|Credit]] feature in Emersion to create a credit if your service provider subscribes to this module. Emersion only supports pulling credit notes from Xero into Emersion. Credit notes in Xero are saved as credits in Emersion. However this synchronisation is one-way. If an Emersion credit ''and'' a Xero credit is created for the same transaction, users will see two credits appearing in Emersion.

Additionally, De-allocating a credit from an invoice in Xero will not change anything in Emersion. This is also true if you then Void the credit note in Xero. Performing these actions will most likely cause your Xero account & linked Emersion account to not balance.

== Configuration of Xero and Emersion ==
Watch the training video to:

* Learn how to connect to Xero from Emersion
* Set your default payment method to go to your nominated bank accounts in Xero
* Map Ledger codes against Xero accounts
* Associate Emersion 'accounts' with Xero 'contacts'

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">https://wiki.emersion.com/wiki/media/xero-integration.mp4</mediaplayer>
 

== Synchronisation with Accounts ==

Customer accounts in Emersion need to be linked to contacts in Xero. We do not currently support creating a Xero contact through integration.

You can ''link'' an Emersion Account to a Xero Contact by utilizing one of the following methods;

=== Creating a new Customer ===
When you create a new customer in Emersion, first screen in the wizard includes a '''Xero Account Name''' field. Use the drop-down to select which account to link to this new customer. This will perform an integration request to your Xero instance and pull a list of active contacts. The contact you wish to link to must already have been created in Xero.

[[File:xero-create-customer.png|border|The Create Customer Wizard showing Xero fields]]

=== Updating Existing Account ===
To do this;
Nav: [[Account_Management/Customer_Screen/Details#Xero_Integration|'''Customer > Detail > Xero Integration''']]. Click the link to go to this page's help page.

== Mapping Ledger Codes ==

An important aspect of integration to accounting platforms like Xero is the ability to map Emersion ledger codes to Xero ledger codes so as to keep your accounting as simple or as complex as you like and to ensure both systems reflect how you receive revenue from your customers.

All Emersion card lines (line items) are broken down into ledger codes. These codes are designed to categorize charges into granular groups and break up different forms of revenue.

Where Emersion integrates with various accounting platforms, we allow the mapping of our ledger codes with those setup within your Xero account.

To begin mapping ledger codes, you need to log into the Emersion system and then follow the steps below:

# Navigate to Admin > Xero > Xero Ledger Map (''tab'')
# Once the page has loaded, you will see a list of ledger codes that are currently available to you under your Emersion account.
# Click on the name of the Emersion ledger code
# Select a ledger code from the drop down list of available ledger codes that have been retrieved from your Xero account.
# You may enter a description of this mapping (''optional'')
# Click the Save Mapping button

It is possible to map multiple different Emersion ledger codes to a single Xero ledger code, or you may choose to be very granular and have an individual Emersion <> Xero ledger code mapping for every single code.

{| class="wikitable"
|-
| Emersion also have a bulk import tool available for you to import & map multiple Xero ledger codes. See [[Data_Import/Xero_Ledger_Code_Mapping|Xero Ledger Code Mapping - Bulk Import]]
|}
 

== Default Xero Ledger Code (200) ==

A very important note on Emersion <> Xero ledger code mapping relates to the scenario where an individual card line whose Emersion ledger code has not been mapped to a Xero ledger code needs to ''fall back'' to a default ledger code.

When we attempt to push (approved) invoice card lines across to your Xero account, we will assign these card lines to default Xero revenue code 200.

* If this code does not exist, has been delete or archived, or has been changed to an account type other than revenue, invoice card lines will fail to push to Xero and you may continue to see an invoice in Xero as $0 & in a Draft status.

In a brand new setup of Xero, there is a default revenue account code '''200''' with the name '''Sales'''.

'''Please do not delete, archive, or make this account code anything other than type revenue. This is the default fallback for un-mapped ledger codes.'''

[[File:Xero-revenue-200.png|border|Xero Default Revenue Account Code 200 - Sales]]

Further information on how to configure you Chart of Accounts in Xero can be found at https://help.xero.com/au/Settings_ChartofAccounts

 

== Important Information ==

=== Xero Pollers ===
* There are 4 ''pollers'' that handle Xero integration automatically. The frequency of these pollers are as follows;
{| class="wikitable"
|-
! Poller !! Action(s) !! Schedule !! Notes
|-
| Push Completed Invoices || When an Emersion invoice is Approved, this poller will attempt to send all the card lines to the linked Xero invoice - and further mark it Authorised (and ready for payment) || Every 15 minutes || Must not have already been pushed. Must be ''Approved''. Xero invoice must still be in ''Draft'' status and exist. Card lines will need to either have ledger codes mapped, or the [[#Default_Xero_Ledger_Code_.28200.29|default Xero account code ''200'']] must exist as a fallback. Total invoice amount must be greater than $0 (zero) dollars. Whilst an initial invoice may be reserved in Xero, we will not push any cardlines for an invoice that totals less than $0 (ie. a "credit invoice").
|-
| Check For Credit Notes || Credit notes created in Xero, will be pulled across and processed as a credit in the ledger || Every 15 minutes || No greater than 30 days ago. Must not already exist in Emersion. Must be attached to an existing (linked) invoice. Must be status ''Paid''.
|-
| Push New Payments || Payments made in Emersion will be pushed and applied to the linked invoice in Xero || Every 1 Hour || Must be made against linked invoice(s). Must not have already been processed. Only payments against invoices are supported. (ie. Not Ledger Credits or Debits)
|-
| Check For Payments || Payments created in Xero against linked Emersion invoices will be pulled across and applied to the invoice in Emersion || Every 1 Hour || No greater than 30 days ago. Must not already exist in Emersion. Must be attached to an existing (linked) invoice. Must be ''Authorised''. Payment amount must be less than the invoice outstanding amount.
|}

* Only transactions that are payments against existing invoices will be pushed to Xero. No '''credit''' or '''debit''' ledger transactions will be pushed.

* Only credit notes that have allocated amounts against already linked invoices will be pulled from Xero. The credit note must also be in status ''Paid''.

* If a payment made in Xero also creates an '''overpayment''', then we will not pull the overpayment amount from Xero - only the allocated payment amount against an already linked invoice.

* If an overpayment amount in Xero is then allocated to an outstanding invoice, we will NOT pull this information in to Emersion

=== Xero Bulk Actions ===

You may wish to bring forward one or more of the "poller" processes manually rather than wait for the scheduled processing time.

* '''Nav:''' Admin > Xero > Xero Bulk Actions
* Simply click on the appropriate process you wish to action. You may choose from;
** Push Pending Payments to Xero (''the page will dynamically determine of any invoices are valid and can be pushed'')
** Pull Payments from Xero
** Pull Credits from Xero
** Push Completed Invoices to Xero (''the page will dynamically determine of any payments are valid and can be pushed'')

[[File:Xero bulk actions 001.png|800px]]

== Xero / Emersion Ledger Transaction ==

The following screenshots represent an Approved invoice that has been pushed to Xero (and set to status 'Awaiting Payment'). 

For the purpose of showing an example between Emersion & Xero, the following numbers represent different methods of individual transactions: 

* ('''1''') Represents a payment made in Xero and applied to the linked invoice. 

Our '''Check For Payments''' poller has then picked this up and ''pulled this payment into Emersion'' and allocated the amount to the linked invoice. 

In the screenshots below, you can see this payment represented in both the Payments tab, as well as the Transactions tab of a customer account. 

Note the ''Transaction Reference'' on the Payment tab and the ''Reference'' on the Transaction tab represent the Xero [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the the payment transaction within Xero. Once logged into Xero, you can view the direct payment by modifying the URL. For example: <nowiki>https://go.xero.com/Bank/ViewTransaction.aspx?bankTransactionID=21abb5e5-e978-4de7-b44e-83d686749ba5</nowiki> - where ''21abb5e5-e978-4de7-b44e-83d686749ba5'' is the reference taken from either the Payment or Transaction tab in Emersion.

* ('''2''') Represents a Payment made in Emersion and applied to the linked invoice. 

Our '''Push New Payments''' poller has picked this up and pushed it to Xero and allocated it to the linked invoice. 

This particular payment in Emersion will have a reference as entered by you when creating the payment (''this is sometimes a system generated reference in the case of automated payments via a payment gateway'') and will push to Xero with a payment reference that references both the (Emersion) Payment ID and the (Emersion) journal ID of the '''unallocateUnallocatedPayment''' transaction type in the customer ledger journal (''Transactions''). For example: ''Payment received in Emersion [Journal #9100699, Payment #2081312]''

* ('''3''') Represents a '''Credit Note''' that has been created in Xero and applied to the linked invoice. 

(Whilst Emersion does not have a concept of a Credit Note per se, we support a '''Credit''' transaction type.) 

Our '''Check For Credit Notes Poller''' has picked up the Credit Note from Xero and applied it to the linked invoice & the customer account in Emersion. This is not a payment, but will be represented as a '''credit''' transaction type in the ledger journal (''Transactions''). 

Note the ''Reference'' on the Transaction tab represent the Xero [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the the credit note within Xero. Just like payments, you can view the direct credit note by modifying the URL. For example: <nowiki>https://go.xero.com/AccountsReceivable/ViewCreditNote.aspx?creditNoteID=e2c84d1f-6f2d-4809-a8f4-1e94e7910718</nowiki> - where ''e2c84d1f-6f2d-4809-a8f4-1e94e7910718'' is the reference taken from the credit transaction in the customer ledger journal (''Transactions'') in Emersion.


<gallery>
File:Xero_sample_001.png|Xero Invoice View
File:Xero_sample_002.png|Emersion Transactions View
File:Xero_sample_003.png|Emersion Payments View
</gallery>

= Related Reports =

The report '''Xero Integration Errors''' (id: 1063) is included with this module. It can be found under '''Report > List > Finance'''

=See Also=
* [[Integrations/Xero/Troubleshooting|Toubleshooting Issues with Xero Integration]]

Introduction to Events Video

2017-12-06T23:38:04Z

CMichaels:

This video will take you through a high level overview of Events in Emersion, that comprises Events and how they fit into the rest of the Emersion system.

This is part of the introductory training program for new clients.

<mediaplayer MWPlayerConfig="MyCustomConfig" height="800" width="1200">https://wiki.emersion.com/wiki/media/Events-Introduction-Event-Concepts.mp4</mediaplayer>