TAG LINE
TAG LINE
SMALL TITLE
A listing of contribution details of services to a specified Share Plan on an account.
identity READ-ONLY | "identity": 4 Type: Number This is the unique numeric identifier for the AccountSharePlanContribution |
accountSharePlanParticipationId | "accountSharePlanParticipationId": 16 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": 15 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": 13 Type: Number Amount that this service has contributed to the Share Plan. |
contributingUsageUnitId | "contributingUsageUnitId": 2 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. |
| GET | Account/SharePlan/Contribution/ |
| Retrieve all of the AccountSharePlanContribution objects. | |
Retrieve all of the AccountSharePlanContribution objects. GET Account/SharePlan/Contribution/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"accountSharePlanParticipationId": 4,
"accountSharePlanParticipationName": "Sample Text Data",
"accountServiceUsageBucketId": 12,
"accountServiceUsageBucketName": "Sample Text Data",
"isContributing": true,
"contributingAmount": 18,
"contributingUsageUnitId": 2,
"contributingUsageUnitName": "Sample Text Data"
}
]
} | |
| GET | 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 Account/SharePlan/Contribution/Paged 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": 13,
"accountSharePlanParticipationName": "Sample Text Data",
"accountServiceUsageBucketId": 17,
"accountServiceUsageBucketName": "Sample Text Data",
"isContributing": true,
"contributingAmount": 25,
"contributingUsageUnitId": 16,
"contributingUsageUnitName": "Sample Text Data"
}
]
}
} | |
| GET | 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 Account/SharePlan/Contribution/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"accountSharePlanParticipationId": 0,
"accountSharePlanParticipationName": "Sample Text Data",
"accountServiceUsageBucketId": 8,
"accountServiceUsageBucketName": "Sample Text Data",
"isContributing": true,
"contributingAmount": 12,
"contributingUsageUnitId": 18,
"contributingUsageUnitName": "Sample Text Data"
}
} | |