| Review the available fields, required fields, valid values, and field-specific requirements for importing Credits into Ordway. |
Note: This object is available in the July Sandbox Release.
For a walkthrough of Credits, see New Credits.
Importing Credits includes the following tabs:
The tabs required for a successful import depend on the data being imported.
Contents
- Before You Begin
- Credit Imports
- Field Requirements
- Credit Tab
- Credit Line Items Tab
- Invoice Credit Tab
- Debit Memo Credit Tab
- Billing Contact Tab
- Shipping Contact Tab
- Import Comments
- Related Topics
Before You Begin
- Review Step 1: Build an Import File to learn how to prepare an import file.
- Review Step 2: Import Data for information about importing data.
- Review New Credits for information about Credits.
- Download the Credit import template from the Import Wizard.
- Make sure you have the required permissions to import Credits.
Credit Imports
A Credit import file includes the following tabs:
- Credit — Contains the fields available for importing Credit records.
- Credit Line Items — Contains the fields available for importing Credit line items.
- Invoice Credit — Contains the fields available for applying Credits to Invoices.
- Debit Memo Credit — Contains the fields available for applying Credits to Debit Memos.
- Billing Contact — Contains billing contact information associated with a Credit.
- Shipping Contact — Contains shipping contact information associated with a Credit.
Field Requirements
The following indicators identify field requirements:
| Indicator | Description |
|---|---|
| X | Required for the specified operation. |
| * | May be required based on settings or additional selections. |
| — | No specific requirement is defined. |
Credit Tab
The Credit tab contains the fields available for creating and updating Credits.
| Field | API Name | Type | Create | Update | Reverse | Valid Values | Notes |
|---|---|---|---|---|---|---|---|
| ID | id | Text | X | X | — | — | — |
| External ID | external_id | Text | — | — | — | — | — |
| Customer ID | customer_id | Text | X | — | — | — | — |
| Date | credit_date | Date | X | — | — | — | — |
| Notes | notes | Text | — | — | — | — | — |
| Status | status | Text | — | — | — | Processed, Reversed | — |
| Amount | credit_amount | Currency | X | — | — | — | Defaults to 0. |
| Currency | currency | Text | — | — | — | — | — |
| Reference Number | reference_number | Text | — | — | — | — | — |
| Auto Apply | auto_apply | Boolean | — | — | — | Yes, No | Defaults to No. |
| Reversed On | reversed_on | Date | — | — | — | — | — |
| Exchange Rate | conversion_rate | Number | — | — | — | — | — |
| lookup_cf | lookup_cf | Lookup | — | — | — | — | — |
| avalara_id | avalara_id | Text | — | — | — | — | — |
Credit Line Items Tab
The Credit Line Items tab contains the fields available for importing Credit line items.
| Field | API Name | Type | Create | Update | Reverse | Valid Values | Notes |
|---|---|---|---|---|---|---|---|
| Credit ID | credit_id | Text | X | X | — | — | — |
| Line Number | line_no | Number | X | X | — | — | — |
| Product ID | product_id | Text | X | X | — | — | — |
| Description | description | Text | — | X | — | — | — |
| Credit Account | credit_account | Text | * | X | — | — | Required if Finance is enabled. |
| Price | unit_price | Currency | X | X | — | — | — |
| Quantity | quantity | Number | X | X | — | — | — |
| Taxable | taxable | Boolean | — | X | — | Yes, No | — |
| Tax Override | tax_override | Boolean | — | X | — | Yes, No | — |
| Line Tax | line_tax | Currency | — | X | — | — | — |
Invoice Credit Tab
The Invoice Credit tab contains the fields available for applying Credits to Invoices.
| Field | API Name | Type | Create | Update | Reverse | Valid Values | Notes |
|---|---|---|---|---|---|---|---|
| Credit ID | credit_id | Text | X | X | — | — | — |
| Invoice ID | id | Text | X | X | — | — | — |
| Amount Applied | amount_applied | Currency | X | X | — | — | — |
Debit Memo Credit Tab
The Debit Memo Credit tab contains the fields available for applying Credits to Debit Memos.
| Field | API Name | Type | Create | Update | Reverse | Valid Values | Notes |
|---|---|---|---|---|---|---|---|
| Credit ID | credit_id | Text | — | — | — | — | — |
| Debit Memo ID | id | Text | — | — | — | — | — |
| Amount Applied | amount_applied | Currency | X | — | — | — | — |
Billing Contact Tab
The Billing Contact tab contains billing contact information associated with a Credit.
| Field | API Name | Type | Create | Update | Reverse | Valid Values | Notes |
|---|---|---|---|---|---|---|---|
| Credit ID | credit_id | Text | X | X | — | — | — |
| First Name | first_name | Text | — | — | — | — | — |
| Last Name | last_name | Text | — | — | — | — | — |
| Display Name | display_name | Text | X | — | — | — | — |
| Text | — | — | — | — | — | ||
| Phone | phone | Text | — | — | — | — | — |
| Mobile | mobile | Text | — | — | — | — | — |
| Job Title | job_title | Text | — | — | — | — | — |
| Department | department | Text | — | — | — | — | — |
| Address 1 | address1 | Text | — | — | — | — | — |
| Address 2 | address2 | Text | — | — | — | — | — |
| City | city | Text | — | — | — | — | — |
| State | state | Text | — | — | — | — | — |
| ZIP | zip | Text | — | — | — | — | — |
| County | county | Text | — | — | — | — | — |
| Country | country | Text | — | — | — | — | — |
Shipping Contact Tab
The Shipping Contact tab contains shipping contact information associated with a Credit.
| Field | API Name | Type | Create | Update | Reverse | Valid Values | Notes |
|---|---|---|---|---|---|---|---|
| Credit ID | credit_id | Text | X | X | — | — | — |
| First Name | first_name | Text | — | — | — | — | — |
| Last Name | last_name | Text | — | — | — | — | — |
| Display Name | display_name | Text | X | — | — | — | — |
| Text | — | — | — | — | — | ||
| Phone | phone | Text | — | — | — | — | — |
| Mobile | mobile | Text | — | — | — | — | — |
| Job Title | job_title | Text | — | — | — | — | — |
| Department | department | Text | — | — | — | — | — |
| Address 1 | address1 | Text | — | — | — | — | — |
| Address 2 | address2 | Text | — | — | — | — | — |
| City | city | Text | — | — | — | — | — |
| State | state | Text | — | — | — | — | — |
| ZIP | zip | Text | — | — | — | — | — |
| County | county | Text | — | — | — | — | — |
| Country | country | Text | — | — | — | — | — |
Import Comments
You can add comments to the import file by starting a row with #. Any row that starts with # is ignored during import.
For example:
| # This row will be ignored during import |
Comments
0 comments
Please sign in to leave a comment.