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.
...
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.
submitTimesheet() would then be called to submit the Timesheet for approval once it has all the necessary time (Shifts) added to it.
rejectTimesheet() or approveTimesheet() are then used to process the approval.
revertTimesheet() can also be used to revert a Submitted or Approved status Timesheet if required. This has exactly the same result as reverting a Timesheet though the RSM InTime UI.
Single Sign On
getSingleSignOnToken() can be used to log in to RSM InTime using an existing RSM InTime User account. This method returns a token that you can then append to any valid RSM InTime URL and it will allow you to retrieve the page as if you were logged into the system directly. This means you can embed RSM InTime pages within another web site or retrieve other data.
Other methods
The interface also provides various other methods. Some examples:
getMissingTimesheetsForPlacement() identifies any periods within the specified range that do not contain an approved timesheet. The response will include a status that indicates if it is Missing, Draft or Submitted.
getAllPayElements() returns a list of all Pay Elements present in the system.
getURLForContractorsPayslip() retrieves the URL to viewing a workers Payslips. *InPay Linked systems only
Getting started
The RSM InTime Web Service uses the Simple Object Access Protocol (SOAP) interface as opposed to REST. This is a stricter protocol than REST which means you can only call the defined methods available and the return types will be in a fixed format. Normally you would start by building "stub" code against the WSDL file that defines the interface.
LATEST WSDL Version: https://your_system_url.com/services/IntimeServiceV3_3?wsdl
Java Example
This example was written using the WSDL file for version 3.2 of the web services on our demo system:
https://demo.in-time.co.uk/services/IntimeServiceV3_2?wsdl
Various tools are available for building the stub code. wsdl2java in the axis 2 package works well for java development:
From the command line run:
/axis2-1.6.2/bin/wsdl2java.sh -or -uri "https://demo.in-time.co.uk/services/IntimeServiceV3_2?wsdl"
This will produce the following files:
/src/uk/co/in_time/IntimeServiceV3_2Stub.java
/src/uk/co/in_time/IntimeServiceV3_2CallbackHandler.java
/src/uk/co/in_time/IntimeServiceV3_2IntimeWebServiceException.java
Include and reference these files in your application and you will be able to make calls to the Web Services. Some examples are given below.
It is important to enclose your web service calls in try / catch blocks as Exceptions are used as the mechanism for feeding back any issues. For example if you attempt to create a placement without providing an External ID, an exception will be returned from the Web Service call with an appropriate message.
Client Code - Pseudocode examples
RETRIEVING ENTITY DATA FROM A FRONTEND SYSTEM:
...
#Get placements and associated data from frontend system that you require in InTIME
#Consultant
def cons = getConsultantsByExternalID(consultantId);
if(cons>1)"Error"
def con = cons.first();
if(con==null)con = new Consutlant();
con*PopulateFields*
createOrUpdateConsutlant(con);
#Manager Client
def mclients = getClientsByExternalID(mclientId);
if(mclients>1)"Error"
def mclient = mclients.first();
if(mclient==null)mclient = new Client();
mclient*PopulateFields*
createOrUpdateClient(mclient);
#Manager
def mans = getManagersByExternalID(managerId);
if(mans>1)"Error"
def man = mans.first();
if(man==null)man = new Manager();
man.client = mclient
man*PopulateFields*
createOrUpdateManager(man);
#Provider
def provs = getProvidersByExternalID(providerId);
if(provs>1)"Error"
def prov = provs.first();
if(prov==null)prov = new Provider();
prov*PopulateFields*
createOrUpdateProvider(prov);
#Worker
def wkrs = getWorkersByExternalID(workerId);
if(wkrs>1)"Error"
def wkr = wkrs.first();
if(wkr==null)wkr = new Worker();
if(prov!=null)wkr.provider = prov
wkr*PopulateFields*
createOrUpdateWorker(wkr);
#Billing Client
def bclients = getClientsByExternalID(bclientId);
if(pclients>1)"Error"
def bclient = bclients.first();
if(bclient==null)bclient = new Client();
bclient*PopulateFields*
createOrUpdateClient(bclient);
#Placement
def plac = getPlacementByExternalID(placementId);
if(plac==null)plac = new Placement();
plac.consultant = con
plac.client = bclient
plac.manager = man
plac.worker = wkr
plac*PopulateFields*
createOrUpdatePlacement(plc);
RETRIEVING UPDATES FROM RSM InTime:
...
As of 3.12 there is a "hidden" parameter. This creates the timesheet but keeps it hidden from the UI so it can not be affected by UI processes. This can be used to create a timesheet that should only be invoiced via the web services for example. Hidden timesheets can be updated via this method while they are still in draft status but you must set the hidden parameter of the method call to true. You can unhide the timesheet by changing the "hidden" property of the timesheet to false. Hidden timesheets still have to be approved before they can be invoiced/exported - the forceApproveTimesheet can be used for this which bypasses the approval route. Hidden timesheets are automatically unhidden when first invoiced on either the Sales or Purchase side.
submitTimesheet() would then be called to submit the Timesheet for approval once it has all the necessary time (Shifts) added to it.
rejectTimesheet() or approveTimesheet() are then used to process the approval.
revertTimesheet() can also be used to revert a Submitted or Approved status Timesheet if required. This has exactly the same result as reverting a Timesheet though the RSM InTime UI.
Invoicing
As of 3.12 you can generate invoices using the generateInvoices( ) method. This method requires a SearchCriteria parameter which is used to filter the items to be invoiced. This needs to be populated with appropriate criteria to select only the items you wish to invoice.
Warning: if no criteria are specified all invoiceable items in the system will be invoiced!
It is possible to specify a list of specific timesheet IDs or ExpenseItem IDs that you wish to invoice using SearchCriteria.timesheetIDs or SearchCriteria.expenseItemIDs.
You must specify the type of invoices you wish to generate from: ClientInvoice, SelfBillInvoice or AdviceNote.
You can not credit invoices using this method. However, invoicing net negative items will result in a Credit Note rather than an Invoice.
To invoice "Hidden" timesheets, set the SearchCriteria.includeHidden property to true.
Examples:
request.setInvoiceType("ClientInvoice");
searchCriteria.setIncludeTimesheets(true);
searchCriteria.setIncludeHidden(true);
long[] tsIds = new long[2];
tsIds[0] = 123L;
tsIds[1] = 456L;
searchCriteria.setTimesheetIDs(tsIds);
searchCriteria.setIncludeExpenses(false);
searchCriteria.setExpenseItemIDFrom(3001L);
searchCriteria.setExpenseItemIDTo(3009L);
request.setSearchCriteria(searchCriteria);
Calendar invDate = Calendar.getInstance();
invDate.set(2024,10,1,0,0,0);
request.setInvoiceDate(invDate);
As of 3.12 you can uploadSupplierInvoice() to an AdviceNote and accept it via acceptSupplierInvoice()
Single Sign On
getSingleSignOnToken() can be used to log in to RSM InTime using an existing RSM InTime User account. This method returns a token that you can then append to any valid RSM InTime URL and it will allow you to retrieve the page as if you were logged into the system directly. This means you can embed RSM InTime pages within another web site or retrieve other data.
An example SSO token would look like this:
QS5TbWl0aDoxNjk0NzY3NDI5NTM0Ojg0OThkMGY1ZTQzMzdlYzI0YjRiZjU3YzZhNDg4MDI4
So appending an SSO token for an Admin user to a URL for the summary of a Worker could look like this:
http://demo.in-time.co.uk/summary/worker?id=1&ticket=QS5TbWl0aDoxNjk0NzY3NDI5NTM0Ojg0OThkMGY1ZTQzMzdlYzI0YjRiZjU3YzZhNDg4MDI4
For the Summary screens only you can append "&embed=true" to the URL to hide the menu and footers. This does not apply to other InTime screens.
IMPORTANT: Note that once you have accessed InTime with an SSO token you are logged into InTime as that user and navigation and access rights are determined exactly as if you logged into InTime directly as that user.
Other methods
The interface also provides various other methods. Some examples:
getMissingTimesheetsForPlacement() identifies any periods within the specified range that do not contain an approved timesheet. The response will include a status that indicates if it is Missing, Draft or Submitted.
getAllPayElements() returns a list of all Pay Elements present in the system.
getURLForContractorsPayslip() retrieves the URL to viewing a workers Payslips. *InPay Linked systems only
Getting started
The RSM InTime Web Service uses the Simple Object Access Protocol (SOAP) interface as opposed to REST. This is a stricter protocol than REST which means you can only call the defined methods available and the return types will be in a fixed format. Normally you would start by building "stub" code against the WSDL file that defines the interface.
LATEST WSDL Version: https://your_system_url.com/services/IntimeServiceV3_8?wsdl
Java Example
This example was written using the WSDL file for version 3.2 of the web services on our demo system:
https://demo.in-time.co.uk/services/IntimeServiceV3_2?wsdl
Various tools are available for building the stub code. wsdl2java in the axis 2 package works well for java development:
From the command line run:
/axis2-1.6.2/bin/wsdl2java.sh -or -uri "https://demo.in-time.co.uk/services/IntimeServiceV3_2?wsdl"
This will produce the following files:
/src/uk/co/in_time/IntimeServiceV3_2Stub.java
/src/uk/co/in_time/IntimeServiceV3_2CallbackHandler.java
/src/uk/co/in_time/IntimeServiceV3_2IntimeWebServiceException.java
Include and reference these files in your application and you will be able to make calls to the Web Services. Some examples are given below.
It is important to enclose your web service calls in try / catch blocks as Exceptions are used as the mechanism for feeding back any issues. For example if you attempt to create a placement without providing an External ID, an exception will be returned from the Web Service call with an appropriate message.
Client Code - Pseudocode examples
RETRIEVING ENTITY DATA FROM A FRONTEND SYSTEM:
#Get placements and associated data from frontend system that you require in InTIME#Consultant |
---|
RETRIEVING UPDATES FROM RSM InTime:
RETRIEVING INVOICES TO EXPORT:
def needRatePayElementCode = false //Not usually needed but if required change to true def entityList = getModifiedItemsWithRefCodeByType(java.lang.String token, java.util.Calendar since, java.lang.String "Reckoning") for(entityList){ def entityRefCode = entity.getRefCode() def invoiceInfo = getInvoiceByRefCode(java.lang.String token, java.lang.String entityRefCode) def invoicingAccount def accountCode def nominalCode //Note - Nominal codes aren't always stored on the invoicing entity it depends on the accounts system and nominal requirements def entityType = invoiceInfo.getEntityType() def entityRefCode = invoiceInfo.getEntityRefCode() if(entityType="Client def entityList = getModifiedItemsWithRefCode(java.lang.String token, java.util.Calendar since) |
---|
RETRIEVING INVOICE LINKS:
...
def entityList = getModifiedItemsWithRefCodeByType(java.lang.String token, java.util.Calendar since, java.lang.String "Reckoning")
for(entityList:entity){
def entityRefCode = entity.getRefCode()
def downloadlink = "https://<SERVER URL>/reckoning/collectInvoice?refCode="+entityRefCode
Call(downloadlink)
}
entity.getType()=="Client")*Read full Client and action as required* |
---|
RETRIEVING INVOICE LINKS:
def entityList = getModifiedItemsWithRefCodeByType(java.lang.String token, java.util.Calendar since, java.lang.String "Reckoning") |
---|
RETRIEVING INVOICES TO EXPORT:
def needRatePayElementCode = false //Not usually needed but if required change to true placement |
---|
RETRIEVING TIMESHEETS:
def entityList = getModifiedItemsWithRefCodeByType(java.lang.String token, java.util.Calendar since, java.lang.String "Timesheet") |
---|
Java Code
Authenticate
try {
//Create an instance of the stub
IntimeServiceV3_2Stub stub = new IntimeServiceV3_2Stub("https://demo.in-time.co.uk/services/IntimeServiceV3_2?wsdl");
//Get an authentication token
IntimeServiceV3_2Stub.Authenticate auth=new IntimeServiceV3_2Stub.Authenticate();
auth.setAgencyRefCode("<supplied_credentials>");
auth.setUsername("<supplied_credentials>");
auth.setPassword("<supplied_credentials>");
IntimeServiceV3_2Stub.AuthenticateResponse authResp=stub.authenticate(auth);
String ticket=authResp.get_return();
System.out.println("Authentication token:" + ticket);
//Use this authentication token (ticket) to pass in to any of the other WebService calls
} catch (java.lang.Exception e) {
System.out.println("Exception occurred: " + e);
}
Read a Placement
try {
IntimeServiceV3_2Stub.GetPlacementByExternalId request=new IntimeServiceV3_2Stub.GetPlacementByExternalId();
request.setId("WEB-PLC-001");
request.setToken(ticket); //from authenticate call
GetPlacementByExternalIdResponse placementResponse=stub.getPlacementByExternalId(request);
Placement placement=placementResponse.get_return();
if (placement != null) {
...
UPDATING FINANCIAL TAG VALUES:
def fiancialTags = ws.getAllFinancialTags |
---|
UPDATING ONCOSTS ON A PLACEMENT (example below is purchase oncosts but same for sales):
def plc = getPlacementByExternalId(token,xxxxx) – xxxx being unique placement Ref |
---|
Java Code
Authenticate
try { //Create an instance of the stub IntimeServiceV3_2Stub stub = new IntimeServiceV3_2Stub("https://demo.in-time.co.uk/services/IntimeServiceV3_2?wsdl"); //Get an authentication token IntimeServiceV3_2Stub.Authenticate auth=new IntimeServiceV3_2Stub.Authenticate(); auth.setAgencyRefCode("<supplied_credentials>"); auth.setUsername("<supplied_credentials>"); auth.setPassword("<supplied_credentials>"); IntimeServiceV3_2Stub.AuthenticateResponse authResp=stub.authenticate(auth); String ticket=authResp.get_return(); System.out.println(" RefCodeAuthentication token:" + placement.getRefCode(ticket) ); System.out.println("Worker:" + placement.getWorker().getExternalId() + " " + placement.getWorker().getLastname());//Use this authentication token (ticket) to pass in to any of the other WebService calls } catch (java.lang.Exception e) { System.out.println(" ConsultantException occurred: " + placement.getConsultant().getExternalId() + " " + placement.getConsultant().getLastname());e); } |
---|
Read a Placement
try { IntimeServiceV3_2Stub.GetPlacementByExternalId request=new IntimeServiceV3_2Stub.GetPlacementByExternalId(); request.setId("WEB-PLC-001"); request.setToken(ticket); //from authenticate call GetPlacementByExternalIdResponse placementResponse=stub.getPlacementByExternalId(request); Placement placement=placementResponse.get_return(); if (placement != null) { System.out.println("ManagerRead Placement with External Id: " + placement.getManager().getExternalId() + " Internal Id: " + placement.getManagergetId()).getLastname; System.out.println("RefCode: " + placement.getRefCode()); System.out.println("ClientWorker:" + placement.getClientgetWorker().getExternalId() + " " + placement.getClientgetWorker().getNamegetLastname()); System.out.println("StartConsultant: " + placement.getStartgetConsultant().getTimegetExternalId() );if (placement.getEnd() != null) {+ " " + placement.getConsultant().getLastname()); System.out.println(" EndManager: " + placement. getEndgetManager(). getTime());getExternalId() + " " + placement.getManager().getLastname()); System.out.println("Client: " + placement.getClient().getExternalId() + " " + placement.getClient().getName()); System.out.println("Start: " + placement.getStart().getTime()); if (placement.getEnd() != null) { System.out.println("End: " + placement.getEnd().getTime()); } System.out.println("Created: " + placement.getCreated().getTime()); System.out.println("Modified: " + placement.getModified().getTime()); System.out.println("TimesheetDateCalculatorName: " + placement.getTimesheetDateCalculatorName()); System.out.println("Timesheeet Approval Route: " + placement.getTimesheetApprovalRoute()); System.out.println("Chargeable Expense Approval Route: " + placement.getChargeableExpenseApprovalRoute()); System.out.println("Non-Chargeable Expense Approval Route: " + placement.getNonChargeableExpenseApprovalRoute()); System.out.println("ContractedHours: " + placement.getContractedHours()); System.out.println("JobDescription :" + placement.getJobDescription()); System.out.println("JobTitle: " + placement.getJobTitle()); System.out.println("NoCommunications: " + placement.getNoCommunications()); System.out.println("PurchaseOrderNum: " + placement.getPurchaseOrderNum()); System.out.println("SalesProject: " + placement.getSalesProject()); System.out.println("PurchaseBranch: " + placement.getPurchaseBranch()); System.out.println("CurrencyForCharge: " + placement.getCurrencyForCharge()); System.out.println("CurrencyForPayExpenses: " + placement.getCurrencyForPayExpenses()); System.out.println("CurrencyForPayTimesheets: " + placement.getCurrencyForPayTimesheets()); System.out.println("Perm: " + placement.getPerm()); System.out.println("TimesheetEmailApproval: " + placement.getTimesheetEmailApproval()); System.out.println("Timesheet layout: " + placement.getLayout()); System.out.println("Internal Agency Comments: " + placement.getInternalAgencyComments()); System.out.println("Holiday Accural Rate: " + placement.getHolidayAccuralRate()); System.out.println("Expenses Template: " + placement.getExpenseTemplate()); System.out.println("Charge Tax Code Override: " + placement.getChargeTaxCodeOverride()); System.out.println("Self Bill Tax Code Override: " + placement.getSelfBillTaxCodeOverride()); System.out.println("PAYEDeductionsOnLtd: " + placement.getPAYEDeductionsOnLtd()); if (placement.getInvoiceContactOverride() != null) { Contact contact = placement.getInvoiceContactOverride(); Address address = contact.getAddress(); System.out.println("Placement charge invoice contact override: "); System.out.println(" Firstname: " + contact.getFirstname()); System.out.println(" Lastname: " + contact.getLastname()); System.out.println(" Email: " + contact.getEmail()); System.out.println(" Phone: " + contact.getPhone()); System.out.println(" Fax: " + contact.getFax()); System.out.println(" Mobile: " + contact.getMobile()); System.out.println("Address:"); System.out.println(" Line 1:" + address.getLine1()); System.out.println(" Line 2:" + address.getLine2()); System.out.println(" Town:" + address.getTown()); System.out.println(" County:" + address.getCounty()); System.out.println(" Postcode: " + address.getPostcode()); System.out.println(" Country:" + address.getCountry()); System.out.println(" Country Code:" + address.getCountryCode()); } if (placement.getRates() != null) { for (Rate rate : placement.getRates()) { System.out.println("Rate Name:" + rate.getName()); System.out.println("Pay:" + rate.getPay()); System.out.println("Charge:" + rate.getCharge()); System.out.println("Priority:" + rate.getPriorityOrder()); System.out.println("ID:" + rate.getId()); System.out.println("Period:" + rate.getPeriod()); System.out.println("PeriodDuration:" + rate.getPeriodDuration()); System.out.println("SelectableByWorkers:" + rate.getSelectableByWorkers()); System.out.println("TimePattern:" + rate.getTimePattern()); System.out.println("TimesheetFields:" + rate.getTimesheetFields()); System.out.println("PayElementCode:" + rate.getPayElementCode()); System.out.println("Payable:" + rate.getPayable()); System.out.println("Chargeable:" + rate.getChargeable()); System.out.println("Taxable:" + rate.getTaxable()); System.out.println("RefCode:" + rate.getRefCode()); } } if (placement.getSplitCommissions() != null) { for (SplitCommission split : placement.getSplitCommissions()) { System.out.println("\nCommission UserID:"+split.getUserId()+" Percentage:"+split.getWeight()); } } if (placement.getAlternativeManagers() != null) { for (User altMan : placement.getAlternativeManagers()) { System.out.println("Alternative Manager:" + altMan.getFirstname() + " " + altMan.getLastname()); System.out.println("External Id: " + altMan.getExternalId() + " Internal ID:" + altMan.getId()); } } } } catch (java.lang.Exception e) { System.out.println("Exception occurred: " + e); } |
---|
...
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. All the following fields can only be read from and updated from the Worker base object: AccountsRef, VATCode, DefaultPaymentCurrency, NominalCode, ExpensesNominalCode, Consolidation and Grouping.
Constants
Whilst Note: Both Worker and LimitedCompany objects have timesheetsOnInvoices field - the one specified in the LimitedCompany will take precedence over Worker.
Constants
Whilst using the RSM 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 | ||
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 |
InvoiceAdjustmentSettings
(Company / Worker)
EntryMethod
DELETED
INCOMPLETE
SUBMITTED
APPROVED
COMPLETED
MISSING
REVERTED
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 | |
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 | |||
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 | 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 |