Skip to main content
POST
Add a proposal to a draft plan or change one (FA_CPA_PA_4).

Headers

Prefer
enum<string>

Preference

Available options:
params=single-object

Body

Add a proposal to a draft plan or change one (FA_CPA_PA_4).

Adding a proposal needs finance.capex_scheme.create; changing one needs finance.capex_scheme.edit, or finance.capex_scheme.create for a proposal sent back to you for revision.

Give the proposal's value as p_fresh_sanction_amount, the new money asked for in the plan's year, and p_approved_carryover_amount, what was approved in an earlier year and is carried into this one: the proposal value is then their sum, either one left out counts as zero, and p_scheme_value is not read. Give neither and p_scheme_value is the value, and the two amounts a proposal already has are kept only while they still add up to it. p_category_master_id (the Category) and p_budget_category_id (the Sub-Category) are values of your organisation's lists named Category Master and Sub-Category Master; one the proposal already holds is kept even after it is retired from its list. Saving a proposal without them leaves it with none.

Every amount can have at most ten digits before the decimal point and two after it, 9,999,999,999.99 at the widest, and so can the proposal value they add up to; a wider one, or one with a third decimal, is refused as INVALID_LINE naming the field. An amount the proposal already holds, sent back unchanged, is kept whatever its width.

The Proposal ID is given when it is left empty, and a typed one is refused where the organisation has said IDs are always given. A proposal consolidated from another quotes that proposal's ID, whatever p_investment_type or p_carried_from_line_id it is later saved with. A carry forward quotes the ID of the proposal it continues, and an ID it took that way goes with the link: change p_carried_from_line_id or p_investment_type so that it continues another proposal or none, and it takes that proposal's ID or is given a new one, even when the ID it had is sent back as p_scheme_code. Where IDs are always given, a proposal that was not consolidated from another and comes to continue one takes that one's ID whatever ID it had. The category is worked out from the proposal value divided by the quantity and is not taken from p_category, which is kept only so that older callers are not refused; p_category_two_id and p_department_id are kept for the same reason and read by nothing, since a proposal no longer has a Category 2 or a department of its own; the department is the plan's. Returns the proposal's ID and category as saved.

p_capex_plan_id
string<uuid>
required
p_justification
string<text>
required
p_name
string<text>
required
p_approved_carryover_amount
number<numeric>
p_asset_class_id
string<uuid>
p_budget_category_id
string<uuid>
p_capex_nature_id
string<uuid>
p_carried_actual_amount
number<numeric>
p_carried_from_line_id
string<uuid>
p_category
string<text>
p_category_master_id
string<uuid>
p_category_two_id
string<uuid>
p_coordinator_user_id
string<uuid>
p_cost_center_id
string<uuid>
p_department_id
string<uuid>
p_depreciation_rate
number<numeric>
p_description
string<text>
p_fresh_sanction_amount
number<numeric>
p_investment_type
string<text>
p_line_id
string<uuid>
p_location_id
string<uuid>
p_original_sanction_amount
number<numeric>
p_priority
string<text>
p_quantity
number<numeric>
p_scheme_code
string<text>
p_scheme_value
number<numeric>
p_site_id
string<uuid>

Response

200

OK