TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 9 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": 14 Type: Number |
charge | "charge": 25 Type: Number |
tax | "tax": 25 Type: Number |
discount | "discount": 10 Type: Number |
payment | "payment": 23 Type: Number |
credit | "credit": 19 Type: Number |
balanceDue | "balanceDue": 24 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": 24,
"accountName": "Sample Text Data",
"balance": 11,
"charge": 24,
"tax": 5,
"discount": 12,
"payment": 17,
"credit": 23,
"balanceDue": 4
}
]
} | |
| 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": 20,
"accountName": "Sample Text Data",
"balance": 15,
"charge": 0,
"tax": 15,
"discount": 3,
"payment": 25,
"credit": 20,
"balanceDue": 7
}
]
}
} | |
| 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": 2,
"accountName": "Sample Text Data",
"balance": 24,
"charge": 2,
"tax": 14,
"discount": 19,
"payment": 12,
"credit": 5,
"balanceDue": 8
}
} | |
| 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": 0,
"accountName": "Sample Text Data",
"balance": 26,
"charge": 5,
"tax": 26,
"discount": 11,
"payment": 10,
"credit": 10,
"balanceDue": 5
}
]
} | |