TAG LINE
TAG LINE
SMALL TITLE
System actions that are taken during the dunning process such as "apply late fee".
identity READ-ONLY | "identity": 19 Type: Number This is the unique numeric identifier for the PaymentActionType |
name READ-ONLY | "name": "Apply late fee" Type: String System defined name for the Action Type. |
sortOrder READ-ONLY | "sortOrder": 23 Type: Number Unused |
| GET | Payment/ActionType/ |
| Retrieve all of the PaymentActionType objects. | |
Retrieve all of the PaymentActionType objects. GET Payment/ActionType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Apply late fee",
"sortOrder": 8
}
]
} | |
| GET | Payment/ActionType/Paged |
| Retrieve all of the PaymentActionType 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 PaymentActionType objects in a paged fashion. GET Payment/ActionType/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Apply late fee",
"sortOrder": 16
}
]
}
} | |
| GET | Payment/ActionType/{id} |
| Retrieve an instance of the PaymentActionType object by its ID. | |
| {id} | Unique identifier for the PaymentActionType object. |
Retrieve an instance of the PaymentActionType object by its ID. GET Payment/ActionType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Apply late fee",
"sortOrder": 20
}
} | |