saveAssignment

Create or update an assignment.

This API call returns error 1006 if assignment module is not enabled on this account.

Input parameters

Parameter name Description Possible value Required
assignmentID  Assignment ID.  Integer    
groupID    Integer    
warehouseID    Integer    
createdUnixTime    Unix timestamp    
receivedUnixTime    Unix timestamp    
completed    Integer (1 or 0)    
bookerEmployeeID  Salesperson who booked time.  Integer    
receiverEmployeeID  Salesperson who received the appliance.  Integer    
returnedByEmployeeID  Salesperson who returned the appliance.  Integer    
applianceID  ID of appliance.  Integer    
vehicleID  ID of vehicle.  Integer    
commentsOnWorkDone    String    
commentsOnWorkLeftUndone    String    
customerID  Customer ID.  Integer    
contactID  Contact person ID.  Integer    
contactPerson  Contact person name.  String    
contactPersonPhone  Contact phone.  String    
vehicleHasAntiTheftBolts  Vehicle-specific attribute. Available only if vehicle module is enabled on your account.  Integer (1 or 0)    
testDrive  Vehicle-specific attribute. Available only if vehicle module is enabled on your account.  Integer (1 or 0)    
addWasherFluid  Vehicle-specific attribute. Available only if vehicle module is enabled on your account.  Integer (1 or 0)    
replaceWindshieldWipers  Vehicle-specific attribute. Available only if vehicle module is enabled on your account.  Integer (1 or 0)    
includedServiceBook  Vehicle-specific attribute. Available only if vehicle module is enabled on your account.  Integer (1 or 0)    
checkExtinguisher  Vehicle-specific attribute. Available only if vehicle module is enabled on your account.  Integer (1 or 0)    
replaceAirFilter  Vehicle-specific attribute. Available only if vehicle module is enabled on your account.  Integer (1 or 0)    
checkBodyWarranty  Vehicle-specific attribute. Available only if vehicle module is enabled on your account.  Integer (1 or 0)    
vehicleMileage  Vehicle-specific attribute. Available only if vehicle module is enabled on your account.  Integer    
*****  Customer comments are presented as a flat list. Each comment is defined by the following parameter, where # is replaced by line number. Line numbers start with 1, 2, 3, ...      
customerComment#    String  yes  
*****  Assignment rows are presented as a flat list. Each assignment row is defined by the following parameters, where # is replaced by line number. Line numbers start with 1, 2, 3, ...      
productID#  ID of the product. Either productID or serviceID can be set, but not both at the same time.  Integer    
serviceID#  ID of the service.  Integer    
amount#    Decimal    
price#    Decimal    
discount#    Decimal    
firstEmployeeID#    Integer    
secondEmployeeID#    Integer    
thirdEmployeeID#    Integer    
firstEmployeeTime#    Integer    
secondEmployeeTime#    Integer    
thirdEmployeeTime#    Integer    
*****  Additional attributes associated with this item.
Attributes must be supplied as a flat list, each attribute defined by the following set of three parameters. Replace # with set number (1, 2, 3, ...). When updating an existing entry, API will only update the attributes specified in input data and leave all other existing attributes unchanged. To delete an attribute, set its value to 'null' or 'undefined'.  
   
attributeName#  Attribute name. Name can only contain the following symbols: A-Z, a-z, 0-9, dash and underscore.  String    
attributeType#  Attribute type, possible types are 'text', 'int' and 'double'. By default 'text'.  String    
attributeValue#  Value of the attribute. Set value to 'null' or 'undefined' to delete an attribute.
'text' attribute can be any string, maximum 255 characters.
'int' must be a signed 32-bit integer.
'double' must be a decimal number. 
String    

Response

Field name Type Description
assignmentID  Integer  ID of the created/updated item.