TAG LINE
SMALL TITLE
An Account Type is a user defined list of possible account types you wish to specify in the system. Examples are "Partner", "Customer", "Reseller" etc.
identity READ-ONLY | "identity": 19 Type: Number This is the unique numeric identifier for the AccountType |
ownerId READ-ONLY | "ownerId": 10 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": "Customer" Type: String User defined name given to the Account Type. |
isDefault | "isDefault": true Type: Boolean Whether or not this Account Type is considered the default one used on data entry. |
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/v2/AccountType/{id} |
| Delete an instance of the AccountType 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 AccountType object. |
Delete an instance of the AccountType object. DELETE api/v2/AccountType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "accountType"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v2/AccountType/ |
| Retrieve all of the AccountType objects. | |
Retrieve all of the AccountType objects. GET api/v2/AccountType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 7,
"ownerName": "Sample Text Data",
"name": "Customer",
"isDefault": true
}
]
} | |
| GET | api/v2/AccountType/Paged |
| Retrieve all of the AccountType 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 AccountType objects in a paged fashion. GET api/v2/AccountType/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,
"ownerId": 24,
"ownerName": "Sample Text Data",
"name": "Customer",
"isDefault": true
}
]
}
} | |
| GET | api/v2/AccountType/{id} |
| Retrieve an instance of the AccountType object by its ID. | |
| {id} | Unique identifier for the AccountType object. |
Retrieve an instance of the AccountType object by its ID. GET api/v2/AccountType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 6,
"ownerName": "Sample Text Data",
"name": "Customer",
"isDefault": true
}
} | |
| POST | api/v2/AccountType/ |
| Create a new instance of the AccountType object. | |
Create a new instance of the AccountType object. POST api/v2/AccountType/
{
"name": "Customer",
"isDefault": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 8,
"ownerName": "Sample Text Data",
"name": "Customer",
"isDefault": true
}
]
}
} | |
| PUT | api/v2/AccountType/{id} |
| Update an existing instance of the AccountType object. | |
Update an existing instance of the AccountType object. PUT api/v2/AccountType/{id}
{
"identity": 1,
"name": "Customer",
"isDefault": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 2,
"ownerName": "Sample Text Data",
"name": "Customer",
"isDefault": true
}
]
}
} | |