TAG LINE
SMALL TITLE
The user defined statuses that can be configured and assigned to an Account. Their meaning is then tied to a base status type to determine if it is billable, non-billable or cancelled.
identity READ-ONLY | "identity": 3 Type: Number This is the unique numeric identifier for the AccountStatusType |
name | "name": "Hello World" Type: String The user defined name given to this status type. |
ownerId READ-ONLY | "ownerId": 1 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. |
isDefault | "isDefault": true Type: Boolean Should this status be used as the default status type. |
preventChanges | "preventChanges": true Type: Boolean If true, a service is assigned this status then the Account will be locked down to prevent changes. |
baseBillingStatusTypeId | "baseBillingStatusTypeId": 3 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. |
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:
| DELETE | api/v3/Account/StatusType/{id} |
| Delete an instance of the AccountStatusType 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 AccountStatusType object. |
Delete an instance of the AccountStatusType object. DELETE api/v3/Account/StatusType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "accountStatusType"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v3/Account/StatusType/ |
| Retrieve all of the AccountStatusType objects. | |
Retrieve all of the AccountStatusType objects. GET api/v3/Account/StatusType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"ownerId": 14,
"ownerName": "Sample Text Data",
"isDefault": true,
"preventChanges": true,
"baseBillingStatusTypeId": 27,
"baseBillingStatusTypeName": "Sample Text Data"
}
]
} | |
| GET | api/v3/Account/StatusType/Paged |
| Retrieve all of the AccountStatusType 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 AccountStatusType objects in a paged fashion. GET api/v3/Account/StatusType/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": "Sample Text Data",
"ownerId": 14,
"ownerName": "Sample Text Data",
"isDefault": true,
"preventChanges": true,
"baseBillingStatusTypeId": 14,
"baseBillingStatusTypeName": "Sample Text Data"
}
]
}
} | |
| GET | api/v3/Account/StatusType/{id} |
| Retrieve an instance of the AccountStatusType object by its ID. | |
| {id} | Unique identifier for the AccountStatusType object. |
Retrieve an instance of the AccountStatusType object by its ID. GET api/v3/Account/StatusType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Sample Text Data",
"ownerId": 7,
"ownerName": "Sample Text Data",
"isDefault": true,
"preventChanges": true,
"baseBillingStatusTypeId": 3,
"baseBillingStatusTypeName": "Sample Text Data"
}
} | |
| POST | api/v3/Account/StatusType/ |
| Create a new instance of the AccountStatusType object. | |
Create a new instance of the AccountStatusType object. POST api/v3/Account/StatusType/
{
"name": "Sample Text Data",
"isDefault": true,
"preventChanges": true,
"baseBillingStatusTypeId": 16
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"ownerId": 25,
"ownerName": "Sample Text Data",
"isDefault": true,
"preventChanges": true,
"baseBillingStatusTypeId": 23,
"baseBillingStatusTypeName": "Sample Text Data"
}
]
}
} | |
| PUT | api/v3/Account/StatusType/{id} |
| Update an existing instance of the AccountStatusType object. | |
Update an existing instance of the AccountStatusType object. PUT api/v3/Account/StatusType/{id}
{
"identity": 1,
"name": "Sample Text Data",
"isDefault": true,
"preventChanges": true,
"baseBillingStatusTypeId": 16
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"ownerId": 19,
"ownerName": "Sample Text Data",
"isDefault": true,
"preventChanges": true,
"baseBillingStatusTypeId": 18,
"baseBillingStatusTypeName": "Sample Text Data"
}
]
}
} | |