Account / SharePlan / Contribution

(API Version v1)

What can you do with AccountSharePlanContribution?

GET api/v1/Account/SharePlan/Contribution
GET api/v1/Account/SharePlan/Contribution/Paged
GET api/v1/Account/SharePlan/Contribution/{id:int}

Properties

Property Details

id	"id": 15 Type: Number This is the unique numeric identifier for the AccountSharePlanContribution
accountSharePlanParticipationId	"accountSharePlanParticipationId": 14 Type: Number Unique identifier for the associated AccountSharePlanParticipation object.
accountServiceUsageBucketId	"accountServiceUsageBucketId": 14 Type: Number Unique identifier for the associated AccountServiceUsageBucket object.
isContributing	"isContributing": true Type: Boolean
contributingAmount	"contributingAmount": "Hello World" Type: String
contributingUsageUnitId	"contributingUsageUnitId": 7 Type: Number Unique identifier for the associated UsageUnit object.
participatingLimit	"participatingLimit": "Hello World" Type: String
participatingUsageUnitId	"participatingUsageUnitId": 5 Type: Number Unique identifier for the associated UsageUnit object.

Update Request Filters

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

DataFlow PATCH objects:

accountSharePlanContribution - create, update, delete

End Points

GET	api/v1/Account/SharePlan/Contribution
Retrieve all of the AccountSharePlanContribution objects.

GET	api/v1/Account/SharePlan/Contribution/Paged
Retreive all of the AccountSharePlanContribution objects in a paged fashion.

GET	api/v1/Account/SharePlan/Contribution/{id:int}
Retrieve an instance of the AccountSharePlanContribution object by it's ID.
{id:int}	Unique identifier for the AccountSharePlanContribution object.