TAG LINE
SMALL TITLE

Service / Base Type

(API Version v2)


Represents an internal base type such as "recurring charge", "non-recurring charge" or "fee".


What can you do with ServiceBaseType?


Properties

Property Details
identity
READ-ONLY
"identity": 8
Type: Number
This is the unique numeric identifier for the ServiceBaseType
name
READ-ONLY
"name": "Recurring Charge"
Type: String
System defined name for the Base Type.
sortOrder
READ-ONLY
"sortOrder": 2
Type: Number
Unused
tokenName
READ-ONLY
"tokenName": "Hello World"
Type: String
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
  • tokenName

End Points

GETapi/v2/Service/BaseType/
Retrieve all of the ServiceBaseType objects.
Retrieve all of the ServiceBaseType objects.
GET api/v2/Service/BaseType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Recurring Charge",
            "sortOrder": 26,
            "tokenName": "Sample Text Data"
        }
    ]
}
GETapi/v2/Service/BaseType/Paged
Retrieve all of the ServiceBaseType 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 ServiceBaseType objects in a paged fashion.
GET api/v2/Service/BaseType/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": "Recurring Charge",
                "sortOrder": 10,
                "tokenName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v2/Service/BaseType/{id}
Retrieve an instance of the ServiceBaseType object by its ID.
{id}Unique identifier for the ServiceBaseType object.
Retrieve an instance of the ServiceBaseType object by its ID.
GET api/v2/Service/BaseType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Recurring Charge",
        "sortOrder": 19,
        "tokenName": "Sample Text Data"
    }
}