TAG LINE
SMALL TITLE

Account / Summary

(API Version v1)


What can you do with AccountSummary?


Properties

Property Details
id
"id": 26
Type: Number
This is the unique numeric identifier for the AccountSummary
accountId
"accountId": 11
Type: Number
Unique identifier for the associated Account object.
balance
"balance": "Hello World"
Type: String
charge
"charge": "Hello World"
Type: String
tax
"tax": "Hello World"
Type: String
discount
"discount": "Hello World"
Type: String
payment
"payment": "Hello World"
Type: String
credit
"credit": "Hello World"
Type: String
balanceDue
"balanceDue": "Hello World"
Type: String


Update Request Filters

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:

  • accountId
  • balance
  • charge
  • tax
  • discount
  • payment
  • credit
  • balanceDue

DataFlow PATCH objects:


End Points

GETapi/v1/Account/Summary
Retrieve all of the AccountSummary objects.
GETapi/v1/Account/Summary/Paged
Retreive all of the AccountSummary objects in a paged fashion.
GETapi/v1/Account/Summary/{id:int}
Retrieve an instance of the AccountSummary object by it's ID.
{id:int}Unique identifier for the AccountSummary object.
GETapi/v1/Account/Summary/{id:int}/Calculate
Retreive all of the Calculate objects for the specified AccountSummary.
{id:int}Unique identifier for the AccountSummary object.