This operation transfers the Contribution case details from external system to ePlanning system.
CaseID required | string A fully qualified Contributions case number, format CON-xxxx. |
stepName required | string <= 32 characters This indicates the steps involved in the contributions case lifecycle. These are given in the sequence as expected by the ePlanning system. To update the values for any step, the respective stepName and all corresponding data should be sent. Please refer to the reference data API for the latest values. Example values are 1.PlanAndDevelopment , 2.TotalUnits , 3.CalculateContribution , 4.FinaliseContribution . |
isOverridePlans | boolean This is to track whether the consent authority has chosen to override automatically identified contributions plans. This attribute is applicable when stepName = 'PlanAndDevelopment' and unapplicable for other steps. When true is provided, plans sent by consent authority will be considered for processing. When false is provided, plans sent by consent authority will be ignored. When case is initiated by consent authority manually or via CreateContribution request to ePlanning system, this is not applicable and will be ignored. |
planOverrideReason | string <= 256 characters This is to track the reason why consent authority chooses to override the system identified contributions plans. This is applicable and required for stepName = 'PlanAndDevelopment' and when isOverridePlans = true. It will be ignored for any other stepName. When case is initiated by consent authority, this is not applicable and will be ignored. Please refer to the reference data API for the latest values. Example values are - 1.New, revised contributions framework(s) apply 2.Different contributions framework(s) apply 3.Additional contributions framework(s) apply 4.Other |
planOverrideReasonDescription | string <= 2000 characters This indicates the detailed description for overriding the plans. This is applicable and required for stepName = 'PlanAndDevelopment' when isOverridePlans = true & planOverrideReason = Other. It will be ignored for any other stepName. When case is initiated by consent authority, this is not applicable and will be ignored. |
Array of objects This is to track the list of contribution plan identifiers. It is applicable and required for stepName = 'PlanAndDevelopment' & when isOverridePlans = true. This will be ignored for any other stepName. This is also required when case is initiated by consent authority manually or via CreateContribution request to ePlanning. Please refer to the reference data API for the latest values. | |
previousContributionInformation | Array of strings <= 2048 characters This is to track the previous arrangements which may impact contributions for new development. This attribute is applicable when stepName = 'PlanAndDevelopment' and will be ignored for any other stepName. Example values are - 1.Previous payment made for state contributions, 2.State planning agreement applies to the development. |
isOverrideApplicantInputs | boolean This is to track if consent authority has chosen to update development inputs provided by applicant. This attribute is applicable when stepName = 'PlanAndDevelopment' and will be ignored for any other stepName. When true is provided, development details shared by consent authority will be considered for processing. When false is provided, development details shared by consent authority will be ignored. When case is initiated by consent authority manually or via CreateContribution request to ePlanning system, this is not applicable and will be ignored. |
Array of objects This is applicable when stepName = 'PlanAndDevelopment' and isOverrideApplicantInputs is 'true' and will be ignored for any other stepName. If consent authority does not provide any data for this condition then ePlanning system processes data if provided by the applicant for this case. Please refer to the reference data API for the latest values. | |
Array of objects This is to track the number of stages of development in a Contribution case. This is applicable and required when stepName = 'PlanAndDevelopment' OR 'TotalUnits' OR 'CalculateContribution'. Note- multiple stages are not applicable under a Complying Develoment Certificate parent application. | |
isFinaliseContribution | boolean This is applicable and required when stepName = 'FinaliseContribution'. By providing 'true' for this attribute, consent authority is agreeing to all required declaration on the Housing and Productivity contribution calculation and accompanying documents is correct. The case will be closed and contribution details cannot be changed or revised once this attribute is submitted as 'true'. |
Array of objects (DownloadableDocument) This is applicable for all the steps and not mandatory. But, please note that for StepName = 'PlanAndDevelopment', previousContributionsInformation is required to upload a document and for stepName = 'CalculateContribution', assessedAmount should be greater than $0.00 to upload a document. | |
updatedByEmail required | string <= 250 characters This is to track the Email ID of the user triggering the request. User must be registered in the planning portal. |
{- "stepName": "string",
- "isOverridePlans": true,
- "planOverrideReason": "string",
- "planOverrideReasonDescription": "string",
- "contributionPlans": [
- {
- "planId": "string"
}
], - "previousContributionInformation": [
- "string"
], - "isOverrideApplicantInputs": true,
- "proposedDevelopment": [
- {
- "developmentCategory": "string",
- "developmentTypes": [
- {
- "developmentType": "string"
}
]
}
], - "stages": [
- {
- "proposedDevelopmentUses": [
- {
- "planId": "string",
- "developmentType": "string",
- "unitOfCharge": "string",
- "totalUnits": 0
}
], - "isExistingDevelopment": true,
- "existingDevelopment": [
- {
- "developmentCategory": "string",
- "developmentTypes": [
- {
- "developmentType": "string"
}
]
}
], - "existingDevelopmentUses": [
- {
- "planId": "string",
- "developmentType": "string",
- "unitOfCharge": "string",
- "totalUnits": 0
}
], - "contributionAssessmentDetails": [
- {
- "planId": "string",
- "assessedAmount": 0,
- "timingOfPayment": "string",
- "assessedAmountReason": "string"
}
], - "assessedAmountReasonDescription": "string"
}
], - "isFinaliseContribution": true,
- "documents": [
- {
- "documentName": "string",
- "documentType": "string",
- "uploadedDateTime": "2019-08-24T14:15:22Z",
}
], - "updatedByEmail": "string"
}
{- "statusCode": 200,
- "message": "Request is successful.",
- "activityId": "CON-1104",
- "details": "Inner Exceptions, Stack Trace, Json Schema etc"
}