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