getAssignments

Retrieve assignments.

Assignments module is an Erply feature for repair workshops. There are two different configurations: appliance repair and vehicle repair. API call getAppliances lists your appliance/vehicle database.

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
applianceID Appliance ID. Integer
vehicleID Vehicle ID. Integer
searchAttributeName Name of attribute to search from. Both "searchAttributeName" and "searchAttributeValue" have to be specified. Error 1030 will be returned if value is an array. String
searchAttributeValue Attribute value to search for. Error 1030 will be returned if value is an array. String
changedSince Retrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with Erply. Integer (Unix timestamp)
recordsOnPage Number of records API should return. By default 20, at most 100. Integer
pageNo API returns at most recordsOnPage items at a time. To retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". Integer

Response

Field name Type Description
assignmentID Integer ID of assignment.
assignmentNumber Integer Number of assignment.
groupID Integer Assignment group
groupName String
warehouseID Integer Location, workshop or store. Location field has been added to assignments in Erply version 2013.
createdUnixTime Unix timestamp Timestamp (date and time) of when the assignment was created.
receivedUnixTime Unix timestamp Timestamp (date and time) of when the appliance/vehicle was brought in for repair.
sourceQuoteID Integer ID of a sales quote this assignment is based on. To get quotes via API, see getSalesDocuments.
completed Integer (1 or 0)
bookerEmployeeID Integer Salesperson ID who booked time for repair.
bookerEmployeeName String Salesperson name who booked time for repair.
receiverEmployeeID Integer Salesperson ID who received the appliance/vehicle from customer.
receiverEmployeeName String Salesperson name who received the appliance/vehicle from customer.
returnedByEmployeeID Integer Salesperson ID who returned the appliance/vehicle to the customer.
returnedByEmployeeName String Salesperson name who returned the appliance/vehicle to the customer.
commentsOnWorkDone String
commentsOnWorkLeftUndone String
applianceID Integer ID of appliance. Appliance-specific attribute. Available only if appliance module is enabled on your account.
applianceName String Name of appliance. Appliance-specific attribute. Available only if appliance module is enabled on your account.
applianceSerialNumber String Serial number of appliance. Appliance-specific attribute. Available only if appliance module is enabled on your account.
applianceStartDateOfWarranty ISO date (yyyy-mm-dd) Start date of warranty. Appliance-specific attribute. Available only if appliance module is enabled on your account.
applianceEndDateOfWarranty ISO date (yyyy-mm-dd) End date of warranty. Appliance-specific attribute. Available only if appliance module is enabled on your account.
customerID Integer Customer ID.
customerName String Customer name.
customerEmail String Customer e-mail address.
contactPerson String Contact person name.
contactPersonPhone String Contact phone.
vehicleID Integer ID of vehicle. Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
vehicleLicencePlate String Licence plate of vehicle. Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
vehicleStartDateOfWarranty ISO date (yyyy-mm-dd) Start date of warranty. Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
vehicleEndDateOfWarranty ISO date (yyyy-mm-dd) End date of warranty. Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
vehicleHasAntiTheftBolts Integer (1 or 0) Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
testDrive Integer (1 or 0) Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
addWasherFluid Integer (1 or 0) Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
replaceWindshieldWipers Integer (1 or 0) Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
includedServiceBook Integer (1 or 0) Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
checkExtinguisher Integer (1 or 0) Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
replaceAirFilter Integer (1 or 0) Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
checkBodyWarranty Integer (1 or 0) Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
vehicleMileage Integer Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
customerComments Array Each array element contains a string comment attribute.
assignmentRows Array The item has the following attributes:

productID - Integer - ID of the product
serviceID - Integer - ID of the service
itemName - String - custom name for product or service (if it was set)
price - Decimal
amount - Decimal
discount - Decimal
firstEmployeeID - Integer
secondEmployeeID - Integer
thirdEmployeeID - Integer
firstEmployeeTime - Decimal
secondEmployeeTime - Decimal
thirdEmployeeTime - Decimal.
lastModified Unix timestamp.
attributes Array Additional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value