Dunning Rule

What can you do with DunningRule?


Properties

Property Details
id
"id": 205
Type: Number
This is the unique numeric identifier for the DunningRule
ownerId
"ownerId": 957
Type: Number
Unique identifier for the associated Owner object.
paymentDunningRuleId
"paymentDunningRuleId": 879
Type: Number
Unique identifier for the associated PaymentDunningRule object.
isActive
"isActive": true
Type: Boolean
days
"days": 751
Type: Number
paymentActionTypeId
"paymentActionTypeId": 983
Type: Number
Unique identifier for the associated PaymentActionType object.
paymentActionValue
"paymentActionValue": "Hello World"
Type: String


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • paymentDunningRuleId
  • isActive
  • days
  • paymentActionTypeId
  • paymentActionValue

DataFlow PATCH objects:


End Points

DELETEapi/v1/DunningRule/{id:int}
Delete an instance of the DunningRule object.
GETapi/v1/DunningRule
Retrieve all of the DunningRule objects.
GETapi/v1/DunningRule/Metadata
Retrieve all of the meta data details of the DunningRule object.
GETapi/v1/DunningRule/Metadata/{option}
Retrieve all the meta data details of the DunningRule object based on provided options.
{option}Metadata options for the DunningRule object.
GETapi/v1/DunningRule/Paged
Retreive all of the DunningRule objects in a paged fashion.
GETapi/v1/DunningRule/{id:int}
Retrieve an instance of the DunningRule object by it's ID.
{id:int}Unique identifier for the DunningRule object.
POSTapi/v1/DunningRule
Create a new instance of the DunningRule object.
PUTapi/v1/DunningRule/{id:int}
Update an existing instance of the DunningRule object.