TAG LINE
SMALL TITLE

Account / SharePlan / Contribution

(API Version v2)


A listing of contribution details of services to a specified Share Plan on an account.


What can you do with AccountSharePlanContribution?


Properties

Property Details
identity
READ-ONLY
"identity": 15
Type: Number
This is the unique numeric identifier for the AccountSharePlanContribution
accountSharePlanParticipationId
"accountSharePlanParticipationId": 13
Type: Number
Unique identifier for the associated AccountSharePlanParticipation object.
accountSharePlanParticipationName
"accountSharePlanParticipationName": "Sample Name"
Type: String
The name of the object associated with the accountSharePlanParticipationId property.
accountServiceUsageBucketId
"accountServiceUsageBucketId": 12
Type: Number
Unique identifier for the associated AccountServiceUsageBucket object.
accountServiceUsageBucketName
"accountServiceUsageBucketName": "Sample Name"
Type: String
The name of the object associated with the accountServiceUsageBucketId property.
isContributing
READ-ONLY
"isContributing": true
Type: Boolean
If this service is contributing an amount to the Share Plan.
contributingAmount
READ-ONLY
"contributingAmount": 15
Type: Number
Amount that this service has contributed to the Share Plan.
contributingUsageUnitId
"contributingUsageUnitId": 26
Type: Number
Unique identifier for the associated UsageUnit object.
contributingUsageUnitName
"contributingUsageUnitName": "Sample Name"
Type: String
The name of the object associated with the contributingUsageUnitId property.
participatingLimit
READ-ONLY
"participatingLimit": 21
Type: Number
The limit in which this service can withdraw from the Share Plan.
participatingUsageUnitId
"participatingUsageUnitId": 9
Type: Number
Unique identifier for the associated UsageUnit object.
participatingUsageUnitName
"participatingUsageUnitName": "Sample Name"
Type: String
The name of the object associated with the participatingUsageUnitId property.


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:

  • accountSharePlanParticipationId
  • accountServiceUsageBucketId
  • isContributing
  • contributingAmount
  • contributingUsageUnitId
  • participatingLimit
  • participatingUsageUnitId

End Points

GETapi/v2/Account/SharePlan/Contribution/
Retrieve all of the AccountSharePlanContribution objects.
Retrieve all of the AccountSharePlanContribution objects.
GET api/v2/Account/SharePlan/Contribution/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountSharePlanParticipationId": 17,
            "accountSharePlanParticipationName": "Sample Text Data",
            "accountServiceUsageBucketId": 7,
            "accountServiceUsageBucketName": "Sample Text Data",
            "isContributing": true,
            "contributingAmount": 27,
            "contributingUsageUnitId": 14,
            "contributingUsageUnitName": "Sample Text Data",
            "participatingLimit": 17,
            "participatingUsageUnitId": 22,
            "participatingUsageUnitName": "Sample Text Data"
        }
    ]
}
GETapi/v2/Account/SharePlan/Contribution/Paged
Retrieve all of the AccountSharePlanContribution 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 AccountSharePlanContribution objects in a paged fashion.
GET api/v2/Account/SharePlan/Contribution/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,
                "accountSharePlanParticipationId": 10,
                "accountSharePlanParticipationName": "Sample Text Data",
                "accountServiceUsageBucketId": 27,
                "accountServiceUsageBucketName": "Sample Text Data",
                "isContributing": true,
                "contributingAmount": 13,
                "contributingUsageUnitId": 13,
                "contributingUsageUnitName": "Sample Text Data",
                "participatingLimit": 10,
                "participatingUsageUnitId": 16,
                "participatingUsageUnitName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v2/Account/SharePlan/Contribution/{id}
Retrieve an instance of the AccountSharePlanContribution object by its ID.
{id}Unique identifier for the AccountSharePlanContribution object.
Retrieve an instance of the AccountSharePlanContribution object by its ID.
GET api/v2/Account/SharePlan/Contribution/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountSharePlanParticipationId": 8,
        "accountSharePlanParticipationName": "Sample Text Data",
        "accountServiceUsageBucketId": 14,
        "accountServiceUsageBucketName": "Sample Text Data",
        "isContributing": true,
        "contributingAmount": 7,
        "contributingUsageUnitId": 8,
        "contributingUsageUnitName": "Sample Text Data",
        "participatingLimit": 26,
        "participatingUsageUnitId": 0,
        "participatingUsageUnitName": "Sample Text Data"
    }
}