AutoBuildClaims

Build and post approvals for Salary Packaged contracts when funds available.

Related: Pay Run Receipts Setup

Claims created and posted by running autoBuildClaims API.

autoBuildClaims runs either on its scheduler job or from the receipt-batch event; the two are complementary β€” the scheduled job should stay on even when the event is in use

Supplementary SWAGGER documentation: api.catch-e.com/docs/?urls.primaryName=Event+Jobs#/Employee%20%2F%20Claims/autoBuildClaims

Note: This API only available for use within Catch-e system.

Parameters

Parameter

Notes

Class

Drop list displays all classes stored in Contract Types - Expenses-Approvals where "Group" is 'Salary Packaged'. Choose one to populate description field for created claims.

Selection Criteria

Claims created when:

  • Contract Type / Details "Group" is 'Salary Packaged'

  • Contract Types - Expenses-Approvals "R" (Recharge) unchecked

  • Employees / Item "Disbursement Type" is 'Recurring'

  • Employees / Item "Payment Method" is 'Direct Credit' with Bank Account populated OR 'Bpay' with Reference populated

  • Funds available (see calculation below)

  • If contract has 'SUB' event: has attachment, marked completed, active status, amount not blank/null and greater than 0.00

Funds Available Calculation

Factor

Description

Funds Received

Total of all receipts where invoice row fully paid (balance 0, no under/over-payment). Part-payments and on-account balances excluded. Funds Received Net and GST calculated from fully paid invoice rows.

less Actuals

Total of all claims and payments posted (includes History Only claims). Actuals Net and GST calculated from posted maintenance and payment rows.

equals Funds Available

Amount available to disburse. If positive and selection criteria met, claim created. Funds Received Net and GST less Actuals Net and GST equals Funds Available Net and GST.

Job Outcomes

Posted claim created for each item with surplus between contract posted receipts total and posted actual costs total (GST inclusive Total of all posted Payments, Claims, Approvals).

Claim Record Creation

  • Supplier, Payee, Payment Method, BSB, Account Number populated from linked Employees / Item record

  • Reference populates with Employees / Item "Reference" (if populated) or Contracts / Claim "Approval"

  • Reimbursement checkbox: Checked if Payee is 'Employee', Unchecked if 'Supplier'

  • Net and GST is difference between posted receipt total and existing actual amounts

  • R (Recharge) set as 'N'

  • Date and Odometer Date are creation date

  • Status is 'Posted'

Next Steps

Posted claim selected in either:

  • Next Disbursement (ABA) batch created

  • Next Disbursement (BPAY) batch created

Exception Report

Scheduler sends report with two columns: Contract ID, Error. (See Disbursements (ABA) Troubleshooting)

Error

Fix

Item has incorrect 'Payment Method' or missing bank details

Linked item Payment Method not 'Direct Credit' or bank account missing. Update Payment Method to Direct Credit or add Bank Account record.

Item has missing bank details for employee

Item Payee is 'Employee' with no linked bank account. Add Bank Account record.

Substantiation event is missing but is required

Substantiation event missing from contract. Create suitable substantiation event.

Substantiation event due date is greater than current FBT year

Substantiation events exist but no event within/before current FBT year. Create suitable substantiation event.

Latest substantiation event has multiple records

Multiple substantiation events on latest due date. System doesn't know which to use. Change due date of one event.

Substantiation event is either missing attachment or completed flag is untick

Substantiation event lacks attachment or completed flag unchecked. Check Completed checkbox and/or attach substantiation document.

Unable to create new claim due to substantiation event amount has been reached for current FBT year

Substantiation event amount less than/equal to total posted payments + maintenance in current FBT year + available balance. No further disbursements possible. Review item/employee benefits and prepare substantiation events for following FBT year.


AutoPostPayments

Post payments for Salary Packaged contracts when funds available.

Related: Pay Run Receipts Setup

Parameters

Parameter

Notes

Module

Choose 'sp' from listbox

Class

Choose 'payments' from listbox

Method

Choose 'autoPostPayments' from listbox

Description

Default entry: 'Salary Packaging Disbursement Payments' when Method = autoPostPayments

Bank Account

Single account: read-only display. Multiple accounts: defaults to '-- All--' with drop list selection. '--All--' can be saved.

Delivery

Select Email or Post. Must match supplier Payment Delivery Type. Email sends with Mail Queue visibility. If supplier email blank, job runs but email fails. Post generates no files; get remittance advice PDF from Payments / Periodic.

Dated To Method

Choose method/day to determine date for record selection. Options: Run Date, Common Day, Run Date Plus.

Dated To Day

Run Date: drop list unavailable. Common Day: choose 1-31 or EOM. Run Date Plus: choose days 1-31.

Dated To

Calculated using next pending job in gbschedulerqueue. Pending jobs deleted on Edit, so Dated To can't calculate (up to 1 minute). When no pending jobs, Next Due shows 'unavailable'. New mode: blank. Edit mode: display-only.

Run Times

Recommend setting out of business hours

Data Validations

Alert

Notes

Cannot process Payment Structure ###### Payment Period No # Item No # as current balance is not positive

Cannot process Payment Structure ###### Payment Period No # Item No # due to insufficient funds

Selected bank account needs linked record where account_type = payables. Ensure correct company used. When packaging Channel set up, company must match.

ExecuteScript Alerts

Job failed! Error: CATCH_E_API_EXECUTE_SCRIPT_ERROR

Error message: Failure executing query #. Message: Statement could not be executed (45000 - 1644 - Billing already locked!)

ExecuteScript job started but couldn't complete. Billing lock not secured for script in query. Script number shown in message. Try again later.