Search

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 nameDescriptionPossible valueRequired
assignmentIDAssignment ID.Integer
applianceIDAppliance ID.Integer
vehicleIDVehicle ID.Integer
searchAttributeNameSearch from attribute name.searchAttributeName and searchAttributeValue have to be specified bothString
searchAttributeValueSearch from attribute valueString
changedSinceRetrieve 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)
recordsOnPageNumber of records API should return. By default 20, at most 100.Integer
pageNoAPI 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 nameTypeDescription
assignmentIDIntegerID of assignment.
assignmentNumberIntegerNumber of assignment.
groupIDIntegerAssignment group
groupNameString
warehouseIDIntegerLocation, workshop or store. Location field has been added to assignments in Erply version 2013.
createdUnixTimeUnix timestampTimestamp (date and time) of when the assignment was created.
receivedUnixTimeUnix timestampTimestamp (date and time) of when the appliance/vehicle was brought in for repair.
sourceQuoteIDIntegerID of a sales quote this assignment is based on. To get quotes via API, see getSalesDocuments.
completedInteger (1 or 0)
bookerEmployeeIDIntegerSalesperson ID who booked time for repair.
bookerEmployeeNameStringSalesperson name who booked time for repair.
receiverEmployeeIDIntegerSalesperson ID who received the appliance/vehicle from customer.
receiverEmployeeNameStringSalesperson name who received the appliance/vehicle from customer.
returnedByEmployeeIDIntegerSalesperson ID who returned the appliance/vehicle to the customer.
returnedByEmployeeNameStringSalesperson name who returned the appliance/vehicle to the customer.
commentsOnWorkDoneString
commentsOnWorkLeftUndoneString
applianceIDIntegerID of appliance. Appliance-specific attribute. Available only if appliance module is enabled on your account.
applianceNameStringName of appliance. Appliance-specific attribute. Available only if appliance module is enabled on your account.
applianceSerialNumberStringSerial number of appliance. Appliance-specific attribute. Available only if appliance module is enabled on your account.
applianceStartDateOfWarrantyISO date (yyyy-mm-dd)Start date of warranty. Appliance-specific attribute. Available only if appliance module is enabled on your account.
applianceEndDateOfWarrantyISO date (yyyy-mm-dd)End date of warranty. Appliance-specific attribute. Available only if appliance module is enabled on your account.
customerIDIntegerCustomer ID.
customerNameStringCustomer name.
customerEmailStringCustomer e-mail address.
contactPersonStringContact person name.
contactPersonPhoneStringContact phone.
vehicleIDIntegerID of vehicle. Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
vehicleLicencePlateStringLicence plate of vehicle. Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
vehicleStartDateOfWarrantyISO date (yyyy-mm-dd)Start date of warranty. Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
vehicleEndDateOfWarrantyISO date (yyyy-mm-dd)End date of warranty. Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
vehicleHasAntiTheftBoltsInteger (1 or 0)Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
testDriveInteger (1 or 0)Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
addWasherFluidInteger (1 or 0)Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
replaceWindshieldWipersInteger (1 or 0)Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
includedServiceBookInteger (1 or 0)Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
checkExtinguisherInteger (1 or 0)Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
replaceAirFilterInteger (1 or 0)Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
checkBodyWarrantyInteger (1 or 0)Vehicle-specific attribute. Available only if vehicle module is enabled on your account.
vehicleMileageIntegerVehicle-specific attribute. Available only if vehicle module is enabled on your account.
customerCommentsArrayEach array element contains a string comment attribute.
assignmentRowsArrayThe item has the following attributes:

productID - Integer - ID of the product
serviceID - Integer - ID of the service
price - Decimal
amount - Decimal
discount - Decimal
firstEmployeeID - Integer
secondEmployeeID - Integer
thirdEmployeeID - Integer
firstEmployeeTime - Decimal
secondEmployeeTime - Decimal
thirdEmployeeTime - Decimal.
lastModifiedUnix timestamp.
attributesArrayAdditional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value