Skip to main content

Description Item API

Create and manage description items for adding text lines to transactions (section headers, notes, instructions).

Endpoints​

MethodEndpointDescription
GET/record/v1/descriptionItemList description items
GET/record/v1/descriptionItem/{id}Get specific item
POST/record/v1/descriptionItemCreate item
PATCH/record/v1/descriptionItem/{id}Update item
DELETE/record/v1/descriptionItem/{id}Delete item

Key Fields​

FieldTypeDescriptionRequired
itemIdstringItem name/numberYes (if not auto)
displayNamestringDisplay nameNo
descriptionstringItem description/textNo
subsidiaryobjectSubsidiary assignmentNo
includeChildrenbooleanInclude child subsidiariesNo
isInactivebooleanInactive flagNo

Example: Create Description Item​

POST /record/v1/descriptionItem
Content-Type: application/json
{
  "itemId": "SECTION-HEADER",
  "displayName": "Section Header - Hardware",
  "description": "--- Hardware Components ---"
}

Response:

{
  "id": "945",
  "itemId": "SECTION-HEADER",
  "displayName": "Section Header - Hardware",
  "description": "--- Hardware Components ---",
  "isInactive": false,
  "lastModifiedDate": "2025-12-25T10:30:00Z"
}

Example: Update Description Item​

PATCH /record/v1/descriptionItem/945
Content-Type: application/json
{
  "description": "=== Hardware Components Section ==="
}

Response:

{
  "id": "945",
  "itemId": "SECTION-HEADER",
  "displayName": "Section Header - Hardware",
  "description": "=== Hardware Components Section ===",
  "lastModifiedDate": "2025-12-25T11:00:00Z"
}

Query Filters​

Find Active Description Items​

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

Find by Item ID Pattern​

GET /record/v1/descriptionItem?q=itemId LIKE 'SECTION%'

Find by Display Name​

GET /record/v1/descriptionItem?q=displayName LIKE '%Header%'

Important Notes​

  • Description items are non-billable text lines that appear on transactions
  • These items do not post to any accounts and have no financial impact
  • Description items are commonly used for:
    • Section headers to organize items on quotes and invoices
    • Special instructions or notes for customers
    • Terms and conditions text
    • Warranty information
    • Product category separators
    • Assembly or kit component descriptions
  • Description items can be added to:
    • Sales orders
    • Invoices
    • Quotes and estimates
    • Purchase orders
    • Item receipts
    • Bills
  • The description field contains the actual text that appears on the transaction
  • Unlike other item types, description items:
    • Do not have prices or costs
    • Cannot be inventoried
    • Do not require account assignments
    • Do not require subsidiary assignment (even in OneWorld)
  • Description items can improve readability and organization of long transaction documents
  • Best practice is to create reusable description items for common headers or notes
  • Description items can be managed programmatically to standardize transaction formatting

Common Use Cases​

Section Headers​

{
  "itemId": "HEADER-SOFTWARE",
  "displayName": "Software Section",
  "description": "--- Software Licenses ---"
}

Special Instructions​

{
  "itemId": "NOTE-DELIVERY",
  "displayName": "Delivery Instructions",
  "description": "Please deliver to receiving dock between 8 AM - 5 PM"
}

Terms and Conditions​

{
  "itemId": "TERMS-WARRANTY",
  "displayName": "Warranty Terms",
  "description": "All products include a 90-day manufacturer warranty"
}

See Also​