TAG LINE
TAG LINE
SMALL TITLE

Account / Summary

(API Version v6)


What can you do with AccountSummary?


Properties

Property Details
identity
READ-ONLY
"identity": 7
Type: Number
This is the unique numeric identifier for the AccountSummary
accountId
"accountId": 11
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.
balance
"balance": 10
Type: Number
charge
"charge": 16
Type: Number
tax
"tax": 13
Type: Number
discount
"discount": 8
Type: Number
payment
"payment": 25
Type: Number
credit
"credit": 16
Type: Number
balanceDue
"balanceDue": 1
Type: Number


End Points

GETapi/v6/Account/Summary/
Retrieve all of the AccountSummary objects.
Retrieve all of the AccountSummary objects.
GET api/v6/Account/Summary/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountId": 0,
            "accountName": "Sample Text Data",
            "balance": 24,
            "charge": 27,
            "tax": 0,
            "discount": 9,
            "payment": 12,
            "credit": 16,
            "balanceDue": 22
        }
    ]
}
GETapi/v6/Account/Summary/Paged
Retrieve all of the AccountSummary 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 AccountSummary objects in a paged fashion.
GET api/v6/Account/Summary/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": 24,
                "accountName": "Sample Text Data",
                "balance": 9,
                "charge": 5,
                "tax": 24,
                "discount": 10,
                "payment": 17,
                "credit": 7,
                "balanceDue": 25
            }
        ]
    }
}
GETapi/v6/Account/Summary/{id}
Retrieve an instance of the AccountSummary object by its ID.
{id}Unique identifier for the AccountSummary object.
Retrieve an instance of the AccountSummary object by its ID.
GET api/v6/Account/Summary/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountId": 23,
        "accountName": "Sample Text Data",
        "balance": 25,
        "charge": 8,
        "tax": 14,
        "discount": 17,
        "payment": 13,
        "credit": 15,
        "balanceDue": 25
    }
}