Paycycle has provided an API to allow third parties to interface with the Paycycle application. The following documentation provides details of the API. If you'd like us to arrange access for your application, then please drop us a line. We understand that there is a lot more that we can do with the API, and this is just the start. If you have specific requirements in mind, then please get in touch.

The Paycycle API has been developed with Windows Communication Foundation (WCF) Services in Microsoft .NET 4. Communication with these services is made via HTTPS using XML.

Aside from transport security provided by SSL, Paycycle has implemented authentication and authorisation for calls to the API. For an API call to be accepted, three conditions must be met. API key – This is a GUID created by Paycycle and supplied to our partner applications, and is used to identify calls from partner applications to Paycycle.

IP Filtering – Partner applications need to supply Paycycle with a range of IP addresses. Requests from partner applications to the Paycycle API using the API Client key must be made from an IP address in the range provided, or the call will not be accepted.

Customer Authorisation key – This is a GUID created by Paycycle and supplied to partner applications, representing a customer of both Paycycle and the partner application. It is used to authorise the customer’s access to the Paycycle functionality through the partner application. Initially this key will be set up by a request to Paycycle Support.

Each call to the API requires the API Client key and the Customer Authorisation Key. Paycycle logs all calls made to the API regardless of whether the call succeeds or not.

Paycycle provides three services for use by partner applications, the Employee service, the PayRun service and the Timesheet service. Schemas for request and response xml can be provided. The descriptions of service methods below display examples of request and response xml and a description of values where pertinent. The response xml returned by every service method will contain a Status and Error Description which will be OK and nil respectively if the method succeeds. The following is a list of Statuses and Error Descriptions that can be returned by all service methods.

1.) Status = ERROR

Error Description = INVALID CLIENT KEY.

Occurs when the API Client Key passed cannot be found.

2.) Status = ERROR

Error Description = INVALID IP ADDRESS.

Occurs when the call is made from an IP Address outside the range provided to Paycycle by the partner application.

3.) Status = ERROR

Error Description = ACCESS DENIED.

Occurs when the Authorisation Key is not found or not associated with the API client key.

4.) Status = ERROR

Error Description = An exception occurred. Please contact Paycycle support.

Occurs when there is an exception in processing the request.

The employee service provides 6 methods:-

GetAllEmployees

GetEmployee

GetEmployeeDetailed

AddEmployee

UpdateEmployee

SetEmployeeBankAccount

The payrun service provides 3 methods:-

GetCurrentPayRunStatus

SetEarningsNumberOfUnits

SetReimbursements

The timesheet service provides 1 method:-

UploadTimesheet