Overview
This reference guide provides detailed field specifications for all CSV import types in WorkSuite. Use this when preparing your CSV files to ensure proper formatting and validation.Customer Import Fields
Customer Fields
| Field Name | Required | Data Type | Max Length | Description | Example |
|---|---|---|---|---|---|
CustomerName | Yes | Text | 255 | Unique customer name | ”Acme Gardens Inc” |
CustomerDescription | No | Text | 1000 | Customer notes | ”Retail nursery chain” |
CustomerTerms | No | Text | 100 | Payment terms name | ”Net 30” |
Location Fields
| Field Name | Required | Data Type | Max Length | Description | Example |
|---|---|---|---|---|---|
LocationCode | Yes* | Text | 50 | Unique location identifier | ”ACME-MAIN” |
LocationName | Yes* | Text | 255 | Location name | ”Main Store” |
LocationAddressLine1 | No | Text | 255 | Street address | ”123 Garden Way” |
LocationAddressLine2 | No | Text | 255 | Apartment/suite | ”Suite 100” |
LocationCity | No | Text | 100 | City name | ”Portland” |
LocationState/Province | No | Text | 50 | State/province | ”OR” |
LocationZipcode | No | Text | 20 | ZIP/postal code | ”97201” |
LocationCountry | No | Text | 3 | Country code (ISO) | “USA” |
LocationAddressToName | No | Text | 255 | Recipient name | ”Receiving Dept” |
LocationDescription | No | Text | 1000 | Location notes | ”Main retail location” |
LocationTerms | No | Text | 100 | Location-specific terms | ”Net 15” |
StoreNumber | No | Text | 50 | Store number | ”STORE-001” |
GLN | No | Text | 13 | Global Location Number | ”1234567890123” |
Contact Fields
| Field Name | Required | Data Type | Max Length | Description | Example |
|---|---|---|---|---|---|
ContactFirstName | Yes* | Text | 100 | First name | ”John” |
ContactLastName | Yes* | Text | 100 | Last name | ”Doe” |
ContactEmailAddress | No | 255 | Email address | ”[email protected]” | |
ContactPhoneNumber | No | Phone | 20 | Phone number | ”503-555-0100” |
ContactTitle | No | Text | 100 | Job title | ”Purchasing Manager” |
ContactMobile | No | Phone | 20 | Mobile phone | ”503-555-0101” |
Billing Address Fields
| Field Name | Required | Data Type | Max Length | Description | Example |
|---|---|---|---|---|---|
BillingToName | No | Text | 255 | Name on billing | ”Acme Gardens Inc” |
BillingAddressLine1 | Yes* | Text | 255 | Street address | ”456 Finance St” |
BillingAddressLine2 | No | Text | 255 | Suite/apt | ”Floor 3” |
BillingCity | Yes* | Text | 100 | City | ”Portland” |
BillingState/Province | Yes* | Text | 50 | State/province | ”OR” |
BillingZipcode | Yes* | Text | 20 | ZIP code | ”97202” |
BillingCountry | No | Text | 3 | Country code | ”USA” |
Validation Rules
CustomerName:- Must be unique across all customers
- Cannot contain only whitespace
- Duplicates are skipped
- Must match email format:
[email protected] - Validated using regex pattern
- Invalid emails cause row to fail
- Accepts various formats
- Automatically formatted to standard format
- Non-numeric characters allowed (dashes, spaces, parentheses)
- Must be unique within the customer
- Can be reused across different customers
- Required if specifying location fields
Order Import Fields
WorkSuite supports two different order import formats depending on your tenant configuration:BPF Format (Ball Park Flowers)
| Field Name | Required | Data Type | Max Length | Description | Example |
|---|---|---|---|---|---|
PoNumber | No | Text | 100 | Customer PO number | ”PO-12345” |
CustomerId | Yes | Text | 50 | Customer ID (must exist) | “CUST001” |
ExpDeliveryDate | Yes | Date | - | Expected delivery date | ”01/15/2024” |
Type | Yes | Text | 1 | Order type: P (Purchase) or C (Credit) | “P” |
SalesPersonEmail | Yes | 255 | Sales person email address | ”[email protected]” | |
OrderByFirstName | No | Text | 100 | First name of person placing order | ”John” |
OrderByLastName | No | Text | 100 | Last name of person placing order | ”Doe” |
OrderByPhone | Yes | Phone | 20 | Phone number of person placing order | ”(555) 555-0123” |
OrderedByEmail | Yes | 255 | Email of person placing order | ”[email protected]” | |
ItemId | Yes | Text | 36 | Item ID (must exist) | “ITEM001” |
Group | Yes | Text | 50 | Item group identifier | ”GRP01” |
Quantity | Yes | Number | - | Order quantity (must be positive) | 10 |
OverridePrice | No | Decimal | - | Override price per unit | 25.50 |
MOIF Format (Mast of Iowa Farmers)
| Field Name | Required | Data Type | Max Length | Description | Example |
|---|---|---|---|---|---|
PoNumber | No | Text | 100 | Customer PO number | ”PO-12345” |
CustomerLocationName | Yes | Text | 255 | Customer location name (must exist) | “Main Warehouse” |
ExpectedDeliveryDate | Yes | Date | - | Expected delivery date | ”01/15/2024” |
Type | Yes | Text | 1 | Order type: P (Purchase), C (Credit), or R (Return) | “P” |
OrderByFirstName | No | Text | 100 | First name of person placing order | ”John” |
OrderByLastName | No | Text | 100 | Last name of person placing order | ”Doe” |
OrderByPhone | Yes | Phone | 20 | Phone number of person placing order | ”(555) 555-0123” |
OrderedByEmail | Yes | 255 | Email of person placing order | ”[email protected]” | |
ItemUpc | Yes | Text | 12 | Item UPC (must exist) | “123456789012” |
Quantity | Yes | Number | - | Order quantity (must be positive) | 10 |
OverridePrice | No | Decimal | - | Override price per unit | 25.50 |
Validation Rules
Order Grouping:- BPF: Orders grouped by CustomerId + ExpDeliveryDate
- MOIF: Orders grouped by CustomerLocationName + ExpectedDeliveryDate
- Each unique combination creates one order
- Line items aggregated under each order
- BPF: Uses CustomerId to find customer
- MOIF: Uses CustomerLocationName to find customer location and associated customer
- Customer/location must exist or order fails
- BPF: Uses ItemId to find item
- MOIF: Uses ItemUpc to find item
- Item must exist or line item skipped
- Accepted:
MM/DD/YYYY,YYYY-MM-DD - Examples: “01/15/2024”, “2024-01-15”
- Invalid dates cause order to fail
- BPF: P (Purchase), C (Credit)
- MOIF: P (Purchase), C (Credit), R (Return)
- Invalid types cause row to fail
- Must be positive numbers
- Decimals allowed (e.g., 2.5)
- Zero or negative quantities cause validation error
- Optional (uses customer pricing if blank)
- Must be non-negative
- Decimal format with up to 2 decimal places
Item Import Fields
Item Fields
| Field Name | Required | Data Type | Max Length | Description | Example |
|---|---|---|---|---|---|
ItemName | Yes | Text | 255 | Item display name | ”Geranium 4-inch” |
Sku | Yes | Text | 255 | Stock keeping unit (unique) | “GER-4IN-RED” |
Upc | Yes | Text | 12 | Universal product code (12 digits) | “123456789012” |
ItemGroup | Yes | Text | 255 | Item group/category | ”Annuals” |
RetailPrice | Yes | Decimal | - | Suggested retail price | 4.99 |
Description | No | Text | 255 | Item description | ”Red geranium in 4-inch pot” |
Program | No | Text | 255 | Program/collection | ”Spring 2025” |
CategoryCode | No | Text | 255 | Category code identifier | ”ANN” |
CategoryName | No | Text | 255 | Category name | ”Annuals” |
Validation Rules
SKU Uniqueness:- Must be unique across all items
- Duplicate SKUs within the CSV are flagged as errors
- Case-sensitive matching
- Required field
- Must be exactly 12 digits
- Must contain only numbers (no dashes or spaces)
- Invalid UPC format causes row to fail
- Required field
- Must be a positive number
- Decimals allowed
- Cannot be negative or zero
- Multiple categories per item supported by using multiple rows with the same SKU
- Each row with the same SKU creates or updates the item and adds the category
- Both CategoryCode and CategoryName are optional
- If category doesn’t exist, it will be created during import
Location Import Fields
Location Fields
| Field Name | Required | Data Type | Max Length | Description | Example |
|---|---|---|---|---|---|
LocationCode | Yes | Text | 50 | Unique location code | ”WH-A-01” |
LocationName | Yes | Text | 255 | Location display name | ”Warehouse A - Bay 1” |
LocationType | No | Text | 50 | Location type | ”Bin” |
ParentLocationCode | No | Text | 50 | Parent location code | ”WH-A” |
Description | No | Text | 1000 | Location description | ”Upper shelf” |
IsActive | No | Boolean | - | Active status | TRUE |
Capacity | No | Number | - | Storage capacity | 100 |
Zone | No | Text | 50 | Warehouse zone | ”Zone A” |
Aisle | No | Text | 20 | Aisle identifier | ”A1” |
Bay | No | Text | 20 | Bay identifier | ”01” |
Level | No | Text | 20 | Shelf level | ”Top” |
Validation Rules
Location Hierarchy:- Locations can have parent-child relationships
- ParentLocationCode must reference existing location
- Creates nested structure (Warehouse → Zone → Bin)
- Common types: Site, Warehouse, Zone, Aisle, Bin
- Type determines hierarchy level
- Optional but recommended
- Must be globally unique
- Case-sensitive
- No special characters recommended
- Optional numeric value
- Represents storage capacity (units vary by use case)
- Used for capacity planning
Category Import Fields
Category Fields
| Field Name | Required | Data Type | Max Length | Description | Example |
|---|---|---|---|---|---|
CategoryName | Yes | Text | 255 | Category name (unique) | “Annuals” |
Description | No | Text | 1000 | Category description | ”Annual flowering plants” |
ParentCategory | No | Text | 255 | Parent category name | ”Flowering Plants” |
SortOrder | No | Integer | - | Display order | 1 |
IsActive | No | Boolean | - | Active status | TRUE |
Color | No | Text | 7 | Display color (hex) | “#FF5733” |
Validation Rules
Category Hierarchy:- Categories can be nested (parent-child)
- ParentCategory must exist before import
- Creates tree structure for organization
- Must be unique at each level
- Siblings cannot have same name
- Different levels can reuse names
- Numeric value for display sequence
- Lower numbers appear first
- Optional (auto-assigned if blank)
Common Validation Patterns
Email Validation
Phone Validation
Date Validation
Boolean Validation
CSV File Formatting
File Requirements
Encoding: UTF-8 (required) Line Endings: LF or CRLF (both supported) Delimiter: Comma (,) Text Qualifier: Double quotes (”) for fields containing commas Header Row: Required (first row must be column names) File Size: Recommended maximum 50MB per fileSpecial Characters
Commas in Values:Empty Fields
- Leave empty for optional fields:
ItemName,,Description - Do not use “NULL” or “N/A” (treated as literal text)
- Empty required fields cause validation error
Example Well-Formatted CSV
Item CSV Example:Error Messages Reference
Common Import Errors
| Error Message | Cause | Solution |
|---|---|---|
| ”Required field missing: CustomerName” | CustomerName column empty or missing | Add customer name to all rows |
| ”Duplicate SKU: ABC123” | Item with this SKU already exists in CSV | Use unique SKU for each item |
| ”Customer not found: CUST001” (BPF) | Customer ID doesn’t exist in system | Import customer first or fix ID |
| ”Customer location not found: Main Warehouse” (MOIF) | Customer location name doesn’t exist | Import customer location first or fix name |
| ”Item not found: ITEM001” (BPF) | Item ID doesn’t exist in system | Import item first or fix ID |
| ”Item not found for UPC: 123456789012” (MOIF) | Item UPC doesn’t exist in system | Import item first or fix UPC |
| ”Invalid email format: johndoe” | Email missing @ or domain | Use proper email format |
| ”Invalid date format: 15-30-2025” | Invalid date (month 30) | Use valid date (MM/DD/YYYY or YYYY-MM-DD) |
| “Invalid type: X” | Order type not P, C, or R | Use valid order type |
| ”Invalid UPC format” | UPC contains non-numeric characters | Use 12-digit numeric UPC only |
| ”Invalid UPC length” | UPC not exactly 12 digits | Ensure UPC is exactly 12 digits |
| ”Quantity must be a positive number” | Negative or zero quantity | Use positive numbers only |
Best Practices
Data Preparation
- Use templates: Download templates from the import screens
- Test small batches: Import 5-10 records first
- Validate in Excel: Check for errors before importing
- Remove formatting: Plain text only, no Excel formatting
- Consistent naming: Use same spelling/capitalization
- Check encoding: Save as UTF-8 with BOM if needed
Import Strategy
- Order of imports:
- Locations → Categories → Items → Customers → Orders
- Break into batches: 100-200 records per file
- Import during off-hours: Reduce system load
- Verify each batch: Check results before next import
- Keep backups: Save original CSV files
Troubleshooting
- Open CSV in text editor: Check for hidden characters
- Re-export from Excel: File → Save As → CSV UTF-8
- Check commas: Ensure values with commas are quoted
- Verify headers: Column names must match exactly
- Review error logs: Read specific error messages
- Test one row: Import single row to isolate issue