TAG LINE
SMALL TITLE
Version 4 APIs
APIs based on the latest platform version 10.3.X
Version 3 APIs
APIs based on platform version 10.2.1
Version 2 APIs
APIs based on platform version 10.2.0

Account / Package / Status Type

(API Version v2)

This object represents user definable statuses for account packages that are based on a main base type that has meaning.

What can you do with AccountPackageStatusType?

Properties

Property Details
identity
READ-ONLY
"identity": 12
Type: Number
This is the unique numeric identifier for the AccountPackageStatusType
ownerId
READ-ONLY
"ownerId": 22
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": "Hello World"
Type: String
The name given to the status type.
preventChanges
"preventChanges": true
Type: Boolean
If true, then the Account Package moves into a Read-only state.
baseBillingStatusTypeId
"baseBillingStatusTypeId": 16
Type: Number
Unique identifier for the associated BaseBillingStatusType object.
baseBillingStatusTypeName
"baseBillingStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the baseBillingStatusTypeId property.

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
  • preventChanges
  • baseBillingStatusTypeId

End Points

DELETEapi/v2/Account/Package/StatusType/{id}
Delete an instance of the AccountPackageStatusType 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 AccountPackageStatusType object.
Delete an instance of the AccountPackageStatusType object.
DELETE api/v2/Account/Package/StatusType/{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": "accountPackageStatusType"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v2/Account/Package/StatusType/
Retrieve all of the AccountPackageStatusType objects.
Retrieve all of the AccountPackageStatusType objects.
GET api/v2/Account/Package/StatusType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 22,
            "ownerName": "Sample Text Data",
            "name": "Sample Text Data",
            "preventChanges": true,
            "baseBillingStatusTypeId": 3,
            "baseBillingStatusTypeName": "Sample Text Data"
        }
    ]
}
GETapi/v2/Account/Package/StatusType/Paged
Retrieve all of the AccountPackageStatusType 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 AccountPackageStatusType objects in a paged fashion.
GET api/v2/Account/Package/StatusType/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": 19,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "preventChanges": true,
                "baseBillingStatusTypeId": 25,
                "baseBillingStatusTypeName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v2/Account/Package/StatusType/{id}
Retrieve an instance of the AccountPackageStatusType object by its ID.
{id}Unique identifier for the AccountPackageStatusType object.
Retrieve an instance of the AccountPackageStatusType object by its ID.
GET api/v2/Account/Package/StatusType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 20,
        "ownerName": "Sample Text Data",
        "name": "Sample Text Data",
        "preventChanges": true,
        "baseBillingStatusTypeId": 2,
        "baseBillingStatusTypeName": "Sample Text Data"
    }
}
POSTapi/v2/Account/Package/StatusType/
Create a new instance of the AccountPackageStatusType object.
Create a new instance of the AccountPackageStatusType object.
POST api/v2/Account/Package/StatusType/

{
    "name": "Sample Text Data",
    "preventChanges": true,
    "baseBillingStatusTypeId": 1
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 11,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "preventChanges": true,
                "baseBillingStatusTypeId": 13,
                "baseBillingStatusTypeName": "Sample Text Data"
            }
        ]
    }
}
PUTapi/v2/Account/Package/StatusType/{id}
Update an existing instance of the AccountPackageStatusType object.
Update an existing instance of the AccountPackageStatusType object.
PUT api/v2/Account/Package/StatusType/{id}

{
    "identity": 1,
    "name": "Sample Text Data",
    "preventChanges": true,
    "baseBillingStatusTypeId": 18
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 1,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "preventChanges": true,
                "baseBillingStatusTypeId": 23,
                "baseBillingStatusTypeName": "Sample Text Data"
            }
        ]
    }
}