Rule engine criteria reference
A rule engine criterion is one condition an invoice must meet before it is financed or moves on to the next swimlane. This page describes what the criteria that operators ask about most check, and which setting you change to make a criterion pass or fail. How criteria are grouped and followed is described in Configure the rule engine: Decisions tree.
Where to find the criteria
Section titled “Where to find the criteria”Open the client and choose the Engine rules tab. The Decision list tab shows the criteria as a table, and the Decision tree tab shows them per group. Both use the same columns:
| Column | What it holds |
|---|---|
| Active | A criterion that is not active is skipped and counts as passed |
| Definition | A short description of what the criterion does |
| Rule criteria | The name of the criterion, for example System Debtor Global Credit Limit |
| Operator and Value | What the criterion is compared with |
| If fail, allow financing? | Whether an operator can override a failure. See Overriding a failed criterion |
| If no value, allow criteria to pass? | What happens when there is nothing to compare |
| Error message | The message shown when the criterion fails |
How a criterion passes or fails
Section titled “How a criterion passes or fails”Each criterion compares a value from the invoice, the client or the debtor with the Value in the rule, using the operator in the row.
| Operator | Passes when |
|---|---|
==, !=, >, >=, <, <= |
The numbers or dates compare as the operator says |
| IN | The debtor’s or client’s value is in the list you pick. Use it as an allow-list |
| NOT IN | The value is not in the list you pick. Use it as a block-list |
When there is nothing to compare, If no value, allow criteria to pass? decides. With No the criterion fails, whichever operator it has. This is the usual reason an IN or NOT IN criterion on a credit rating fails for a debtor that has never had a credit check: with no rating there is no value to be in or out of the list, so the criterion fails unless the option is Yes. A value of 0 counts as a value, not as no value, with three exceptions where 0 counts as not set: Max. allowed overdrawn client account amount and Expired ledger amount on the client, and Limit expired debtor ledger on the system debtor.
Financing switches
Section titled “Financing switches”Three criteria check the Allow financing setting at one level. All three fail when the setting is off, and use If no value when the level does not exist for the invoice.
| Rule criteria | Reads Allow financing on |
|---|---|
| System Debtor Financial Rule Financing Enabled | The system debtor, in the Credit limit section of its page. See The System Debtor View |
| System Debtor Group Financing Enabled | The system debtor group the debtor belongs to. A debtor in no group follows If no value |
| Validate Client Debtor Financial Rule Allow Factoring | The client debtor, on the client debtor’s page. See The Client Debtor View |
Client and product
Section titled “Client and product”| Rule criteria | What it checks |
|---|---|
| Client Activated | The client is enabled, approved and allowed for financing |
| Client Financing Enabled | The invoice has a client product and the product is enabled. The product is switched on and off in the Products list on the client’s page, and credit monitoring can switch it off. See Credit information, monitoring and insurance limits |
Credit limits
Section titled “Credit limits”The limit criteria compare the invoice amount with what is left of a limit.
| Rule criteria | What it checks |
|---|---|
| System Debtor Global Credit Limit | The invoice amount against the disposable part of the Credit Limit you enter on the system debtor. It fails when no limit is entered, whatever If no value says |
| System Debtor Currency Credit Limit (with recourse) and (without recourse) | The invoice amount against the limit for the invoice’s currency, in the limits table on the system debtor. It follows If no value when there is no limit for that currency |
| Client Global Credit Limit | The invoice amount, converted to the client’s contract currency, against the client’s global limit. It follows If no value when no global limit is set |
| Client Currency Credit Limit (with recourse) and (without recourse) | The invoice amount against the client’s limit for the invoice’s currency. It follows If no value when there is no limit for that currency |
| Disposable credit amount for system debtor | The debtor’s disposable credit against a maximum in the debtor’s financing rule. That maximum cannot be set in the Operations Portal, only through the API, so the criterion follows If no value until it is set |
The criteria that say (with recourse) or (without recourse) check only the limit of the kind the invoice would be financed with. See Rules that both test and set recourse.
Client account overdrawn
Section titled “Client account overdrawn”Client Overdrawn Client Account Amount limits how far the client’s account may be overdrawn when financing is attempted. It reads Max. allowed overdrawn client account amount, on the client’s Financing tab in the Rules section, and compares it with the total of the negative balances on the client’s invoice factoring fund accounts. The criterion fails when that total has reached the maximum, and follows If no value when no maximum is set or the maximum is 0.
The rule engine checks the maximum only through this criterion. If the criterion is not in the client’s rule, the rule engine does not check it. The maximum is also checked outside the rule engine, for example when financing is approved in an errand or when an invoice is refinanced. There too a maximum of 0 counts as not set.
Delivery verification
Section titled “Delivery verification”Client Invoice Delivery Verification Requirement (first number of invoices) requires an approved delivery verification on the client’s first invoices. The Value is a count: the number of the client’s first invoices that must all have an approved delivery verification.
- With a value of 3, no invoice of the client can be financed until the client has three invoices and all three have an approved delivery verification.
- Every invoice of the client counts, credit invoices included.
- The criterion is evaluated for the client as a whole, not for the single invoice. Once the delivery verifications are approved, the earlier invoices can be financed at the next attempt.