Account / Summary

(API Version v3)

What can you do with AccountSummary?

GET api/v3/Account/Summary/
Retrieve all of the AccountSummary objects.
GET api/v3/Account/Summary/Paged
Retrieve all of the AccountSummary objects in a paged fashion.
GET api/v3/Account/Summary/{id}
Retrieve an instance of the AccountSummary object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 16 Type: Number This is the unique numeric identifier for the AccountSummary
accountId	"accountId": 5 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": 10 Type: Number
tax	"tax": 3 Type: Number
discount	"discount": 21 Type: Number
payment	"payment": 5 Type: Number
credit	"credit": 10 Type: Number
balanceDue	"balanceDue": 14 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

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": 23,
            "accountName": "Sample Text Data",
            "balance": 5,
            "charge": 15,
            "tax": 2,
            "discount": 12,
            "payment": 13,
            "credit": 7,
            "balanceDue": 4
        }
    ]
}

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": 13,
                "accountName": "Sample Text Data",
                "balance": 0,
                "charge": 17,
                "tax": 4,
                "discount": 3,
                "payment": 26,
                "credit": 26,
                "balanceDue": 11
            }
        ]
    }
}

GET	api/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": 21, "accountName": "Sample Text Data", "balance": 1, "charge": 10, "tax": 14, "discount": 15, "payment": 17, "credit": 6, "balanceDue": 3 } }