getEvents

Retrieve events or appointments.

In Erply backend, events (appointments) are listed in the Calendar » Tasks module.

To edit or add an event, use saveEvent.

Input parameters

Parameter name Description Possible value Required
eventID  Retrieve one specific event.  Integer    
description  Search for an event, by any text contained in event name (description).  String    
employeeID  Filter events by employee (assignee, stylist).  Integer    
submitterID  Filter events by creator.  Integer    
supllierID  Filter events by supplier.  Integer    
statusID  Filter events by status.  Integer    
typeID  Filter events by type.  Integer    
customerID  Retrieve events associated with one customer.  Integer    
customerIDs  Comma-separated list of customer IDs. Retrieve events associated with multiple customers.  String    
startDateTimeFrom    ISO date and time string ("yyyy-mm-dd hh:mm:ss")    
startDateTimeUntil    ISO date and time string ("yyyy-mm-dd hh:mm:ss")    
endDateTimeFrom    ISO date and time string ("yyyy-mm-dd hh:mm:ss")    
endDateTimeUntil    ISO date and time string ("yyyy-mm-dd hh:mm:ss")    
resourceID    Integer    
projectID    Integer    
warehouseID  Filter events by location.

Salon-specific attribute. Available only if Salon / Spa module is enabled on your account. 
Integer    
searchAttributeName  Search from attribute name.searchAttributeName and searchAttributeValue have to be specified both  String    
searchAttributeValue  Search from attribute value  String    
getAllSalonEvents  This is an event type filter. getAllSalonEvents = 1 returns all special spa/salon events (appointments, employee breaks, lunches, vacations, sick days), except for the events that represent employee work schedule.  Integer (0 or 1)    
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)    
lang  Retrieve item names in a specific language. If omitted, API will return item names in the default language of your ERPLY account.
Possible values:
  • 'eng' - English
  • 'spa' - Spanish
  • 'ger' - German
  • 'swe' - Swedish
  • 'fin' - Finnish
  • 'rus' - Russian
  • 'est' - Estonian
  • 'lat' - Latvian
  • 'lit' - Lithuanian
  • 'gre' - Greek
 
String    
orderBy  Possible values: "startTime", "endTime", "type", "status", "customerName", "employeeName", "submitterName". By default: "startTime"  String    
orderByDir        
recordsOnPage  Number of records API should return. By default 20, at most 1000.  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
eventID  Integer  ID of existing document. If this parameter is present, then an existing event is updated.  
description  String  Event name or description.  
typeID  Integer  Event type ID. For all event types, see getEventTypes.  
typeName  String  Event type name.  
startTime  Datetime (yyyy-mm-dd hh:mm:ss)  Start date and time of the event, eg. 2010-05-18 15:40:00 (in the account's default timezone).  
endTime  Datetime (yyyy-mm-dd hh:mm:ss)  End date and time of the event, eg. 2010-05-18 16:00:00 (in the account's default timezone).  
customerID  Integer  ID of the customer related to this event (eg. a phone call or a meeting with particular customer).  
customerName  String  Name of the customer.  
contactID  Integer  ID of the customer's contact person.  
contactName  String  Name of the contact person.  
projectID  Integer  ID of the project associated with this event.  
projectName  String  Name of the project.  
employeeID  Integer  Employee whom this task was assigned to.  
employeeName  String  Employee name.  
submitterID  Integer  Employee who entered or assigned this task.  
submitterName  String  Submitter's name.  
supplierID  Integer  Supplier ID.  
supplierName  String  Supplier name.  
statusID  Integer  Event status ID. For all event statuses, see getEventStatuses.  
statusName  String  Event status name.  
completed  0 or 1, by default 0  1 if this event is completed, otherwise 0  
resourceID  Integer  Resource associated with this event.  
resourceName  String  Resource name.  
productID  Integer  Product ID. This is a salon-specific field — the service (eg. a haircut or coloring) associated with this appointment.

API only returns this field if Salon / SPA module is enabled on your account.  
productName  Integer  Product name. API only returns this field if Salon / SPA module is enabled on your account.  
warehouseID  Integer  Location / salon ID. API only returns this field if Salon / SPA module is enabled on your account.  
checkInTime  Unix timestamp  API only returns this field if Salon / SPA module is enabled on your account.  
checkOutTime  Unix timestamp  API only returns this field if Salon / SPA module is enabled on your account.  
serviceStartTime  Unix timestamp  API only returns this field if Salon / SPA module is enabled on your account.  
type  String  Special codename of the event type. This is only available for special spa/salon events, if you are using the respective module. Possible values: APPOINTMENT, SCHEDULE, BREAK, LUNCH, VACATION, SICKDAY.  
status  String  Name of the event status. If Salon / SPA module is enabled, possible values: SCHEDULED, CHECKEDIN, NOSHOW, BEINGSERVICED, CHECKEDOUT, NONE.  
notes  Text  Longer description, associated e-mail message or anything else.  
lastModified  Unix timestamp    
attributes  Array  Additional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value
 
added  Unix timestamp  Item's creation time. To retrieve this field, set input parameter responseMode = "detail". This field is not included in the output by default.