Data & Automation API: AutoBuildClaims

AutoBuildClaims

| --- |

Use this method to build and post approvals for Salary Packaged contracts when funds are available.

See also the Pay Run Receipts Setup page.

Claims are created and posted by running the autoBuildClaims API.
Supplementary swagger documentation for the autoBuildClaims API is available here: https://api.catch-e.com/docs/?urls.primaryName=Event+Jobs#/Employee%20%2F%20Claims/autoBuildClaims(https://api.catch-e.com/docs/?urls.primaryName=Event+Jobs#/Employee%20%2F%20Claims/autoBuildClaims).
This API is only available for use within the Catch-e system.

Parameters

This job type has the following input parameters:

• Class — Drop List. The list displays all classes stored in Contract Types - Expenses-Approvals where the "Group" is ‘Salary Packaged’. Choose the one you want to use to populate the description field for the claims that are created. Create a Contract Type

Selection Criteria

1. Contract Type / Details "Group" is 'Salary Packaged'
2. Contract Types - Expenses-Approvals "R" (Recharge) is un-checked
3. Employees / Item "Disbursement Type" is 'Recurring'
4. Employees / Item "Payment Method"
5. is 'Direct Credit' and "Bank Account" is populated or
6. is 'Bpay' and "Reference" is populated
7. There are funds available. See the Funds Available Calculation details below.
8. If the contract has a 'SUB' event,
9. it has an attachment
10. is marked as completed
11. has an active status
12. the amount is not blank/null and is greater than 0.00

Funds Available Calculation

| ; align = "left"| 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 |

Job Outcomes

A posted claim is created for each item where there is a surplus between the contract's posted receipts total and posted actual costs total (the GST inclusive Total of all posted Payments, Claims and Approvals).

A claim record is created and posted

1. "Supplier", "Payee", "Payment Method", "BSB" and "Account Number" fields are populated with the value stored in the linked Employees / Item record.
2. "Reference" populates with
3. Employees / Item "Reference" (if populated, otherwise)
4. Contracts / Claim "Approval"
5. "Reimbursement" check box is
6. Checked if the "Payee" is ‘Employee’
7. Un-checked if the "Payee" is ‘Supplier’
8. "Net" and "GST" is the difference between the posted receipt total ed budget and the existing actual amounts.
9. "R" (Recharge) is set as ‘N’.
10. "Date" and "Odometer Date" are the date of creation.
11. "Status" is 'Posted'.

Next Steps

The posted claim will be selected in either

1. the next Disbursement(ABA) batch that is created or
2. the next Disbursement(BPAY) batch that is created

Exception report sent by scheduler

Report contains two columns: Contract ID, Error. See also the Disbursements (ABA) Troubleshooting_Troubleshooting) page.

• Item has incorrect ‘Payment Method’ or missing bank details’ — Linked item "Payment Method" is not ‘Direct Credit’ or bank account is missing. Fix this by 1. Updating the "Payment Method" to 'Direct Credit' or 2. Adding a Bank Account record to the item.
• Item has missing bank details for employee — The item Payee is 'Employee' and there is no linked bank account. Fix this by adding a Bank Account record to the item.
• Substantiation event is missing but is required — Substantiation event is missing from contract but is required Fix this by creating a suitable substantiation event.
• Substantiation event due date is greater than current FBT year — Substantiation events exist but there is no event within or before the current FBT year. Fix this by creating a suitable substantiation event.
• Latest substantiation event has multiple records — Multiple substantiation events exist on latest due date. If there are multiple events recorded for the same day, the system does not know which record to use for the validation process. Fix this by changing the due date of one of the events.
• Substantiation event is either missing attachment or completed flag is untick — Substantiation event does not have either attachment or completed flag is untick. Fix this by 1. Checking the "Completed" checkbox and/or 2. Attaching the substantiation document.
• Unable to create new claim due to substantiation event amount has been reached for current FBT year — Substantiation event amount is less than or equal to total posted payments + total posted maintenance in current FBT year + Available balance No further disbursements can be made in this FBT year. Review the item and the employee's other benefits and prepare suitable substantiation events for the following FBT year.

AutoPostPayments

Use this method to post payments for Salary Packaged contracts when funds are available.

See also the Pay Run Receipts Setup page.

Parameters

• Module — Choose 'sp' from the listbox.
• Class — Choose 'payments' from the list box.
• Method — Choose 'autoPostPayments' from the list box.
• Description — ‘Salary Packaging Disbursement Payments’ will be a default entry when “Method” = ‘autoPostPayments’
• Bank Account — Single Bank Account – where only one bank account is in use, this field will be a read-only display of the bank account name. Multiple Bank Accounts – where multiple bank accounts are in use, this field will default to ‘—All—’ where one of the multiple accounts can then be selected from a drop list. '--All--' can be saved as a selection.
• Delivery — Select 'Email' or 'Post'. Select the delivery type you need. If you are creating a job for a specific supplier, the "Delivery" selection must match the suppliers "Payment Delivery Type". If it does not, the job will run, but nothing will happen. If the delivery method is 'Email', emails will be sent and can be viewed from the Mail Queue screen. If the supplier's email address is blank, the job will still run, but the email will be in the Mail Queue with a 'Failed' status. If the delivery method is 'Post', no output files will be generated by the job. You can get the remittance advice PDF from the Payments / Periodic screen at any time.
• Dated To Method — Choose the method and day you want to determine the date that will be used to select records for payment. The options are “Run Date”, “Common Day” and “Run Date Plus”. Visit the Dated To Method page for more details.
• Dated To Day — If the "Dated To Method" is 'Run Date', the "Day" drop list is not available. If the "Dated To Method" is 'Common Day', choose from 1st - 31st or EOM from the drop list. If the "Dated To Method" is 'Run Date Plus', choose from days 1-31 from the drop list.
• Dated To — “Dated To” is calculated using the next 'pending' job in gbschedulerqueue. On clicking Edit any 'pending' jobs are deleted so "Dated To" cannot be calculated and it takes up to a minute on Save for the scheduler to tick over and create the next 'pending' job. When there are no 'pending' jobs "Next Due" has the value 'unavailable'. In ‘New’ mode the “Dated To” field will be blank In ‘Edit’ mode the “Dated To” field will be non-editable – display only.
• Run Times — We recommend you set these jobs to run out of business hours.

Data Validations

The selected bank account needs to have a linked record where = 'payables'.

Ensure the correct company is used for . When a packaging Channel is set up the company must match with

ExecuteScript Alerts

ReserveBatchNosWebService

This API replicates legacy web service reserveBatchNos.

Supplementary SWAGGER documentation is available here: reserveBatchNos

Enable

Go to Setup / Reference Data → gbcontrols) and find the "apiwebserviceswrapper_login" control.

Populate this control with a 'web_services' user login and password.
This user will be used to run the API from within code.

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on WebServices.

Authentication

Authenticate with the API before running this API.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

URL Examples

https://api.test.catch-e.com/web-services/gl/system/reserveBatchNos

Headers

Body (form-data)

Response Details

{ "batch_no_start": XXXXXX, "batch_no_end": XXXXX}

| 401 - Unauthorized | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized"}

| You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again. |
| 403 - Forbidden | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden"}

| You do not have permissions for this request. Go to System Roles and enter 'web_services' Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked. |
| 406 - Not Acceptable | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Cannot honor Accept type specified"}

| The Accept Header must be set as 'application/octet-stream'. Update the Accept Header and try again. |
| 418 - Invalid Credentials | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Invalid Credentials", "status": 418, "detail": "Web services API wrapper credentials have not been configured"}

| You need to enable Web Services Go to Setup / Reference Data → gbcontrols) and find the "apiwebserviceswrapperlogin" control. Populate this control with a 'webservices' user login and password. This user will be used to run the API from within code. |
| Input validation errors | | |

For 'batch_nos': Required field is not provided.For 'batch_nos': Value must be greater than 1.For 'batch_nos': Value must be less than 1000.

| 'batchnos' is a required field. Enter the number of batchnos you wish to reserve. 'batch_nos' must be a positive number. Enter a value that is between 1 and 1,000. Only 1,000 batch nos can be reserved at one time. |
| 422 - Unprocessable Content Input | | |

 "batch_nos": { "isEmpty": "Value is required and can't be empty" }

| You have not passed a value for 'batchnos'. 'batchnos' is a required field, enter the number of batch_nos you wish to reserve. | |

 "batch_nos": { "notDigits": "The input must contain only digits" }

| You may have entered a negative number. 'batch_nos' must be a positive number. Enter a value that is 1 or more. | |

 "web_service_error": { "CATCH_E_ERROR_BATCH_NOS_INVALID": "Invalid batch_nos value. Must be a positive integer." }

| You have entered '0'. 'batch_nos' must be a positive number. Enter a value that is 1 or more. |
| 424 - Failed Dependency | | |

 "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Failed Dependency", "status": 422, "detail": "Upstream service temporarily unavailable. Please retry."}

| The API cannot run at this time. This can happen for a various reasons, for example: service resource limits have been exceeded the system is in maintenance mode |