Versions Compared

Old Version 100

changes.mady.by.user Alex Smith

Saved on

compared with

New Version 101

changes.mady.by.user Craig Fordham

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.  

...

def needRatePayElementCode = false //Not usually needed but if required change to true 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"){
        invoicingAccount = getClientByRefCode(java.lang.String entityRefCode)
        accountCode = invoicingAccount.getAccountsRef()
        nominalCode = invoicingAccount.getNominalCode()
    {
    if(entityType="Worker"){
        invoicingAccount = getWorkerByRefCode(java.lang.String entityRefCode)
        accountCode = invoicingAccount.getAccountsReference()
        nominalCode = invoicingAccount.getNominalCode()
    }
    if(entityType="Provider"){
        invoicingAccount = getProviderByRefCode(java.lang.String entityRefCode)
        accountCode = invoicingAccount.getAccountsRef()
        nominalCode = invoicingAccount.getNominalCode()
    }
    //Get any other details from invocing entities requied above to create / update sales or purchase account in accounts package.
    if(!(invoiceInfo.getExported)){
        for(invoiceInfo.getInvoiceLineInfo():InvoiceLineInfo invoiceLineInfo){
            def invoiceLineInfoPlacementId = invoiceLineInfo.getPlacementId
            def invoiceLineInfoTimesheetId = invoiceLineInfo.getTimesheetId
            def invoiceLineInfoShiftId = invoiceLineInfo.getShiftId
            def invoiceLineInfoExpenseItemId = invoiceLineInfo.getExpenseId
            def invoiceLineInfoAdjustmentId = invoiceLineInfo.getAdjustmentId
            def placement = getPlacementById(java.lang.String token, java.lang.Long invoiceLineInfoPlacementId)
            def timesheet = getTimesheetById(java.lang.String token, java.lang.Long invoiceLineInfoTimesheetId)
            
            if(needRatePayElementCode){  def expenseItem = getExpenseItemById(java.lang.String token, java.lang.Long invoiceLineInfoExpenseItemId)
                def invoiceInfoShiftId = invoiceinfo.getShiftId(adjustment = getAdjustmentById(java.lang.String token, java.lang.Long invoiceLineInfoAdjustmentId)

                def invoiceInfoTimesheetId = invoiceinfo.getTimesheetId()if(needRatePayElementCode){
                def timesheet invoiceLineInfoShiftId = webservice.getTimesheetById(invoiceInfoTimesheetId)invoiceLineInfo.getShiftId
                def shifts = timesheet.getShifts()
                def wantedShift
                for(shifts s where s.id=invoiceInfoShiftIdinvoiceLineInfoShiftId) wantedShift = s
                    if(wantedShift){
                    def rate = wantedShift.getRate()
                    def payElementCode = rate.getPayElementCode()
                }
            }
            //Collect details from InvoiceInfo, InvoiceLineInfo, Placement, Timesheet, ExpenseItem, Adjustment, Shift, Rate, Pay Element as required for transaction in Accounts System
        }
        def exportSuccessful = false;
        #Attempt to export details to Accounts System and if successfull exportSuccessful=true
        if(exportSuccessful)markInvoiceAsExported(java.lang.String token, java.lang.String invoiceInfo.getRefCode(), java.lang.String now())
    }
}

...

FieldConstant

Comment

Notes
Client


invoicePeriod0Weekly

1Two-Weekly

2Four-Weekly

3Calendar Monthly

44-4-5

5Other




InvoiceDeliveryMethod (howSendInvoices)0PostInvoice delivery method

1Email

2Fax

3Not sent




timesheetsOnInvoices0Timesheets On Invoices

1Timesheets Not On Invoices




paperOnInvoices-1Agency Default

0No Attachments

1Attach Paper Timesheets

2Attach Expense Group Paper

4Attach Expense Receipts Paper

<sum of the above>Attach the appropriate paperFor 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" };
client.setConsolidation(cConsolidation);

Everything Goes On One Invoice



Code Required

String[] cConsolidation = new String[] { "charge-payment-term","destination","source","charge-currency","sales-tax-code","client","sheet-type" };
client.setConsolidation(cConsolidation);

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" };
client.setConsolidation(cConsolidation);

Each Placement is Invoiced Separately



Code Required

String[] cConsolidation = new String[] { "charge-payment-term","destination","source","charge-currency","sales-tax-code","client","sheet" };
client.setConsolidation(cConsolidation);

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” };
client.setConsolidation(cConsolidation);

Each Candidate Is Invoiced Separately






grouping

Code Required

String[] cGrouping = new String[] { "sheet-rate" };

client.setGrouping(cGrouping);

Sheet Rate




Worker


workerTypepayeFor PAYE Workers

ltdFor Ltd Company Workers

external-contractorFor Non Ltd Company Workers

cisFor CIS Workers

umbFor Workers operating through an UmbrellaYou must also reference the umbrella against the worker, otherwise the worker will appear as LTD.

ir35For workers inside scope of IR35 (deemed)




cisBusinessTypeSoleTrader


Company


Trust


Partnership





cisPercentage0


20


30





paymentFrequencyweekly


monthly


<InPay Payroll Name>If InPay connected, for PAYE workers, use the InPay Payroll Name




limitedCompany.timesheetsOnInvoices

0Timesheets On Invoices

1Timesheets Not On Invoices




limitedCompany.paperOnInvoices-1Agency Default

0No Attachments

1Attach Paper Timesheets

2Attach Expense Group Paper

4Attach Expense Receipts Paper

<sum of the above>Attach the appropriate paperFor example, 5 to attach timesheets and receipts




genderM


F





limitedCompany.invoicePeriod0Weekly

1Two-Weekly

2Four-Weekly

3Calendar Monthly

44-4-5

5Other




Payment Methodbacs
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




sendLtdCompanyTimesheets0

Do not send a copy of the timesheets to the worker or provider 



1Only send a copy of timesheets to the worker's ltd company email address

2Send a copy of timesheets to the worker's provider if they have one, otherwise send it to the worker

3Send copies to both the worker and provider




consolidation

Code Required

String[] wConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","worker" };
worker.setConsolidation(wConsolidation);

Everything Goes On One Invoice



Code Required

String[] wConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","worker","sheet-type" };
worker.setConsolidation(wConsolidation);

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" };
worker.setConsolidation(wConsolidation);

Each Placement is Invoiced Separately



Code Required

String[] wConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","worker","sheet" };
worker.setConsolidation(wConsolidation);

Each Timesheet Or Expense Item Is Invoiced Separately






grouping

Code Required

String[] wGrouping = new String[] { "sheet","sheet-rate" };

worker.setGrouping(wGrouping);

Sheet Rate




Placement


layoutstandard
See Maintaining Placements

calendar





timesheetDateCalculatorweekly
See Maintaining Placements. You can see all possible values for this in the ui.

monthly


<many more>See UI for all options.




Rates


period60 / HFor hourly rates entered in hours format (hours only or start, break, finish).

1440 / FFor 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)).




timePatterndefaultWill use the selected default time pattern

<any string>The string should match the name of a time pattern in the system




timesheetFieldsSTART_FINISH_BREAKEnter start, break, finishOnly when period above is 60

HOURSEnter hours onlyOnly when period above is 60

DECIMALEnter time as a decimalOnly when period above is 1440

DAYTickbox only (equivalent to entering decimals as 1.00)Only when period above is 1440

InvoiceAdjustmentSettings

(Company / Worker)




AdjustBy0Fixed Amount

1Percentage
AdjustPer0Per Worker

1Per Timesheet

2Per Invoice
AdjustType0Addition

1Deduction
ExpenseType


EntryMethod

0Gross valuePopulate the GrossValue and optionally the VatAmount field on an ExpenseItem with this entry method

1Net ValuePopulate the NetValue field on an ExpenseItem with this entry method

2Units and Unit netPopulate 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.

3Units and NetPopulate the Unit and Net Value fields on an ExpenseItem with this entry method.




Timesheet


StatusgetTimesheetStatus()getStatus()

-1

DELETED



1

INCOMPLETE



2

SUBMITTED



3

APPROVED



5

COMPLETED



-2

MISSING



-3

REVERTED






InvoiceInfo (Invoice)


Invoice TypegetInvoiceDescription()


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" };
provider.setConsolidation(pConsolidation);

Everything Goes On One Invoice



Code Required

String[] pConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","ltd-co-provider","sheet-type" };
provider.setConsolidation(pConsolidation);

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" };
provider.setConsolidation(pConsolidation);

Each Placement is Invoiced Separately



Code Required

String[] pConsolidation = new String[] { "destination","source","pay-currency","purchase-tax-code","ltd-co-provider","sheet" };
provider.setConsolidation(pConsolidation);

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” };
provider.setConsolidation(pConsolidation);

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

5Other




timesheetsOnInvoices0Timesheets On Invoices

1Timesheets Not On Invoices




paperOnInvoices-1Agency Default

0No Attachments

1Attach Paper Timesheets

2Attach Expense Group Paper

4Attach Expense Receipts Paper

<sum of the above>Attach the appropriate paperFor example, 5 to attach timesheets and receipts

...