Line Attribute Data Reference
The LineAttribute object. The object apiName is LineAttribute — not the Salesforce LineAttribute__c name, which is rejected (404 No access to object metadata with name LineAttribute__c). Field names are Nue camelCase apiNames, not Salesforce field names.
Describe the live object at any time:
curl '{baseUrl}/api/metadata/objects/LineAttribute' -H 'nue-api-key: YOUR_API_KEY'Fields
Field | Type | Required | Description |
|---|---|---|---|
name | Text (80) | Yes | Unique. Rep-facing label. |
scope | Multi-select picklist | Yes | Where the attribute appears. Send as an array. See Scope values. |
mappedFieldApiName | Text (255) | No | The Salesforce field the attribute maps to, e.g. Overage_Rate__c. Required for a usable attribute, though the API allows a draft without it. |
isActive | Boolean | No | Defaults to false. Controls the draft/active lifecycle. |
appliesToProductsFilter | Long text | No | Product filter; empty applies to all products. |
description | Text (255) | No | Rep-facing help text. |
defaultPluginActionId | Lookup (Pricing Plugin) | No | Optional default plugin action. |
Read-only, system-populated: id, createdById, createdDate, lastModifiedById, lastModifiedDate.
Scope values
scope is a multi-select picklist (value set LineAttributeScope). Send an array of one or both:
Value | Where the attribute appears |
|---|---|
Line Editor | Quick Actions on the Quote Line Editor |
Subscription Card | Update Fields on the Lifecycle Manager Subscription Card |
Errors
Status | Example | Cause |
|---|---|---|
400 | {"message":"scope is required."} | A required field (name, scope) is missing. |
401 | INVALID_AUTH_KEY | Missing or invalid nue-api-key, or a key from a different environment. |
404 | No access to object metadata with name LineAttribute__c | Wrong object name — use LineAttribute, not the Salesforce __c name. |
Related resources
- Line Attributes — concept, admin UI, and rep workflow
- Create Objects — the generic Objects API
- Update Quote & Order Apex Global Method — setting line attribute values on lines