Create or update an assignment.
This API call returns error 1006 if assignment module is not enabled on this account.
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 | |
itemName# | name of the item (use only if you want to override the default product/service name) | string | |
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 |
Field name | Type | Description |
---|---|---|
assignmentID | integer | ID of the created/updated item. |