TAG LINE
SMALL TITLE

Account Type

(API Version v4)


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.


What can you do with AccountType?


Properties

Property Details
identity
READ-ONLY
"identity": 6
Type: Number
This is the unique numeric identifier for the AccountType
ownerId
READ-ONLY
"ownerId": 12
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.


End Points

DELETEapi/v4/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/v4/AccountType/{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": "accountType"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/AccountType/
Retrieve all of the AccountType objects.
Retrieve all of the AccountType objects.
GET api/v4/AccountType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 21,
            "ownerName": "Sample Text Data",
            "name": "Customer",
            "isDefault": true
        }
    ]
}
GETapi/v4/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/v4/AccountType/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": 7,
                "ownerName": "Sample Text Data",
                "name": "Customer",
                "isDefault": true
            }
        ]
    }
}
GETapi/v4/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/v4/AccountType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 27,
        "ownerName": "Sample Text Data",
        "name": "Customer",
        "isDefault": true
    }
}
POSTapi/v4/AccountType/
Create a new instance of the AccountType object.
Create a new instance of the AccountType object.
POST api/v4/AccountType/

{
    "name": "Customer",
    "isDefault": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 4,
                "ownerName": "Sample Text Data",
                "name": "Customer",
                "isDefault": true
            }
        ]
    }
}
POSTapi/v4/AccountType/Search
Retreive a list of AccountType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of AccountType objects based on search criteria.
POST api/v4/AccountType/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 6,
            "ownerName": "Sample Text Data",
            "name": "Customer",
            "isDefault": true
        }
    ]
}
PUTapi/v4/AccountType/{id}
Update an existing instance of the AccountType object.
Update an existing instance of the AccountType object.
PUT api/v4/AccountType/{id}

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