> ## Documentation Index > Fetch the complete documentation index at: https://docs.assetinfinity.ai/llms.txt > Use this file to discover all available pages before exploring further. # The consolidated capex plan: one row for each capex proposal approved for the consolidation plan, made when it was… > The consolidated capex plan: one row for each capex proposal approved for the consolidation plan, made when it was approved. What the proposal decided is read off it and cannot be changed here: fiscal_year (with fiscal_calendar_name, the fiscal calendar the plan is counted on, and fiscal_year_start_month, the month that calendar starts its year in, so fiscal_year 2027 starting in April is April 2026 to March 2027), scheme_code (the Request ID), the unit and location, category_master_id and budget_category_id (the Category and Sub-Category), priority (the Item Type: VITAL, ESSENTIAL or DESIRABLE), investment_type (NEW or CARRY_FORWARD), carried_from_line_id (the Reference ID), scheme_value (the Capex Amount) and category (PROJECT, SPECIFIED, CLUBBED or FLEXIBLE). proposal_status is the proposal's: APPROVED_FOR_PLAN while it is being planned, then PLAN_APPROVED or PLAN_REJECTED. The coordinator, item_description, quantity, nature, fresh_sanction_amount, approved_carryover_amount and justification started as the proposal had them and are changed here without changing the proposal. The rest is planning: carryover_cashflow_cy (the approved cashflow of the current year carried forward) and carryover_order_reference for a carry forward; py1_carryover_outflow and py1_fresh_outflow, the estimated cash outflow in the planned year (PY1); py2_outflow to py5_outflow for the four years after it; gst_rate_id, the GST rate, a value of your organisation's GST Rate Master list, with gst_rate_name its name and gst_rate_percent its rate as a whole percentage; py1_month_01 to py1_month_12, the planned year's cash flow month by month from its first month; and asset_block_id, the asset block, a value of your organisation's Asset Block Master list, with asset_block_name its name. depreciation_rate_percent is the Applicable Depreciation: the block's depreciation rate as a whole percentage, as the block had it when the row was saved with it. It is kept while the row keeps that block, so a rate changed on the list afterwards does not change a row already planned; it is null where the block had no rate. Worked out, never stored: py1_carryover_total is carryover_cashflow_cy plus approved_carryover_amount; py1_proposed_plan is that plus fresh_sanction_amount; py1_outflow is py1_carryover_outflow plus py1_fresh_outflow; py1_outflow_difference is py1_proposed_plan less py1_outflow; py2_py5_outflow is the four outer years added up; py1_cashflow_total is the twelve months added up, and py1_cashflow_balanced whether it equals py1_outflow. Each _gst_credit and _gst column is the GST inside that figure, the figure divided by one plus the rate times the rate, rounded to two places, and null where the figure or the rate is missing; py1_gst_credit_total adds up the twelve months' credit, and equals py1_gst_credit when the months are balanced, give or take rounding. The planning is approved in a workflow of its own. A row goes to its first level by itself when its proposal is approved, and its approvers plan it while it waits on them; where no workflow holds it, it stays here for your organisation's planners to plan and send with api.submit_capex_consolidated_line. When the last level approves, proposal_status is PLAN_APPROVED; a rejection at any level is PLAN_REJECTED. request_id and request_display_status are the planning's own approval request, the open one where there is one, as your approvals show it; null until the plan is sent for approval. last_approved_by_name and last_approved_at are who gave the planning its latest approval, and when. Both are null until a level of the planning approves it, and stay null for a plan approved at once because no workflow applied; the approval of the proposal itself is never shown here. planning_open says whether the planners can still change the row: they cannot once the plan is approved or rejected, or while it is with approvers. planning_needs lists, in the sheet's words, what the row still needs before its planning can be approved or sent: any of the six mandatory fields (a GST rate whose value has no rate counting as missing), the carried cashflow of a carry forward, and the twelve months adding up to py1_outflow; it is empty when nothing. may_edit says whether you may change the row now: while it is with its approvers only the approver it waits on may, and otherwise anybody holding finance.capex_consolidation.edit. may_send says whether you may send it for approval. You see every row of the plan if you may view the consolidated plan. Without that, you see a row only while a step of its planning approval is waiting on you under your own authority, so that you can plan it before you sign; once you have decided, it is gone from what you see. ## OpenAPI ````yaml /api-reference/openapi.json get /capex_consolidated_lines openapi: 3.0.0 info: description: '' title: >- The only schema PostgREST exposes. Reads are security_invoker views; writes are SECURITY DEFINER functions. Rebuilt wholesale on every deploy — it holds no data. version: 12.2.3 servers: - url: https://app.assetinfinity.ai/api security: [] tags: - name: Signing in - name: Profile - name: My work - name: Sites and locations - name: Assets - name: Asset lifecycle - name: Asset components - name: Kits - name: Work lifecycle - name: Work order execution - name: Work sequencing - name: Maintenance - name: Inspections - name: Checklists - name: Verification - name: Self verification - name: Inventory - name: Inventory detail - name: Parts demand - name: Procurement - name: Catalogue - name: Vendors and contracts - name: Contracts - name: Amendments - name: Vendor spend forecast - name: Workforce - name: Workforce detail - name: Capacity - name: Dispatch - name: Shutdown - name: Permits - name: Tools - name: Tools on jobs - name: Bookings - name: Booking hand over - name: Booking bills - name: Calibration history - name: Reliability - name: Sensors and meters - name: Readers - name: Trackers - name: Real-time location - name: Feeds - name: Energy - name: IT assets - name: IT asset software - name: IT asset topology - name: Warranty lookups - name: Map - name: Floor plans - name: Labels - name: Lost and found - name: Visitors - name: Root cause analysis - name: Costing - name: Finance - name: E-way bills - name: E-way bill filing - name: Budgets - name: Capex plans - name: Capex consolidation - name: Capex capitalization - name: FF&E plans - name: Documents - name: Document control - name: Document folders - name: Document tree - name: Knowledge - name: Reports - name: Dashboards - name: Extracts - name: Data exports - name: Audit center - name: Audit feed - name: Activity - name: Conversations - name: Notifications - name: Date reminders - name: Channels - name: Search - name: Copilot - name: Import - name: Bulk jobs - name: File exchange - name: Filing exceptions - name: Files - name: Sync - name: Support - name: API keys - name: Webhooks - name: MCP connections - name: MCP sign-in - name: SCIM provisioning - name: Directory sync - name: Security streams - name: Clarity - name: Single sign-on - name: Two-factor sign-in - name: Admin - name: Access - name: Lookups - name: Read models - name: Reference - name: Reference columns - name: Reference entry - name: List views - name: Mapping - name: Numbering - name: Branding - name: Custom fields - name: Form studio - name: Workflows - name: Workflow studio - name: Rules - name: Statuses and transitions - name: Currencies and locales - name: Today - name: Work configuration - name: Asset configuration - name: Inventory configuration - name: Tool configuration - name: Workforce configuration - name: Vendor and contract configuration - name: Document configuration - name: Inspection configuration - name: Sites, locations and the organisation - name: Setup - name: Features - name: Billing - name: Licence - name: Welcome - name: Tray - name: Tenant switch - name: Release - name: Upgrade - name: Telegram - name: Whatsapp - name: Inbound mail - name: Platform externalDocs: description: PostgREST Documentation url: https://postgrest.org/en/v12/references/api.html paths: /capex_consolidated_lines: get: tags: - Capex consolidation summary: >- The consolidated capex plan: one row for each capex proposal approved for the consolidation plan, made when it was… description: >- The consolidated capex plan: one row for each capex proposal approved for the consolidation plan, made when it was approved. What the proposal decided is read off it and cannot be changed here: fiscal_year (with fiscal_calendar_name, the fiscal calendar the plan is counted on, and fiscal_year_start_month, the month that calendar starts its year in, so fiscal_year 2027 starting in April is April 2026 to March 2027), scheme_code (the Request ID), the unit and location, category_master_id and budget_category_id (the Category and Sub-Category), priority (the Item Type: VITAL, ESSENTIAL or DESIRABLE), investment_type (NEW or CARRY_FORWARD), carried_from_line_id (the Reference ID), scheme_value (the Capex Amount) and category (PROJECT, SPECIFIED, CLUBBED or FLEXIBLE). proposal_status is the proposal's: APPROVED_FOR_PLAN while it is being planned, then PLAN_APPROVED or PLAN_REJECTED. The coordinator, item_description, quantity, nature, fresh_sanction_amount, approved_carryover_amount and justification started as the proposal had them and are changed here without changing the proposal. The rest is planning: carryover_cashflow_cy (the approved cashflow of the current year carried forward) and carryover_order_reference for a carry forward; py1_carryover_outflow and py1_fresh_outflow, the estimated cash outflow in the planned year (PY1); py2_outflow to py5_outflow for the four years after it; gst_rate_id, the GST rate, a value of your organisation's GST Rate Master list, with gst_rate_name its name and gst_rate_percent its rate as a whole percentage; py1_month_01 to py1_month_12, the planned year's cash flow month by month from its first month; and asset_block_id, the asset block, a value of your organisation's Asset Block Master list, with asset_block_name its name. depreciation_rate_percent is the Applicable Depreciation: the block's depreciation rate as a whole percentage, as the block had it when the row was saved with it. It is kept while the row keeps that block, so a rate changed on the list afterwards does not change a row already planned; it is null where the block had no rate. Worked out, never stored: py1_carryover_total is carryover_cashflow_cy plus approved_carryover_amount; py1_proposed_plan is that plus fresh_sanction_amount; py1_outflow is py1_carryover_outflow plus py1_fresh_outflow; py1_outflow_difference is py1_proposed_plan less py1_outflow; py2_py5_outflow is the four outer years added up; py1_cashflow_total is the twelve months added up, and py1_cashflow_balanced whether it equals py1_outflow. Each _gst_credit and _gst column is the GST inside that figure, the figure divided by one plus the rate times the rate, rounded to two places, and null where the figure or the rate is missing; py1_gst_credit_total adds up the twelve months' credit, and equals py1_gst_credit when the months are balanced, give or take rounding. The planning is approved in a workflow of its own. A row goes to its first level by itself when its proposal is approved, and its approvers plan it while it waits on them; where no workflow holds it, it stays here for your organisation's planners to plan and send with api.submit_capex_consolidated_line. When the last level approves, proposal_status is PLAN_APPROVED; a rejection at any level is PLAN_REJECTED. request_id and request_display_status are the planning's own approval request, the open one where there is one, as your approvals show it; null until the plan is sent for approval. last_approved_by_name and last_approved_at are who gave the planning its latest approval, and when. Both are null until a level of the planning approves it, and stay null for a plan approved at once because no workflow applied; the approval of the proposal itself is never shown here. planning_open says whether the planners can still change the row: they cannot once the plan is approved or rejected, or while it is with approvers. planning_needs lists, in the sheet's words, what the row still needs before its planning can be approved or sent: any of the six mandatory fields (a GST rate whose value has no rate counting as missing), the carried cashflow of a carry forward, and the twelve months adding up to py1_outflow; it is empty when nothing. may_edit says whether you may change the row now: while it is with its approvers only the approver it waits on may, and otherwise anybody holding finance.capex_consolidation.edit. may_send says whether you may send it for approval. You see every row of the plan if you may view the consolidated plan. Without that, you see a row only while a step of its planning approval is waiting on you under your own authority, so that you can plan it before you sign; once you have decided, it is gone from what you see. parameters: - $ref: '#/components/parameters/rowFilter.capex_consolidated_lines.id' - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.capex_plan_line_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.created_at - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.updated_at - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.capex_plan_id - $ref: '#/components/parameters/rowFilter.capex_consolidated_lines.plan_code' - $ref: '#/components/parameters/rowFilter.capex_consolidated_lines.plan_name' - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.fiscal_year - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.fiscal_year_start_month - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.fiscal_calendar_name - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.business_unit_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.division_name - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.scheme_code - $ref: '#/components/parameters/rowFilter.capex_consolidated_lines.site_id' - $ref: '#/components/parameters/rowFilter.capex_consolidated_lines.site_name' - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.location_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.location_name - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.category_master_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.category_master_name - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.budget_category_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.budget_category_name - $ref: '#/components/parameters/rowFilter.capex_consolidated_lines.priority' - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.investment_type - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.carried_from_line_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.carried_from_code - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.scheme_value - $ref: '#/components/parameters/rowFilter.capex_consolidated_lines.category' - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.currency_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.currency_code - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.proposal_status - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.proposal_status_reason - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.proposal_status_at - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.coordinator_user_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.coordinator_name - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.item_description - $ref: '#/components/parameters/rowFilter.capex_consolidated_lines.quantity' - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.capex_nature_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.nature_name - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.fresh_sanction_amount - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.approved_carryover_amount - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.justification - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.carryover_cashflow_cy - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.carryover_order_reference - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_carryover_total - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_proposed_plan - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_carryover_outflow - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_fresh_outflow - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_outflow - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_outflow_difference - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py2_outflow - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py3_outflow - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py4_outflow - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py5_outflow - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py2_py5_outflow - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.gst_rate_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.gst_rate_name - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.gst_rate_percent - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_gst_credit - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py2_gst_credit - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py3_gst_credit - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py4_gst_credit - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py5_gst_credit - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_01 - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_02 - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_03 - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_04 - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_05 - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_06 - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_07 - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_08 - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_09 - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_10 - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_11 - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_12 - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_cashflow_total - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_01_gst - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_02_gst - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_03_gst - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_04_gst - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_05_gst - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_06_gst - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_07_gst - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_08_gst - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_09_gst - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_10_gst - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_11_gst - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_month_12_gst - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_gst_credit_total - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.py1_cashflow_balanced - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.asset_block_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.asset_block_name - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.depreciation_rate_percent - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.request_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.request_display_status - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.last_approved_by_user_id - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.last_approved_by_name - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.last_approved_at - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.planning_open - $ref: >- #/components/parameters/rowFilter.capex_consolidated_lines.planning_needs - $ref: '#/components/parameters/rowFilter.capex_consolidated_lines.may_edit' - $ref: '#/components/parameters/rowFilter.capex_consolidated_lines.may_send' - $ref: '#/components/parameters/select' - $ref: '#/components/parameters/order' - $ref: '#/components/parameters/range' - $ref: '#/components/parameters/rangeUnit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/preferCount' responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/capex_consolidated_lines' type: array application/vnd.pgrst.object+json: schema: items: $ref: '#/components/schemas/capex_consolidated_lines' type: array application/vnd.pgrst.object+json;nulls=stripped: schema: items: $ref: '#/components/schemas/capex_consolidated_lines' type: array text/csv: schema: items: $ref: '#/components/schemas/capex_consolidated_lines' type: array description: OK '206': description: Partial Content components: parameters: rowFilter.capex_consolidated_lines.id: in: query name: id required: false schema: type: string rowFilter.capex_consolidated_lines.capex_plan_line_id: in: query name: capex_plan_line_id required: false schema: type: string rowFilter.capex_consolidated_lines.created_at: in: query name: created_at required: false schema: type: string rowFilter.capex_consolidated_lines.updated_at: in: query name: updated_at required: false schema: type: string rowFilter.capex_consolidated_lines.capex_plan_id: in: query name: capex_plan_id required: false schema: type: string rowFilter.capex_consolidated_lines.plan_code: in: query name: plan_code required: false schema: type: string rowFilter.capex_consolidated_lines.plan_name: in: query name: plan_name required: false schema: type: string rowFilter.capex_consolidated_lines.fiscal_year: in: query name: fiscal_year required: false schema: type: string rowFilter.capex_consolidated_lines.fiscal_year_start_month: in: query name: fiscal_year_start_month required: false schema: type: string rowFilter.capex_consolidated_lines.fiscal_calendar_name: in: query name: fiscal_calendar_name required: false schema: type: string rowFilter.capex_consolidated_lines.business_unit_id: in: query name: business_unit_id required: false schema: type: string rowFilter.capex_consolidated_lines.division_name: in: query name: division_name required: false schema: type: string rowFilter.capex_consolidated_lines.scheme_code: in: query name: scheme_code required: false schema: type: string rowFilter.capex_consolidated_lines.site_id: in: query name: site_id required: false schema: type: string rowFilter.capex_consolidated_lines.site_name: in: query name: site_name required: false schema: type: string rowFilter.capex_consolidated_lines.location_id: in: query name: location_id required: false schema: type: string rowFilter.capex_consolidated_lines.location_name: in: query name: location_name required: false schema: type: string rowFilter.capex_consolidated_lines.category_master_id: in: query name: category_master_id required: false schema: type: string rowFilter.capex_consolidated_lines.category_master_name: in: query name: category_master_name required: false schema: type: string rowFilter.capex_consolidated_lines.budget_category_id: in: query name: budget_category_id required: false schema: type: string rowFilter.capex_consolidated_lines.budget_category_name: in: query name: budget_category_name required: false schema: type: string rowFilter.capex_consolidated_lines.priority: in: query name: priority required: false schema: type: string rowFilter.capex_consolidated_lines.investment_type: in: query name: investment_type required: false schema: type: string rowFilter.capex_consolidated_lines.carried_from_line_id: in: query name: carried_from_line_id required: false schema: type: string rowFilter.capex_consolidated_lines.carried_from_code: in: query name: carried_from_code required: false schema: type: string rowFilter.capex_consolidated_lines.scheme_value: in: query name: scheme_value required: false schema: type: string rowFilter.capex_consolidated_lines.category: in: query name: category required: false schema: type: string rowFilter.capex_consolidated_lines.currency_id: in: query name: currency_id required: false schema: type: string rowFilter.capex_consolidated_lines.currency_code: in: query name: currency_code required: false schema: type: string rowFilter.capex_consolidated_lines.proposal_status: in: query name: proposal_status required: false schema: type: string rowFilter.capex_consolidated_lines.proposal_status_reason: in: query name: proposal_status_reason required: false schema: type: string rowFilter.capex_consolidated_lines.proposal_status_at: in: query name: proposal_status_at required: false schema: type: string rowFilter.capex_consolidated_lines.coordinator_user_id: in: query name: coordinator_user_id required: false schema: type: string rowFilter.capex_consolidated_lines.coordinator_name: in: query name: coordinator_name required: false schema: type: string rowFilter.capex_consolidated_lines.item_description: in: query name: item_description required: false schema: type: string rowFilter.capex_consolidated_lines.quantity: in: query name: quantity required: false schema: type: string rowFilter.capex_consolidated_lines.capex_nature_id: in: query name: capex_nature_id required: false schema: type: string rowFilter.capex_consolidated_lines.nature_name: in: query name: nature_name required: false schema: type: string rowFilter.capex_consolidated_lines.fresh_sanction_amount: in: query name: fresh_sanction_amount required: false schema: type: string rowFilter.capex_consolidated_lines.approved_carryover_amount: in: query name: approved_carryover_amount required: false schema: type: string rowFilter.capex_consolidated_lines.justification: in: query name: justification required: false schema: type: string rowFilter.capex_consolidated_lines.carryover_cashflow_cy: in: query name: carryover_cashflow_cy required: false schema: type: string rowFilter.capex_consolidated_lines.carryover_order_reference: in: query name: carryover_order_reference required: false schema: type: string rowFilter.capex_consolidated_lines.py1_carryover_total: in: query name: py1_carryover_total required: false schema: type: string rowFilter.capex_consolidated_lines.py1_proposed_plan: in: query name: py1_proposed_plan required: false schema: type: string rowFilter.capex_consolidated_lines.py1_carryover_outflow: in: query name: py1_carryover_outflow required: false schema: type: string rowFilter.capex_consolidated_lines.py1_fresh_outflow: in: query name: py1_fresh_outflow required: false schema: type: string rowFilter.capex_consolidated_lines.py1_outflow: in: query name: py1_outflow required: false schema: type: string rowFilter.capex_consolidated_lines.py1_outflow_difference: in: query name: py1_outflow_difference required: false schema: type: string rowFilter.capex_consolidated_lines.py2_outflow: in: query name: py2_outflow required: false schema: type: string rowFilter.capex_consolidated_lines.py3_outflow: in: query name: py3_outflow required: false schema: type: string rowFilter.capex_consolidated_lines.py4_outflow: in: query name: py4_outflow required: false schema: type: string rowFilter.capex_consolidated_lines.py5_outflow: in: query name: py5_outflow required: false schema: type: string rowFilter.capex_consolidated_lines.py2_py5_outflow: in: query name: py2_py5_outflow required: false schema: type: string rowFilter.capex_consolidated_lines.gst_rate_id: in: query name: gst_rate_id required: false schema: type: string rowFilter.capex_consolidated_lines.gst_rate_name: in: query name: gst_rate_name required: false schema: type: string rowFilter.capex_consolidated_lines.gst_rate_percent: in: query name: gst_rate_percent required: false schema: type: string rowFilter.capex_consolidated_lines.py1_gst_credit: in: query name: py1_gst_credit required: false schema: type: string rowFilter.capex_consolidated_lines.py2_gst_credit: in: query name: py2_gst_credit required: false schema: type: string rowFilter.capex_consolidated_lines.py3_gst_credit: in: query name: py3_gst_credit required: false schema: type: string rowFilter.capex_consolidated_lines.py4_gst_credit: in: query name: py4_gst_credit required: false schema: type: string rowFilter.capex_consolidated_lines.py5_gst_credit: in: query name: py5_gst_credit required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_01: in: query name: py1_month_01 required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_02: in: query name: py1_month_02 required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_03: in: query name: py1_month_03 required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_04: in: query name: py1_month_04 required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_05: in: query name: py1_month_05 required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_06: in: query name: py1_month_06 required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_07: in: query name: py1_month_07 required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_08: in: query name: py1_month_08 required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_09: in: query name: py1_month_09 required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_10: in: query name: py1_month_10 required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_11: in: query name: py1_month_11 required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_12: in: query name: py1_month_12 required: false schema: type: string rowFilter.capex_consolidated_lines.py1_cashflow_total: in: query name: py1_cashflow_total required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_01_gst: in: query name: py1_month_01_gst required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_02_gst: in: query name: py1_month_02_gst required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_03_gst: in: query name: py1_month_03_gst required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_04_gst: in: query name: py1_month_04_gst required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_05_gst: in: query name: py1_month_05_gst required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_06_gst: in: query name: py1_month_06_gst required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_07_gst: in: query name: py1_month_07_gst required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_08_gst: in: query name: py1_month_08_gst required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_09_gst: in: query name: py1_month_09_gst required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_10_gst: in: query name: py1_month_10_gst required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_11_gst: in: query name: py1_month_11_gst required: false schema: type: string rowFilter.capex_consolidated_lines.py1_month_12_gst: in: query name: py1_month_12_gst required: false schema: type: string rowFilter.capex_consolidated_lines.py1_gst_credit_total: in: query name: py1_gst_credit_total required: false schema: type: string rowFilter.capex_consolidated_lines.py1_cashflow_balanced: in: query name: py1_cashflow_balanced required: false schema: type: string rowFilter.capex_consolidated_lines.asset_block_id: in: query name: asset_block_id required: false schema: type: string rowFilter.capex_consolidated_lines.asset_block_name: in: query name: asset_block_name required: false schema: type: string rowFilter.capex_consolidated_lines.depreciation_rate_percent: in: query name: depreciation_rate_percent required: false schema: type: string rowFilter.capex_consolidated_lines.request_id: in: query name: request_id required: false schema: type: string rowFilter.capex_consolidated_lines.request_display_status: in: query name: request_display_status required: false schema: type: string rowFilter.capex_consolidated_lines.last_approved_by_user_id: in: query name: last_approved_by_user_id required: false schema: type: string rowFilter.capex_consolidated_lines.last_approved_by_name: in: query name: last_approved_by_name required: false schema: type: string rowFilter.capex_consolidated_lines.last_approved_at: in: query name: last_approved_at required: false schema: type: string rowFilter.capex_consolidated_lines.planning_open: in: query name: planning_open required: false schema: type: string rowFilter.capex_consolidated_lines.planning_needs: in: query name: planning_needs required: false schema: type: string rowFilter.capex_consolidated_lines.may_edit: in: query name: may_edit required: false schema: type: string rowFilter.capex_consolidated_lines.may_send: in: query name: may_send required: false schema: type: string select: description: Filtering Columns in: query name: select required: false schema: type: string order: description: Ordering in: query name: order required: false schema: type: string range: description: Limiting and Pagination in: header name: Range required: false schema: type: string rangeUnit: description: Limiting and Pagination in: header name: Range-Unit required: false schema: default: items type: string offset: description: Limiting and Pagination in: query name: offset required: false schema: type: string limit: description: Limiting and Pagination in: query name: limit required: false schema: type: string preferCount: description: Preference in: header name: Prefer required: false schema: enum: - count=none type: string schemas: capex_consolidated_lines: description: >- The consolidated capex plan: one row for each capex proposal approved for the consolidation plan, made when it was approved. What the proposal decided is read off it and cannot be changed here: fiscal_year (with fiscal_calendar_name, the fiscal calendar the plan is counted on, and fiscal_year_start_month, the month that calendar starts its year in, so fiscal_year 2027 starting in April is April 2026 to March 2027), scheme_code (the Request ID), the unit and location, category_master_id and budget_category_id (the Category and Sub-Category), priority (the Item Type: VITAL, ESSENTIAL or DESIRABLE), investment_type (NEW or CARRY_FORWARD), carried_from_line_id (the Reference ID), scheme_value (the Capex Amount) and category (PROJECT, SPECIFIED, CLUBBED or FLEXIBLE). proposal_status is the proposal's: APPROVED_FOR_PLAN while it is being planned, then PLAN_APPROVED or PLAN_REJECTED. The coordinator, item_description, quantity, nature, fresh_sanction_amount, approved_carryover_amount and justification started as the proposal had them and are changed here without changing the proposal. The rest is planning: carryover_cashflow_cy (the approved cashflow of the current year carried forward) and carryover_order_reference for a carry forward; py1_carryover_outflow and py1_fresh_outflow, the estimated cash outflow in the planned year (PY1); py2_outflow to py5_outflow for the four years after it; gst_rate_id, the GST rate, a value of your organisation's GST Rate Master list, with gst_rate_name its name and gst_rate_percent its rate as a whole percentage; py1_month_01 to py1_month_12, the planned year's cash flow month by month from its first month; and asset_block_id, the asset block, a value of your organisation's Asset Block Master list, with asset_block_name its name. depreciation_rate_percent is the Applicable Depreciation: the block's depreciation rate as a whole percentage, as the block had it when the row was saved with it. It is kept while the row keeps that block, so a rate changed on the list afterwards does not change a row already planned; it is null where the block had no rate. Worked out, never stored: py1_carryover_total is carryover_cashflow_cy plus approved_carryover_amount; py1_proposed_plan is that plus fresh_sanction_amount; py1_outflow is py1_carryover_outflow plus py1_fresh_outflow; py1_outflow_difference is py1_proposed_plan less py1_outflow; py2_py5_outflow is the four outer years added up; py1_cashflow_total is the twelve months added up, and py1_cashflow_balanced whether it equals py1_outflow. Each _gst_credit and _gst column is the GST inside that figure, the figure divided by one plus the rate times the rate, rounded to two places, and null where the figure or the rate is missing; py1_gst_credit_total adds up the twelve months' credit, and equals py1_gst_credit when the months are balanced, give or take rounding. The planning is approved in a workflow of its own. A row goes to its first level by itself when its proposal is approved, and its approvers plan it while it waits on them; where no workflow holds it, it stays here for your organisation's planners to plan and send with api.submit_capex_consolidated_line. When the last level approves, proposal_status is PLAN_APPROVED; a rejection at any level is PLAN_REJECTED. request_id and request_display_status are the planning's own approval request, the open one where there is one, as your approvals show it; null until the plan is sent for approval. last_approved_by_name and last_approved_at are who gave the planning its latest approval, and when. Both are null until a level of the planning approves it, and stay null for a plan approved at once because no workflow applied; the approval of the proposal itself is never shown here. planning_open says whether the planners can still change the row: they cannot once the plan is approved or rejected, or while it is with approvers. planning_needs lists, in the sheet's words, what the row still needs before its planning can be approved or sent: any of the six mandatory fields (a GST rate whose value has no rate counting as missing), the carried cashflow of a carry forward, and the twelve months adding up to py1_outflow; it is empty when nothing. may_edit says whether you may change the row now: while it is with its approvers only the approver it waits on may, and otherwise anybody holding finance.capex_consolidation.edit. may_send says whether you may send it for approval. You see every row of the plan if you may view the consolidated plan. Without that, you see a row only while a step of its planning approval is waiting on you under your own authority, so that you can plan it before you sign; once you have decided, it is gone from what you see. properties: approved_carryover_amount: format: numeric type: number asset_block_id: description: >- Note: This is a Foreign Key to `capex_asset_blocks.id`. format: uuid type: string asset_block_name: format: character varying maxLength: 150 type: string budget_category_id: description: >- Note: This is a Foreign Key to `capex_asset_blocks.id`. format: uuid type: string budget_category_name: format: character varying maxLength: 150 type: string business_unit_id: description: >- Note: This is a Foreign Key to `business_units.id`. format: uuid type: string capex_nature_id: description: >- Note: This is a Foreign Key to `capex_natures.id`. format: uuid type: string capex_plan_id: description: >- Note: This is a Foreign Key to `capex_plans.id`. format: uuid type: string capex_plan_line_id: description: >- Note: This is a Foreign Key to `capex_plan_lines.id`. format: uuid type: string carried_from_code: format: character varying maxLength: 60 type: string carried_from_line_id: description: >- Note: This is a Foreign Key to `capex_plan_lines.id`. format: uuid type: string carryover_cashflow_cy: format: numeric type: number carryover_order_reference: format: character varying maxLength: 10 type: string category: format: character varying maxLength: 12 type: string category_master_id: description: >- Note: This is a Foreign Key to `capex_asset_blocks.id`. format: uuid type: string category_master_name: format: character varying maxLength: 150 type: string coordinator_name: format: character varying maxLength: 200 type: string coordinator_user_id: description: >- Note: This is a Foreign Key to `capex_invite_candidates.id`. format: uuid type: string created_at: format: timestamp with time zone type: string currency_code: format: character varying maxLength: 3 type: string currency_id: description: >- Note: This is a Foreign Key to `asset_cost_to_keep.currency_id`. format: uuid type: string depreciation_rate_percent: format: numeric type: number division_name: format: character varying maxLength: 200 type: string fiscal_calendar_name: format: character varying maxLength: 120 type: string fiscal_year: format: integer type: integer fiscal_year_start_month: format: smallint type: integer fresh_sanction_amount: format: numeric type: number gst_rate_id: description: >- Note: This is a Foreign Key to `capex_asset_blocks.id`. format: uuid type: string gst_rate_name: format: character varying maxLength: 150 type: string gst_rate_percent: format: numeric type: number id: description: |- Note: This is a Primary Key. format: uuid type: string investment_type: format: character varying maxLength: 16 type: string item_description: format: text type: string justification: format: text type: string last_approved_at: format: timestamp with time zone type: string last_approved_by_name: format: character varying maxLength: 200 type: string last_approved_by_user_id: description: >- Note: This is a Foreign Key to `capex_invite_candidates.id`. format: uuid type: string location_id: format: uuid type: string location_name: format: character varying maxLength: 200 type: string may_edit: format: boolean type: boolean may_send: format: boolean type: boolean nature_name: format: character varying maxLength: 120 type: string plan_code: format: character varying maxLength: 60 type: string plan_name: format: character varying maxLength: 200 type: string planning_needs: format: text[] items: type: string type: array planning_open: format: boolean type: boolean priority: format: character varying maxLength: 12 type: string proposal_status: format: character varying maxLength: 24 type: string proposal_status_at: format: timestamp with time zone type: string proposal_status_reason: format: text type: string py1_carryover_outflow: format: numeric type: number py1_carryover_total: format: numeric type: number py1_cashflow_balanced: format: boolean type: boolean py1_cashflow_total: format: numeric type: number py1_fresh_outflow: format: numeric type: number py1_gst_credit: format: numeric type: number py1_gst_credit_total: format: numeric type: number py1_month_01: format: numeric type: number py1_month_01_gst: format: numeric type: number py1_month_02: format: numeric type: number py1_month_02_gst: format: numeric type: number py1_month_03: format: numeric type: number py1_month_03_gst: format: numeric type: number py1_month_04: format: numeric type: number py1_month_04_gst: format: numeric type: number py1_month_05: format: numeric type: number py1_month_05_gst: format: numeric type: number py1_month_06: format: numeric type: number py1_month_06_gst: format: numeric type: number py1_month_07: format: numeric type: number py1_month_07_gst: format: numeric type: number py1_month_08: format: numeric type: number py1_month_08_gst: format: numeric type: number py1_month_09: format: numeric type: number py1_month_09_gst: format: numeric type: number py1_month_10: format: numeric type: number py1_month_10_gst: format: numeric type: number py1_month_11: format: numeric type: number py1_month_11_gst: format: numeric type: number py1_month_12: format: numeric type: number py1_month_12_gst: format: numeric type: number py1_outflow: format: numeric type: number py1_outflow_difference: format: numeric type: number py1_proposed_plan: format: numeric type: number py2_gst_credit: format: numeric type: number py2_outflow: format: numeric type: number py2_py5_outflow: format: numeric type: number py3_gst_credit: format: numeric type: number py3_outflow: format: numeric type: number py4_gst_credit: format: numeric type: number py4_outflow: format: numeric type: number py5_gst_credit: format: numeric type: number py5_outflow: format: numeric type: number quantity: format: numeric type: number request_display_status: format: text type: string request_id: format: uuid type: string scheme_code: format: character varying maxLength: 60 type: string scheme_value: format: numeric type: number site_id: description: >- Note: This is a Foreign Key to `entry_currencies.for_site_id`. format: uuid type: string site_name: format: character varying maxLength: 200 type: string updated_at: format: timestamp with time zone type: string type: object ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.