Difference between revisions of "Data Import/Xero Ledger Code Mapping"

From Emersion
Jump to: navigation, search
(Created page with "= Import Ledger Code Mapping for Xero =")
 
Line 1: Line 1:
 
= Import Ledger Code Mapping for Xero =
 
= Import Ledger Code Mapping for Xero =
 +
 +
This feature provides an easy and fast way to import xero ledger code mappings via a bulk upload tool.
 +
 +
The system utilises the '''Bulk upload processing notification event''' to send a notification with the results of the import attempt. See below for further information.
 +
 +
If the import is successful, the email notification will advise you when the import process is complete. <br />
 +
If the import is not successful, the email notification will send details of the records that failed validation and why.
 +
 +
== Preparing your Data ==
 +
To prepare your data for import, you will need to create a CSV import file or you can download the import file below. You will need to extract the csv file and save it.
 +
 +
There is a hard limit of 10,000 notes that can be created using this import tool. If you need to import more than 10,000 notes at a time, please create multiple import files.
 +
A single import file can have up to 9999 rows of data plus the header row.
 +
 +
[[media: xero-ledger-code-mapping-import-template.csv]]
 +
 +
Export the full list of Emersion ledger codes by running the '''Ledger Codes (and Mapping)''' report located on the '''Reference''' tab under the Reports section of Cumulus.
 +
 +
Enter the data into the import sheet. You must ensure the data meets all validation requirements that are contained in the data definition table below. When you submit the data file for import, the system will parse the file looking for errors. If the system finds no errors, the system will import the ledger code mappings into the system. The file needs to be error-free in order to import the data. In the event errors are found, no data will be imported into Emersion. Review the bulk upload processing notification email, correct the file and try again.
 +
 +
== Importing your Data ==
 +
 +
To access the Xero Ledger Mapping import tool:
 +
 +
# Log into Cumulus.
 +
# Nav: '''Admin > Bulk Import > Xero Ledger Account Mappings'''.
 +
# Click the Browse button and select the csv file containing the data you want to import.
 +
# If you want the bulk upload processing notification email to be sent to a different email address than the address defined in the event template, tick the Override? checkbox and enter an alternative email address. This will only apply for this upload. To change the email address for all future imports, you will need to change the recipient defined in the event template.
 +
# Press '''Submit'''
 +
 +
== Xero Ledger Account Mappings Data Definitions ==
 +
 +
{| class="wikitable"
 +
|+Xero Ledger Account Mappings Import Data Definition table
 +
|Data field ||Description
 +
|-
 +
|LEDGER_CODE_ID ||The ID of Emersion ledger code. This is optional however if this is not provided, Emersion will attempt to import based on the LEDGER_CODE_NAME. You must provide a LEDGER_CODE_ID or a LEDGER_CODE_NAME.
 +
|-
 +
|LEDGER_CODE_NAME    ||The name of the Emersion Ledger Code. This is optional however if this is not provided, Emersion will attempt to import based on the LEDGER_CODE_ID. You must provide a LEDGER_CODE_ID or a LEDGER_CODE_NAME.
 +
|-
 +
|xero_ledger_account_name ||
 +
|-
 +
|IS_SHARED    || A flag denoting if any available quota which remains at the end of the period can be shared with other services on the same account with similar shared subscriptions. Accepted values are:
 +
* 0 Is not shared
 +
* 1 Is shared 
 +
If left blank, 0 will be set. (optional field)
 +
|-
 +
|FALLBACK_RATECARD_ID || The ID of the rate card that is used once the included value is reached and excess charges commences. The rate card must exist in Emersion. (optional field)
 +
|-
 +
|INCLUDED_VALUE_TYPE_ID  ||The type of included value. Accepted values are:
 +
* Dollars
 +
* Seconds
 +
* Kilobytes
 +
* Units
 +
These fields ''are'' case sensitive (mandatory field)
 +
|-
 +
|SERVICE_PLAN_ID    ||Service plan this included value is for. The service plan must exist in Emersion, (mandatory field)
 +
|-
 +
|INCLUDED_VALUE_SLOT_TYPE_ID    ||  The corresponding slot number. Accepted values are:
 +
* SLOT1
 +
* SLOT2
 +
* SLOT3
 +
* SLOT4
 +
 +
These fields ''are'' case sensitive (mandatory field)
 +
|-
 +
|EXTERNAL_NAME    ||The ‘external’ name is the vanity name for this included value allowance that will be used on any external or public facing interface or invoice. (mandatory field)
 +
|-
 +
|INCVAL_PRORATA    ||A flag denoting whether the allowance is pro-rated when a short period exists. Accepted values are:
 +
* 0 allowance is not pro-rated
 +
* 1 allowance is pro-rated 
 +
If left blank, 1 will be set. (optional field)
 +
|-
 +
|SHARE_KEY      || When shared (Is Shared = 1), sharing the included value is achieved via a key.  The share key is a string of alphanumeric characters. If '''Is Shared''' = 0, this information will be discarded. If '''Is Shared''' = 1, this is mandatory.
 +
|-
 +
|}
 +
 +
= See Also =
 +
 +
* [[Integrations/Xero | Xero Inegration with Emersion]]

Revision as of 12:07, 22 December 2015

Import Ledger Code Mapping for Xero

This feature provides an easy and fast way to import xero ledger code mappings via a bulk upload tool.

The system utilises the Bulk upload processing notification event to send a notification with the results of the import attempt. See below for further information.

If the import is successful, the email notification will advise you when the import process is complete.
If the import is not successful, the email notification will send details of the records that failed validation and why.

Preparing your Data

To prepare your data for import, you will need to create a CSV import file or you can download the import file below. You will need to extract the csv file and save it.

There is a hard limit of 10,000 notes that can be created using this import tool. If you need to import more than 10,000 notes at a time, please create multiple import files. A single import file can have up to 9999 rows of data plus the header row.

media: xero-ledger-code-mapping-import-template.csv

Export the full list of Emersion ledger codes by running the Ledger Codes (and Mapping) report located on the Reference tab under the Reports section of Cumulus.

Enter the data into the import sheet. You must ensure the data meets all validation requirements that are contained in the data definition table below. When you submit the data file for import, the system will parse the file looking for errors. If the system finds no errors, the system will import the ledger code mappings into the system. The file needs to be error-free in order to import the data. In the event errors are found, no data will be imported into Emersion. Review the bulk upload processing notification email, correct the file and try again.

Importing your Data

To access the Xero Ledger Mapping import tool:

  1. Log into Cumulus.
  2. Nav: Admin > Bulk Import > Xero Ledger Account Mappings.
  3. Click the Browse button and select the csv file containing the data you want to import.
  4. If you want the bulk upload processing notification email to be sent to a different email address than the address defined in the event template, tick the Override? checkbox and enter an alternative email address. This will only apply for this upload. To change the email address for all future imports, you will need to change the recipient defined in the event template.
  5. Press Submit

Xero Ledger Account Mappings Data Definitions

Xero Ledger Account Mappings Import Data Definition table
Data field Description
LEDGER_CODE_ID The ID of Emersion ledger code. This is optional however if this is not provided, Emersion will attempt to import based on the LEDGER_CODE_NAME. You must provide a LEDGER_CODE_ID or a LEDGER_CODE_NAME.
LEDGER_CODE_NAME The name of the Emersion Ledger Code. This is optional however if this is not provided, Emersion will attempt to import based on the LEDGER_CODE_ID. You must provide a LEDGER_CODE_ID or a LEDGER_CODE_NAME.
xero_ledger_account_name
IS_SHARED A flag denoting if any available quota which remains at the end of the period can be shared with other services on the same account with similar shared subscriptions. Accepted values are:
  • 0 Is not shared
  • 1 Is shared

If left blank, 0 will be set. (optional field)

FALLBACK_RATECARD_ID The ID of the rate card that is used once the included value is reached and excess charges commences. The rate card must exist in Emersion. (optional field)
INCLUDED_VALUE_TYPE_ID The type of included value. Accepted values are:
  • Dollars
  • Seconds
  • Kilobytes
  • Units

These fields are case sensitive (mandatory field)

SERVICE_PLAN_ID Service plan this included value is for. The service plan must exist in Emersion, (mandatory field)
INCLUDED_VALUE_SLOT_TYPE_ID The corresponding slot number. Accepted values are:
  • SLOT1
  • SLOT2
  • SLOT3
  • SLOT4

These fields are case sensitive (mandatory field)

EXTERNAL_NAME The ‘external’ name is the vanity name for this included value allowance that will be used on any external or public facing interface or invoice. (mandatory field)
INCVAL_PRORATA A flag denoting whether the allowance is pro-rated when a short period exists. Accepted values are:
  • 0 allowance is not pro-rated
  • 1 allowance is pro-rated

If left blank, 1 will be set. (optional field)

SHARE_KEY When shared (Is Shared = 1), sharing the included value is achieved via a key. The share key is a string of alphanumeric characters. If Is Shared = 0, this information will be discarded. If Is Shared = 1, this is mandatory.

See Also

Retrieved from "https://mediawiki.emersion.com.au/wiki/index.php?title=Data_Import/Xero_Ledger_Code_Mapping&oldid=4197"