Application / Workflows

Rules Engine Actions

This article provides an overview of the functions and details of actions in the Rules Engine.

Delete

Note

If you create a rule on the Global Rules tab, it will be applied to all items mentioned in the rule. However, if you create the rule in Workflows, it will only affect the items assigned to that specific workflow.


You can select from the following actions:
Assign workflow - Assigns an existing workflow to a trigger event. To do so, select a workflow from the drop down menu, which lists both active and inactive workflows. You can use this action to switch a customer from one workflow to another.

Exclude customer from workflow -Excludes a customer from the current workflow.

Create Task - Creates a task which you must configure using the provided settings.

Enable payment methods - Enables ACH or credit card payments for the customer, either separately or simultaneously.

Disable payment methods - Disables ACH or credit card payments for the customer, either separately or simultaneously.

Schedule a call - Creates a task with a scheduled call assigned to the appropriate AR specialist.

Add a note to a customer - Creates a note for a customer, which will be displayed on the NOTES tab on the Statement page.

Exclude invoice from workflow (only for Invoice Events) - Excludes an invoice from the current workflow that contains the invoice..  
For this action, you can also check Keep invoice included in global rules to exclude the corresponding invoices from Workflows but keep them in Global rules:

By default, this check box is unchecked, meaning that the corresponding invoices are excluded from both Workflows and Global rules.

Include invoice to workflow (only for Invoice Events) - Includes an invoice in a customer's current workflow.

Send an e-mail reminder - Sends an email reminder through your AR mailbox to pre-defined recipients.The recipients can be customer-level billing contacts, invoice level billing contacts, and additional custom fields defined to be used as email recipients. To learn how to create email templates, see Creating Email Templates‍ article.

If you configure a rule for the workflow, it will send a reminder for each individual invoice that meets the specified conditions. To prevent multiple emails from being sent, you can check Run for the oldest invoice only in the workflow settings.

Delete

Warning

If a trigger is a Customer Event or Payment Event and the email template includes Invoice dynamic fields, these fields will not be used in the email reminder.


Delete

Note

If an automated email reminder has the Use invoice billing contactscheck box checked in the global rule's or collection workflow's settings and contains one of the following dynamic tags, the invoice billing contact will receive the following:
  • Customer Open Invoices Table – The invoice billing contact will receive only the invoice-level billing contact's documents.

  • Open Documents Table – The invoice billing contact will receive the invoice-level billing contact's invoices and open documents.


Send group email reminder – Sends one email reminder to a billing contact (invoice or customer level) regarding all the invoices that were triggered by the X days after invoice date or X days before/after invoice due date invoice events, i.e. the recipient receives one email for all invoices that were triggered by the same conditions.

You can choose this action in the Add new rule dialog within Collection Workflows and Global Rules.

Grouping of invoices is based on the following criteria:

  • Triggered event

  • Workflow/global rule

  • Company

  • Billing contact (i.e. customer contacts or invoice level billing contact)
    If Use invoice billing contacts is checked, each invoice level billing contact will receive a consolidated email with all relevant invoices assigned to them. If unchecked, the customer billing contact will be used instead. Additionally, it is important to select the billing contact role as the recipient of the email.

Based on this criteria, a billing contact will receive a group email triggered by a single rule in a workflow or a rule from a single company associated with a billing contact.

Additionally, you can also set a RECURRING ACTION for the group reminder, i.e. whether the group reminder should be sent repeatedly and how often. You can do this by checking Repeat every _ days and entering the number of days:

As a result, the reminder will be sent repeatedly and will include invoices attached to the original group reminder minus paid invoices. This process will continue until all invoices are paid.

Delete

Note

If this action is chosen, no other actions can be added. If other actions are already chosen, this one is hidden.

 If a rule is triggered by a child's invoice (i.e., when the Parent level collections setting is enabled in the Statement page | ACTIVITY | SETTINGS), the parent company will also receive the group email.

If supplemental documents are attached and the Parent level collections setting is enabled (Statement page | ACTIVITY | SETTINGS), the invoice attachments are included as follows:
  • If there is one invoice with attachments from the parent company and one from the child company, the group reminder will include the customer supplemental documents from the parent company for both invoices.
  • If all invoices with attachments are from the parent company, the group reminder will include the customer supplemental documents from the parent company.
  • If all invoices with attachments are from the child company, the group reminder will include the customer supplemental documents from the child company.
If the Run for oldest invoice only based on check box is checked, the group reminder will include a group of all the oldest invoices that match the rule's settings.

If both Run for oldest invoice only based on and Use invoice billing contacts are checked, YayPay will send a group of the oldest invoices that are found within each individual invoice billing contact and that match the rule's settings.

Additionally, all other rule settings are also applied. For example, this includes options such as Do not send reminder if ERP PDF is missing, [ADMIN] Workflow/ Global Rules - Use Sending time as Cut-off time, Use Business currency for custom conditions, custom conditions themselves etc.


Send group mail reminder – Sends one mail reminder to a selected company regarding all the invoices that were triggered by the X days after invoice date or X days before/after invoice due date invoice events, i.e. the recipient receives one mail for all invoices that were triggered by the same conditions.
You can choose this action in the Add new rule dialog within Collection Workflows and Global Rules.

Grouping of invoices is based on the following criteria:

  • Triggered event
  • Workflow/global rule
  • Company/ Customer (their address)

Based on this criteria, user receives a group email generated by a single rule in a workflow or rule, sent to a single company for a specific service.

Delete

Caution

If you configure a rule with the Send group mail reminder action, ensure that your PDF attachments do not exceed the permitted page limit. For example, the limit for PDF attachments when using Certified ERR (US mail service) is 13 pages. If your files are larger than this limit, choose a different service to ensure that your mail is sent.

We only consider the date, not the time for our due or created calculations. This means that invoices with different times (00:00:00 or 23:59:59) will still be grouped together in the same batch.

For additional details, see also the Note box related to the Send group email reminder action.


Delete

Tip

Tip  For this reminder, you can select an email template containing a dynamic tag called Triggered Invoices Table

This tag generates a table listing open invoices triggered by specific events. The table will only include invoices that meet the specific trigger criteria, such as being 15 days past due, rather than including all invoices within the 1-30 days time range.

Set dispute assignee – Assigns a selected role or person to handle a dispute when one of the following events occurs: Dispute is opened, Dispute is updated , X days after dispute created or X days after dispute updated.

You can choose this action in the Add new rule dialog within collection workflows and global rules.

When you select this action, additional Assign role and Assign specialist options appear. Using these options, set whether a role or a specific person will handle a dispute.

Based on this selection, either the Select Role or Select Assignee drop down menu will appear. From this menu, select either a role or a specific user from a list of active users, grouped by their roles. The selected user or role will then be automatically assigned to the dispute when the specified event occurs.

If you select a role as a dispute assignee, the actual person assigned will be different for each customer. If there is no user assigned to the selected role, the dispute will remain unassigned.

After the specified event occurs, the chosen assignee and the date of assignment will be displayed on the Disputes page in the Dispute Assignee and Dispute Assignment Date columns which you can add to the grid.

Update external credit data – Updates external credit data of the Creditsafe or Dun&Bradstreet inquiry providers when one of the workflow or global rules events occurs.

You can choose this action in the Add new rule dialog within collection workflows and global rules.

To make the Update external credit data action visible in the Action drop down menu:

  • Check the Enable Online Credit Application check box in Settings | Business , i.e. this functionality is available for Advanced Credit users only.
  • Ensure that the Creditsafe or Dun&BradstreetTM credit inquiry provider is connected in Settings | Payments/Credits.
  • Ensure the following is set:
    • For Creditsafe – Creditsafe ID field.
      You can do so manually via the Manage Rates dialog on the Statement page, via the Manage Application Form dialog on the Submitted Applications page or via the Credit Mapping Excel file.
      After the specified event occurs, the Credit Score and Creditsafe Rate fields on the Statement page will automatically be updated.
    • For Dun&Bradstreet – D&B PAYDEX field.
      You can do so manually via the Manage Rates dialog on the Statement page, via the Manage Application Form dialog on the Submitted Applications page or via the Credit Mapping Excel file.
      After the specified event occurs, the D&B PAYDEX field on the Statement page will automatically be updated.

Additionally, any updates will also be logged on the CREDIT SCORE LOG tab located at the bottom of the Statement page.

Delete

Note

For updating external credit data, the following applies:
  • If a customer or form lacks the correct ID, it will be skipped from the request.
  • If a user adds more than one action to the rule, rules are triggered based on the user provider connection and IDs.
  • If the D&B PAYDEX value is NA, score updates are skipped.


Attaching Documents to Email Reminders:

You can choose to attach specific documents to the email reminder.

You can use the following options for attaching documents:

  • Attach PDFs of open invoices that trigger the action - Only available for invoice type events.

If checked, the Attach Supplemental Documents of the invoice that triggered the action check box becomes available and checking it will include all the attached invoice level supplemental documents for which you checked the Available in Workflows check box when uploading/ editing them.

  • Attach PDF of the credit memo that triggered the action - Available only for Credit Memo Type of events.
  • Attach open invoice PDF(s) - Available for all events.
    You can select which open invoices to attach based on their expected payment date using the provided options.

Additionally, checking the Include Invoice Supplemental Document(s) check box will include all the attached invoice level supplemental documents for which you checked the Available in Workflows check box when uploading/ editing them.

  • Attach open credit memo PDFs - Available for all events. Only the 200 most recent credit memos are attached.
  • Attach Customer Statement PDF - Available for all events.
  • Attach Child Customer Statement PDF - Available for all events.
  • Attach Customer Statement Excel - Available for all events.
  • Attach Child Customer Statement Excel - Available for all events.
  • Attach Customer Supplemental Documents - Available for the Send mail and Send an email reminder Action types.
    To learn more about customer level supplemental documents, see the Customer Level Supplemental Documents‍ article.
  • Attach Payment Receipt - Available for the following events: Partial payment made through YayPay and Payment made through YayPay.
  • Business Supplemental Documents - Available for the Send mail and Send an email reminder Action types. To learn more about business level supplemental documents, see the Business Level Supplemental Documents‍ article.

Adjusting Content of Dynamic Tables in Email Reminder Templates:

This section describes the use of the Include invoices by bucket to Open Invoices/Open Documents Table options.

It is only applied when one of the following dynamic tags is used in the selected email template:

Use it to specify (with the provided options) which open invoices to list in the given dynamic table based on their expected payment date.

Delete

Note

If the Open Documents Table tag is used, that option only affects the listed open invoices. The other types of open documents (adjustments, credit memos, payments) are listed all.

Add a note to an invoice (only for Invoice Events) - triggered by chosen event note is created for a customer, and will be available on the Statement page > Activity panel > tab Notes with the Invoice number in the heading

Assign AR Specialist - will assign a chosen AR (can be used to assign or change an AR) 

Assign CS specialist - will assign a chosen CS (can be used to assign or change a CS) 

Assign Sales representative - will assign a chosen Sales (can be used to assign or change a Sales) 

Call invoice delayed event - is used for creating delayed events and should be created along with Invoice delayed event

Call customer delayed event - is used for creating delayed events and should be created along with Customer delayed event

Can't find what you need?

Contact our support team support@yaypay.com for help.