TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 27 Type: Number This is the unique numeric identifier for the AccountSummary |
accountId | "accountId": 3 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": 26 Type: Number |
charge | "charge": 27 Type: Number |
tax | "tax": 17 Type: Number |
discount | "discount": 11 Type: Number |
payment | "payment": 1 Type: Number |
credit | "credit": 24 Type: Number |
balanceDue | "balanceDue": 10 Type: Number |
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:
| GET | api/v3/Account/Summary/ |
| Retrieve all of the AccountSummary objects. | |
Retrieve all of the AccountSummary objects. GET api/v3/Account/Summary/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"accountId": 6,
"accountName": "Sample Text Data",
"balance": 12,
"charge": 8,
"tax": 27,
"discount": 10,
"payment": 21,
"credit": 24,
"balanceDue": 5
}
]
} | |
| GET | api/v3/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/v3/Account/Summary/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,
"accountId": 17,
"accountName": "Sample Text Data",
"balance": 26,
"charge": 26,
"tax": 7,
"discount": 21,
"payment": 10,
"credit": 1,
"balanceDue": 19
}
]
}
} | |
| GET | api/v3/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/v3/Account/Summary/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"accountId": 1,
"accountName": "Sample Text Data",
"balance": 1,
"charge": 27,
"tax": 18,
"discount": 0,
"payment": 5,
"credit": 12,
"balanceDue": 24
}
} | |