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 / Contract / Status Type

(API Version v3)

This object lists the different types of contract status types such as "Active" or "Expired".

What can you do with AccountContractStatusType?

Properties

Property Details
identity
READ-ONLY
"identity": 7
Type: Number
This is the unique numeric identifier for the AccountContractStatusType
ownerId
READ-ONLY
"ownerId": 24
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": "Expires at End of Term"
Type: String
The name given to the Status Type. The user can name a status type whatever they like, the actions associated with the Status Type will be determined by the system statusTypeId.
statusTypeId
"statusTypeId": 6
Type: Number
Unique identifier for the associated StatusType object.
statusTypeName
"statusTypeName": "Sample Name"
Type: String
The name of the object associated with the statusTypeId property.
sortOrder
READ-ONLY
"sortOrder": 3
Type: Number
Unused field and can be ignored

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:

  • identity
  • name
  • statusTypeId
  • sortOrder

End Points

DELETEapi/v3/Account/Contract/StatusType/{id}
Delete an instance of the AccountContractStatusType 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 AccountContractStatusType object.
Delete an instance of the AccountContractStatusType object.
DELETE api/v3/Account/Contract/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": "accountContractStatusType"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v3/Account/Contract/StatusType/
Retrieve all of the AccountContractStatusType objects.
Retrieve all of the AccountContractStatusType objects.
GET api/v3/Account/Contract/StatusType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 16,
            "ownerName": "Sample Text Data",
            "name": "Expires at End of Term",
            "statusTypeId": 21,
            "statusTypeName": "Sample Text Data",
            "sortOrder": 18
        }
    ]
}
GETapi/v3/Account/Contract/StatusType/Paged
Retrieve all of the AccountContractStatusType 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 AccountContractStatusType objects in a paged fashion.
GET api/v3/Account/Contract/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": 27,
                "ownerName": "Sample Text Data",
                "name": "Expires at End of Term",
                "statusTypeId": 19,
                "statusTypeName": "Sample Text Data",
                "sortOrder": 7
            }
        ]
    }
}
GETapi/v3/Account/Contract/StatusType/{id}
Retrieve an instance of the AccountContractStatusType object by its ID.
{id}Unique identifier for the AccountContractStatusType object.
Retrieve an instance of the AccountContractStatusType object by its ID.
GET api/v3/Account/Contract/StatusType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 18,
        "ownerName": "Sample Text Data",
        "name": "Expires at End of Term",
        "statusTypeId": 4,
        "statusTypeName": "Sample Text Data",
        "sortOrder": 3
    }
}
POSTapi/v3/Account/Contract/StatusType/
Create a new instance of the AccountContractStatusType object.
Create a new instance of the AccountContractStatusType object.
POST api/v3/Account/Contract/StatusType/

{
    "name": "Expires at End of Term",
    "statusTypeId": 19
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 27,
                "ownerName": "Sample Text Data",
                "name": "Expires at End of Term",
                "statusTypeId": 0,
                "statusTypeName": "Sample Text Data",
                "sortOrder": 1
            }
        ]
    }
}
PUTapi/v3/Account/Contract/StatusType/{id}
Update an existing instance of the AccountContractStatusType object.
Update an existing instance of the AccountContractStatusType object.
PUT api/v3/Account/Contract/StatusType/{id}

{
    "identity": 1,
    "name": "Expires at End of Term",
    "statusTypeId": 16
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 21,
                "ownerName": "Sample Text Data",
                "name": "Expires at End of Term",
                "statusTypeId": 14,
                "statusTypeName": "Sample Text Data",
                "sortOrder": 13
            }
        ]
    }
}