TAG LINE
SMALL TITLE
Version 4 APIs
APIs based on the latest platform version 10.3.X
Version 3 APIs
APIs based on platform version 10.2.1
Version 2 APIs
APIs based on platform version 10.2.0

Account / Summary

(API Version v3)

What can you do with AccountSummary?

Properties

Property Details
identity
READ-ONLY
"identity": 0
Type: Number
This is the unique numeric identifier for the AccountSummary
accountId
"accountId": 15
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": 4
Type: Number
tax
"tax": 1
Type: Number
discount
"discount": 10
Type: Number
payment
"payment": 8
Type: Number
credit
"credit": 26
Type: Number
balanceDue
"balanceDue": 15
Type: Number

Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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

End Points

GETapi/v3/Account/Summary/
Retrieve all of the AccountSummary objects.
Retrieve all of the AccountSummary objects.
GET api/v3/Account/Summary/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountId": 9,
            "accountName": "Sample Text Data",
            "balance": 24,
            "charge": 24,
            "tax": 7,
            "discount": 7,
            "payment": 9,
            "credit": 26,
            "balanceDue": 19
        }
    ]
}
GETapi/v3/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/v3/Account/Summary/Paged
View Sample Response
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": 0,
                "accountName": "Sample Text Data",
                "balance": 26,
                "charge": 16,
                "tax": 14,
                "discount": 13,
                "payment": 27,
                "credit": 17,
                "balanceDue": 18
            }
        ]
    }
}
GETapi/v3/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/v3/Account/Summary/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountId": 26,
        "accountName": "Sample Text Data",
        "balance": 22,
        "charge": 2,
        "tax": 2,
        "discount": 2,
        "payment": 10,
        "credit": 27,
        "balanceDue": 15
    }
}