Rules Application

Output representation of the details of rules application.

JSON Example

This example shows the rules application response.

1{
2  "isSuccess": true,
3  "rulesApplicationSummary": {
4    "fetchedPaymentsCount": 250,
5    "fetchedCreditMemosCount": 250,
6    "totalPaymentApplications": 250,
7    "totalCreditMemoApplications": 200,
8    "areAllInvoicesConsidered": true
9  },
10  "appliedRules": [
11    "Match ID",
12    "Match Balance"
13  ],
14  "errors": []
15}

Property Name	Type	Description	Filter Group and Version	Available Version
`isSuccess`	Boolean	Indicates whether the rules are applied (`true`) or not (`false`).	Big, 66.0	66.0
`rulesApplicationSummary`	Rules Application Summary	Summary of the application rule. This includes the number of payments and credit memos for the account, the total number of payments and credit memos that are applied to invoices, and whether all invoices for an account are considered (`true`) or not (`false`).	Big, 66.0	66.0
`appliedRules`	String[]	Rules that were applied. Valid values are `Match ID`, `Match Balance`, `Prioritize Highest Balance Invoices`, or `Prioritize Oldest Invoices`.	Big, 66.0	66.0
`errors`	Rules Application Error[]	Details of the errors if the API request was unsuccessful.	Big, 66.0	66.0