Knowledge Center

Knowledge Center > Billing and Payments > Billing Operations > Usage > Import Usage Data

Import Usage Data

You can add usage data by either uploading (importing) a file or by using the Zuora API.

Downloading the Usage Template

To upload usage charges, you must first download and populate the Export Usage File template.

To download the template:

  1. Navigate to Billing > Usages in the left-hand navigation section.
  2. Click Add Usages (on the right side of the screen).
  3. Next to Export Usage File Template, click either Excel or CSV. The template will open in the selected format. 

Usage File Format

The usage file type is in Microsoft Excel (.xls) or comma-separated value (.csv) format. To export a copy of the correct usage file format, click the file type link next to Export Usage File Template.

The usage file format has the following columns. 

Column Description

ACCOUNT_ID

Enter the account number . For example, the default account number, such as A00000001, or your custom account number. 

Be sure to use the account number not the Account ID or Account Name. 

Required? yes

UOM

Enter the unit of measure. This must match the UOM for the usage that is set up in Billing > Customize Units of Measure.

Required? yes

QTY

Enter the quantity. 

Required? yes

STARTDATE

Enter the start date of the usage.  This date determines the invoice item service period the associated usage is billed to. Date format is based on locale of the current user.

Default date format:  MM/DD/YYYY 

Required? yes

ENDDATE

Enter the end date of the usage.  This is not used in calculations for usage billing and is optional. Date format is based on locale of the current user.

Default date format:  MM/DD/YYYY

Required? The value of this column is option, but the column header is required in the usage file.

SUBSCRIPTION_ID

Enter the subscription number or subscription name.

If you created the subscription in the Zuora application, Zuora created a number automatically in a format similar to: A-S00000001

If you do not provide a value for this field, the associated usage will be added to all subscriptions for the specified Account that use this Unit Of Measure.

If your Accounts can have multiple subscriptions and you do not want double or triple counting of usage, you must specify the Subscription or Charge ID in each usage record.

Required? The value of this column is option, but the column header is required in the usage file.

CHARGE_ID

Enter the charge number, for example, C-00000001, when you add your rate plan to your subscription and you view your individual charges. See Adding Products and Rate Plans for additional information.

If your Accounts can have multiple subscriptions and you do not want double or triple counting of usage, you must specify the specific Subscription or Charge ID in each usage record. 

This field is related to the Charge Number on the subscription rate plan.

Required? The value of this column is option, but the column header is required in the usage file.

DESCRIPTION

Enter a description for the charge. 

Required? No

Do not create a custom field with the same name as the standard Zuora field for the Usage object. If you do, it is confusing which is the correct field when importing a usage file. For example, having two STARTDATE fields in a usage file.

STARTDATE and ENDDATE Format and User Locale

The format used for STARTDATE and ENDDATE depends on the locale of the current user. This format is not controlled by the locale that you set for your Zuora tenant. For example, if user's locale is set to English (United Kingdom) or English (Australia), the date format would be DD/MM/YYYY.

See Managing Users for information about configuring the locale setting. 

Importing Usage Data

To import usage data:

  1. Navigate to Billing > Usages in the left-hand navigation section.
  2. Click Add Usages, located at the upper-right corner of the page.
  3. From this page, you can download an empty usage load template. Click Export Usage File Template.
  4. Edit the file to add usage data. See "Usage File Format," above, for more information about the fields in the template and their meaning.

Do not delete any columns in the Usage template file. Although the values are optional and the fields are empty, the Usage file will not import successfully if any of the column field names in the downloaded Usage template do not exist in the uploaded Usage file.

  1. Click Browse and select the file that you want to import. The file must be in the Zuora Billing usage file format. 
  2. Click Submit.

After importing the usage file, the usage uploads are automatically set to the Pending Process status. This status indicates that the usage is waiting to be billed. Once they are billed (when you post an invoice that contains these usage charges), the status will be updated to Processed. See Reviewing and Posting Bill Runs for information about posting an invoice. See How Do I Load Usage Information Into Zuora on a Regular (Daily) basis for more information about automating usage loading.

Mass Usage Upload

Zuora allows you to perform a mass, asynchronous upload of usage records using the Zuora web interface or the Zuora API. 

  • You can import zipped comma-separated value (.csv) files using the Zuora web interface or API. In addition, you can import zipped Microsoft Excel (.xls) files using the Zuora web interface. You can import a single file at a time, up to 4 MB in size. 
  • You can download the import result in a single, zipped .csv file.
  • You can query records that have been imported successfully using the ImportId field of the Usage object.
  • You can use import notifications to send the import result to one or more users. 

Do not perform any processes that will use this data, such as bill runs, until the usage import is complete. 

Handling Upload Failures

There are two types of failures that can occur when uploading usage information:

  • Upload failure: If the file cannot be uploaded, Zuora will return you to the usage upload page. Verify that the file matches the usage file format, and then upload the file again. In this case, Zuora does not load any information. This type of failure can occur if the file type is not recognized, or if the file is too large (greater than 4 MB). 
  • Import failure: If Zuora cannot import the data successfully, the system will return an Import Processed | Failed Status notification. If this occurs, verify that the file is correct, and then upload the file again.  
Last modified
00:35, 15 Nov 2016

Tags

Classifications

(not set)