RSM 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.
...
Field | Constant | Comment | Notes | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Client | |||||||||||||
invoicePeriod | 0 | Weekly | |||||||||||
1 | Two-Weekly | ||||||||||||
2 | Four-Weekly | ||||||||||||
3 | Calendar Monthly | ||||||||||||
4 | 4-4-5 | ||||||||||||
5 | Other | ||||||||||||
InvoiceDeliveryMethod (howSendInvoices) | 0 | Post | Invoice delivery method | ||||||||||
1 | |||||||||||||
2 | Fax | ||||||||||||
3 | Not sent | ||||||||||||
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 | |||||||||||
consolidation | Code Required String[] cConsolidation = new String[] { "charge-payment-term","destination","source","charge-currency","sales-tax-code","client" }; | Everything Goes On One Invoice | |||||||||||
Code Required String[] cConsolidation = new String[] { "charge-payment-term","destination","source","charge-currency","sales-tax-code","client","sheet-type" }; | Expenses Go On On Invoice And Expenses Go On Another | ||||||||||||
Code Required String[] cConsolidation = new String[] { "charge-payment-term","destination","source","charge-currency","sales-tax-code","client","placement" }; | Each Placement is Invoiced Separately | ||||||||||||
Code Required String[] cConsolidation = new String[] { "charge-payment-term","destination","source","charge-currency","sales-tax-code","client","sheet" }; | Each Timesheet Or Expense Item Is Invoiced Separately | ||||||||||||
Code Required String[] cConsolidation = new String[] { "charge-payment-term","destination","source","charge-currency","sales-tax-code","client",”worker” }; | Each Candidate Is Invoiced Separately | ||||||||||||
grouping | Code Required String[] cGrouping = new String[] { "sheet-rate" }; client.setGrouping(cGrouping); | Sheet Rate | |||||||||||
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 | ||||||||||||
limitedCompany.timesheetsOnInvoices | 0 | Timesheets On Invoices | |||||||||||
1 | Timesheets Not On Invoices | ||||||||||||
limitedCompany.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 | |||||||||||||
limitedCompany.invoicePeriod | 0 | Weekly | |||||||||||
1 | Two-Weekly | ||||||||||||
2 | Four-Weekly | ||||||||||||
3 | Calendar Monthly | ||||||||||||
4 | 4-4-5 | ||||||||||||
5 | Other | ||||||||||||
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 | ||||||||||||
sendLtdCompanyTimesheets | 0 | Do not send a copy of the timesheets to the worker or provider | |||||||||||
1 | Only send a copy of timesheets to the worker's ltd company email address | ||||||||||||
2 | Send a copy of timesheets to the worker's provider if they have one, otherwise send it to the worker | ||||||||||||
3 | Send copies to both the worker and provider | ||||||||||||
consolidation | Code Required String[] wConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","worker" }; | Everything Goes On One Invoice | |||||||||||
Code Required String[] wConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","worker","sheet-type" }; | Expenses Go On On Invoice And Expenses Go On Another | ||||||||||||
Code Required String[] wConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","worker","placement" }; | Each Placement is Invoiced Separately | ||||||||||||
Code Required String[] wConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","worker","sheet" }; | Each Timesheet Or Expense Item Is Invoiced Separately | ||||||||||||
grouping | Code Required String[] wGrouping = new String[] { "sheet","sheet-rate" }; worker.setGrouping(wGrouping); | Sheet Rate | statementD | Always N | N | Placement | layout | standard | See Maintaining Placements | calendar | timesheetDateCalculator | Usual: weekly ( | |
statementA | StatementA | Example: "ANN NN" | |||||||||||
statementD | Always N | N | |||||||||||
engagementType | None/N,A,B,C,D,E,F,Z | ||||||||||||
Placement | |||||||||||||
layout | standard | See Maintaining Placements | |||||||||||
calendar | |||||||||||||
timesheetDateCalculatorName (timesheetDateCalculator) | Usual: weekly (Default: Monday - Sunday) monthly (Calendar: 1st - 28/29/30/31th) Others: weekly_tue-mon weekly_wed-tue weekly_thurs-wed weekly_fri-thurs weekly_sat-fri weekly_sun-sat two-weekly two-weekly_tue-mon two-weekly_wed-tue two-weekly_thurs-wed two-weekly_fri-thurs two-weekly_sat-fri two-weekly_sun-sat two-weekly_timeplan four-weekly half-monthly-16th monthly2nd monthly3rd monthly4th monthly5th monthly6th monthly7th monthly8th monthly9th monthly10th monthly11th monthly12th monthly13th monthly14th monthly15th monthly16th monthly17th monthly18th monthly19th monthly20th monthly21st monthly22th monthly23th monthly24th monthly25th monthly26th monthly27th monthly28th half-monthly-15th four-four-five four-four-five-lastFri-old four-four-five-lastFri weekly-split four-four-five-2ndLastFri weekly_tue-mon-split weekly_wed-tue-split weekly_thurs-wed-split weekly_fri-thurs-split weekly_sat-fri-split weekly_sun-sat-split two-weekly-split two-weekly-alt four-weekly-split two-weekly-split-alt fri - (Saturday - Friday) - DO NOT USE sat - (Monday - Sunday) - DO NOT USE sun - (Monday - Sunday) - DO NOT USE | See Maintaining Placements | |||||||||||
Rates | |||||||||||||
period | 60 / H | For hourly rates entered in hours format (hours only or start, break, finish). | |||||||||||
1440 / F | 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 hourly rates, 480 for a daily rates (if daily rate it worth 8 hours)). | |||||||||||
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. | |||||||||||
Timesheet | |||||||||||||
Status | getTimesheetStatus() | getStatus() | |||||||||||
-1 | DELETED | ||||||||||||
1 | INCOMPLETE | ||||||||||||
2 | SUBMITTED | ||||||||||||
3 | APPROVED | ||||||||||||
5 | COMPLETED | ||||||||||||
-2 | MISSING | ||||||||||||
-3 | REVERTED | ||||||||||||
InvoiceInfo (Invoice) | |||||||||||||
Invoice Type | getInvoiceDescription() | ||||||||||||
Advice Note | |||||||||||||
Client Invoice | |||||||||||||
Client Credit Note | |||||||||||||
Self Bill Invoice | |||||||||||||
Self Bill Credit Note | |||||||||||||
Supplier Invoice | |||||||||||||
Supplier Credit Note | |||||||||||||
Provider | |||||||||||||
consolidation | Code Required String[] pConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","ltd-co-provider" }; | Everything Goes On One Invoice | |||||||||||
Code Required String[] pConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","ltd-co-provider","sheet-type" }; | Expenses Go On On Invoice And Expenses Go On Another | ||||||||||||
Code Required String[] pConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","ltd-co-provider","placement" }; | Each Placement is Invoiced Separately | ||||||||||||
Code Required String[] pConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","ltd-co-provider","sheet" }; | Each Timesheet Or Expense Item Is Invoiced Separately | ||||||||||||
Code Required String[] pConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","ltd-co-provider",”worker” }; | Each Candidate Is Invoiced Separately | ||||||||||||
grouping | Code Required String[] pGrouping = new String[] { "sheet-rate" }; provider.setGrouping(pGrouping); | Sheet Rate | |||||||||||
invoicePeriod | 0 | Weekly | |||||||||||
1 | Two-Weekly | ||||||||||||
2 | Four-Weekly | ||||||||||||
3 | Calendar Monthly | ||||||||||||
4 | 4-4-5 | ||||||||||||
5 | Other | ||||||||||||
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 |
...