new Modification()
- Source:
Methods
(static) Modification#getAlternateName() → {String}
Get the field value
- Source:
Returns:
- Type
- String
(static) Modification#getAmount() → {Number}
Get the field value
the additional cost of the modifier when it was applied
- Source:
Returns:
must be a long integer
- Type
- Number
(static) Modification#getId() → {String}
Get the field value
- Source:
Returns:
- Type
- String
(static) Modification#getLineItemRef() → {base.Reference}
Get the field value
The line item with which the modification is associated
- Source:
Returns:
- Type
- base.Reference
(static) Modification#getModifier() → {inventory.Modifier}
Get the field value
The modifier object. Values from the Modifier are copied to the Modification at the time that the order is placed. Modifier values may change after the modification is created.
- Source:
Returns:
- Type
- inventory.Modifier
(static) Modification#getName() → {String}
Get the field value
the name of the modifier when it was applied
- Source:
Returns:
- Type
- String
(static) Modification#getQuantitySold() → {Number}
Get the field value
This is only used in reports. The count of how many of these modifiers that were sold.
- Source:
Returns:
must be a long integer
- Type
- Number
(static) Modification#setAlternateName(alternateName)
Set the field value
Parameters:
Name | Type | Description |
---|---|---|
alternateName |
String |
- Source:
(static) Modification#setAmount(amount)
Set the field value
the additional cost of the modifier when it was applied
Parameters:
Name | Type | Description |
---|---|---|
amount |
Number | must be a long integer |
- Source:
(static) Modification#setId(id)
Set the field value
Parameters:
Name | Type | Description |
---|---|---|
id |
String |
- Source:
(static) Modification#setLineItemRef(lineItemRef)
Set the field value
The line item with which the modification is associated
Parameters:
Name | Type | Description |
---|---|---|
lineItemRef |
base.Reference |
- Source:
(static) Modification#setModifier(modifier)
Set the field value
The modifier object. Values from the Modifier are copied to the Modification at the time that the order is placed. Modifier values may change after the modification is created.
Parameters:
Name | Type | Description |
---|---|---|
modifier |
inventory.Modifier |
- Source:
(static) Modification#setName(name)
Set the field value
the name of the modifier when it was applied
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
- Source:
(static) Modification#setQuantitySold(quantitySold)
Set the field value
This is only used in reports. The count of how many of these modifiers that were sold.
Parameters:
Name | Type | Description |
---|---|---|
quantitySold |
Number | must be a long integer |
- Source: