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.
...
try { GetSingleSignOnToken ss=new GetSingleSignOnToken(); ss.setToken(ticket); ss.setUsername(<username>); ss.setTimeToLiveSeconds(360); GetSingleSignOnTokenResponse ssResp=stub.getSingleSignOnToken(ss); if (ssResp!=null) { System.out.println("Single Sign on Token: " + ssResp.get_return()); } //Can now append the token to any InTime URL to use access it without logging in. E.g. //https://demo.in-time.co.uk/placement/show?placement=<placement_id>&ticket=<token> } catch (Exception e) { System.out.println("Exception occurred: " + e); } |
|---|
Limited Company Details
Limited Company type workers have additional information that relate to their limited company. To provide access to this an associated LimitedCompany object and a LtdCompanyContact object were added to the Worker object.
Version 3.0 as of this version the situation is simplified. There is no LtdCompanyContact object on the worker. The Limited Company Contact details (name, email, address) should be read and updated via the LimitedCompany.InvoiceContact object. Any InTime data fields that can be referenced from the base Worker object and the LimitedCompany object will only be populated in and can only be updated from the fields on the Worker object. These fields are: AccountsRef, VATCode, DefaultPaymentCurrency, NominalCode, ExpensesNominalCode, Consolidation and Grouping.
Version 2.9 and earlier. Both the LtdCompanyContact object and the LimitedCompany.InvoiceContact are populated with the details on the Limited Company Contact when reading a Worker from InTime. When updating InTime the LtdCompanyContact takes precedence over the LimitedCompany.InvoiceContact for the name, email, phone and address details so the LtdCompanyContact should be updated where these details need to change. There are certain fields in both the Worker object and the Company object that relate to the same piece of InTime data. These are listed below. You should use the fields on the base Worker object to read and update all of these except the VAT Code. Where possible these
AccountsRef, VATCode, DefaultPaymentCurrency, NominalCode, ExpensesNominalCode, Consolidation and Grouping
Constants
Whilst using the InTime Web Services, some fields have expected values from a range of constants. These are detailed below.
| Field | Constant | Comment | Notes |
|---|---|---|---|
| Client | |||
| invoicePeriod | 0 | Weekly | |
| 1 | Two-Weekly | ||
| 2 | Four-Weekly | ||
| 3 | Calendar Monthly | ||
| 4 | 4-4-5 | ||
| howSendInvoices | 0 | Post | Invoice delivery method |
| 1 | |||
| 2 | Fax | ||
| 3 | Not sent | ||
| 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 also reference the umbrella against the worker, otherwise the worker will appear as LTD. | |
| ir35 | For workers inside scope of IR35 (deemed) | ||
| 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 | |||
| LTD invoice period | 0 | Weekly | |
| 1 | Two-Weekly | ||
| 2 | Four-Weekly | ||
| 3 | Calendar Monthly | ||
| 4 | 4-4-5 | ||
| Payment Method | bacs | NOT CASE SENSITIVE | |
| cheque | NOT CASE SENSITIVE | ||
| cash | NOT CASE SENSITIVE | ||
| chaps | NOT CASE SENSITIVE | ||
| ach | NOT CASE SENSITIVE | ||
| international | NOT CASE SENSITIVE | ||
| building society | NOT CASE SENSITIVE | ||
| 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 | |
InvoiceAdjustmentSettings (Company / Worker) | |||
| AdjustBy | 0 | Fixed Amount | |
| 1 | Percentage | ||
| AdjustPer | 0 | Per Worker | |
| 1 | Per Timesheet | ||
| 2 | Per Invoice | ||
| AdjustType | 0 | Addition | |
| 1 | Deduction | ||
ExpenseType EntryMethod | 0 | Gross value | Populate the GrossValue and optionally the VatAmount field on an ExpenseItem with this entry method |
| 1 | Net Value | Populate the NetValue field on an ExpenseItem with this entry method | |
| 2 | Units and Unit net | Populate the Unit and UnitNet fields on an ExpenseItem with this entry method. E.g. Set Unit = 30 and UnitNet = 0.45 to claim 30 miles at 45p per mile. | |
| 3 | Units and Net | Populate the Unit and Net Value fields on an ExpenseItem with this entry method. |