Emersion - User contributions [en]

API

2020-01-15T23:46:14Z

Medge: /* Provider Based API Functionality (Certificate Based) */

{{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.

Authentication is handled via a username and password. Some Emersion customers use an SSL certificates to authenticate, but this authentication method is now deprecated.

== Testing APIs ==
Emersion does not provide a sandbox environment for APIs. To gain experience and guidance on the operations contained within an API, [https://resources.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 ==
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 a WSSE header for authentication.

=== Provider-level APIs ===
For Production, use; https://api.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 =
* [[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 =

* [[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

2020-01-15T23:45:43Z

Medge: /* Security and Access Controls */

{{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.

Authentication is handled via a username and password. Some Emersion customers use an SSL certificates to authenticate, but this authentication method is now deprecated.

== Testing APIs ==
Emersion does not provide a sandbox environment for APIs. To gain experience and guidance on the operations contained within an API, [https://resources.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 a WSSE header for authentication.

=== Provider-level APIs ===
For Production, use; https://api.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 =
* [[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 =

* [[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/Account

2019-09-13T00:36:37Z

Medge: /* Account */

== Account ==
The 'Account' section of the Emersion API layer primarily contains account management based functions.

The WSDL is at https://external.emersion.com.au/Accounts.wsdl

{{#subpages:page=API/Account}}.

API/Services/SetServiceIdentifier

2019-04-26T03:16:04Z

Medge:

=== Set Service Identifier ===

'''Purpose:''' Based on the requirements gathered in [[API/Services/GetServiceIdentifierRequirements|Get Service Identifier Requirements]] this method will populate the service identifier information that is required for an order.

'''Inputs'''

<soapenv:Header/>
<soapenv:Body>
<ord:SetServiceIdentifier>
<ord:AccountPresaleSQID>112233</ord:AccountPresaleSQID> 
<ord:Username>emersion</ord:Username> 
<ord:Realm>yourrealm.com.au</ord:Realm> 
<ord:Password>emersion123!</ord:Password> 
</ord:SetServiceIdentifier>
</soapenv:Body>

'''Output'''

<SOAP-ENV:Body>
<ns1:SetServiceIdentifierResponse>
<ns1:Status>true</ns1:Status>
</ns1:SetServiceIdentifierResponse>
</SOAP-ENV:Body>

'''Error String'''

* "Missing Account Presale SQ ID" - Account Presale SQ ID is not supplied.
* "Account Presale SQ does not exist" - Account Presale SQ ID supplied does not exist in system.
* "Account does not exist" - Account ID supplied does not exist in system.
* "Invalid Account ID" - Account ID supplied does not belong to the same parent group as the API caller.
* "Missing Package Plan" - Package Plan must be selected before calling this function.
* "Missing Username" - Username is not supplied.
* "Invalid Username" - Username does not meet username policy.
* "Missing Password" - Password is not supplied.
* "Invalid Password" - Password does not meet password policy.

API/Orders/FindNWBSQAddress

2019-02-15T01:30:47Z

Medge:

=== Find NWB SQ Address ===
'''Purpose:''' This method is part of the address-based service qualification (SQ) requirements for the AAPT NwB service type. It searches and retrieves a Location ID based upon an address selected by the user. This location ID is then used by the [[API/Orders/PerformNWBSQ|Perform NWB SQ]] method to complete the SQ process.

'''WSDL: Orders.wsdl'''

'''Input'''

* ServiceTypeID: int - Required
* AddressDetails: Array
* RuralMailNumber: string - Optional
* RuralMailType: string - Optional
* LevelNumber: string - Optional
* LevelType: string - Optional
* UnitNumber: string - Optional
* UnitType: string - Optional
* PlanNumber: string - Optional
* LotNumber: string - Optional
* StreetNumber: string - Optional
* StreetNumberSuffix: string - Optional
* SiteName: string - Optional
* StreetName: string - Optional
* StreetType: string - Optional
* StreetTypeSuffix: string - Optional
* Suburb: string - Required
* State: string - Required (Use Abbreviations as per XSD)
* Postcode: int - Required

<ord:FindNWBSQAddressRequest>
<ord:ServiceTypeID>3261</ord:ServiceTypeID>
<ord:AddressDetails>

<ord:RuralMailNumber>?</ord:RuralMailNumber>

<ord:RuralMailType>?</ord:RuralMailType>

<ord:LevelNumber>?</ord:LevelNumber>

<ord:LevelType>?</ord:LevelType>

<ord:UnitNumber>?</ord:UnitNumber>

<ord:UnitType>?</ord:UnitType>

<ord:PlanNumber>?</ord:PlanNumber>

<ord:LotNumber>?</ord:LotNumber>

<ord:StreetNumber>?</ord:StreetNumber>

<ord:StreetNumberSuffix>?</ord:StreetNumberSuffix>

<ord:SiteName>?</ord:SiteName>

<ord:StreetName>?</ord:StreetName>

<ord:StreetType>?</ord:StreetType>

<ord:StreetTypeSuffix>?</ord:StreetTypeSuffix>
<ord:Suburb>Melbourne</ord:Suburb>
<ord:State>VIC</ord:State>
<ord:Postcode>3000</ord:Postcode>
</ord:AddressDetails>
</ord:FindNWBSQAddressRequest>

'''Output'''

<ord:FindNWBSQAddressResponse>
<ord:Address>
<ord:ServiceProvider>Telstra</ord:ServiceProvider>
<ord:LocationID>XXXXXXXX</ord:LocationID>
<ord:LocationName>460 Bourke Street, Melbourne 3000</ord:LocationName>
</ord:Address>
</ord:FindNWBSQAddressResponse>

'''Error String'''

* "Missing service type id" : Service type id is not supplied or less than 1
* "Undefined service type": service type does note exist or not belong to the account.
* "Service type is not available for ordering" : Service type id is not exist in sellable service type
* "Missing service check type on service type id #XXXXXX" : Service type does not has service check type
* "Service type id #XXXXXX is not qualified for NWB SQ : Service type service check type is not VOIPFNN
* "Missing address Details": Address details is not supplied or provided.
* "Missing state": Address state is not supplied.
* "Undefined state": Address state does not exist.
* "Missing postcode": postcode is not supplied.
* "Invalid postcode": postcode is not 4 digits number.
* "Undefined street type": Address street type does not exist.
* "Undefined street type suffix": Address street type suffix does not exist.

API/UseCases/ServiceOrders

2019-01-04T06:07:03Z

Medge:

{{DISPLAYTITLE: Use Case: Ordering a Service}}
= Overview =
Emersion's APIs can be utilised to complete the onboarding of your end user customers. This article is aimed at developers to explain the required workflow for onboarding your customer via the APIs, particularly the workflow for orders themselves. For the purposes of this article, the term 'onboarding' refers to the following processes:

* starting an order for a service.
* completing a service qualification (SQ).
* selecting a package plan to subscribe to.
* configuring the service.
* submission of the order.

In order for these processes to be completed successfully, the execution of API calls must be completed in the specific order below.

= Prerequisites =
The following prerequisites apply to using the APIs for ordering.

=== Preparation ===
Emersion strongly recommends you step through the order process in Cumulus before attempting to programmatically replicate the process outside the system. This is the best way to gain an optimal understanding of how the order process works. It will also reduce the developer time needed and assist with troubleshooting. A solid understanding of the process is essential.

=== Create the Account ===
Before you can commence an order, an account needs to exist in the system. This article focuses primarily on the workflow of the order, but in an end-to-end onboarding case scenario, it includes the creation of an account as a first step. If users may place orders for existing accounts, you may want to leverage off the [[API/Account/GetAccount|GetAccount]] or [[API/Account/GetAccountFromUsernameAndPassword|GetAccountFromUsernameAndPassword]] methods to validate the customer.

= Ordering Workflow =

== Diagrams ==
The following diagrams are a pictorial representation of the orders workflow for APIs.

<p style="border:0px solid #AAA;padding:30;line-height:2">
<span>
[[file:Emersion APIs - Ordering Tools.png|800px|top]]

[[file:Emersion APIs - Ordering Serv Config Tools.png|500px|top]]
</span></p>

= START YOUR ORDER =

=== Create Order ===
Start the order process with this API call in order to be able to progress to performing an SQ.
* [[API/Orders/StartOrder| Start Order]]

=== Perform Service Qualification (SQ) ===
After starting an order, the user needs to perform an SQ to confirm the service's availability. There are 3 choices for service providers to use depending on the service types being sold.

'''''Important Note: Not all service types are currently supported by the available SQ APIs'''''. Review the specific help page on each API call for further details. If you find that you are unable to complete a service order end-to-end because a service type you are subscribed to is not supported, please contact Emersion Sales.

==== Option 1 ====
'''Perform Simple SQ'''<br />
This API call creates an SQ entry so the user can proceed to the next step in the orders workflow. It is used for manual and semi-manually provisioned service types and for service types that do not require a service qualification.
* [[API/Orders/PerformSimpleSQ|Perform Simple SQ]]

==== Option 2====
'''Perform General Phone SQ''' <br />
This method provides the ability to perform an SQ for a service type that is defined as using the checktype ''GeneralPhone''.
* [[API/Orders/PerformGeneralPhoneSQ| Perform General Phone SQ]]
* [[API/Orders/PerformGeneralRangedSQ| Perform General Ranged SQ]]
==== Option 3====
Option 3 contains two methods to perform an address-based SQ.

'''Perform NWB SQ - Find Address'''<br />
This method provides the ability to perform an SQ for AAPT NwB services. This part of the SQ is designed as a prerequisite for address based service qualifications for AAPT.
* [[API/Orders/FindNWBSQAddress|Find NwB address]]

'''Perform NWB SQ - SQ'''<br />
This API call takes the output from the Find NWB SQ Address and performs a service qualification (SQ) for the AAPT NwB service type.
* [[API/Orders/PerformNWBSQ|Perform NwB SQ]]

== PACKAGE SELECTION ==
Once the order has been started and a successful SQ result is known, the next step in the process is around package choice and selection. Use these two APIs to display a list of available packages for the user to choose from. After the user has selected a package, you can move onto the next phase of the order or optionally present further information regarding the package by using the method [[API/Plans/GetPackagePlanDetails|GetPackagePlanDetails]].

=== Get Available Packages ===
This method will return a list of packages that are available to order once a successful SQ has been obtained.
* [[API/Orders/GetAvailablePackages|Get Available Packages]]

=== Select Package Plan ===
The system needs to know what package is selected. This can only be done once per order. The order will error if subsequent submissions via this call are received.
* [[API/Orders/SelectPackagePlan|Select Package Plan]]

== SERVICE CONFIGURATION ==
For each service contained a package, information needs to be collected for a variety of purposes, including but not limited to authentication, provisioning and reporting. The following section contains several GET and SET functions that will handle all these service configuration requirements. Emersion may need to change the requirements for a service type from time to time without notice. These methods are designed to handle such evolutionary adaptations by gathering the up-to-date set of requirements each time.

=== GET METHODS ===

=== Get Service Configuration Requirements ===
This request will return all data fields that needs to be completed as part of configuring each service contained in the selected package, along with whether they are mandatory or not.
* [[API/Services/GetServiceConfigurationRequirements|Get Service Configuration Requirements]]

=== Get Service Feature Configuration Requirements ===
This call retrieves a list of service features that are mandatory or optional.
* [[API/Services/GetServiceFeatureConfigurationRequirements| Get Service Feature Configuration Requirements]]

=== Get Service Contact Requirements ===
Some service types require one or more service-level contacts as part of the configuration. This method will retrieve any business rules pertaining to service contact requirements so that they can be included with an order. Service level contacts should not be confused with those that are associated with an account (i.e. primary, billing).
* [[API/Services/GetServiceContactRequirements|Get Service Contact Requirements]]

=== Get Service Identifier Requirements ===
This request is designed to advise of any service identifier requirements beyond service-based identifiers which are part of the SQ process. E.g. Those used for authentication purposes.
* [[API/Services/GetServiceIdentifierRequirements|Get Service Identifier Requirements]]

=== Get Service Identifier Realms ===
This request is designed to be gather requirements related to realms, which are an aspect of [[API/Services/GetServiceIdentifierRequirements| service identifiers]]. This will return a list of available identifier realms that are presently associated against the parent account.
* [[API/Services/GetServiceIdentifierRealm|Get Service Identifier Realm]]

=== Get Service Address Requirements ===
This request is designed to be gather any service address requirements that may pertain to the order.
* [[API/Services/GetServiceAddressRequirement|Get Service Address Requirements]]

=== SET METHODS ===

=== Set Service Configuration Requirements ===
Based on the requirements gathered in [[API/Services/GetServiceConfigurationRequirements|Get Service Configuration Requirements]], this is used to configure any service configuration which is part of the service. Note: This cannot be configured until the 'Package Plan' is selected.
* [[API/Services/SetServiceConfiguration| Set Service Configuration]]

=== Set Service Feature Setup===
Based on the requirements (optional or mandatory) gathered in [[API/Services/GetServiceFeatureConfigurationRequirements| Get Service Feature Configuration Requirements]], this API call is used to configure any service features. Note: This cannot be configured until the 'Package Plan' is selected.
* [[API/Services/SetServiceFeatureSetup| Set Service Feature Setup]]

=== Set Service Contacts===
Based on the requirements gathered in [[API/Services/GetServiceContactRequirements|Get Service Contact Requirements]] this method will populate the service contact information that is required for an order.
* [[API/Services/SetServiceContacts| Set Service Contacts]]

=== Set Service Identifiers ===
Based on the requirements gathered in [[API/Services/GetServiceContactRequirements|Get Service Contact Requirements]] this method will populate the service contact information that is required for an order.
* [[API/Services/SetServiceIdentifier| Set Service Identifier]]

=== Set Service Address===
Add or update service address in the Order
* Set Service Address

== REVIEW AND SUBMIT ==

=== Get Service Address ===
This call is optional for an order, but may be useful to reflect back to the user what they have entered. The method retrieves any service addresses that has been collected in the order.
* Get Service Address

=== Get Terms And Conditions ===
This call is mandatory for an order by a service provider who subscribes to the Terms and Conditions module. The method retrieves any terms and condition text blocks.
* [[API/Plans/GetTermsAndConditions|Get Terms and Conditions]]

=== Submit (Create) Order ===
For the submission of an order. All information that has been previously submitted will be validated and if the order passes it will be accepted into the system. Package subscription(s), service subscription(s) and service(s) in a PreActive state will be created.
* [[API/Orders/CompleteOrder| Complete Order]]

= Other Useful API for Orders =
While these do not directly form part of the primary workflow for an order, service providers may find the following API functions worth considering to improve the user experience with your applications.

=== Create Note ===
During the ordering process there may be reasons to put additional notes in the system against a customer.
* [[API/Account/AddNote| Add Note]]

=== Create Payment ===
The [[API/RetailServices/CreatePayment| Create Payment]] function can collect a payment for you if you wish that to be part of the order process.

API/Orders/PerformGeneralRangedSQ

2019-01-04T06:02:48Z

Medge: Created page with "=== Perform General Ranged SQ === This method provides the ability to perform a service qualification (SQ) for a service type that is defined as using the checktype ''GeneralR..."

=== Perform General Ranged SQ ===
This method provides the ability to perform a service qualification (SQ) for a service type that is defined as using the checktype ''GeneralRanged''. You can ascertain if you're selling service types that use the ''GeneralRanged'' checktype by using the API call [[API/Plans/GetPackagePlanDetails|Get Package Plan Detail]].

WSDL: Orders.wsdl

'''Inputs'''

* AccountPresaleID: int - Required
* ServiceTypeID: int - Required
* TransferType: string - Required (New, Churn)
* RangeSize: int - Optional
* Identifier: string - Required for TransferType Churn

<ord:PerformGeneralPhoneSQRequest>
<ord:AccountPresaleID>100380</ord:AccountPresaleID>
<ord:ServiceTypeID>3204</ord:ServiceTypeID>
<ord:TransferType>Churn</ord:TransferType>

<ord:Identifier>61363273699</ord:Identifier>
<ord:RangeSize>10</RangeSize>
</ord:PerformGeneralPhoneSQRequest>

'''Output'''

* AccountPresaleSQID: int
* AvailableTransferType: string

<ns1:PerformGeneralPhoneSQResponse>
<ns1:AccountPresaleSQID>362210</ns1:AccountPresaleSQID>
<ns1:AvailableTransferType>Internal Churn</ns1:AvailableTransferType>
<ns1:ServiceQualificationMessage>Your SQ was successful</ns1:ServiceQualificationMessage>
</ns1:PerformGeneralPhoneSQResponse>

=== Error String===
'''SP Account Validation'''
* "Undefined account status": Account status is not defined
* "Undefined account type": Account type is not defined
* "Account Type is not eligible to create order": Account type is wholesale account
* "Order creation is restricted for this account": Account Status can not order is set to 1 or account type can not order is set to 1
* "This account is 'Account Status Name' - please contact your upstream provider": Account status is suspended or restricted

'''End User Account Validation'''
* "Missing account presale id": Account presale id is not supplied or less than 1
* "Invalid account presale id": Account presale id length less than 6 digits
* "Account presale is not valid for order": Account presale has been completed
* "Account presale already contain package plan": Account presale has a package plan
* "Missing service type id": Service type id is not supplied or less than 1
* "Invalid service type id": Service type id length less than 6 digits
* "Service type is not available for ordering": Service type id does not exist in sellable service type
* "Missing service check type on service type id #XXXXXX": Service type does not has service check type
* "Service type id #'ServiceTypeID' is not qualified for General Range SQ": Service type service check type is not of type 'GeneralRanged'
* "Missing transfer type": transfer type is not supplied or less than 1 char
* "Invalid transfer type": Transfer type is not "New" or "Churn"
* "Transfer type new is not supported": Service type provisioning new is not enabled.
* "Transfer type churn is not supported": Service type provisioning churn is not enabled.
* "Missing identifier": Identifier is not supplied or less than 1 char
* "Invalid Identifier": Identifier fail validation

'''When overriding SQ in the account presale'''
* "Service Qualification for service type id #XXXXXXis currently in pending status": Service qualification in pending status
* "Service Qualification id #XXXXXX is not valid for deletion": Service qualification contain package plan

API/Services/GetServiceAvailabilityForAddress

2018-05-10T00:27:22Z

Medge:

'''Purpose '''

Determine what services are available at an address.

'''NOTE''' This API call currently references a deprecated table and should be considered currently not operable.

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ser:getServiceAvailabilityForAddress>
<ser:address_id>100156</ser:address_id>

<ser:service_type>3501</ser:service_type>
</ser:getServiceAvailabilityForAddress>
</soapenv:Body>

'''Output'''
<SOAP-ENV:Body>
<ns1:getServiceAvailabilityForAddressResponse>
<ns1:ServiceAvailabilityItem>
<ns1:identifier>LOC000016786489</ns1:identifier>
<ns1:class_number>3</ns1:class_number>
<ns1:servicable>true</ns1:servicable>
<ns1:description>It's all good mate</ns1:description>
<ns1:service_type_id>3501</ns1:service_type_id>
<ns1:service_type_name>Open Networks Fibre</ns1:service_type_name>
<ns1:service_type_description>Open Networks Fibre</ns1:service_type_description>
</ns1:ServiceAvailabilityItem>
</ns1:getServiceAvailabilityForAddressResponse>
</SOAP-ENV:Body>

'''Error String'''

133. Invalid or missing address_id

API/Services/GetServiceTypesForAddress

2018-05-10T00:25:33Z

Medge:

'''Purpose '''

Get a list of service types available at a given address

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ser:getServiceTypesForAddress>
<ser:address_id>1</ser:address_id>
<ser:carrier_id>1</ser:carrier_id>
<ser:minimum_class_number>1</ser:minimum_class_number>
</ser:getServiceTypesForAddress>
</soapenv:Body>

'''Output'''
<SOAP-ENV:Body>
<ns1:getServiceTypesForAddressResponse>
<ns1:ServiceTypeItem>
<ns1:service_id>1</ns1:service_id>
<ns1:type_name></ns1:type_name>
<ns1:port_available>false</ns1:port_available>
</ns1:ServiceTypeItem>
</ns1:getServiceTypesForAddressResponse>
</SOAP-ENV:Body>

'''Error String'''

Invalid or missing address_id

Invalid or missing carrier_id

Invalid or missing minimum_class_number

API/Services/GetServiceTypesForAddress

2018-05-09T03:20:57Z

Medge:

'''Purpose '''

Get a list of service types available at a given address

''' NOTE ''' This API call currently references a deprecated table and should be considered currently not operable.

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ser:getServiceTypesForAddress>
<ser:address_id>1</ser:address_id>
<ser:carrier_id>1</ser:carrier_id>
<ser:minimum_class_number>1</ser:minimum_class_number>
</ser:getServiceTypesForAddress>
</soapenv:Body>

'''Output'''
<SOAP-ENV:Body>
<ns1:getServiceTypesForAddressResponse>
<ns1:ServiceTypeItem>
<ns1:service_id>1</ns1:service_id>
<ns1:type_name></ns1:type_name>
<ns1:port_available>false</ns1:port_available>
</ns1:ServiceTypeItem>
</ns1:getServiceTypesForAddressResponse>
</SOAP-ENV:Body>

'''Error String'''

Invalid or missing address_id

Invalid or missing carrier_id

Invalid or missing minimum_class_number

Main Page/Provisioning/BulkSuspend/Telstra

2017-12-06T22:52:56Z

Medge: /* Telstra Mobile - Bulk Suspend */

== Telstra Mobile - Bulk Suspend ==

Emersion has implemented an optional module which permits bulk suspend and unsuspend of Telstra Mobile Services. This ultimately is useful when dealing with large amounts of users that need to be managed.

It is recommended when using this page that batches no more than 100 services each time are used.

The page itself takes a CSV file import, with two columns, these being SERVICE_ID and SUSPEND_ACTION. The SUSPEND_ACTION flag has two acceptable values, 0 (unsuspend) and 1 (suspend). Upon choosing the reactivation and/or suspend reasons and uploading your file, the system will integrate with the Emersion provisioning system and action as appropriate.

A note will be placed on the customers account so upon review it is easy to tell the user was suspended using this tool.

An example file will look like;

SERVICE_ID,SUSPEND_ACTION

363622,1

893812,0

The page is located under Services -> Bulk Provisioning. If you do not see it you may not have access to it. If the feature is part of your Emersion offering, and it has been activated for you, then it's probably a permission issue and you should review the module access permissions against your underlying role. If you do not have the feature enabled, you will need to contact Emersion Sales.

A video running through the overall procedure is below;

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

Services/Orders/NewOrder

2017-12-06T22:51:31Z

Medge:

{{DISPLAYTITLE:New Order}}
== Introduction ==

The New Order process is the core section for attaching new packages and services to your existing customers.

This process will deal with package selection, service qualification, service configuration and more.

Depending on the package type or ordering type you may see additional sections such as ;

* Credit Checks
* Terms and Conditions
* Product Sales
* Authentication Information

Note: Some of these features are add-ons to the standard Emersion base product, for more information you will need to contact sales.

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

== Service Type Selection ==

* Package Preview

[[Image:Services_NewOrder_001.png|thumb|Service Type Selection - No service types selected]]

As of release [[ReleaseNotes#3.21_-_22_March_2011|3.21]], Emersion have modified the service type selection UI to enable the ''previewing'' of available packages (see image above). As you click on each service type's check-box, the page will dynamically search for available packages & display those that are applicable. If multiple check-boxes are selected, the page will once again dynamically search for & refresh the package preview list with more (or less) applicable packages.

* Express Package Subscription

[[Image:Services_NewOrder_002.png|thumb|Express Package Subscription]]

If you have created a package plan(s) that <u>ONLY</u> contains non-mandatory service plans (service types), and select the service type(s) corresponding to those in the package & can successful view a list packages, you will be presented with a new column called '''Express''' with an action link to Subscribe to this package without activating any service subscriptions.

Once subscribed to this package, you can allocate the service and configure it appropriately.

Main Page

2017-12-06T04:55:28Z

Medge:

{{DISPLAYTITLE:'''Welcome to the Emersion Software Systems Wiki'''}}

This repository is used to provide education on Emersion's billing and provisioning system, Emersion concepts and online help to all Emersion's users regarding all of the features and functions available to you.

The Emersion Wiki is updated regularly to reflect the latest changes to the system. New and updated articles (and videos) are appearing every week. Therefore we encourage you to visit this wiki on a regular basis and subscribe to updates.

If there is a section of the system of which you would specifically like further information about, please contact our [[Support and help from Emersion|support team]].

== Announcements ==
Emersion is pleased to advise our customers that we have released a significant set of enhancements to invoice templates in order to give service providers new layout and configuration options. [https://resources.emersion.com/display/EKB/2017/11/21/Announcement+-+Invoice+Templates Check out the details here].

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
=== Emersion Knowledge Base News ===
* Looking for help for Invoice Templates? [[Main_Page/2017_EKB/invoice_templates| Read more here...]]
* Logging in to the Emersion Knowledge Base [[Main_Page/2017_EKB/Authentication| Read more here...]]
* We have begin shifting to our new Emersion Knowledge Base. [[Main_Page/2017_EKB|Read more here...]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>

=== SUPPORT ===
* [[New Tariffs|See the latest updates to our Tariff Lists]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>

=== TRAINING ===
* [[Service_Types|The Emersion 101 on Service Types]]
* [[Product_Rate_Cards/Access_Fee_Discount|Discount pricing based on volume? Have you seen our Access Fee Discount feature yet?]]
* [[Ledger_Allocating_Payments|Allocating Payments to Invoices and the Ledger Journal]]
</p>
</td>
</tr>

<tr colspan=3>
<td>
=== RELEASE NOTES ===

* [[ReleaseNotes|See what's new in the latest update of Emersion]]

</td>
</tr>

</table>

== Core Emersion Modules ==
<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
* [[Admin|Admin Settings]]
** [[Admin/PermissionManagement|Permissions Management]]
* [[Account Management | Customer and Account Management]]
** [[Account Management/Customer Screen | The Customer Screen]]

'''Billing Objects'''
* [[Billing Objects|An Introduction to all the Emersion Billing Objects]]
* [[Service_Types|Service Types]]
* [[PackagePlans/PackagePlans|Package Plans]]
* [[ServicePlans/ServicePlans|Service Plans]]
* [[ServicePlans/RateCard|Rate Cards and Rates]]
** [[ServicePlans/RateCard/Creating_Rate_Cards|Maintaining Rate Cards and Rates]]
* [[Services | Services]]
* [[Products|Products]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
* [[Invoicing|Invoicing]]
* [[Billing_Cheat_Sheet|The Billing Cheat Sheet]]
* [[Ledger_Management|Ledger Management]]
</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>

* [[Services/Orders | Ordering services]]
* [[Account_Management/Customer_Screen/Service_Subscriptions|Service Subscriptions]]
* [[Main_Page/Provisioning|Provisioning]]
* [[Quarantine|Quarantine]]
* [[:Events|Events]]
* [[Reports|Reports]]
* [[Data Import|Data Import (Bulk Upload/Update)]]
</p>
</td>
</tr>
</table>

== Optional Modules ==

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
* [[Account Management/Auto Top-up | Automated Top-up]]
* [[Agent Management |Agents]]
* [[Cost_Centres|Cost Centres]]
* [[Commissions|Commissions]]
* [[EPS|Electronic Payments]]
* [[Inventory and Warehouses | Inventory and Warehouses]]
</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
* [[Payments/Manual_Payment_Batch | Manual Payment Batch]]
* [[Payment Plans V2 | Payment Plans]]
* [[Service Desk|Service Desk]]
* [[Early Upgrade|Early Upgrades]]
* [[Admin/Credit_Levels|Credit Levels for Staff Users]]
* [[Product_Rate_Cards/Access_Fee_Discount|Access Fee Discounts based on volume]]
</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
* [[API | Emersion APIs]]
</p>
<p>
* External Portals
** [[End_User_Portal|End User Portal]]
** [[Sign_Up_Portal|Sign Up Portal]]
** [[Main_Page/Provisioning/Service_Type_Migrate/Service_Activation_Portal|Service Activation Portal]]
</p>
</td>
</tr>
</table>

== Integration ==
* [[Integrations|Integration with Other Applications]] (eg. Xero, ZenDesk)
* [[Integrations/Postal Integration Invoice Delivery|Postal Invoices and Integration for Invoice delivery to mail houses]]

== References ==
* [[Reference|Reference Material]]
* [[Glossary|Glossary of Terms and Abbreviations]]

== Training and Consulting Services ==

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
<b>Training</b>
* [[Emersion User Manuals|Emersion User Manuals]]
* [[Emersion Training Slides|Training Slides]]
* [[Emersion Videos|Training Videos]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
<b>Consulting Services</b>
* [[Consulting_Services/Package_Plans | Package Plan Consulting]]
</p>
</td>
<td width="33.33%" align="left" valign="top">  
</td>
</tr>

<tr>
<td>   </td>
<td>   </td>
<td>   </td>
</tr>

</table>

== Additional Help ==

* [[Support and help from Emersion|If you need Support from Emersion, start here]]
* [[Emersion Invoice Reconciliation|How to Reconcile Emersion's Invoice to you]]

== Carrier & Service Supplier information ==
This section contains infomation relevant to specific service suppliers and carriers that are popular in Emersion.

=== Optus ===
* [[Optus Usage collection | Optus RBT and Optus Multiline]]
[[file:Emersion Optus RBT Service Management System Manual v1.2.pdf]]<br />
[[file:Emersion Optus RBT Wholesaler Appendix v1.0.pdf]]<br />

=== Telstra ===
* [[Telstra_NBN|Telstra NBN]]
* [[file:Emersion Telstra eBill Manual V1.0.pdf]]<br />
* [[file:Emersion Telstra 3G Manual V0.1.pdf]]<br />
* [[file:Emersion Telstra Mobile Management User Manual v1.0.pdf]]<br />

=== AAPT ===
[[file:Emersion AAPT DSL Manual V2.0.pdf|Emersion AAPT DSL Manual]]<br />

* [[AAPT Rebill | AAPT Rebill]]
* [[Broadsoft Softswitch as a Service | AAPT Broadsoft Softswitch as a Service (Voice SSasS) - Semi Manual]]
* [[AAPT_National_Wholesale_Broadband_L3 | AAPT National Wholesale Broadband L3 (Broadband Connect) Layer 3]]
* [[AAPT IP-Line | AAPT IP-Line]]

Main Page

2017-12-06T04:45:32Z

Medge:

{{DISPLAYTITLE:'''Welcome to the Emersion Software Systems Wiki'''}}

This repository is used to provide education on Emersion's billing and provisioning system, Emersion concepts and online help to all Emersion's users regarding all of the features and functions available to you.

The Emersion Wiki is updated regularly to reflect the latest changes to the system. New and updated articles (and videos) are appearing every week. Therefore we encourage you to visit this wiki on a regular basis and subscribe to updates.

If there is a section of the system of which you would specifically like further information about, please contact our [[Support and help from Emersion|support team]].

*AWS*
== Announcements ==
Emersion is pleased to advise our customers that we have released a significant set of enhancements to invoice templates in order to give service providers new layout and configuration options. [https://resources.emersion.com/display/EKB/2017/11/21/Announcement+-+Invoice+Templates Check out the details here].

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
=== Emersion Knowledge Base News ===
* Looking for help for Invoice Templates? [[Main_Page/2017_EKB/invoice_templates| Read more...]]
* Logging in to the Emersion Knowledge Base [[Main_Page/2017_EKB/Authentication| Read more...]]
* We have begin shifting to our new Emersion Knowledge Base. [[Main_Page/2017_EKB|Read More...]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>

=== SUPPORT ===
* [[New Tariffs|See the latest updates to our Tariff Lists]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>

=== TRAINING ===
* [[Service_Types|The Emersion 101 on Service Types]]
* [[Product_Rate_Cards/Access_Fee_Discount|Discount pricing based on volume? Have you seen our Access Fee Discount feature yet?]]
* [[Ledger_Allocating_Payments|Allocating Payments to Invoices and the Ledger Journal]]
</p>
</td>
</tr>

<tr colspan=3>
<td>
=== RELEASE NOTES ===

* [[ReleaseNotes|See what's new in the latest update of Emersion]]

</td>
</tr>

</table>

== Core Emersion Modules ==
<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
* [[Admin|Admin Settings]]
** [[Admin/PermissionManagement|Permissions Management]]
* [[Account Management | Customer and Account Management]]
** [[Account Management/Customer Screen | The Customer Screen]]

'''Billing Objects'''
* [[Billing Objects|An Introduction to all the Emersion Billing Objects]]
* [[Service_Types|Service Types]]
* [[PackagePlans/PackagePlans|Package Plans]]
* [[ServicePlans/ServicePlans|Service Plans]]
* [[ServicePlans/RateCard|Rate Cards and Rates]]
** [[ServicePlans/RateCard/Creating_Rate_Cards|Maintaining Rate Cards and Rates]]
* [[Services | Services]]
* [[Products|Products]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
* [[Invoicing|Invoicing]]
* [[Billing_Cheat_Sheet|The Billing Cheat Sheet]]
* [[Ledger_Management|Ledger Management]]
</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>

* [[Services/Orders | Ordering services]]
* [[Account_Management/Customer_Screen/Service_Subscriptions|Service Subscriptions]]
* [[Main_Page/Provisioning|Provisioning]]
* [[Quarantine|Quarantine]]
* [[:Events|Events]]
* [[Reports|Reports]]
* [[Data Import|Data Import (Bulk Upload/Update)]]
</p>
</td>
</tr>
</table>

== Optional Modules ==

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
* [[Account Management/Auto Top-up | Automated Top-up]]
* [[Agent Management |Agents]]
* [[Cost_Centres|Cost Centres]]
* [[Commissions|Commissions]]
* [[EPS|Electronic Payments]]
* [[Inventory and Warehouses | Inventory and Warehouses]]
</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
* [[Payments/Manual_Payment_Batch | Manual Payment Batch]]
* [[Payment Plans V2 | Payment Plans]]
* [[Service Desk|Service Desk]]
* [[Early Upgrade|Early Upgrades]]
* [[Admin/Credit_Levels|Credit Levels for Staff Users]]
* [[Product_Rate_Cards/Access_Fee_Discount|Access Fee Discounts based on volume]]
</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
* [[API | Emersion APIs]]
</p>
<p>
* External Portals
** [[End_User_Portal|End User Portal]]
** [[Sign_Up_Portal|Sign Up Portal]]
** [[Main_Page/Provisioning/Service_Type_Migrate/Service_Activation_Portal|Service Activation Portal]]
</p>
</td>
</tr>
</table>

== Integration ==
* [[Integrations|Integration with Other Applications]] (eg. Xero, ZenDesk)
* [[Integrations/Postal Integration Invoice Delivery|Postal Invoices and Integration for Invoice delivery to mail houses]]

== References ==
* [[Reference|Reference Material]]
* [[Glossary|Glossary of Terms and Abbreviations]]

== Training and Consulting Services ==

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
<b>Training</b>
* [[Emersion User Manuals|Emersion User Manuals]]
* [[Emersion Training Slides|Training Slides]]
* [[Emersion Videos|Training Videos]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
<b>Consulting Services</b>
* [[Consulting_Services/Package_Plans | Package Plan Consulting]]
</p>
</td>
<td width="33.33%" align="left" valign="top">  
</td>
</tr>

<tr>
<td>   </td>
<td>   </td>
<td>   </td>
</tr>

</table>

== Additional Help ==

* [[Support and help from Emersion|If you need Support from Emersion, start here]]
* [[Emersion Invoice Reconciliation|How to Reconcile Emersion's Invoice to you]]

== Carrier & Service Supplier information ==
This section contains infomation relevant to specific service suppliers and carriers that are popular in Emersion.

=== Optus ===
* [[Optus Usage collection | Optus RBT and Optus Multiline]]
[[file:Emersion Optus RBT Service Management System Manual v1.2.pdf]]<br />
[[file:Emersion Optus RBT Wholesaler Appendix v1.0.pdf]]<br />

=== Telstra ===
* [[Telstra_NBN|Telstra NBN]]
* [[file:Emersion Telstra eBill Manual V1.0.pdf]]<br />
* [[file:Emersion Telstra 3G Manual V0.1.pdf]]<br />
* [[file:Emersion Telstra Mobile Management User Manual v1.0.pdf]]<br />

=== AAPT ===
[[file:Emersion AAPT DSL Manual V2.0.pdf|Emersion AAPT DSL Manual]]<br />

* [[AAPT Rebill | AAPT Rebill]]
* [[Broadsoft Softswitch as a Service | AAPT Broadsoft Softswitch as a Service (Voice SSasS) - Semi Manual]]
* [[AAPT_National_Wholesale_Broadband_L3 | AAPT National Wholesale Broadband L3 (Broadband Connect) Layer 3]]
* [[AAPT IP-Line | AAPT IP-Line]]

Main Page

2017-12-06T04:45:14Z

Medge:

{{DISPLAYTITLE:'''Welcome to the Emersion Software Systems Wiki'''}}

This repository is used to provide education on Emersion's billing and provisioning system, Emersion concepts and online help to all Emersion's users regarding all of the features and functions available to you.

The Emersion Wiki is updated regularly to reflect the latest changes to the system. New and updated articles (and videos) are appearing every week. Therefore we encourage you to visit this wiki on a regular basis and subscribe to updates.

If there is a section of the system of which you would specifically like further information about, please contact our [[Support and help from Emersion|support team]].

AWS
== Announcements ==
Emersion is pleased to advise our customers that we have released a significant set of enhancements to invoice templates in order to give service providers new layout and configuration options. [https://resources.emersion.com/display/EKB/2017/11/21/Announcement+-+Invoice+Templates Check out the details here].

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
=== Emersion Knowledge Base News ===
* Looking for help for Invoice Templates? [[Main_Page/2017_EKB/invoice_templates| Read more...]]
* Logging in to the Emersion Knowledge Base [[Main_Page/2017_EKB/Authentication| Read more...]]
* We have begin shifting to our new Emersion Knowledge Base. [[Main_Page/2017_EKB|Read More...]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>

=== SUPPORT ===
* [[New Tariffs|See the latest updates to our Tariff Lists]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>

=== TRAINING ===
* [[Service_Types|The Emersion 101 on Service Types]]
* [[Product_Rate_Cards/Access_Fee_Discount|Discount pricing based on volume? Have you seen our Access Fee Discount feature yet?]]
* [[Ledger_Allocating_Payments|Allocating Payments to Invoices and the Ledger Journal]]
</p>
</td>
</tr>

<tr colspan=3>
<td>
=== RELEASE NOTES ===

* [[ReleaseNotes|See what's new in the latest update of Emersion]]

</td>
</tr>

</table>

== Core Emersion Modules ==
<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
* [[Admin|Admin Settings]]
** [[Admin/PermissionManagement|Permissions Management]]
* [[Account Management | Customer and Account Management]]
** [[Account Management/Customer Screen | The Customer Screen]]

'''Billing Objects'''
* [[Billing Objects|An Introduction to all the Emersion Billing Objects]]
* [[Service_Types|Service Types]]
* [[PackagePlans/PackagePlans|Package Plans]]
* [[ServicePlans/ServicePlans|Service Plans]]
* [[ServicePlans/RateCard|Rate Cards and Rates]]
** [[ServicePlans/RateCard/Creating_Rate_Cards|Maintaining Rate Cards and Rates]]
* [[Services | Services]]
* [[Products|Products]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
* [[Invoicing|Invoicing]]
* [[Billing_Cheat_Sheet|The Billing Cheat Sheet]]
* [[Ledger_Management|Ledger Management]]
</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>

* [[Services/Orders | Ordering services]]
* [[Account_Management/Customer_Screen/Service_Subscriptions|Service Subscriptions]]
* [[Main_Page/Provisioning|Provisioning]]
* [[Quarantine|Quarantine]]
* [[:Events|Events]]
* [[Reports|Reports]]
* [[Data Import|Data Import (Bulk Upload/Update)]]
</p>
</td>
</tr>
</table>

== Optional Modules ==

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
* [[Account Management/Auto Top-up | Automated Top-up]]
* [[Agent Management |Agents]]
* [[Cost_Centres|Cost Centres]]
* [[Commissions|Commissions]]
* [[EPS|Electronic Payments]]
* [[Inventory and Warehouses | Inventory and Warehouses]]
</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
* [[Payments/Manual_Payment_Batch | Manual Payment Batch]]
* [[Payment Plans V2 | Payment Plans]]
* [[Service Desk|Service Desk]]
* [[Early Upgrade|Early Upgrades]]
* [[Admin/Credit_Levels|Credit Levels for Staff Users]]
* [[Product_Rate_Cards/Access_Fee_Discount|Access Fee Discounts based on volume]]
</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
* [[API | Emersion APIs]]
</p>
<p>
* External Portals
** [[End_User_Portal|End User Portal]]
** [[Sign_Up_Portal|Sign Up Portal]]
** [[Main_Page/Provisioning/Service_Type_Migrate/Service_Activation_Portal|Service Activation Portal]]
</p>
</td>
</tr>
</table>

== Integration ==
* [[Integrations|Integration with Other Applications]] (eg. Xero, ZenDesk)
* [[Integrations/Postal Integration Invoice Delivery|Postal Invoices and Integration for Invoice delivery to mail houses]]

== References ==
* [[Reference|Reference Material]]
* [[Glossary|Glossary of Terms and Abbreviations]]

== Training and Consulting Services ==

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
<b>Training</b>
* [[Emersion User Manuals|Emersion User Manuals]]
* [[Emersion Training Slides|Training Slides]]
* [[Emersion Videos|Training Videos]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
<b>Consulting Services</b>
* [[Consulting_Services/Package_Plans | Package Plan Consulting]]
</p>
</td>
<td width="33.33%" align="left" valign="top">  
</td>
</tr>

<tr>
<td>   </td>
<td>   </td>
<td>   </td>
</tr>

</table>

== Additional Help ==

* [[Support and help from Emersion|If you need Support from Emersion, start here]]
* [[Emersion Invoice Reconciliation|How to Reconcile Emersion's Invoice to you]]

== Carrier & Service Supplier information ==
This section contains infomation relevant to specific service suppliers and carriers that are popular in Emersion.

=== Optus ===
* [[Optus Usage collection | Optus RBT and Optus Multiline]]
[[file:Emersion Optus RBT Service Management System Manual v1.2.pdf]]<br />
[[file:Emersion Optus RBT Wholesaler Appendix v1.0.pdf]]<br />

=== Telstra ===
* [[Telstra_NBN|Telstra NBN]]
* [[file:Emersion Telstra eBill Manual V1.0.pdf]]<br />
* [[file:Emersion Telstra 3G Manual V0.1.pdf]]<br />
* [[file:Emersion Telstra Mobile Management User Manual v1.0.pdf]]<br />

=== AAPT ===
[[file:Emersion AAPT DSL Manual V2.0.pdf|Emersion AAPT DSL Manual]]<br />

* [[AAPT Rebill | AAPT Rebill]]
* [[Broadsoft Softswitch as a Service | AAPT Broadsoft Softswitch as a Service (Voice SSasS) - Semi Manual]]
* [[AAPT_National_Wholesale_Broadband_L3 | AAPT National Wholesale Broadband L3 (Broadband Connect) Layer 3]]
* [[AAPT IP-Line | AAPT IP-Line]]

Main Page

2017-12-06T01:23:17Z

Medge:

{{DISPLAYTITLE:'''Welcome to the Emersion Software Systems Wiki'''}}

This repository is used to provide education on Emersion's billing and provisioning system, Emersion concepts and online help to all Emersion's users regarding all of the features and functions available to you.

The Emersion Wiki is updated regularly to reflect the latest changes to the system. New and updated articles (and videos) are appearing every week. Therefore we encourage you to visit this wiki on a regular basis and subscribe to updates.

If there is a section of the system of which you would specifically like further information about, please contact our [[Support and help from Emersion|support team]].

== Announcements ==
Emersion is pleased to advise our customers that we have released a significant set of enhancements to invoice templates in order to give service providers new layout and configuration options. [https://resources.emersion.com/display/EKB/2017/11/21/Announcement+-+Invoice+Templates Check out the details here].

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
=== Emersion Knowledge Base News ===
* Looking for help for Invoice Templates? [[/2017_EKB/invoice_templates| Read more...]]
* Logging in to the Emersion Knowledge Base [[/2017_EKB/Authentication| Read more...]]
* We have begin shifting to our new Emersion Knowledge Base. [[/2017_EKB|Read More...]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>

=== SUPPORT ===
* [[New Tariffs|See the latest updates to our Tariff Lists]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>

=== TRAINING ===
* [[Service_Types|The Emersion 101 on Service Types]]
* [[Product_Rate_Cards/Access_Fee_Discount|Discount pricing based on volume? Have you seen our Access Fee Discount feature yet?]]
* [[Ledger_Allocating_Payments|Allocating Payments to Invoices and the Ledger Journal]]
</p>
</td>
</tr>

<tr colspan=3>
<td>
=== RELEASE NOTES ===

* [[ReleaseNotes|See what's new in the latest update of Emersion]]

</td>
</tr>

</table>

== Core Emersion Modules ==
<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
* [[Admin|Admin Settings]]
** [[Admin/PermissionManagement|Permissions Management]]
* [[Account Management | Customer and Account Management]]
** [[Account Management/Customer Screen | The Customer Screen]]

'''Billing Objects'''
* [[Billing Objects|An Introduction to all the Emersion Billing Objects]]
* [[Service_Types|Service Types]]
* [[PackagePlans/PackagePlans|Package Plans]]
* [[ServicePlans/ServicePlans|Service Plans]]
* [[ServicePlans/RateCard|Rate Cards and Rates]]
** [[ServicePlans/RateCard/Creating_Rate_Cards|Maintaining Rate Cards and Rates]]
* [[Services | Services]]
* [[Products|Products]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
* [[Invoicing|Invoicing]]
* [[Billing_Cheat_Sheet|The Billing Cheat Sheet]]
* [[Ledger_Management|Ledger Management]]
</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>

* [[Services/Orders | Ordering services]]
* [[Account_Management/Customer_Screen/Service_Subscriptions|Service Subscriptions]]
* [[Main_Page/Provisioning|Provisioning]]
* [[Quarantine|Quarantine]]
* [[:Events|Events]]
* [[Reports|Reports]]
* [[Data Import|Data Import (Bulk Upload/Update)]]
</p>
</td>
</tr>
</table>

== Optional Modules ==

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
* [[Account Management/Auto Top-up | Automated Top-up]]
* [[Agent Management |Agents]]
* [[Cost_Centres|Cost Centres]]
* [[Commissions|Commissions]]
* [[EPS|Electronic Payments]]
* [[Inventory and Warehouses | Inventory and Warehouses]]
</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
* [[Payments/Manual_Payment_Batch | Manual Payment Batch]]
* [[Payment Plans V2 | Payment Plans]]
* [[Service Desk|Service Desk]]
* [[Early Upgrade|Early Upgrades]]
* [[Admin/Credit_Levels|Credit Levels for Staff Users]]
* [[Product_Rate_Cards/Access_Fee_Discount|Access Fee Discounts based on volume]]
</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
* [[API | Emersion APIs]]
</p>
<p>
* External Portals
** [[End_User_Portal|End User Portal]]
** [[Sign_Up_Portal|Sign Up Portal]]
** [[Main_Page/Provisioning/Service_Type_Migrate/Service_Activation_Portal|Service Activation Portal]]
</p>
</td>
</tr>
</table>

== Integration ==
* [[Integrations|Integration with Other Applications]] (eg. Xero, ZenDesk)
* [[Integrations/Postal Integration Invoice Delivery|Postal Invoices and Integration for Invoice delivery to mail houses]]

== References ==
* [[Reference|Reference Material]]
* [[Glossary|Glossary of Terms and Abbreviations]]

== Training and Consulting Services ==

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">
<p>
<b>Training</b>
* [[Emersion User Manuals|Emersion User Manuals]]
* [[Emersion Training Slides|Training Slides]]
* [[Emersion Videos|Training Videos]]

</p>
</td>
<td width="33.33%" align="left" valign="top">
<p>
<b>Consulting Services</b>
* [[Consulting_Services/Package_Plans | Package Plan Consulting]]
</p>
</td>
<td width="33.33%" align="left" valign="top">  
</td>
</tr>

<tr>
<td>   </td>
<td>   </td>
<td>   </td>
</tr>

</table>

== Additional Help ==

* [[Support and help from Emersion|If you need Support from Emersion, start here]]
* [[Emersion Invoice Reconciliation|How to Reconcile Emersion's Invoice to you]]

== Carrier & Service Supplier information ==
This section contains infomation relevant to specific service suppliers and carriers that are popular in Emersion.

=== Optus ===
* [[Optus Usage collection | Optus RBT and Optus Multiline]]
[[file:Emersion Optus RBT Service Management System Manual v1.2.pdf]]<br />
[[file:Emersion Optus RBT Wholesaler Appendix v1.0.pdf]]<br />

=== Telstra ===
* [[Telstra_NBN|Telstra NBN]]
* [[file:Emersion Telstra eBill Manual V1.0.pdf]]<br />
* [[file:Emersion Telstra 3G Manual V0.1.pdf]]<br />
* [[file:Emersion Telstra Mobile Management User Manual v1.0.pdf]]<br />

=== AAPT ===
[[file:Emersion AAPT DSL Manual V2.0.pdf|Emersion AAPT DSL Manual]]<br />

* [[AAPT Rebill | AAPT Rebill]]
* [[Broadsoft Softswitch as a Service | AAPT Broadsoft Softswitch as a Service (Voice SSasS) - Semi Manual]]
* [[AAPT_National_Wholesale_Broadband_L3 | AAPT National Wholesale Broadband L3 (Broadband Connect) Layer 3]]
* [[AAPT IP-Line | AAPT IP-Line]]

API/Services/serviceLookup

2017-09-27T00:46:41Z

Medge: made it correctorer

'''Purpose '''

Returns service subscription information for a particular service identifier.

Note: This API will return all service subscriptions that are under your end users irrespective of the status that match the supplied identifier.

'''Inputs'''

<soapenv:Body>
<ser:serviceLookup>
<ser:service_identifier>1300333333</ser:service_identifier> - identifier to search (mandatory)
<ser:service_type_id>133300</ser:service_type_id> - service type ID to filter with (optional) - see reference data for more information
<ser:max_records>100</ser:max_records> - limit to return (optional)
</ser:serviceLookup>
</soapenv:Body>

'''Output'''
<SOAP-ENV:Body>
<ns1:serviceLookupResponse>
<ns1:serviceLookupItem>
<ns1:account_id></ns1:account_id> - end user account ID
<ns1:service_identifier></ns1:service_identifier> - service identifier provided via input
<ns1:subscription_status_name></ns1:subscription_status_name> - vanity name for the subscription status (e.g. Preactive, Active etc.)
<ns1:subscription_status_id></ns1:subscription_status_id> - primary key for the subscription status (e.g. 1 = Preactive - See reference tables for full mapping)
<ns1:service_subscr_start_date></ns1:service_subscr_start_date> - the date the subscription started
<ns1:service_subscr_end_date></ns1:service_subscr_end_date> - the date the subscription ended
<ns1:contract_length></ns1:contract_length> - the length of the contract by definition (not how much time is left, how long it is defined to be.)
<ns1:contract_internal_name></ns1:contract_internal_name> - the internal name attached to the contract (if a contract is attached.)
<ns1:contract_external_name></ns1:contract_external_name> - the external name attached to the contract (if a contract is attached.)
<ns1:contract_start_date></ns1:contract_start_date> - the start date of the contract (if a contract is attached.)
<ns1:contract_end_date></ns1:contract_end_date> - the enddate of the contract (if a contract is attached.)
<ns1:service_start_date></ns1:service_start_date> - the start date of the service
<ns1:service_end_date></ns1:service_end_date> - the end date of the service
<ns1:service_type_name></ns1:service_type_name> - the vanity name attached to the service type
<ns1:carrier_name></ns1:carrier_name> - the carrier name
<ns1:service_id></ns1:service_id> - the primary key for the service.
</ns1:serviceLookupItem>
</ns1:serviceLookupResponse>
</SOAP-ENV:Body>

'''Validation Errors'''
- Missing service_identifier - Missing mandatory parameter for service identifier.

API/Services/serviceLookup

2017-09-27T00:32:40Z

Medge: made it corrector

'''Purpose '''

Returns service subscription information for a particular service identifier.

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ser:serviceLookup>
<ser:service_identifier>1</ser:service_identifier>
</ser:serviceLookup>
</soapenv:Body>

'''Output'''
<SOAP-ENV:Body>
<ns1:serviceLookupResponse>
<ns1:serviceLookupItem>
<ns1:account_id></ns1:account_id> - end user account ID
<ns1:service_identifier></ns1:service_identifier> - service identifier provided via input
<ns1:subscription_status_name></ns1:subscription_status_name> - vanity name for the subscription status (e.g. Preactive, Active etc.)
<ns1:subscription_status_id></ns1:subscription_status_id> - primary key for the subscription status (e.g. 1 = Preactive - See reference tables for full mapping)
<ns1:service_subscr_start_date></ns1:service_subscr_start_date> - the date the subscription started
<ns1:service_subscr_end_date></ns1:service_subscr_end_date> - the date the subscription ended
<ns1:contract_length></ns1:contract_length> - the length of the contract by definition (not how much time is left, how long it is defined to be.)
<ns1:contract_internal_name></ns1:contract_internal_name> - the internal name attached to the contract (if a contract is attached.)
<ns1:contract_external_name></ns1:contract_external_name> - the external name attached to the contract (if a contract is attached.)
<ns1:contract_start_date></ns1:contract_start_date> - the start date of the contract (if a contract is attached.)
<ns1:contract_end_date></ns1:contract_end_date> - the enddate of the contract (if a contract is attached.)
<ns1:service_start_date></ns1:service_start_date> - the start date of the service
<ns1:service_end_date></ns1:service_end_date> - the end date of the service
<ns1:service_type_name></ns1:service_type_name> - the vanity name attached to the service type
<ns1:carrier_name></ns1:carrier_name> - the carrier name
<ns1:service_id></ns1:service_id> - the primary key for the service.
</ns1:serviceLookupItem>
</ns1:serviceLookupResponse>
</SOAP-ENV:Body>

'''Validation Errors'''
- Missing service_identifier - Missing mandatory parameter for service identifier.

API/Services/serviceLookup

2017-09-27T00:31:18Z

Medge: made it correct.

'''Purpose '''

Returns service subscription information for a particular service identifier.

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ser:serviceLookup>
<ser:service_identifier>1</ser:service_identifier>
</ser:serviceLookup>
</soapenv:Body>

'''Output'''
<SOAP-ENV:Body>
<ns1:serviceLookupResponse>
<ns1:serviceLookupItem>
<ns1:account_id></ns1:account_id> - end user account ID
<ns1:service_identifier></ns1:service_identifier> - service identifier provided via input
<ns1:subscription_status_name></ns1:subscription_status_name> - vanity name for the subscription status (e.g. Preactive, Active etc.)
<ns1:subscription_status_id></ns1:subscription_status_id> - primary key for the subscription status (e.g. 1 = Preactive - See reference tables for full mapping)
<ns1:service_subscr_start_date></ns1:service_subscr_start_date> - the date the subscription started
<ns1:service_subscr_end_date></ns1:service_subscr_end_date> - the date the subscription ended
<ns1:contract_internal_name></ns1:contract_internal_name> - the internal name attached to the contract (if a contract is attached.)
<ns1:contract_external_name></ns1:contract_external_name> - the external name attached to the contract (if a contract is attached.)
<ns1:contract_start_date></ns1:contract_start_date> - the start date of the contract (if a contract is attached.)
<ns1:contract_end_date></ns1:contract_end_date> - the enddate of the contract (if a contract is attached.)
<ns1:service_start_date></ns1:service_start_date> - the start date of the service
<ns1:service_end_date></ns1:service_end_date> - the end date of the service
<ns1:service_type_name></ns1:service_type_name> - the vanity name attached to the service type
<ns1:carrier_name></ns1:carrier_name> - the carrier name
<ns1:service_id></ns1:service_id> - the primary key for the service.
</ns1:serviceLookupItem>
</ns1:serviceLookupResponse>
</SOAP-ENV:Body>

'''Validation Errors'''
- Missing service_identifier - Missing mandatory parameter for service identifier.

API/Services/TokeniseCreditCard

2016-11-16T20:30:45Z

Medge:

'''Purpose '''

This allow customer to store credit card in to EPS and generate token for a secure way of making / requesting payment.

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ser:TokeniseCreditCardRequest>
<ser:TokeniseCreditCard account_id="511596" card_type="Visa" card_name="Customer Name" card_number="4444333322221111" card_expiry="6/2015" card_cvv="123" automated_payment_configuration="1" />
</ser:TokeniseCreditCardRequest>
</soapenv:Body>

'''Description'''

Required attribute:
* automated_payment_configuration = Type positive integer option:
** 1 = One off payment (Default).
** 2 = One off payment and set as default payment.
** 3 = Set as default payment and enable recurring charges.
* account_id = Type positive integer
* Card_type = Type Option
** Visa
** MasterCard
** American Express
** Diners
* card_name = Type string at least 1 character
* card_number = Type string must be valid card credit card number base on the card_type
* card_expiry = Type date format mm/YYYY
* card_cvv = Type non negative integer

'''Output'''
<SOAP-ENV:Body>
<ns1:TokeniseCreditCardResponse>
<ns1:CreditCardTokenResponse>
305889725747721480112620601729009174294547589547C
</ns1:CreditCardTokenResponse>
</ns1:TokeniseCreditCardResponse>
</SOAP-ENV:Body>

'''Error String'''

148.Payment gateway has not been initialised

149.Required TokeniseCreditCard' element

150.Invalid account ID ['.$requestDetails->account_id.'].

151.Account provided is not currently active.

152.Required credit card type

153.Required credit card number

154.Required credit card holder name

155.Required credit card expiry date

156.Credit Card provided expired.

157.Invalid credit card expiry date

158.Required credit card security number / cvv

159.Credit card type ['.$requestDetails->card_type.'] is currently not supported. Please try another card.

160.Invalid Credit Card Details.

161.Unable to process credit card. '.$request->getError());

API/RetailServices/UsersByRealm

2016-10-27T04:48:36Z

Medge:

'''Purpose '''

The UsersByRealm function allows you get RADIUS information about users for a given realm.

'''Inputs'''
<nowiki><soapenv:Header/>
<soapenv:Body>
<ret:UsersByRealm>
<ret:realm>1</ret:realm>
</ret:UsersByRealm>
</soapenv:Body></nowiki>

'''Output'''
<nowiki><SOAP-ENV:Body>
<ns1:UsersByRealmResponse>
<ns1:ComplexUser>
<ns1:account_id>1</ns1:account_id>
<ns1:service_id>1</ns1:>
<ns1:service_subscription_id>1</ns1:service_subscription_id>
<ns1:account_name>1</ns1:account_name>
<ns1:fnn>1</ns1:fnn>
<ns1:username>1</ns1:username>
<ns1:password>1</ns1:password>
<ns1:reply_attributes>1</ns1:reply_attributes>
<ns1:ip_address>1</ns1:ip_address>
<ns1:framed_route>1</ns1:framed_route>
<ns1:shaping_attributes>1</ns1:shaping_attributes>
<ns1:service_name>1</ns1:service_name>
<ns1:total_period_upload_data>1</ns1:total_period_upload_data>
<ns1:total_period_download_data>1</ns1:total_period_download_data>
<ns1:total_allowance>1</ns1:total_allowance>
<ns1:usage_period_start>1</ns1:usage_period_start>
<ns1:usage_period_end>1</ns1:usage_period_end>
</ns1:ComplexUser>
</ns1:UsersByRealmResponse>
</SOAP-ENV:Body></nowiki>

'''Error String'''

202. Invalid or Missing account id

203. Invalid or Missing realm

204. Records not found

API/RetailServices/UsersByUserName

2016-10-27T04:48:14Z

Medge:

'''Purpose '''

The UsersByUserName function allows you get RADIUS information about a particular user.

'''Inputs'''
<nowiki><soapenv:Header/>
<soapenv:Body>
<ret:UsersByUserName>
<ret:username>name</ret:username>
</ret:UsersByUserName>
</soapenv:Body>
</nowiki>
'''Output'''
<nowiki><SOAP-ENV:Body>
<ns1:UsersByUserNameResponse>
<ns1:ComplexUser>
<ns1:account_id>1</ns1:account_id>
<ns1:service_id>1</ns1:>
<ns1:service_subscription_id>1</ns1:service_subscription_id>
<ns1:account_name>1</ns1:account_name>
<ns1:fnn>1</ns1:fnn>
<ns1:username>1</ns1:username>
<ns1:password>1</ns1:password>
<ns1:reply_attributes>1</ns1:reply_attributes>
<ns1:ip_address>1</ns1:ip_address>
<ns1:framed_route>1</ns1:framed_route>
<ns1:shaping_attributes>1</ns1:shaping_attributes>
<ns1:service_name>1</ns1:service_name>
<ns1:total_period_upload_data>1</ns1:total_period_upload_data>
<ns1:total_period_download_data>1</ns1:total_period_download_data>
<ns1:total_allowance>1</ns1:total_allowance>
<ns1:usage_period_start>1</ns1:usage_period_start>
<ns1:usage_period_end>1</ns1:usage_period_end>
</ns1:ComplexUser>
</ns1:UsersByUserNameResponse>
</SOAP-ENV:Body></nowiki>

'''Error String'''

205. Invalid or Missing account id

206. Invalid or Missing username

207. Records not found '. $username

Service Desk

2016-10-12T23:46:25Z

Medge:

The Service Desk module (sometimes referred to as the ticketing module) gives users the ability to:

* offer customers the ability to log faults or issues to a set of pre-defined ticket queues
* Easily view, access and action tickets for a customer
* assign and reassign tickets to other staff users.
* link to services to assist in isolating what a ticket might be about
* Escalate to your supplier (parent) if your wholesaler is also using Emersion
* Leverage the ticket 'status' to manage escalations.

The following video will run you through the basic use of the service desk operation.

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">http://wiki.emersion.com.au/wiki/media/service_desk_basic_training.mp4</mediaplayer>

Some advanced features exist for the service desk product such as;

* Routing of creation and updating of tickets using an inbound email address and email box
* Identifying tickets which have not yet been associated with a customer.

For a training session or an enquiry on these advanced functions, please contact sales.

API/RetailServices

2016-03-30T22:40:17Z

Medge:

The 'RetailServices' section of the Emersion API layer works with functions to do with the debit and credit of cardlines or payments as well as a number of radius based services for those clients that use Emersion Radius.

The WSDL is at https://external.emersion.com.au/RetailServices.wsdl

* [[API/RetailServices/CreateLedgerCardline|Create Ledger Cardline]]
* [[API/RetailServices/CreatePayment|Create Payment]]
* [[API/RetailServices/UpdateFlatFile|Update Flat File]]
* [[API/RetailServices/UsersByRealm|Users By Realm]]
* [[API/RetailServices/UsersByUserName|Users By User Name]]

API/RetailServices

2016-03-30T22:39:30Z

Medge:

The 'RetailServices' section of the Emersion API layer works with functions to do with the debit and credit of cardlines or payments as well as a number of radius based services for those clients that use Emersion Radius.

The WSDL is at https://external-prerelease.emersion.com.au/RetailServices.wsdl

* [[API/RetailServices/CreateLedgerCardline|Create Ledger Cardline]]
* [[API/RetailServices/CreatePayment|Create Payment]]
* [[API/RetailServices/UpdateFlatFile|Update Flat File]]
* [[API/RetailServices/UsersByRealm|Users By Realm]]
* [[API/RetailServices/UsersByUserName|Users By User Name]]

Data Import/Payments

2015-12-03T00:23:34Z

Medge: /* Emersion File Format */

= Bulk Import Payments =

The ''Bulk Import'' function allows you to import payment details received from external sources, e.g. [[BPAY|BPAY]] etc. The payments are then applied against customer accounts without requiring manual entry using the [[Receive_Payment|''Receive Payment'']] or [[Take_Payment|''Take Payment'']] functions.

Emersion supports two import file formats: Emersion Format Comma Separated Value file (.CSV), and Australian Bankers Association format (.ABA).

==Emersion File Format==

NOTE: The format for the Emersion File Format has changed. Please review the below carefully.

The Emersion Bulk Payment file is in .CSV format, as follows:

{| border="1" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
|-
|'''Field'''
|'''Description'''
|-
|'PAYMENT_DATE'
|(YYYY-MM-DD)
|-
|'PAYMENT_TIME'
|(HH:MM:SS)
|-
|'ACCOUNT_ID'
|(Emersion Account ID e.g 123456)
|-
|'BPAY_BILLER_CODE'
|
|-
|'BPAY_REFERENCE'
|
|-
|'CUST_REFERENCE'
|
|-
|'AMOUNT'
|(INC TAX)
|-
|'SURCHARGE_AMOUNT'
|(EX TAX)
|-
|'SURCHARGE_PERCENT'
|(As a whole Number e.g 3% = '3')
|-
|'PAYMENT_METHOD'
|(See Below Ref Table)
|-
|'PAYMENT_NOTE'
|
|-
|'INVOICE_LIST'
|Pipe Delimited list - If blank will be Unallocated Payment. Where INVOICE_LIST and INVOICE_ALLOCATION_LIST are pipe delimited fields including which invoices are to be paid, and how much is meant to be allocated.
|-
|'INVOICE_ALLOCATION_LIST'
|Pipe Delimited list if $ amounts in the same order as the Invoices in the Invoice List.
|-
|'SURCHARGE_IN_AMOUNT'
|(true - when the surcharge is contained in the amount)
|-
|'SURCHARGE_AMOUNT_INC_TAX'
|(true - when the surcharge (amount) already includes tax)
|}

Accepted payment methods:
VISA_MC, AMEX, DINERS, CONTRA, AGENT, DIRECTDEBIT, EFT, EFTPOS, CASH, CHEQUE, MORDER, BPAY, PAYBYPHONE, POSTBILLPAY, CREDITCARD, CCOLLECTION, SECUREPAYIVR, XERO

==ABA File Format==

The Australian Bankers Association (ABA) file format is used by many banks for batch transactions. Though not an Australian standard, many banks have adopted this format (e.g. Bank of Queensland, NAM, Westpac etc). The ABA file format is also known as a Direct Entry file or Centrex file. It has the file extension .ABA and is a standard ASCII file. Please contact your bank or financial institution for further information about obtaining your payment information in ABA format.

==Bulk Import==

# Select '''Finance''' > '''Bulk Import '''from the '''Menu.''' The ''Import Payments page'' will appear.
# Select the file type of the payment file to import by clicking the required file type option button, either ''Emersion Bulk Format'', or ''ABA''. You can click the ''Sample Format File'' link beside the file option to display the file format.
# Click the '''Browse''' button beside the ''* CSV File to Import'' field. A ''File Upload'' window will appear.
# Navigate to and select the required payment file and click the '''Open''' button. The selected file name will appear in the ''* CSV File to Import'' field.
# Click the '''Upload File and Verify''' button. The system will verify the file is in the correct format. Once verified, the ''Import Payments – Preview File & Confirm'' page will display.
# Click the '''Confirm Import''' button. A window will appear to prompt you to confirm the upload.
# Click the '''Yes''' button to confirm the file upload. The system will process the payments in the file'', ''and update the accounts’ payment details with the payment information.
# Click the '''No''' button to cancel the file upload.

== Manual Payment Imports ==

There is an additional feature that allows a user to bulk import payments that are sourced from the following providers;
* Secure Pay IVR
* Aust Post Bill Pay
* Commbiz Bpay

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">http://wiki.emersion.com.au/wiki/media/manual_payment_import.mp4</mediaplayer>

= See Also =
* [[Payments|Payments]]
* [[EPS|EPS]]
* [[BPAY|BPAY]]
* [[Invoicing|Invoicing]]

Data Import/Payments

2015-12-03T00:20:35Z

Medge: /* Emersion File Format */

= Bulk Import Payments =

The ''Bulk Import'' function allows you to import payment details received from external sources, e.g. [[BPAY|BPAY]] etc. The payments are then applied against customer accounts without requiring manual entry using the [[Receive_Payment|''Receive Payment'']] or [[Take_Payment|''Take Payment'']] functions.

Emersion supports two import file formats: Emersion Format Comma Separated Value file (.CSV), and Australian Bankers Association format (.ABA).

==Emersion File Format==

NOTE: The format for the Emersion File Format has changed. Please review the below carefully.

The Emersion Bulk Payment file is in .CSV format, as follows:

{| border="1" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
|-
|'''Field'''
|'''Description'''
|-
|'PAYMENT_DATE'
|(YYYY-MM-DD)
|-
|'PAYMENT_TIME'
|(HH:MM:SS)
|-
|'ACCOUNT_ID'
|(Emersion Account ID e.g 123456)
|-
|'BPAY_BILLER_CODE'
|
|-
|'BPAY_REFERENCE'
|
|-
|'CUST_REFERENCE'
|
|-
|'AMOUNT'
|(INC TAX)
|-
|'SURCHARGE_AMOUNT'
|(EX TAX)
|-
|'SURCHARGE_PERCENT'
|(As a whole Number e.g 3% = '3')
|-
|'PAYMENT_METHOD'
|(See Below Ref Table)
|-
|'PAYMENT_NOTE'
|
|-
|'INVOICE_LIST'
|Pipe Delimited list - If blank will be Unallocated Payment. Where INVOICE_LIST and INVOICE_ALLOCATION_LIST are pipe delimited fields including which invoices are to be paid, and how much is meant to be allocated.
|-
|'INVOICE_ALLOCATION_LIST'
|Pipe Delimited list if $ amounts in the same order as the Invoices in the Invoice List.
|-
|'SURCHARGE_IN_AMOUNT'
|(true - when the surcharge is contained in the amount)
|-
|'SURCHARGE_AMOUNT_INC_TAX'
|(true - when the surcharge (amount) already includes tax)
|}

==ABA File Format==

The Australian Bankers Association (ABA) file format is used by many banks for batch transactions. Though not an Australian standard, many banks have adopted this format (e.g. Bank of Queensland, NAM, Westpac etc). The ABA file format is also known as a Direct Entry file or Centrex file. It has the file extension .ABA and is a standard ASCII file. Please contact your bank or financial institution for further information about obtaining your payment information in ABA format.

==Bulk Import==

# Select '''Finance''' > '''Bulk Import '''from the '''Menu.''' The ''Import Payments page'' will appear.
# Select the file type of the payment file to import by clicking the required file type option button, either ''Emersion Bulk Format'', or ''ABA''. You can click the ''Sample Format File'' link beside the file option to display the file format.
# Click the '''Browse''' button beside the ''* CSV File to Import'' field. A ''File Upload'' window will appear.
# Navigate to and select the required payment file and click the '''Open''' button. The selected file name will appear in the ''* CSV File to Import'' field.
# Click the '''Upload File and Verify''' button. The system will verify the file is in the correct format. Once verified, the ''Import Payments – Preview File & Confirm'' page will display.
# Click the '''Confirm Import''' button. A window will appear to prompt you to confirm the upload.
# Click the '''Yes''' button to confirm the file upload. The system will process the payments in the file'', ''and update the accounts’ payment details with the payment information.
# Click the '''No''' button to cancel the file upload.

== Manual Payment Imports ==

There is an additional feature that allows a user to bulk import payments that are sourced from the following providers;
* Secure Pay IVR
* Aust Post Bill Pay
* Commbiz Bpay

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">http://wiki.emersion.com.au/wiki/media/manual_payment_import.mp4</mediaplayer>

= See Also =
* [[Payments|Payments]]
* [[EPS|EPS]]
* [[BPAY|BPAY]]
* [[Invoicing|Invoicing]]

Data Import/Payments

2015-12-03T00:19:51Z

Medge: /* Emersion File Format */

= Bulk Import Payments =

The ''Bulk Import'' function allows you to import payment details received from external sources, e.g. [[BPAY|BPAY]] etc. The payments are then applied against customer accounts without requiring manual entry using the [[Receive_Payment|''Receive Payment'']] or [[Take_Payment|''Take Payment'']] functions.

Emersion supports two import file formats: Emersion Format Comma Separated Value file (.CSV), and Australian Bankers Association format (.ABA).

==Emersion File Format==

NOTE: The format for the Emersion File Format has changed. Please review the below carefully.

The Emersion Bulk Payment file is in .CSV format, as follows:

{| border="1" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
|-
|'''Field'''
|'''Description'''
|-
|'PAYMENT_DATE'
|(YYYY-MM-DD)
|-
|'PAYMENT_TIME'
|(HH:MM:SS)
|-
|'ACCOUNT_ID'
|(Emersion Account ID e.g 123456)
|-
|'BPAY_BILLER_CODE'
|
|-
|'BPAY_REFERENCE'
|
|-
|'CUST_REFERENCE'
|
|-
|'AMOUNT'
|(INC TAX)
|-
|'SURCHARGE_AMOUNT'
|(EX TAX)
|-
|'SURCHARGE_PERCENT'
|(As a whole Number e.g 3% = '3')
|-
|'PAYMENT_METHOD'
|(See Below Ref Table)
|-
|'PAYMENT_NOTE'
|
|-
|'INVOICE_LIST'
|(Pipe Delimited list e.g 123456 | 1234466)(If blank will be Unallocated Payment. Where INVOICE_LIST and INVOICE_ALLOCATION_LIST are pipe delimited fields including which invoices are to be paid, and how much is meant to be allocated.)
|-
|'INVOICE_ALLOCATION_LIST'
|(Pipe Delimited list if $ amounts in the same order as the Invoices in the Invoice List e.g 120 | 230)
|-
|'SURCHARGE_IN_AMOUNT'
|(true - when the surcharge is contained in the amount)
|-
|'SURCHARGE_AMOUNT_INC_TAX'
|(true - when the surcharge (amount) already includes tax)
|}

==ABA File Format==

The Australian Bankers Association (ABA) file format is used by many banks for batch transactions. Though not an Australian standard, many banks have adopted this format (e.g. Bank of Queensland, NAM, Westpac etc). The ABA file format is also known as a Direct Entry file or Centrex file. It has the file extension .ABA and is a standard ASCII file. Please contact your bank or financial institution for further information about obtaining your payment information in ABA format.

==Bulk Import==

# Select '''Finance''' > '''Bulk Import '''from the '''Menu.''' The ''Import Payments page'' will appear.
# Select the file type of the payment file to import by clicking the required file type option button, either ''Emersion Bulk Format'', or ''ABA''. You can click the ''Sample Format File'' link beside the file option to display the file format.
# Click the '''Browse''' button beside the ''* CSV File to Import'' field. A ''File Upload'' window will appear.
# Navigate to and select the required payment file and click the '''Open''' button. The selected file name will appear in the ''* CSV File to Import'' field.
# Click the '''Upload File and Verify''' button. The system will verify the file is in the correct format. Once verified, the ''Import Payments – Preview File & Confirm'' page will display.
# Click the '''Confirm Import''' button. A window will appear to prompt you to confirm the upload.
# Click the '''Yes''' button to confirm the file upload. The system will process the payments in the file'', ''and update the accounts’ payment details with the payment information.
# Click the '''No''' button to cancel the file upload.

== Manual Payment Imports ==

There is an additional feature that allows a user to bulk import payments that are sourced from the following providers;
* Secure Pay IVR
* Aust Post Bill Pay
* Commbiz Bpay

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">http://wiki.emersion.com.au/wiki/media/manual_payment_import.mp4</mediaplayer>

= See Also =
* [[Payments|Payments]]
* [[EPS|EPS]]
* [[BPAY|BPAY]]
* [[Invoicing|Invoicing]]

Data Import/Payments

2015-12-03T00:15:40Z

Medge: /* Emersion File Format */

= Bulk Import Payments =

The ''Bulk Import'' function allows you to import payment details received from external sources, e.g. [[BPAY|BPAY]] etc. The payments are then applied against customer accounts without requiring manual entry using the [[Receive_Payment|''Receive Payment'']] or [[Take_Payment|''Take Payment'']] functions.

Emersion supports two import file formats: Emersion Format Comma Separated Value file (.CSV), and Australian Bankers Association format (.ABA).

==Emersion File Format==

NOTE: The format for the Emersion File Format has changed. Please review the below carefully.

The Emersion Bulk Payment file is in .CSV format, as follows:

{| border="1" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
|-|'''Field'''|'''Description'''
|-|'PAYMENT_DATE'|(YYYY-MM-DD)
|-|'PAYMENT_TIME'|(HH:MM:SS)
|-|'ACCOUNT_ID'|(Emersion Account ID e.g 123456)
|-|'BPAY_BILLER_CODE'|
|-|'BPAY_REFERENCE'|
|-|'CUST_REFERENCE'|
|-|'AMOUNT'|(INC TAX)
|-|'SURCHARGE_AMOUNT'|(EX TAX)
|-|'SURCHARGE_PERCENT'|(As a whole Number e.g 3% = '3')
|-|'PAYMENT_METHOD'|(See Below Ref Table)
|-|'PAYMENT_NOTE' |
|-|'INVOICE_LIST' |(Pipe Delimited list e.g 123456 | 1234466)(If blank will be Unallocated Payment. Where INVOICE_LIST and INVOICE_ALLOCATION_LIST are pipe delimited fields including which invoices are to be paid, and how much is meant to be allocated.)
|-|'INVOICE_ALLOCATION_LIST'|(Pipe Delimited list if $ amounts in the same order as the Invoices in the Invoice List e.g 120 | 230)
|-|'SURCHARGE_IN_AMOUNT'|(true - when the surcharge is contained in the amount)
|-|'SURCHARGE_AMOUNT_INC_TAX'|(true - when the surcharge (amount) already includes tax)
|}

==ABA File Format==

The Australian Bankers Association (ABA) file format is used by many banks for batch transactions. Though not an Australian standard, many banks have adopted this format (e.g. Bank of Queensland, NAM, Westpac etc). The ABA file format is also known as a Direct Entry file or Centrex file. It has the file extension .ABA and is a standard ASCII file. Please contact your bank or financial institution for further information about obtaining your payment information in ABA format.

==Bulk Import==

# Select '''Finance''' > '''Bulk Import '''from the '''Menu.''' The ''Import Payments page'' will appear.
# Select the file type of the payment file to import by clicking the required file type option button, either ''Emersion Bulk Format'', or ''ABA''. You can click the ''Sample Format File'' link beside the file option to display the file format.
# Click the '''Browse''' button beside the ''* CSV File to Import'' field. A ''File Upload'' window will appear.
# Navigate to and select the required payment file and click the '''Open''' button. The selected file name will appear in the ''* CSV File to Import'' field.
# Click the '''Upload File and Verify''' button. The system will verify the file is in the correct format. Once verified, the ''Import Payments – Preview File & Confirm'' page will display.
# Click the '''Confirm Import''' button. A window will appear to prompt you to confirm the upload.
# Click the '''Yes''' button to confirm the file upload. The system will process the payments in the file'', ''and update the accounts’ payment details with the payment information.
# Click the '''No''' button to cancel the file upload.

== Manual Payment Imports ==

There is an additional feature that allows a user to bulk import payments that are sourced from the following providers;
* Secure Pay IVR
* Aust Post Bill Pay
* Commbiz Bpay

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">http://wiki.emersion.com.au/wiki/media/manual_payment_import.mp4</mediaplayer>

= See Also =
* [[Payments|Payments]]
* [[EPS|EPS]]
* [[BPAY|BPAY]]
* [[Invoicing|Invoicing]]

ReleaseNotes

2015-06-29T23:19:13Z

Medge: /* 3.71.00 - 29 June 2015 */

The following topics are available:
*[[ReleaseNotes/2015|RELEASE NOTES ARCHIVE 2015]]
*[[ReleaseNotes/2014|RELEASE NOTES ARCHIVE 2014]]
*[[ReleaseNotes/2013|RELEASE NOTES ARCHIVE 2013]]
*[[ReleaseNotes/2012|RELEASE NOTES ARCHIVE 2012]]
*[[ReleaseNotes/2011|RELEASE NOTES ARCHIVE 2011]]
*[[ReleaseNotes/2010|RELEASE NOTES ARCHIVE 2010]]

= 3.71.00 - 29 June 2015 =

== New Features / Optional Modules ==
'''''<u>Fees may apply to have these configured, activated and maintained</u>'''''

If you are interested in subscribing to any of our new enhancements, please contact our Sales Team for further information at sales@emersion.com.au

=== Retail Package Catalogue ===
The system will restrict which package plans are displayed to a user when ordering services or migrating for Retail Service Providers based upon role (Staff Group or Agent)

This feature allows retail service providers to group plans into collections. A collection of plans can then be assigned against account groups.

Once the collection is assigned to an account group, it gives service providers control over who can access or sell these groups of package plans. The control extends to both new orders and migrations separately.

http://wiki.emersion.com.au/wiki/index.php/PackagePlans/PackageCatalogue#Role-based_Package_Catalogue_.28Retail_Service_Providers_only.29Stock Expiry Feature

A new optional feature has been built which allows tracking of stock as it expires. This has been deployed for Telstra WME SIM Stock.

=== Payment Extensions ===
A New Feature has been developed to support payment extensions without having to put the client on a payment plan. This will record the original payment extension date, but also any changes.
Read more about Payment Extensions.
http://wiki.emersion.com.au/wiki/index.php/InvoiceManagement/Payment_Extensions

=== SMS Gateway Extensions ===
Emersion has developed a framework to supports multiple SMS providers through the Events system.
Different events can now be configured to use different SMS providers. This requires subscription to SMS Events and an Agreement to be in place with SMS gateway suppliers.
This will allow a Service Provider to have an alternative SMS vendor or Multiple Vendors.
Setup and Configuration Fees apply and Emersion will charge per SMS Fee and Monthly Access Fee for SMS Functionality.

=== Service Desk ===
The Service Desk module has been enhanced to support creating new tickets and updating tickets via email.

=== Service Type Migrate ===
The new Service Type Migrate feature is an extension of the default service migration functionality that comes standard with Emersion. This new service migration better supports both singular and mass migrations of services between service types and ensures the end user has a seamless and effortless experience during the migration process. The feature comes with an optional End User service activation portal. End Users can also activate their new service via the End User Portal.

Read more about Service Type Migrations.
http://wiki.emersion.com.au/wiki/index.php/Main_Page/Provisioning/Service_Type_Migrate

=== Auto Top of Account ===
This new account-level feature is designed for businesses who want to ensure their customers always retain a positive account balance. Events notify the customer when they approach their credit limit and the system can automatically take a payment when the customer’s account balances reaches the auto top-up threshold.
Read more about Auto top-up.
http://wiki.emersion.com.au/wiki/index.php/Account_Management/Auto_Top-up

=== Account & Service Note Import tool ===
A new import tool has been built to give users to import customer and service subscription notes in bulk from CSV.

=== Bulk Account Status Change ===
A new bulk import has been built to allow account statuses to be updated in bulk from CSV

=== Bulk Invoice Approval tool ===
A new bulk update tool has been built to give users the ability to bulk approve invoices from CSV.
Read more about the new bulk import and update facilities

== New Service Types ==
'''''<u>Fees may apply to have these configured, activated and maintained</u>'''''

If you are interested in subscribing to any of our new enhancements, please contact our Sales Team for further information at sales@emersion.com.au

== Enhancements – Optional Modules ==
'''''<u>Fees may apply to have these configured, activated and maintained</u>'''''

If you are interested in subscribing to any of our new enhancements, please contact our Sales Team for further information at sales@emersion.com.au

=== ZenDesk Integration ===
This has been enhanced to ensure when contacts were added, that Zendesk is also updated.
When a username is updated in Emersion, Emersion now synchronises this change with the existing profile within Zendesk, updates the username (an email in zendesk) and marks it as a primary identity.

=== Late Payment Fees – Overdue Invoice ===
When creating late fees for overdue invoices, the cardline that was generated is stored for reporting purposes.

=== Payment Plan V2 ===
has been changed to ensure that you can create a payment plan for any amount outstanding on an invoice as long as it is not in dispute.

=== Bolt-ons ===
We have removed the charge at normal rate within the plan bolt on configuration, as this is now managed via a plan bolt on override.

=== Product Inventory ===
Added a new feature / Event to check when stock gets too low within the product inventory.

=== SMS Events ===
Mass SMS Out has been improved to have an account status filter to be consistent with mass mail out.

=== Account Discount Subscription ===
Account Discount Subscription now has support for bulk service feature pricing for volume discounts.

=== SIM / Product Inventory ===
This feature allows the tracking of SIM stock as it expires. The product inventory import functionality has also been updated to support a SELL_BEFORE_DATE so that expired SIMs cannot be used.

=== Included Value ===
The included value feature set was enhanced to support the ability to prorata the access fee for an included value plan but not the usage allowance.

=== Service Activation Event ===
A new event has been developed that will send a notification when a new service is activated.

=== Commissions ===
Screens have been adjusted to better handle large numbers of commission records.

=== Customer Sign Up Portal Timeout ===
Orders created via the Customer Sign Up portal will time out after 24 hours. This will fall in line with product time-out rules. Pending orders now also come with improved locking to prevent a service identifier from being allocated inappropriately.

== Service Type Framework Enhancements ==
'''''<u>Fees may apply to have these configured, activated and maintained</u>'''''
If you are interested in subscribing to any of our new enhancements, please contact our Sales Team for further information at sales@emersion.com.au

Implemented a flag against the service type to prevent an administrator from performing a migration.

=== Telstra WME ===
Support for Withdraw Request has been added within the service drop down and sends a synchronous request through to Telstra.
During the ordering process, if an identifier is available it will be displayed.
Added feature that permits the ability to get the current balance directly from the Telstra WME platform when editing a service.
Now supports credit check features.
New support for management of call forwarding via Cumulus and the End User Portal.

=== Wholesale Service Information Records (SIRs) ===
Previously card lines would be generated for usage files at the end of the billing month with no visibility to exposed credit until this time. This process has now been changed so that card lines are created as soon as the usage file is generated.

== Enhancements – General ==
'''''<u>These enhancements are provided as part of base platform and are included as per your maintenance fees </u>'''''

*An update was made to the TinyMCE editor, used with the event templates. This resolves some compatibility issues with Internet Explorer experienced with the previous version.

*The system can now flag an account to be a test account. Upon advising Emersion and the account undergoing an assessment, Emersion has the ability to put an account into test mode, an Emersion ratified Test account can be isolated for billing purposes. A Test Account cannot have commercial services on it.

*Changes to the Rating engine were made to support the previously released included value features on package plans.

*Added support to hide some service configuration fields (object properties) from the order screens.

*Hourly bolt-ons have been deprecated.

*Event template variable “Username with-out realm” now populates correctly.

*The Manual Payment Batch import tool has been extended to prevent automated payments being processed immediately when that was not desired

*Added the ability to undo a future service cancellation where appropriate (within business rules controlling where cancellation is possible).

*Instance Identifiers are now reflected on retail invoices where the feature is billable. Invoices also now include the service feature quantity.

*Product Purchase screens no longer show product categories with no products in them.

*The Product screens have been updated to allow a user to view and edit a sub category after creating a product.

== Bug Fixes ==

*Fixed the issue causing the occasional error with the ‘magnifying glass’ that expanded the package plan display when placing an order.

*Fixed an issue where multiple bolt-on periods were appearing on invoices when the bolt-on had been cancelled.

*Fixed an error in the Report Schedule List causing it to throw an exception.

*Fixed issue when reloading cart list that cause the serial number not popping up light box on second item load into the cart.

*Fixed an issue where the invoice was not recording Service Feature quantity.

*Fixed issues with pagination and column sorting on the Services > List page. The page also now requires criteria to be entered before it will return search results.

*Corrected an issue to ensure an automated payment does not attempt to take another payment when it was scheduled to do so in the event of an active payment plan.

*Fixed a code bug affecting the Manual Provisioning page, which meant that on all cancellations, "Finalise Migration" was appearing incorrectly.

*Fixed a bug surrounding cases when payments are received if an account has a pending invoice so that the pending invoice is always be reconciled, updated and re-rendered automatically.

*Fixed the product purchase calculation on the customer list so it correctly includes only point of sale purchases and not all purchases.

*Fixed bug on retrieving thumbnail images for a product.

*Fixed a bug preventing the delete customer account contact link from appearing.

*Fixed calculation for purchase display in account list

*Fixed a minor defect on the service plan feature allowance tab of Packages & Plans.

=== API Testing Function ===
There is a new method to assist with connectivity testing with the SSL certificate-based API without having to run an official method.

API

2015-05-20T04:02:26Z

Medge: fixed the URL for UAT

= Emersion API Infrastructure =

Emersion has implemented an External API Framework Layer to assist in clients integrating directly into parts of the Emersion Eco-System.

Most additions to the framework to date have been directly from client requests, and Emersion is able to extend or add new functionality on a case by case and quoted basis.

For a quote on a solution to fit your requirement, please contact the Emersion Sales team.

For an individual or business looking to work with our API layer, we can recommend the freeware software Soap UI to perform testing and gain guidance on operations contained within the API.

This software allows you to view the methods contained within the API and send and receive test calls to the API without having to write a system.

There are two types of API currently supported by Emersion, one which is designed for Emersion customers to authenticate via SSL to perform administrative functions, and another where the end users of clients can authenticate (generally for use with SmartPhones) via a username and password to perform end user tasks. Please note access to the end user API is an add-on feature.

== Provider Based API Functionality ==

=== Security Layer ===
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising SSL certificate as security. The SSL certificates are provided by Emersion, and may be subject to a professional services charge
depending on your Emersion agreement.

The WSDL for each set of functions is documented in the next section.

For Production, use; https://external.emersion.com.au/
For the UAT API layer use; https://uat1-external.emersion.com.au/

=== Provider API Documentation ===

There are different API types, listed below;

[[API/Minimal|Minimal - Basic Introductory Methods]]

[[API/Services|Services - Mostly Service Centric Based Methods (most methods go here.)]]

[[API/RetailServices|Retail Services - User Based Information including Payment Integration]]

[[API/Reference|Reference Data for use within API calls]]

[[API/UserPortal|User Portal based methods]]

[[API/AAPT|AAPT Specific Integration functions]]

== End User Based API Functions ==

This is the API layer of which will be used to enable Emersion customers to have thin clients such as those of which are embedded on smart phones communicate with our platform directly for the purpose of information and self service.

=== Security Layer ===
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising simple/basic HTaccess authentication - the end user username and password is what is used.

The WSDL for each set of functions is documented in the next section.

For production, use; https://to-be-advised.emersion.com.au/

For testing, use; https://to-be-advised-prerelease.emersion.com.au/

If you have UAT access, it is via http://api-uat.emersion.com.au/Account.wsdl

NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code

=== API Documentation ===

* [[API/EndUser|End User API]]
* [[file:Emersion API Documentation v0.20.pdf]]

Data Import/Cardlines

2015-04-24T03:51:09Z

Medge:

== Ledger Cardline - Bulk Import Feature ==

The Emersion system has a feature which permits you to bulk import cardlines into the system.

This is an add-on feature - if you do not have access to it and would like to use it, please contact Emersion Sales.

The format (in CSV) for a ledger cardline file is as follows;

{| class="wikitable"
|-
! TRANSACTION_DATE !! ACTUAL_VALUE !! TAX_AMOUNT !! DESCRIPTION !! LEDGER_CODE !! ACCOUNT_ID !! SERVICE_ID !! BILLING_TYPE_ID !! COVERS_FROM !! COVERS_TO
|-
| 2010-12-30 || 10 || 1 || "Test Transaction, Blah" || LEDGER_CODE || 111377 || 171519 || 1 || 2010-12-30 || 2010-12-30
|-
| 2010-02-01 || 33 || 3 || "Blah Transaction, Blah" || || 111377 || || 1 || 2010-12-30 || 2010-12-30
|-
| 2010-12-30 || 22 || 2.2 || Test Transaction || MY_TRANSACTION || 111683 || 173038 || 2 || 2010-12-30 || 2010-12-30
|}

[[File:Sample Cardline Import.csv|thumbnail|Cardline Sample Import File]]

The fields are described below;
* TRANSACTION_DATE - This field is mandatory and must be in the format of YYYY-MM-DD

* ACTUAL_VALUE - This field represents the EX TAX portion of your charge. It is mandatory and
must be rounded to two decimal places.

* TAX_AMOUNT - This represents the tax portion of your charge. Can be zero. Is mandatory and
must be rounded to two decimal places.

* DESCRIPTION - This is the description for the charge that will appear on the customers invoice
or service information record. It is mandatory and must be less than 255 characters.

* LEDGER_CODE - This is the a ledger code from the Emersion system. You can find a list of the
available ledger codes in the ledger code (mapping) report -
https://cumulus.emersion.com.au/report/generic/view/1001 - Please ensure you use the ledger code NAME,
not the MAPPING_NAME or SIMPLE_CODE.

* ACCOUNT_ID - The account you wish to have the cardline assigned against. This is a mandatory field.

* SERVICE_ID - The service ID you want this charge to be assigned against. This is not mandatory and has no default.

* BILLING_TYPE_ID - Whether the charge (or credit) you are creating is representative of an advance
charge (1) or an arrears charge (2). It is not mandatory and defaults to 1 (advance).

* COVERS_FROM - The start date for the period of which the charge (or credit) covers. This is mandatory
and must be in the format of YYYY-MM-DD

* COVERS_TO - The end date for the period of which the charge (or credit) covers. This is not mandatory,
will default to the covers from and must be in the format of YYYY-MM-DD

File:Sample Cardline Import.csv

2015-04-24T03:49:47Z

Medge: Sample Cardline Import Sheet

Sample Cardline Import Sheet

Data Import/Cardlines

2015-04-24T03:42:12Z

Medge:

The Emersion system has a feature which permits you to bulk import cardlines into the system.

This is an add-on feature - if you do not have access to it and would like to use it, please contact Emersion Sales.

The format (in CSV) for a ledger cardline file is as follows;

{| class="wikitable"
|-
! TRANSACTION_DATE !! ACTUAL_VALUE !! TAX_AMOUNT !! DESCRIPTION !! LEDGER_CODE !! ACCOUNT_ID !! SERVICE_ID !! BILLING_TYPE_ID !! COVERS_FROM !! COVERS_TO
|-
| 2010-12-30 || 10 || 1 || "Test Transaction, Blah" || LEDGER_CODE || 111377 || 171519 || 1 || 2010-12-30 || 2010-12-30
|-
| 2010-02-01 || 33 || 3 || "Blah Transaction, Blah" || || 111377 || || 1 || 2010-12-30 || 2010-12-30
|-
| 2010-12-30 || 22 || 2.2 || Test Transaction || MY_TRANSACTION || 111683 || 173038 || 2 || 2010-12-30 || 2010-12-30
|}

The fields are described below;
* TRANSACTION_DATE - This field is mandatory and must be in the format of YYYY-MM-DD

* ACTUAL_VALUE - This field represents the EX TAX portion of your charge. It is mandatory and
must be rounded to two decimal places.

* TAX_AMOUNT - This represents the tax portion of your charge. Can be zero. Is mandatory and
must be rounded to two decimal places.

* DESCRIPTION - This is the description for the charge that will appear on the customers invoice
or service information record. It is mandatory and must be less than 255 characters.

* LEDGER_CODE - This is the a ledger code from the Emersion system. You can find a list of the
available ledger codes in the ledger code (mapping) report -
https://cumulus.emersion.com.au/report/generic/view/1001 - Please ensure you use the ledger code NAME,
not the MAPPING_NAME or SIMPLE_CODE.

* ACCOUNT_ID - The account you wish to have the cardline assigned against. This is a mandatory field.

* SERVICE_ID - The service ID you want this charge to be assigned against. This is not mandatory and has no default.

* BILLING_TYPE_ID - Whether the charge (or credit) you are creating is representative of an advance
charge (1) or an arrears charge (2). It is not mandatory and defaults to 1 (advance).

* COVERS_FROM - The start date for the period of which the charge (or credit) covers. This is mandatory
and must be in the format of YYYY-MM-DD

* COVERS_TO - The end date for the period of which the charge (or credit) covers. This is not mandatory,
will default to the covers from and must be in the format of YYYY-MM-DD

Data Import/Cardlines

2015-04-24T03:40:24Z

Medge:

The Emersion system has a feature which permits you to bulk import cardlines into the system.

This is an add-on feature - if you do not have access to it and would like to use it, please contact Emersion Sales.

The format (in CSV) for a ledger cardline file is as follows;

{| class="wikitable"
|-
! TRANSACTION_DATE !! ACTUAL_VALUE !! TAX_AMOUNT !! DESCRIPTION !! LEDGER_CODE !! ACCOUNT_ID !! SERVICE_ID !! BILLING_TYPE_ID !! COVERS_FROM !! COVERS_TO
|-
| 1/09/2010 || 10 || 1 || "Test Transaction, Blah" || LEDGER_CODE || 111377 || 171519 || 1 || 1/09/2010 || 1/10/2010
|-
| 1/10/2010 || 33 || 3 || "Blah Transaction, Blah" || || 111377 || || 1 || 1/10/2010 || 1/10/2010
|-
| 1/09/2010 || 22 || 2.2 || Test Transaction || MY_TRANSACTION || 111683 || 173038 || 2 || 1/09/2010 || 1/10/2010
|}

The fields are described below;
* TRANSACTION_DATE - This field is mandatory and must be in the format of YYYY-MM-DD

* ACTUAL_VALUE - This field represents the EX TAX portion of your charge. It is mandatory and
must be rounded to two decimal places.

* TAX_AMOUNT - This represents the tax portion of your charge. Can be zero. Is mandatory and
must be rounded to two decimal places.

* DESCRIPTION - This is the description for the charge that will appear on the customers invoice
or service information record. It is mandatory and must be less than 255 characters.

* LEDGER_CODE - This is the a ledger code from the Emersion system. You can find a list of the
available ledger codes in the ledger code (mapping) report -
https://cumulus.emersion.com.au/report/generic/view/1001 - Please ensure you use the ledger code NAME,
not the MAPPING_NAME or SIMPLE_CODE.

* ACCOUNT_ID - The account you wish to have the cardline assigned against. This is a mandatory field.

* SERVICE_ID - The service ID you want this charge to be assigned against. This is not mandatory and has no default.

* BILLING_TYPE_ID - Whether the charge (or credit) you are creating is representative of an advance
charge (1) or an arrears charge (2). It is not mandatory and defaults to 1 (advance).

* COVERS_FROM - The start date for the period of which the charge (or credit) covers. This is mandatory
and must be in the format of YYYY-MM-DD

* COVERS_TO - The end date for the period of which the charge (or credit) covers. This is not mandatory,
will default to the covers from and must be in the format of YYYY-MM-DD

Data Import/Cardlines

2015-04-24T03:40:00Z

Medge:

The Emersion system has a feature which permits you to bulk import cardlines into the system.

This is an add-on feature - if you do not have access to it and would like to use it, please contact Emersion Sales.

The format (in CSV) for a ledger cardline file is as follows;

{| class="wikitable"
|-
! TRANSACTION_DATE !! ACTUAL_VALUE !! TAX_AMOUNT !! DESCRIPTION !! LEDGER_CODE !! ACCOUNT_ID !! SERVICE_ID !! BILLING_TYPE_ID !! COVERS_FROM !! COVERS_TO
|-
| 1/09/2010 || 10 || 1 || "Test Transaction || Blah" || LEDGER_CODE || 111377 || 171519 || 1 || 1/09/2010 || 1/10/2010
|-
| 1/10/2010 || 33 || 3 || "Blah Transaction || Blah" || || 111377 || || 1 || 1/10/2010 || 1/10/2010
|-
| 1/09/2010 || 22 || 2.2 || Test Transaction || MY_TRANSACTION || 111683 || 173038 || 2 || 1/09/2010 || 1/10/2010
|}

The fields are described below;
* TRANSACTION_DATE - This field is mandatory and must be in the format of YYYY-MM-DD

* ACTUAL_VALUE - This field represents the EX TAX portion of your charge. It is mandatory and
must be rounded to two decimal places.

* TAX_AMOUNT - This represents the tax portion of your charge. Can be zero. Is mandatory and
must be rounded to two decimal places.

* DESCRIPTION - This is the description for the charge that will appear on the customers invoice
or service information record. It is mandatory and must be less than 255 characters.

* LEDGER_CODE - This is the a ledger code from the Emersion system. You can find a list of the
available ledger codes in the ledger code (mapping) report -
https://cumulus.emersion.com.au/report/generic/view/1001 - Please ensure you use the ledger code NAME,
not the MAPPING_NAME or SIMPLE_CODE.

* ACCOUNT_ID - The account you wish to have the cardline assigned against. This is a mandatory field.

* SERVICE_ID - The service ID you want this charge to be assigned against. This is not mandatory and has no default.

* BILLING_TYPE_ID - Whether the charge (or credit) you are creating is representative of an advance
charge (1) or an arrears charge (2). It is not mandatory and defaults to 1 (advance).

* COVERS_FROM - The start date for the period of which the charge (or credit) covers. This is mandatory
and must be in the format of YYYY-MM-DD

* COVERS_TO - The end date for the period of which the charge (or credit) covers. This is not mandatory,
will default to the covers from and must be in the format of YYYY-MM-DD

Data Import/Cardlines

2015-04-24T03:39:37Z

Medge:

The Emersion system has a feature which permits you to bulk import cardlines into the system.

This is an add-on feature - if you do not have access to it and would like to use it, please contact Emersion Sales.

The format (in CSV) for a ledger cardline file is as follows;

{| class="wikitable"
|-
! TRANSACTION_DATE !! ACTUAL_VALUE !! TAX_AMOUNT !! DESCRIPTION !! LEDGER_CODE !! ACCOUNT_ID !! SERVICE_ID !! BILLING_TYPE_ID !! COVERS_FROM !! COVERS_TO
|-
| 1/09/2010 || 10 || 1 || "Test Transaction || Blah" || LEDGER_CODE || 111377 || 171519 || 1 || 1/09/2010 || 1/10/2010
|-
1/10/2010 || 33 || 3 || "Blah Transaction || Blah" || || 111377 || || 1 || 1/10/2010 || 1/10/2010
|-
| 1/09/2010 || 22 || 2.2 || Test Transaction || MY_TRANSACTION || 111683 || 173038 || 2 || 1/09/2010 || 1/10/2010
|}

The fields are described below;
* TRANSACTION_DATE - This field is mandatory and must be in the format of YYYY-MM-DD

* ACTUAL_VALUE - This field represents the EX TAX portion of your charge. It is mandatory and
must be rounded to two decimal places.

* TAX_AMOUNT - This represents the tax portion of your charge. Can be zero. Is mandatory and
must be rounded to two decimal places.

* DESCRIPTION - This is the description for the charge that will appear on the customers invoice
or service information record. It is mandatory and must be less than 255 characters.

* LEDGER_CODE - This is the a ledger code from the Emersion system. You can find a list of the
available ledger codes in the ledger code (mapping) report -
https://cumulus.emersion.com.au/report/generic/view/1001 - Please ensure you use the ledger code NAME,
not the MAPPING_NAME or SIMPLE_CODE.

* ACCOUNT_ID - The account you wish to have the cardline assigned against. This is a mandatory field.

* SERVICE_ID - The service ID you want this charge to be assigned against. This is not mandatory and has no default.

* BILLING_TYPE_ID - Whether the charge (or credit) you are creating is representative of an advance
charge (1) or an arrears charge (2). It is not mandatory and defaults to 1 (advance).

* COVERS_FROM - The start date for the period of which the charge (or credit) covers. This is mandatory
and must be in the format of YYYY-MM-DD

* COVERS_TO - The end date for the period of which the charge (or credit) covers. This is not mandatory,
will default to the covers from and must be in the format of YYYY-MM-DD

Data Import/Cardlines

2015-04-24T03:38:07Z

Medge:

The Emersion system has a feature which permits you to bulk import cardlines into the system.

This is an add-on feature - if you do not have access to it and would like to use it, please contact Emersion Sales.

The format (in CSV) for a ledger cardline file is as follows;

{| class="wikitable"
|-
! TRANSACTION_DATE !! ACTUAL_VALUE !! TAX_AMOUNT !! DESCRIPTION !! LEDGER_CODE !! ACCOUNT_ID !! SERVICE_ID !! BILLING_TYPE_ID !! COVERS_FROM !! COVERS_TO
|-
| 1/09/2010 || 10 || 1 || "Test Transaction || Blah" || LEDGER_CODE || 111377 || 171519 || 1 || 1/09/2010 || 1/10/2010
|-
1/10/2010 || 33 || 3 || "Blah Transaction || Blah" || || 111377 || || 1 || 1/10/2010 || 1/10/2010
|-
| 1/09/2010 || 22 || 2.2 || Test Transaction || MY_TRANSACTION || 111683 || 173038 || 2 || 1/09/2010 || 1/10/2010
|}

The fields are described below;
* TRANSACTION_DATE - This field is mandatory and must be in the format of YYYY-MM-DD
* ACTUAL_VALUE - This field represents the EX TAX portion of your charge. It is mandatory and must be rounded to two decimal places.
* TAX_AMOUNT - This represents the tax portion of your charge. Can be zero. Is mandatory and must be rounded to two decimal places.
* DESCRIPTION - This is the description for the charge that will appear on the customers invoice or service information record. It is mandatory and must be less than 255 characters.
* LEDGER_CODE - This is the a ledger code from the Emersion system. You can find a list of the available ledger codes in the ledger code (mapping) report - https://cumulus.emersion.com.au/report/generic/view/1001 - Please ensure you use the ledger code NAME, not the MAPPING_NAME or SIMPLE_CODE.
* ACCOUNT_ID - The account you wish to have the cardline assigned against. This is a mandatory field.
* SERVICE_ID - The service ID you want this charge to be assigned against. This is not mandatory and has no default.
* BILLING_TYPE_ID - Whether the charge (or credit) you are creating is representative of an advance charge (1) or an arrears charge (2). It is not mandatory and defaults to 1 (advance).
* COVERS_FROM - The start date for the period of which the charge (or credit) covers. This is mandatory and must be in the format of YYYY-MM-DD
* COVERS_TO - The end date for the period of which the charge (or credit) covers. This is not mandatory, will default to the covers from and must be in the format of YYYY-MM-DD

API/Reference

2015-02-26T05:15:52Z

Medge:

=== API Reference Data ===

This section is for all reference tables for use within the Emersion API layer.
..
==== API sections ====
{{#subpages:page=API/Reference}}.

API/EndUser/Account

2014-12-24T02:03:57Z

Medge: /* Account */

== Account ==

The 'Account' section of the Emersion API layer primarily contains account management and point of sale based functions.
This contains an extended create customer interface, an update customer interface, and a way to do very simple point of sale transactions via the API.

The WSDL is at http://api-uat.emersion.com.au/Account.wsdl

* [[API/EndUser/Account/invoicesByAccount|invoicesByAccount]]
* [[API/EndUser/Account/getInvoiceById|getInvoiceById]]
* [[API/EndUser/Account/getAccountBalanceSummaryInfo|getAccountBalanceSummaryInfo]]
* [[API/EndUser/Account/makeAdHocPayment|makeAdHocPayment]]
* [[API/EndUser/Account/getContactByAccountAndType|getContactByAccountAndType]]
* [[API/EndUser/Account/createSession|createSession]]
* [[API/EndUser/Account/updateAccount|updateAccount]]
* [[API/EndUser/Account/addOneTimeBoltOn|addOneTimeBoltOn]]

API

2014-12-24T02:02:30Z

Medge: /* Security Layer */

= Emersion API Infrastructure =

Emersion has implemented an External API Framework Layer to assist in clients integrating directly into parts of the Emersion Eco-System.

Most additions to the framework to date have been directly from client requests, and Emersion is able to extend or add new functionality on a case by case and quoted basis.

For a quote on a solution to fit your requirement, please contact the Emersion Sales team.

For an individual or business looking to work with our API layer, we can recommend the freeware software Soap UI to perform testing and gain guidance on operations contained within the API.

This software allows you to view the methods contained within the API and send and receive test calls to the API without having to write a system.

There are two types of API currently supported by Emersion, one which is designed for Emersion customers to authenticate via SSL to perform administrative functions, and another where the end users of clients can authenticate (generally for use with SmartPhones) via a username and password to perform end user tasks. Please note access to the end user API is an add-on feature.

== Provider Based API Functionality ==

=== Security Layer ===
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising SSL certificate as security. The SSL certificates are provided by Emersion, and may be subject to a professional services charge
depending on your Emersion agreement.

The WSDL for each set of functions is documented in the next section.

For production, use; https://external.emersion.com.au/

For testing, use; https://external-prerelease.emersion.com.au/

NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code

=== Provider API Documentation ===

There are different API types, listed below;

[[API/Minimal|Minimal - Basic Introductory Methods]]

[[API/Services|Services - Mostly Service Centric Based Methods (most methods go here.)]]

[[API/RetailServices|Retail Services - User Based Information including Payment Integration]]

[[API/Reference|Reference Data for use within API calls]]

[[API/UserPortal|User Portal based methods]]

[[API/AAPT|AAPT Specific Integration functions]]

== End User Based API Functions ==

This is the API layer of which will be used to enable Emersion customers to have thin clients such as those of which are embedded on smart phones communicate with our platform directly for the purpose of information and self service.

=== Security Layer ===
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising simple/basic HTaccess authentication - the end user username and password is what is used.

The WSDL for each set of functions is documented in the next section.

For production, use; https://to-be-advised.emersion.com.au/

For testing, use; https://to-be-advised-prerelease.emersion.com.au/

If you have UAT access, it is via http://api-uat.emersion.com.au/Account.wsdl

NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code

=== API Documentation ===

[[API/EndUser|End User API]]

API

2014-11-10T01:20:51Z

Medge:

= Emersion API Infrastructure =

Emersion has implemented an External API Framework Layer to assist in clients integrating directly into parts of the Emersion Eco-System.

Most additions to the framework to date have been directly from client requests, and Emersion is able to extend or add new functionality on a case by case and quoted basis.

For a quote on a solution to fit your requirement, please contact the Emersion Sales team.

For an individual or business looking to work with our API layer, we can recommend the freeware software Soap UI to perform testing and gain guidance on operations contained within the API.

This software allows you to view the methods contained within the API and send and receive test calls to the API without having to write a system.

There are two types of API currently supported by Emersion, one which is designed for Emersion customers to authenticate via SSL to perform administrative functions, and another where the end users of clients can authenticate (generally for use with SmartPhones) via a username and password to perform end user tasks. Please note access to the end user API is an add-on feature.

== Provider Based API Functionality ==

=== Security Layer ===
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising SSL certificate as security. The SSL certificates are provided by Emersion, and may be subject to a professional services charge
depending on your Emersion agreement.

The WSDL for each set of functions is documented in the next section.

For production, use; https://external.emersion.com.au/

For testing, use; https://external-prerelease.emersion.com.au/

NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code

=== Provider API Documentation ===

There are different API types, listed below;

[[API/Minimal|Minimal - Basic Introductory Methods]]

[[API/Services|Services - Mostly Service Centric Based Methods (most methods go here.)]]

[[API/RetailServices|Retail Services - User Based Information including Payment Integration]]

[[API/Reference|Reference Data for use within API calls]]

[[API/UserPortal|User Portal based methods]]

[[API/AAPT|AAPT Specific Integration functions]]

== End User Based API Functions ==

This is the API layer of which will be used to enable Emersion customers to have thin clients such as those of which are embedded on smart phones communicate with our platform directly for the purpose of information and self service.

=== Security Layer ===
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising a username and password which is embedded within the SOAP Body as security.

The WSDL for each set of functions is documented in the next section.

For production, use; https://to-be-advised.emersion.com.au/

For testing, use; https://to-be-advised-prerelease.emersion.com.au/

NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code

=== API Documentation ===

[[API/EndUser|End User API]]

API

2014-11-10T01:20:34Z

Medge: /* = API Documentation */

= Emersion API Infrastructure =

Emersion has implemented an External API Framework Layer to assist in clients integrating directly into parts of the Emersion Eco-System.

Most additions to the framework to date have been directly from client requests, and Emersion is able to extend or add new functionality on a case by case and quoted basis.

For a quote on a solution to fit your requirement, please contact the Emersion Sales team.

For an individual or business looking to work with our API layer, we can recommend the freeware software Soap UI to perform testing and gain guidance on operations contained within the API.

This software allows you to view the methods contained within the API and send and receive test calls to the API without having to write a system.

There are two types of API currently supported by Emersion, one which is designed for Emersion customers to authenticate via SSL to perform administrative functions, and another where the end users of clients can authenticate (generally for use with SmartPhones) via a username and password to perform end user tasks. Please note access to the end user API is an add-on feature.

== Provider Based API Functionality ==

=== Security Layer ===
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising SSL certificate as security. The SSL certificates are provided by Emersion, and may be subject to a professional services charge
depending on your Emersion agreement.

The WSDL for each set of functions is documented in the next section.

For production, use; https://external.emersion.com.au/

For testing, use; https://external-prerelease.emersion.com.au/

NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code

=== Provider API Documentation ===

There are different API types, listed below;

[[API/Minimal|Minimal - Basic Introductory Methods]]

[[API/Services|Services - Mostly Service Centric Based Methods (most methods go here.)]]

[[API/RetailServices|Retail Services - User Based Information including Payment Integration]]

[[API/Reference|Reference Data for use within API calls]]

[[API/UserPortal|User Portal based methods]]

[[API/AAPT|AAPT Specific Integration functions]]

== End User Based API Functions ==

This is the API layer of which will be used to enable Emersion customers to have thin clients such as those of which are embedded on smart phones communicate with our platform directly for the purpose of information and self service.

=== Security Layer ===
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising a username and password which is embedded within the SOAP Body as security.

The WSDL for each set of functions is documented in the next section.

For production, use; https://to-be-advised.emersion.com.au/

For testing, use; https://to-be-advised-prerelease.emersion.com.au/

NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code

== API Documentation ==

[[API/EndUser|End User API]]

API

2014-11-10T01:20:21Z

Medge:

= Emersion API Infrastructure =

Emersion has implemented an External API Framework Layer to assist in clients integrating directly into parts of the Emersion Eco-System.

Most additions to the framework to date have been directly from client requests, and Emersion is able to extend or add new functionality on a case by case and quoted basis.

For a quote on a solution to fit your requirement, please contact the Emersion Sales team.

For an individual or business looking to work with our API layer, we can recommend the freeware software Soap UI to perform testing and gain guidance on operations contained within the API.

This software allows you to view the methods contained within the API and send and receive test calls to the API without having to write a system.

There are two types of API currently supported by Emersion, one which is designed for Emersion customers to authenticate via SSL to perform administrative functions, and another where the end users of clients can authenticate (generally for use with SmartPhones) via a username and password to perform end user tasks. Please note access to the end user API is an add-on feature.

== Provider Based API Functionality ==

=== Security Layer ===
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising SSL certificate as security. The SSL certificates are provided by Emersion, and may be subject to a professional services charge
depending on your Emersion agreement.

The WSDL for each set of functions is documented in the next section.

For production, use; https://external.emersion.com.au/

For testing, use; https://external-prerelease.emersion.com.au/

NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code

=== Provider API Documentation ===

There are different API types, listed below;

[[API/Minimal|Minimal - Basic Introductory Methods]]

[[API/Services|Services - Mostly Service Centric Based Methods (most methods go here.)]]

[[API/RetailServices|Retail Services - User Based Information including Payment Integration]]

[[API/Reference|Reference Data for use within API calls]]

[[API/UserPortal|User Portal based methods]]

[[API/AAPT|AAPT Specific Integration functions]]

== End User Based API Functions ==

This is the API layer of which will be used to enable Emersion customers to have thin clients such as those of which are embedded on smart phones communicate with our platform directly for the purpose of information and self service.

=== Security Layer ===
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising a username and password which is embedded within the SOAP Body as security.

The WSDL for each set of functions is documented in the next section.

For production, use; https://to-be-advised.emersion.com.au/

For testing, use; https://to-be-advised-prerelease.emersion.com.au/

NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code

=== API Documentation ==

[[API/EndUser|End User API]]

API

2014-10-23T23:17:04Z

Medge:

=== Emersion API Infrastructure ===

Emersion has implemented an External API Framework Layer to assist in clients integrating directly into parts of the Emersion Eco-System.

Most additions to the framework to date have been directly from client requests, and Emersion is able to extend or add new functionality on a case by case and quoted basis.

For a quote on a solution to fit your requirement, please contact the Emersion Sales team.

For an individual or business looking to work with our API layer, we can recommend the freeware software Soap UI to perform testing and gain guidance on operations contained within the API.

This software allows you to view the methods contained within the API and send and receive test calls to the API without having to write a system.

=== Security Layer ===
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising SSL certificate as security. The SSL certificates are provided by Emersion, and may be subject to a professional services charge
depending on your Emersion agreement.

The WSDL for each set of functions is documented in the next section.

For production, use; https://external.emersion.com.au/

For testing, use; https://external-prerelease.emersion.com.au/

NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code

=== API Documentation ===

There are different API types, listed below;

[[API/Minimal|Minimal - Basic Introductory Methods]]

[[API/Services|Services - Mostly Service Centric Based Methods (most methods go here.)]]

[[API/RetailServices|Retail Services - User Based Information including Payment Integration]]

[[API/Reference|Reference Data for use within API calls]]

[[API/UserPortal|User Portal based methods]]

[[API/AAPT|AAPT Specific Integration functions]]

API/Minimal

2014-09-11T23:15:29Z

Medge: /* Minimal */

== Minimal ==

The first set of web services released by Emersion for Integration by clients, it was the 'minimal' set of services to get up and going, and thus the name. Due to backwards compatibility with anyone using the services, it will remain as 'Minimal', even though there is nothing minimal about it.
Account type is inserted based on the parent account type:
* Wholesale Account will create Service Provider Account Type.
* Service Provider Account and Agent Account will create End User Account Type.
* End User and Engineering account are not allowed to create new account.
* Emersion Account is not currently supported because the account has the capability of creating 2 different types of account which are wholesale and service provider.

The WSDL is at https://external-prerelease.emersion.com.au/Minimal.wsdl

* [[API/Minimal/CreateAccount|Create Account]]
* [[API/Minimal/GetServicesByServiceType|Get Services By ServiceType]]
* [[API/Minimal/GetXMLAccountSummary|Get XML Account Summary]]
* [[API/Minimal/GetContactByAccountAndType|Get Contact By Account And Type]]

API/Minimal

2014-09-11T23:14:38Z

Medge: /* Minimal */

API/Reference

2014-09-11T22:47:34Z

Medge: /* API Reference Data */

=== API Reference Data ===

This section is for all reference tables for use within the Emersion API layer.

==== API sections ====
{{#subpages:page=API/Reference}}.

API/Reference

2014-09-11T22:45:38Z

Medge: /* API Reference Data */

=== API Reference Data ===

This section is for all reference tables for use within the Emersion API layer.

{{#subpages:page=API/Reference|format=ol}}.

API/Reference

2014-09-11T22:45:21Z

Medge: /* API Reference Data */

=== API Reference Data ===

This section is for all reference tables for use within the Emersion API layer.

{{#subpages:page=API|format=ol}}.