TAG LINE
SMALL TITLE

Account / SharePlan / Contribution

(API Version v4)


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": 10
Type: Number
This is the unique numeric identifier for the AccountSharePlanContribution
accountSharePlanParticipationId
"accountSharePlanParticipationId": 7
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": 24
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": 4
Type: Number
Amount that this service has contributed to the Share Plan.
contributingUsageUnitId
"contributingUsageUnitId": 8
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": 19
Type: Number
The limit in which this service can withdraw from the Share Plan.
participatingUsageUnitId
"participatingUsageUnitId": 22
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.


End Points

GETapi/v4/Account/SharePlan/Contribution/
Retrieve all of the AccountSharePlanContribution objects.
Retrieve all of the AccountSharePlanContribution objects.
GET api/v4/Account/SharePlan/Contribution/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountSharePlanParticipationId": 6,
            "accountSharePlanParticipationName": "Sample Text Data",
            "accountServiceUsageBucketId": 2,
            "accountServiceUsageBucketName": "Sample Text Data",
            "isContributing": true,
            "contributingAmount": 27,
            "contributingUsageUnitId": 23,
            "contributingUsageUnitName": "Sample Text Data",
            "participatingLimit": 19,
            "participatingUsageUnitId": 2,
            "participatingUsageUnitName": "Sample Text Data"
        }
    ]
}
GETapi/v4/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/v4/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": 17,
                "accountSharePlanParticipationName": "Sample Text Data",
                "accountServiceUsageBucketId": 23,
                "accountServiceUsageBucketName": "Sample Text Data",
                "isContributing": true,
                "contributingAmount": 2,
                "contributingUsageUnitId": 15,
                "contributingUsageUnitName": "Sample Text Data",
                "participatingLimit": 14,
                "participatingUsageUnitId": 19,
                "participatingUsageUnitName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/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/v4/Account/SharePlan/Contribution/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountSharePlanParticipationId": 0,
        "accountSharePlanParticipationName": "Sample Text Data",
        "accountServiceUsageBucketId": 18,
        "accountServiceUsageBucketName": "Sample Text Data",
        "isContributing": true,
        "contributingAmount": 23,
        "contributingUsageUnitId": 0,
        "contributingUsageUnitName": "Sample Text Data",
        "participatingLimit": 20,
        "participatingUsageUnitId": 11,
        "participatingUsageUnitName": "Sample Text Data"
    }
}
POSTapi/v4/Account/SharePlan/Contribution/Search
Retreive a list of AccountSharePlanContribution objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of AccountSharePlanContribution objects based on search criteria.
POST api/v4/Account/SharePlan/Contribution/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "accountSharePlanParticipationId": 6,
            "accountSharePlanParticipationName": "Sample Text Data",
            "accountServiceUsageBucketId": 27,
            "accountServiceUsageBucketName": "Sample Text Data",
            "isContributing": true,
            "contributingAmount": 11,
            "contributingUsageUnitId": 20,
            "contributingUsageUnitName": "Sample Text Data",
            "participatingLimit": 3,
            "participatingUsageUnitId": 15,
            "participatingUsageUnitName": "Sample Text Data"
        }
    ]
}