RulesApplicationResponse Class

Contains properties to store the response details for the rules application request.

Namespace 

RulesAppln

RulesApplicationResponse Constructors 

Learn more about the constructors available with the RulesApplicationResponse class.

The RulesApplicationResponse class includes these constructors.

RulesApplicationResponse(isSuccess, appliedRules, rulesApplicationSummary, errors) 

Initializes the RulesApplicationResponse class that stores the response details for the rules application request.

Signature 

public RulesApplicationResponse(Boolean isSuccess, List<String> appliedRules, RulesAppln.RulesApplicationSummaryResponse rulesApplicationSummary, List<RulesAppln.RulesApplicationErrorResponse> errors)

Parameters 

isSuccess

Type: Boolean

Indicates whether the rules are applied (true) or not (false).

appliedRules

Type: List<String>

Comma-delimited list of applied rules.

rulesApplicationSummary

Type: RulesAppln.RulesApplicationSummaryResponse

Details of the rules application that includes these details.

  • Payment and credit memo count for the account
  • Payment and credit memo count that’s applied to invoices or invoice lines
  • Details of rules

errors

Type: List<RulesAppln.RulesApplicationErrorResponse>

List of error responses that occurred during the rules application.

RulesApplicationResponse() 

Initializes an empty instance of the RulesApplicationResponse class.

Signature 

public RulesApplicationResponse()

RulesApplicationResponse Properties 

Learn more about the properties available with the RulesApplicationResponse class.

The RulesApplicationResponse class includes these properties.

  • appliedRules

    Get the comma-delimited list of rules that were applied.

  • errors

    Get the list of error responses that occurred during the rules application.

  • isSuccess

    Get the boolean value that indicates whether the rules were applied (true) or not (false).

  • rulesApplicationSummary

    Get the details of the rules application that includes payment and credit memo count for the account, payment and credit memo count that’s applied to invoices or invoice lines, and whether the exact amount rule is applied.

appliedRules 

Get the comma-delimited list of rules that were applied.

Signature 

public List<String> appliedRules {get; set;}

Property Value 

Type: List<String>

errors 

Get the list of error responses that occurred during the rules application.

Signature 

public List<RulesAppln.RulesApplicationErrorResponse> errors {get; set;}

Property Value 

Type: List<RulesAppln.RulesApplicationErrorResponse>

isSuccess 

Get the boolean value that indicates whether the rules were applied (true) or not (false).

Signature 

public Boolean isSuccess {get; set;}

Property Value 

Type: Boolean

rulesApplicationSummary 

Get the details of the rules application that includes payment and credit memo count for the account, payment and credit memo count that’s applied to invoices or invoice lines, and whether the exact amount rule is applied.

Signature 

public RulesAppln.RulesApplicationSummaryResponse rulesApplicationSummary {get; set;}

Property Value 

Type: RulesAppln.RulesApplicationSummaryResponse