Payment / Dunning Rule

What can you do with PaymentDunningRule?


Properties

Property Details
id
"id": 976
Type: Number
This is the unique numeric identifier for the PaymentDunningRule
ownerId
"ownerId": 393
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
isActive
"isActive": true
Type: Boolean
minimumOverdue
"minimumOverdue": "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:

  • name
  • isActive
  • minimumOverdue

DataFlow PATCH objects:


End Points

DELETEapi/v1/Payment/DunningRule/{id:int}
Delete an instance of the PaymentDunningRule object.
GETapi/v1/Payment/DunningRule
Retrieve all of the PaymentDunningRule objects.
GETapi/v1/Payment/DunningRule/Metadata
Retrieve all of the meta data details of the PaymentDunningRule object.
GETapi/v1/Payment/DunningRule/Metadata/{option}
Retrieve all the meta data details of the PaymentDunningRule object based on provided options.
{option}Metadata options for the PaymentDunningRule object.
GETapi/v1/Payment/DunningRule/Paged
Retreive all of the PaymentDunningRule objects in a paged fashion.
GETapi/v1/Payment/DunningRule/Paged/Detail
Retreive all of the PaymentDunningRule objects in a paged fashion with all object details.
GETapi/v1/Payment/DunningRule/{id:int}
Retrieve an instance of the PaymentDunningRule object by it's ID.
{id:int}Unique identifier for the PaymentDunningRule object.
GETapi/v1/Payment/DunningRule/{id:int}/Detail
Retreive all of the Detail objects for the specified PaymentDunningRule.
{id:int}Unique identifier for the PaymentDunningRule object.
PATCHapi/v1/Payment/DunningRule/{id:int}
Update the PaymentDunningRule object and optionally make changes to any child objects.
POSTapi/v1/Payment/DunningRule
Create a new instance of the PaymentDunningRule object.
PUTapi/v1/Payment/DunningRule/{id:int}
Update an existing instance of the PaymentDunningRule object.