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

(API Version v4)

What can you do with AccountSummary?

Properties

Property Details
identity
READ-ONLY
"identity": 24
Type: Number
This is the unique numeric identifier for the AccountSummary
accountId
"accountId": 21
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": 5
Type: Number
charge
"charge": 22
Type: Number
tax
"tax": 7
Type: Number
discount
"discount": 19
Type: Number
payment
"payment": 18
Type: Number
credit
"credit": 3
Type: Number
balanceDue
"balanceDue": 23
Type: Number

End Points

GETapi/v4/Account/Summary/
Retrieve all of the AccountSummary objects.
Retrieve all of the AccountSummary objects.
GET api/v4/Account/Summary/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountId": 18,
            "accountName": "Sample Text Data",
            "balance": 18,
            "charge": 24,
            "tax": 26,
            "discount": 25,
            "payment": 7,
            "credit": 18,
            "balanceDue": 14
        }
    ]
}
GETapi/v4/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/v4/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": 8,
                "accountName": "Sample Text Data",
                "balance": 7,
                "charge": 15,
                "tax": 4,
                "discount": 2,
                "payment": 6,
                "credit": 3,
                "balanceDue": 6
            }
        ]
    }
}
GETapi/v4/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/v4/Account/Summary/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountId": 9,
        "accountName": "Sample Text Data",
        "balance": 5,
        "charge": 19,
        "tax": 25,
        "discount": 19,
        "payment": 0,
        "credit": 21,
        "balanceDue": 19
    }
}
POSTapi/v4/Account/Summary/Search
Retreive a list of AccountSummary 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 AccountSummary objects based on search criteria.
POST api/v4/Account/Summary/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,
            "accountId": 15,
            "accountName": "Sample Text Data",
            "balance": 20,
            "charge": 6,
            "tax": 9,
            "discount": 15,
            "payment": 9,
            "credit": 24,
            "balanceDue": 19
        }
    ]
}