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 / Parent

(API Version v2)

This object represents the hierarchy connections between different accounts within the system.

What can you do with AccountParent?

Properties

Property Details
identity
READ-ONLY
"identity": 21
Type: Number
This is the unique numeric identifier for the AccountParent
accountId
"accountId": 7
Type: Number
Unique identifier for the associated Account object.
accountName
"accountName": "Sample Name"
Type: String
The name of the object associated with the accountId property.
parentAccountId
"parentAccountId": 13
Type: Number
Unique identifier for the associated Account object.
parentAccountName
"parentAccountName": "Sample Name"
Type: String
The name of the object associated with the parentAccountId property.
topAccountId
READ-ONLY
"topAccountId": 21
Type: Number
Unique identifier for the associated Account object.
topAccountName
READ-ONLY
"topAccountName": "Sample Name"
Type: String
The name of the object associated with the topAccountId 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:

  • identity
  • accountId
  • parentAccountId

End Points

DELETEapi/v2/Account/Parent/{id}
Delete an instance of the AccountParent 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 AccountParent object.
Delete an instance of the AccountParent object.
DELETE api/v2/Account/Parent/{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": "accountParent"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v2/Account/Parent/
Retrieve all of the AccountParent objects.
Retrieve all of the AccountParent objects.
GET api/v2/Account/Parent/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountId": 23,
            "accountName": "Sample Text Data",
            "parentAccountId": 4,
            "parentAccountName": "Sample Text Data",
            "topAccountId": 20,
            "topAccountName": "Sample Text Data"
        }
    ]
}
GETapi/v2/Account/Parent/Paged
Retrieve all of the AccountParent 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 AccountParent objects in a paged fashion.
GET api/v2/Account/Parent/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,
                "accountId": 16,
                "accountName": "Sample Text Data",
                "parentAccountId": 11,
                "parentAccountName": "Sample Text Data",
                "topAccountId": 22,
                "topAccountName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v2/Account/Parent/{id}
Retrieve an instance of the AccountParent object by its ID.
{id}Unique identifier for the AccountParent object.
Retrieve an instance of the AccountParent object by its ID.
GET api/v2/Account/Parent/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountId": 16,
        "accountName": "Sample Text Data",
        "parentAccountId": 5,
        "parentAccountName": "Sample Text Data",
        "topAccountId": 19,
        "topAccountName": "Sample Text Data"
    }
}
POSTapi/v2/Account/Parent/
Create a new instance of the AccountParent object.
Create a new instance of the AccountParent object.
POST api/v2/Account/Parent/

{
    "accountId": 23,
    "parentAccountId": 4
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 22,
                "accountName": "Sample Text Data",
                "parentAccountId": 20,
                "parentAccountName": "Sample Text Data",
                "topAccountId": 1,
                "topAccountName": "Sample Text Data"
            }
        ]
    }
}
PUTapi/v2/Account/Parent/{id}
Update an existing instance of the AccountParent object.
Update an existing instance of the AccountParent object.
PUT api/v2/Account/Parent/{id}

{
    "identity": 1,
    "accountId": 25,
    "parentAccountId": 6
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 2,
                "accountName": "Sample Text Data",
                "parentAccountId": 1,
                "parentAccountName": "Sample Text Data",
                "topAccountId": 7,
                "topAccountName": "Sample Text Data"
            }
        ]
    }
}