TAG LINE
SMALL TITLE

Payment / Dunning Rule

(API Version v3)


What can you do with PaymentDunningRule?


Properties

Property Details
id
"id": 19
Type: Number
This is the unique numeric identifier for the PaymentDunningRule
ownerId
"ownerId": 3
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

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the PaymentDunningRule object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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