Skip to main content

Other Charge Sale Item API

Create and manage miscellaneous fees and charges sold directly to customers (shipping, handling, setup fees, etc.).


Endpoints

MethodEndpointDescription
GET/record/v1/otherChargeSaleItemList other charge sale items
GET/record/v1/otherChargeSaleItem/{id}Get specific item
POST/record/v1/otherChargeSaleItemCreate item
PATCH/record/v1/otherChargeSaleItem/{id}Update item
DELETE/record/v1/otherChargeSaleItem/{id}Delete item

Key Fields

FieldTypeDescriptionRequired
itemIdstringItem name/numberYes (if not auto)
displayNamestringDisplay nameNo
descriptionstringItem descriptionNo
subsidiaryobjectSubsidiary assignmentYes (OneWorld)
incomeAccountobjectIncome accountYes
salesDescriptionstringSales descriptionNo
basePricenumberBase selling priceNo
taxScheduleobjectTax scheduleNo
departmentobjectDefault departmentNo
classobjectDefault classNo
locationobjectDefault locationNo
isInactivebooleanInactive flagNo
isTaxablebooleanTaxable flagNo
includeChildrenbooleanInclude child subsidiariesNo

Example: Create Other Charge Sale Item

POST /record/v1/otherChargeSaleItem
Content-Type: application/json
{
"itemId": "SETUP-FEE",
"displayName": "Setup and Configuration Fee",
"description": "One-time setup and configuration service",
"subsidiary": {
"id": "1"
},
"incomeAccount": {
"id": "400"
},
"salesDescription": "Setup and configuration - one-time fee",
"basePrice": 99.00,
"taxSchedule": {
"id": "1"
},
"isTaxable": true,
"department": {
"id": "30"
}
}

Response:

{
"id": "934",
"itemId": "SETUP-FEE",
"displayName": "Setup and Configuration Fee",
"description": "One-time setup and configuration service",
"subsidiary": {
"id": "1",
"refName": "Parent Company"
},
"incomeAccount": {
"id": "400",
"refName": "Other Revenue"
},
"salesDescription": "Setup and configuration - one-time fee",
"basePrice": 99.00,
"taxSchedule": {
"id": "1",
"refName": "Tax Schedule"
},
"isTaxable": true,
"department": {
"id": "30",
"refName": "Implementation"
},
"isInactive": false,
"lastModifiedDate": "2025-12-25T10:30:00Z"
}

Example: Update Other Charge Sale Item

PATCH /record/v1/otherChargeSaleItem/934
Content-Type: application/json
{
"basePrice": 149.00,
"salesDescription": "Premium setup and configuration - one-time fee"
}

Response:

{
"id": "934",
"itemId": "SETUP-FEE",
"displayName": "Setup and Configuration Fee",
"basePrice": 149.00,
"salesDescription": "Premium setup and configuration - one-time fee",
"lastModifiedDate": "2025-12-25T11:00:00Z"
}

Query Filters

Find Active Other Charge Sale Items

GET /record/v1/otherChargeSaleItem?q=isInactive=false

Find by Item ID Pattern

GET /record/v1/otherChargeSaleItem?q=itemId LIKE 'SETUP%'

Find by Price Range

GET /record/v1/otherChargeSaleItem?q=basePrice>=50 AND basePrice<=200

Find by Income Account

GET /record/v1/otherChargeSaleItem?q=incomeAccount.id=400

Find Taxable Charges

GET /record/v1/otherChargeSaleItem?q=isTaxable=true

Find by Department

GET /record/v1/otherChargeSaleItem?q=department.id=30

Important Notes

  • Other charge sale items represent miscellaneous fees and charges you sell to customers, not charges you purchase from vendors
  • These items appear on sales transactions (invoices, sales orders, cash sales) only
  • The incomeAccount is required and determines where revenue is posted when the charge is invoiced
  • Unlike Other Charge Resale Items, sale items do not track COGS or vendor relationships
  • Unlike Other Charge Purchase Items, sale items do not track expense accounts
  • Common use cases include:
    • Shipping and handling fees
    • Setup and installation fees
    • Configuration charges
    • Rush order fees
    • Processing fees
    • Packaging charges
    • Subscription activation fees
    • Restocking fees
  • Other charge sale items do not track inventory quantity or use costing methods
  • The basePrice is optional but commonly used to set a default charge amount
  • Other charge sale items are ideal for:
    • One-time fees that aren't regular services
    • Incidental charges on customer orders
    • Administrative fees
    • Special handling charges
  • In OneWorld accounts, subsidiary assignment is mandatory
  • Other charge sale items can have default department, class, and location dimensions
  • Use isTaxable and taxSchedule to control tax treatment on sales transactions
  • These items help standardize and track various ancillary charges in sales operations

See Also