TAG LINE
TAG LINE
SMALL TITLE

Account / SharePlan / Contribution

(API Version v7)


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": 25
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": 26
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": 24
Type: Number
Amount that this service has contributed to the Share Plan.
contributingUsageUnitId
"contributingUsageUnitId": 7
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.


End Points

GETAccount/SharePlan/Contribution/
Retrieve all of the AccountSharePlanContribution objects.
Retrieve all of the AccountSharePlanContribution objects.
GET Account/SharePlan/Contribution/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountSharePlanParticipationId": 9,
            "accountSharePlanParticipationName": "Sample Text Data",
            "accountServiceUsageBucketId": 27,
            "accountServiceUsageBucketName": "Sample Text Data",
            "isContributing": true,
            "contributingAmount": 2,
            "contributingUsageUnitId": 14,
            "contributingUsageUnitName": "Sample Text Data"
        }
    ]
}
GETAccount/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 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": 24,
                "accountSharePlanParticipationName": "Sample Text Data",
                "accountServiceUsageBucketId": 7,
                "accountServiceUsageBucketName": "Sample Text Data",
                "isContributing": true,
                "contributingAmount": 20,
                "contributingUsageUnitId": 2,
                "contributingUsageUnitName": "Sample Text Data"
            }
        ]
    }
}
GETAccount/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 Account/SharePlan/Contribution/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountSharePlanParticipationId": 12,
        "accountSharePlanParticipationName": "Sample Text Data",
        "accountServiceUsageBucketId": 21,
        "accountServiceUsageBucketName": "Sample Text Data",
        "isContributing": true,
        "contributingAmount": 12,
        "contributingUsageUnitId": 7,
        "contributingUsageUnitName": "Sample Text Data"
    }
}