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