TAG LINE
SMALL TITLE

Payment / Action Type

(API Version v3)


System actions that are taken during the dunning process such as "apply late fee".


What can you do with PaymentActionType?


Properties

Property Details
identity
READ-ONLY
"identity": 25
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": 2
Type: Number
Unused


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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
  • sortOrder

End Points

GETapi/v3/Payment/ActionType/
Retrieve all of the PaymentActionType objects.
Retrieve all of the PaymentActionType objects.
GET api/v3/Payment/ActionType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Apply late fee",
            "sortOrder": 24
        }
    ]
}
GETapi/v3/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 api/v3/Payment/ActionType/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,
                "name": "Apply late fee",
                "sortOrder": 20
            }
        ]
    }
}
GETapi/v3/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 api/v3/Payment/ActionType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Apply late fee",
        "sortOrder": 3
    }
}