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