Assigning Allowances Accounts via CSV upload

Assigning accounts via CSV import facilitates the bulk assigning accounts of differing values to multiple users. A sample file is attached at the bottom of this guide that you can use as a template.

Each of the columns must be kept in the file, but you only need to put data into the columns depending on your requirements.

• id/email - At least one is required. If id is provided alongside email, email will be ignored. id is the user GUID for existing users. If you don't know what this is, don't worry - just use email! 
• planId - Mandatory at all times
• tierId - Mandatory except for gifting plans where amount is provided.
• amount - May be provided instead of tier for gifting plans if a custom amount is desired. If both amount and tierId are provided, an error will be returned. Has no effect on any allocation type other than Gifting.
• startingAllowanceAmount - Can be used to specify a custom amount for the first period of an allowance. Upon the first renewal, the value of tierId  will be the value topped up. Has no effect on any allocation type other than Allowance.

Finding the planId and tierId

Navigate to the Gifting or Allowances page (whichever type you wish to allocate via upload).

Find the relevant account.

Move your cursor over the # symbol next to the account name to get the planId (you can then copy the id string).

Move your cursor over the # symbol next to the tier name to get the tierId (you can then copy the id string).

Uploading the File

1. Navigate to the Users page.

    

2. Select "Import" at the top right of the page.
   

    

3.  Select the "ACCOUNTS" tab and click "Upload CSV"
   

    

4. Select "Choose File" and choose the .CSV file you have prepared, then click "Open"
   

    

5. Once you've attached a file, select "Upload"
   
    
6. Review the data, and if it's all correct, select "Complete Import" (or "Reset" if you want to change something).
   

The system will then work in the background to assign the accounts, with a progress bar to let you know once the process is complete!

Things to watch out for:

• Email is the identifier for employees. If you include an email that doesn't match an existing user email, the whole import will fail.
• Users must exist in the system before you can assign them an account. You can't use this import option to both create a user and assign them an account at the same time. To see how to create users via CSV upload, please refer to this Help Centre guide.
• Only enter the numerical value for amount and startingAllowanceAmount. Don't use $ symbols.