Adjustments & Pay Runs: Jobs for autoBuildClaims

Adjustment approvals, pay run management, and billing

Jobs for autoBuildClaims

SELECT st.method, sj.schedulerjobid, sj.description, sj.parameters, minutes, hours, days, months, weekdays, sj.statusflag FROM gb_scheduler_jobs AS sj inner join gb_scheduler_types AS st ON st.schedulertypeid = sj.schedulertypeid AND st.method IN ('autoBuildClaims') ORDER BY st.method, sj.schedulerjob_id; 

spApprovalsAutoBuildClaimsEventJob

select * from gb_api_event_subscriptions where callback_url LIKE '%.catch-e.com/event/job/sp/approvals/auto-build-claims' and filter_policy = '{"eventType":["sl.receipts.batch.posted"]}' ; 

spApprovalsAutoPostClaimsEventJob (under construction)

select * from gb_api_event_subscriptions where callback_url LIKE '%.catch-e.com/event/job/sp/approvals/auto-post-claims' and filter_policy = '{"eventType":["sl.receipts.batch.posted"]}' ; 

Pay Cycle Setup

Your pay cycle set-up affects a range of functions in the system.

  • Quotes / Contact "Pay Cycle" - used in quote pdf calculations

  • Contracts / Billing "Periodic Interval" - carries across from accepted quotes

  • Contracts / Billing "Start Periodic" - enabling the first billing to auto populate

Clients

  • Clients / Packaging Defaults "Pay Cycle"

  • Clients / Quote Defaults "Pay Cycle" - the default value for this field is 'Monthly'. You can change the default in Setup / Reference Data.

  • Clients / Contract Defaults "Contract Pay Cycle From Quote" - if checked, the quote pay cycle is carried into the contract record as the "Periodic Interval"

When creating a new client, the check box defaults as follows:

  • If the client is linked to a channel, the setting stored in the Channels / Quote Defaults "Contract Pay Cycle From Quote" check box is used

  • In all other cases, the setting for Setup / Reference Data - gb_controls "fmclientscontractpaycyclefromquoteflag_default" is used.

Drivers / Contact "Pay Cycle"

Employees / Contact "Pay Cycle"

Default Settings

Below are the default entries stored in the gb_pay_cycles table.

These can be updated to suit your needs.

Pay Cycles that are not enabled for billing can be selected when creating quotes, but are not able to be used in contract records. Remove these records if you do not want to create quote records like this.

Enabled for billing

paycycleid

paycyclecode

Description

billing_flag

paycyclesper_year

taxcyclesper_year

Start Periodic

100000

weekly

Weekly

yes

52.00

52.0000

Can auto-populate

100001

fortnightly

Fortnightly

yes

26.00

26.0000

Can auto-populate

100011

fortnightly2

Fortnightly2

yes

26.00

26.0000

Can auto-populate

100003

bi-monthly

Same as twice monthly

yes

24.00

24.0000

Can auto-populate

100007

4-weekly

4 Weekly

yes

13.00

13.0000

Can auto-populate

100002

monthly

Monthly

yes

12.00

12.0000

Can auto-populate

100004

quarterly

Quarterly

yes

4.00

4.0000

100006

annual

Annually

yes

1.00

1.0000

Not enabled for billing

paycycleid

paycyclecode

Description

billing_flag

paycyclesper_year

taxcyclesper_year

Start Periodic

100012

daily

Daily

no

365.00

364.0000

100009

twice-monthly

Two specific days e.g. 15th and last-day of month

no

24.00

24.0000

100008

month-end

Last day of month

no

12.00

12.0000

100010

month-day

E.g. always on the 23rd month

no

12.00

12.0000

100005

semi-annual

Semi-annual

no

2.00

2.0000

100013

bi-annual

Bi-annual

no

2.00

2.0000


sp approvals autoPostClaims

This job will post claims that pass the Funds Check.

More than one job can be scheduled.

See also the Pay Run Receipts Setup page.

Job Details

Job criteria:

  • Contract Type Group = 'Salary Packaged'

  • Contract Type / Details "Auto Post On Claims" is checked.

  • Contract is linked to an Item

  • The claim has an 'Active' status and a 'Pending Funds' sub status.

  • The claim value is greater than 0.00 (if it is 0.00 or a negative amount, the claim will be ignored).

  • All claims are selected regardless of date.

  • There are funds available. See the Funds Available Calculation details below.

  • Payee is either 'Supplier' or 'Employee'.

  • Payment Method is either 'Direct Credit' or 'Bpay'.

  • This variation of the Funds Check ignores the Contracts / Claim "Reimbursement" check box. Any claim that meets all the criteria above will be posted.

Job outcomes:

  • The claim passes the funds check validation and is 'Posted'.

  • The funds check validation fails and the claim remains at 'Active' status and 'Pending Funds' sub status. It will be checked again the next time the job runs.

  • The claim fails a different check validation during the job run. The claim is updated to the 'Posting Failed' sub status.

  • Investigate these claim records by going to Contracts / Claim and running the error process for the failed claim.

  • This should provide the validation failure message. An example of this happening is the claim failing a GST Checks.

Funds Available Calculation

Factor

Description

Funds Received

The total of all receipts where the invoice row has been fully paid. I.e. the balance is 0, there is no under-payment or over-payment on the invoice row. Therefore, part-payments and on account balances are not included here. Funds Received Net and GST are calculated from all fully paid invoice rows.

less

Actuals

The total of all claims and payments for the contract that have been posted. This includes 'History Only' claims. Actuals Net and GST are calculated from all posted maintenance and payment rows.

equals

Funds Available

The amount available to disburse. If this amount is positive and selection criteria have been met, a claim record will be created. Funds Received Net and GST less Actuals Net and GST equals Funds Available Net and GST.

Parameters

  • Selection (Drop List) - Choose which order to select claims to process for each contract. Available options are: Approval Date (Earliest), Approval ID (Smallest), Total (Smallest), Total (Largest).

  • Allowable Funds Balance (Number) - You can enter the value that the "Current Funds Balance (incl GST)" displayed on the Funds Balance pop-up can become once the claim has been processed. E.g. if you enter -100.00, the "Current Funds Balance (incl GST)" can fall to -100.00.

Mail

  • Send Mail (Check Box) - Opt for mail to be sent to receive a report called 'autoPost_exceptions'. This report lists each claim that has not be posted and the reason why. Below are the three common reasons:

    • Skipping zero dollar claim (shown if the claim is 0 or a negative value)

    • Skipping employee claim due to no driver bank account stored (Bank Account details are missing)

    • Insufficient funds - remaining funds balance -####.## (displays the funds balance)

Process Flow Chart

(Reference to process flow chart)

Scheduler Messages

The messages below are shown on Scheduler / Schedule as "Last Message" and also on Scheduler / Queue as "Message".

Completed

  • Nothing to post! - Displays in sp / approvals / autoPostClaims when no claims have been selected to post (either because none were found or the claims did not meet the posting criteria).

Failed

  • Bad input for /sp/approvals/auto-post-claims API service - Displays in sp / approvals / autoPostClaims when a required table was locked when this job was run, so it could not be completed. The job will run again when next scheduled to do so.