The Generic API Loader application uses Zuora APIs in combination with CSV templates to perform mass requests. It enables you to create, update, and delete any Zuora object in bulk.

The Generic API Loader takes in a CSV file, reads through each line, performs the desired operation, and generates a results file and a failures file. If no error is encountered during the execution job, the failures file will be blank and the results file will report success statements for each line in the CSV. Otherwise, the lines are added to the failures file and each error is listed in the results file. This allows for an iterative approach where the failures file can be corrected based on the error received in the status file and re-uploaded as a new task.

Note that If you want to update the following objects, you are recommended to configure the API loader for those specific objects and use the standard templates :

Known Limitations

The following limitations are applicable to Generic API Loader:

• When the Invoice Settlement feature is enabled for your tenant, Developer Tool defaults to the REST calls for the following objects:
  • Credit Memo
  • Debit Memo
  • Payment
  • Refund

  Currently, only the fields in SOAP calls, and the fields in the REST calls to these objects can be updated. The Generic API Loader only supports updating custom fields on the main objects listed above; it does not support updating custom fields sub-items, such as Debit Memo Item.

• The Developer Tools do not support updating custom fields on the Order Action object. You can use the REST Update order custom fields call to update custom fields on the Order Action object.

• When updating the ProductRatePlanCharge object where the Tax feature is enabled, you must include the TaxMode and TaxableCode fields in the CSV file.
• The files encoded with UTF-8 are supported, but encoded with UTF-8 with byte order mark (BOM) are not supported.