InTime provides a SOAP Web Service Interface that allows two-way flow of information to external systems. This enables automated and efficient transfer of data to and from your other systems reducing effort and duplication.
...
Once you have a current copy you can then periodically check for any items that have been modified since the last update and just update the details of those modified items. This is much more efficient than attempting to update all entities every the time.
Data Retrieval (Read operations)
There are a number of methods that enable you to read back the full details of an entity. The required entity can be identified by a number of different fields. Examples are:
...
Identifying Entities
Most InTime entities can be referenced by three different fields: the internal database ID (primary key); a GUID referred to as "refCode"; and the "externalId". We recommend using the externalId wherever possible as this is what is displayed as the primary reference in the InTime UI, can contain alpha-numerics and is human readable. Some entities such as InvoiceInfo do not have an externalId field so the refCode should be used to reference these.
Data Retrieval (Read operations)
There are a number of methods that enable you to read back the full details of an entity. The required entity can be identified by a number of different fields. Examples are:
getWorkerByRefCode() returns the worker entity that has the specified RefCode.
...
With version 2.0 it is now possible to create data in InTime via the Web Services. This includes the following entities: Worker, Client, Manager, Consultant, Provider, Placement and Timesheet. These mostly take the form of createOrUpdateXXX as this allows the same method to be used to create the entity if it doesn't exist or update it if it does. Examples are: createOrUpdateWorker(), createorUpdatePlacement() and createOrUpdateProvider()
If you are gong to create and update data in InTime it is best practice to attempt to read the entity from InTime first. This ensures that any updates made within the UI are not loast and any fields not accessible through the API are not overwritten by the Web Service update. This is demonstrated in the examples below.
Timesheets
updateTimesheet() method will create a new Timesheet or update an existing one if it exists in Draft status. The Timesheet will be saved with Draft status. The Timesheet object you supply to this method must contain all the necessary data which includes a valid Placement reference, the Period End date and one or more Shifts. Each Shift must reference a valid Rate from the Placement, the Time worker or a Decimal value and the Date on which it was worked. It will normally be necessary to retrieve the details of the Placement the Timesheet relates to in order to correctly complete all the required fields.
...
| Field | Constant | Comment | Notes |
|---|---|---|---|
| Client | |||
| invoice period | 0 | Weekly | |
| 1 | Two-Weekly | ||
| 2 | Four-Weekly | ||
| 3 | Calendar Monthly | ||
| 4 | 4-4-5 | ||
| Worker | |||
| workerType | paye | For PAYE Workers | |
| ltd | For Ltd Company Workers | ||
| external-contractor | For Non Ltd Company Workers | ||
| cis | For CIS Workers | ||
| umb | For Workers operating through an Umbrella | You must specify the umbrella against the worker, otherwise the worker will appear as LTD. | |
| cisBusinessType | SoleTrader | ||
| Company | |||
| Trust | |||
| Partnership | |||
| cisPercentage | 0 | ||
| 20 | |||
| 30 | |||
| paymentFrequency | weekly | ||
| monthly | |||
| <InPay Payroll Name> | If InPay connected, for PAYE workers, use the InPay Payroll Name | ||
| timesheetsOnInvoices | 0 | Timesheets On Invoices | |
| 1 | Timesheets Not On Invoices | ||
| paperOnInvoices | -1 | Agency Default | |
| 0 | No Attachments | ||
| 1 | Attach Paper Timesheets | ||
| 2 | Attach Expense Group Paper | ||
| 4 | Attach Expense Receipts Paper | ||
| <sum of the above> | Attach the appropriate paper | For example, 5 to attach timesheets and receipts | |
| gender | M | ||
| F | |||
| U | Unkown | ||
| LTD invoice period | 0 | Weekly | |
| 1 | Two-Weekly | ||
| 2 | Four-Weekly | ||
| 3 | Calendar Monthly | ||
| 4 | 4-4-5 | ||
| Payment Method | bacs | ||
| cheque | |||
| cash | |||
| chaps | |||
| ach | |||
| international | |||
| building society | |||
| Placement | |||
| layout | standard | See Maintaining Placements | |
| calendar | |||
| timesheetDateCalculator | weekly | See Maintaining Placements. You can see all possible values for this in the ui. | |
| monthly | |||
| <many more> | See UI for all options. | ||
| Rates | |||
| period | 60 | For hourly rates entered in hours format (hours only or start, break, finish). | |
| 1440 | For fixed rates of a specified duration entered in decimal format (decimal or tickbox) | ||
| periodDuration | <any integer> | The duration in minutes for the fixed rate (e.g. 60 for hours, 480 for a day). | |
| timePattern | default | Will use the selected default time pattern | |
| <any string> | The string should match the name of a time pattern in the system | ||
| timesheetFields | START_FINISH_BREAK | Enter start, break, finish | Only when period above is 60 |
| HOURS | Enter hours only | Only when period above is 60 | |
| DECIMAL | Enter time as a decimal | Only when period above is 1440 | |
| DAY | Tickbox only (equivalent to entering decimals as 1.00) | Only when period above is 1440 |