Update Service Charges
post
/config/sim/v1/sales/updateServicecharges
Updates the Service Charge. If Service Charge is not found, it creates a new Service Charge.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Request body
Root Schema : ServiceChargeCURequestBody
Type:
objectModel for Service Charge Object
Show Source
-
amount:
integer
Maximum amount allowed for an open-priced or amount ServiceChargeExample:
1 -
consumerDisplayname:
object consumerDisplayname
A group of string objects representing the name of the Service Charge in configured languages
-
dataExtensions:
array dataExtensions
An array of data extensions
-
effGrpObjNum:
integer
Object number of the Effectivity Group for the current recordExample:
1 -
externalReference1:
string
An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32Example:
ExternalReference1 -
externalReference2:
string
An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32Example:
ExternalReference2 -
halo:
integer
Maximum amount allowed for an open-priced or amount ServiceChargeExample:
1 -
hierUnitId(required):
integer
Unique reference of the hierarchy unit of the propertyExample:
1 -
mainLevelPopup:
integer
The Main Level that activates after pressing the ServiceChargeExample:
1 - menuLevels: object menuLevels
-
name(required):
object name
A group of string objects representing the name of the Service Charge in configured languages
-
nlu:
integer
A unique Number Lookup (0-9,999,999,999) for the ServiceChargeExample:
1 -
objectNum(required):
integer
Object number of the Service ChargeExample:
1 -
options:
string
A String of Values of 0s and 1s of length 56 representing the enablement or disablement of the options associated with ServiceChargesExample:
00000000000000000000000000000000000000000000000000000000 -
percent:
integer
Percentage for the manual ServiceCharge.Example:
1 -
percentToTipsPaid:
integer
Percentage for the manual ServiceCharge.Example:
1 -
pickupTenderOrMediaObjNum:
integer
Print Class for the DiscountExample:
1 -
printClassObjNum:
integer
Print Class for the DiscountExample:
1 -
privilegeGroup:
integer
Privilege Group number to restrict the use of the ServiceChargeExample:
1 -
reportGroupObjNum:
integer
Report Group to associate with the ServiceCharge.Example:
1 -
subLevelPopup:
integer
The Main Level that activates after pressing the ServiceChargeExample:
1 -
svcItmzr:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge itemizers on which the ServiceCharge is computableExample:
1 -
svcSLUNum:
integer
Object number of the Screen Lookup key for the ServiceCharge.Example:
1 -
taxClassObjNum:
integer
Tax Class to be ServiceChargeedExample:
1 -
transDefaultMainLevel:
boolean
A Boolean flag indicating to return the transaction to the default Main Level after pressing the ServiceChargeExample:
false -
transDefaultSubLevel:
boolean
A Boolean flag indicating to return the transaction to the default Sub Level after pressing the ServiceCharge.Example:
false
Nested Schema : consumerDisplayname
Type:
objectA group of string objects representing the name of the Service Charge in configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : name
Type:
objectA group of string objects representing the name of the Service Charge in configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : items
Type:
Show Source
object-
columnName:
string
Name of the extension fieldExample:
extension column 1 -
value:
string
Value of the extension fieldExample:
Value1
Response
Supported Media Types
- application/json
200 Response
Service Charge object to a specified hierarchy unit .
Root Schema : ServiceChargeAddUpdateResponse
Type:
Show Source
object-
effGrpObjNum:
integer
Object number of the Effectivity Group for the current recordExample:
1 -
hierUnitId:
integer
Unique reference of the hierarchy unit of the propertyExample:
1 -
objectNum:
integer
Object number of the Service ChargeExample:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html