Note: This Object will be available in the August Sandbox Release.

This use case example will cover importing Credits in bulk. 

Import File Structure

The sample import file for Credits includes nested objects which are separated into individual sheets in Excel or separate files for csv. Nested Credit objects include: 

• Credit Line Items
• Invoice Credit
• Billing Contact
• Shipping Contact

Update Billing & Shipping Contact Information

It is not necessary to populate the Billing Contact and Shipping Contact tab when importing new Credits. This data is automatically retrieved from the Customer. 

When updating Tiers or Transaction Posting Entries, all records and fields must be included  in the import file. The import process overwrites the records on update by deleting all of the records for that subscription and creating new records from your import file. Therefore, any records intentionally left out of the import file will be deleted.

Important: When creating new Credits and Credit Line Items or Invoice Credits at the same time, you must provide temporary IDs to link the Credits to the Credit Line Items and/or Invoice Credits. When auto Document Numbering is enabled via Menu > Settings > Document Numbering > Credit ID, the temporary IDs provided in the file will be overwritten by auto-generated IDs.

Example Credit Import Tab

Example Credit Line Items Tab

Example Invoice Credit Tab

Step 1: Build an Import File

Be sure to review Import Basics: Build an Import File article before proceeding. 

1. Within Ordway, navigate to Menu > Operations > Import Data.

2. Download the Credit Sample Template in the desired format; either .csv or .xls.

3. Populate the data. Reference required fields for Credit Imports. 

For this use case where we are importing new Credits, we will include: 

Credit Tab:

• ID (temp ID as mentioned above)
• Customer ID
• Date
• Amount
• Auto-Apply
• Reference Number
• Currency

Credit Line Items Tab: 

• Credit ID (temp ID as mentioned above)
• Line Number
• Product ID
• Description
• Credit Account
• Price
• Quantity
• Taxable 
• Tax Override
• Line Tax

Invoice Credit Tab:

• Credit ID (temp ID as mentioned above)
• Invoice ID
• Amount Applied

Billing Contact Tab: Leave blank unless different from the information stored with the Customer in Ordway

• Credit ID
• First name
• Last Name
• Display Name
• Email
• Address fields (Address 1, Address 2, City, State, Zip, County, Country)

Shipping Contact Tab: Leave blank unless different from the information stored with the Customer in Ordway

• Credit ID
• First name
• Last Name
• Display Name
• Email
• Address (Address 1, Address 2, City, State, Zip, County, Country)

4. Save the file when finished. 

Step 2: Import Data

1. Within Ordway, navigate to Menu > Operations > Import Data.

2. Select Proceed next to Credits.

3. Click Select File to navigate to the populated Credit template from Step 1. Accepted file types include .csv, .xlsx, or .zip.

4. Optional: Send import results in an email.

Click the toggle next to ‘Send import results to the following email address(es). Use a comma to separate each address.’ 

5. Click Next to continue.

6. Verify the object data to be uploaded with the corresponding spreadsheet tab.

7. Click Next to continue. 

8. Select the Date Format in the import file to match the Date Format field drop-down in the Import Wizard.

To edit or customize available mappings, read about how to Save Field Mappings. 

9. Verify all columns are correctly mapped on the Map Columns screen for each tab in the import file. Ordway automatically maps fields with the same name. Review all mappings to ensure they are correct. 

Note the separate tabs, each with their own mapping fields:

Credit Tab

Credit Line Items Tab

Billing Contact Tab

Shipping Contact Tab

10. Click Next to Continue.

The screen displays the number of records found. 

11. Click Import to continue.

12. The screen displays the total number of rows processed per tab and any rows with errors. View failed record reasons by hovering over the error icon in red on the corresponding row.

Fix any errors by clicking Fix Errors, then click in the individual cell to edit the value. 

Note: Be sure to check each tab included in the import and correct all errors.

Example error:

13. Once any errors are corrected, click Import.

14. Once the import completes, view the results including the number of records processed and records skipped due to errors. 

15. Click Done. You are automatically returned to the most recently visited page.

Step 3: View Import History