TAG LINE
SMALL TITLE

Payment / Dunning Rule

(API Version v4)


Represents user defined dunning rules.


What can you do with PaymentDunningRule?


Properties

Property Details
identity
READ-ONLY
"identity": 19
Type: Number
This is the unique numeric identifier for the PaymentDunningRule
ownerId
READ-ONLY
"ownerId": 13
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
name
"name": "Apply Late Fee"
Type: String
User defined name for the Dunning Rule.
isActive
"isActive": true
Type: Boolean
Whether or not this Dunning Rule is active and can be assigned to an AR Term.
minimumOverdue
"minimumOverdue": 1456
Type: Number
The minimum outstanding balance that needs to be met before the Dunning Rule takes effect.


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/v4/Payment/DunningRule/{id}
Delete an instance of the PaymentDunningRule object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the PaymentDunningRule object.
Delete an instance of the PaymentDunningRule object.
DELETE api/v4/Payment/DunningRule/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "paymentDunningRule"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Payment/DunningRule/
Retrieve all of the PaymentDunningRule objects.
Retrieve all of the PaymentDunningRule objects.
GET api/v4/Payment/DunningRule/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 10,
            "ownerName": "Sample Text Data",
            "name": "Apply Late Fee",
            "isActive": true,
            "minimumOverdue": 1456
        }
    ]
}
GETapi/v4/Payment/DunningRule/Paged
Retrieve all of the PaymentDunningRule objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the PaymentDunningRule objects in a paged fashion.
GET api/v4/Payment/DunningRule/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 17,
                "ownerName": "Sample Text Data",
                "name": "Apply Late Fee",
                "isActive": true,
                "minimumOverdue": 1456
            }
        ]
    }
}
GETapi/v4/Payment/DunningRule/Paged/Detail
Retrieve all of the PaymentDunningRule objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the PaymentDunningRule objects in a paged fashion with all object details.
GET api/v4/Payment/DunningRule/Paged/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 27,
                "ownerName": "Sample Text Data",
                "name": "Apply Late Fee",
                "isActive": true,
                "minimumOverdue": 1456,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v4/Payment/DunningRule/{id}
Retrieve an instance of the PaymentDunningRule object by its ID.
{id}Unique identifier for the PaymentDunningRule object.
Retrieve an instance of the PaymentDunningRule object by its ID.
GET api/v4/Payment/DunningRule/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 21,
        "ownerName": "Sample Text Data",
        "name": "Apply Late Fee",
        "isActive": true,
        "minimumOverdue": 1456
    }
}
GETapi/v4/Payment/DunningRule/{id}/Detail
Retrieve deep detail of the PaymentDunningRule object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the PaymentDunningRule object.
Retrieve deep detail of the PaymentDunningRule object by its ID.
GET api/v4/Payment/DunningRule/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 23,
        "ownerName": "Sample Text Data",
        "name": "Apply Late Fee",
        "isActive": true,
        "minimumOverdue": 1456,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v4/Payment/DunningRule/{id}
Update or Add the PaymentDunningRule object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the PaymentDunningRule object.
Update or Add the PaymentDunningRule object and optionally make changes to any child objects.
PATCH api/v4/Payment/DunningRule/{id}

{
    "details": {},
    "paymentDunningRules": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "Apply Late Fee",
                "isActive": true,
                "minimumOverdue": 1456
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "paymentDunningRule",
                "instance": {
                    "identity": 1,
                    "ownerId": 10,
                    "ownerName": "Sample Text Data",
                    "name": "Apply Late Fee",
                    "isActive": true,
                    "minimumOverdue": 1456
                }
            }
        ]
    }
}
POSTapi/v4/Payment/DunningRule/
Create a new instance of the PaymentDunningRule object.
Create a new instance of the PaymentDunningRule object.
POST api/v4/Payment/DunningRule/

{
    "name": "Apply Late Fee",
    "isActive": true,
    "minimumOverdue": 1456
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 8,
                "ownerName": "Sample Text Data",
                "name": "Apply Late Fee",
                "isActive": true,
                "minimumOverdue": 1456
            }
        ]
    }
}
POSTapi/v4/Payment/DunningRule/Search
Retreive a list of PaymentDunningRule objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of PaymentDunningRule objects based on search criteria.
POST api/v4/Payment/DunningRule/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 19,
            "ownerName": "Sample Text Data",
            "name": "Apply Late Fee",
            "isActive": true,
            "minimumOverdue": 1456
        }
    ]
}
PUTapi/v4/Payment/DunningRule/{id}
Update an existing instance of the PaymentDunningRule object.
Update an existing instance of the PaymentDunningRule object.
PUT api/v4/Payment/DunningRule/{id}

{
    "identity": 1,
    "name": "Apply Late Fee",
    "isActive": true,
    "minimumOverdue": 1456
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 9,
                "ownerName": "Sample Text Data",
                "name": "Apply Late Fee",
                "isActive": true,
                "minimumOverdue": 1456
            }
        ]
    }
}