| Description | Manage Financial Plans |
| Name | ManageFinancialPlanDataIn |
| Namespace | http://sap.com/xi/AP/FinancialAccounting/Global |
| Product | SAP Business ByDesign |
| Process component | Financial Accounting |
| Process component namespace | http://sap.com/xi/AP/FinancialAccounting/Global |
| Deployment unit | Financials |
| Endpoint Activation | By Scoping of Process Component | Operations |
|
| Release Status | Released |
| Technical documentation on the SAP API Business Hub | Manage Financial Plans |
| General web service documentation | A2X Web Services (SOAP) |
An interface to maintain financial plan data from an external planning system.
The Web service interface Manage Financial Plan Data In enables you to connect an external planning application to your system and to create, update or delete financial plans in your system.
The Web service interface Manage Financial Plan Data In offers the operation Maintain As Bundle.
Here is an example of a simple Web service request:
Show full documentation
Show full documentation
<ns1:FinancialPlanDataBundleMaintainRequest xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>WS_MSG_ID_0</ID>
</BasicMessageHeader>
<FinancialPlanData>
<ID>SIMPLE_PLAN_2014</ID>
<SetOfBooksID>0001</SetOfBooksID>
<Description>Simple plan 2014</Description>
<PlanData>
<CompanyID>MC10000</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<CostCentreID>MC21000</CostCentreID>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1.23</Amount>
</PeriodAmount>
</PlanData>
</FinancialPlanData>
</ns1:FinancialPlanDataBundleMaintainRequest>
Financial Planning with third-party software is configured in your system.
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
Create or update a cost center plan for cost center MC21000, G/L accounts 500300 and 517300, and accounting periods 1 to 3 of fiscal year 2014:
<ns1:FinancialPlanDataBundleMaintainRequest xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>WS_MSG_ID_1</ID>
</BasicMessageHeader>
<FinancialPlanData planDataListCompleteTransmissionIndicator="true">
<ID>CC_PLAN_2014</ID>
<SetOfBooksID>0001</SetOfBooksID>
<Description>Cost center plan 2014</Description>
<DefaultIndicator>true</DefaultIndicator>
<ResponsibleEmployeeID>MC1645</ResponsibleEmployeeID>
<PlanData>
<CompanyID>MC10000</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<CostCentreID>MC21000</CostCentreID>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1001</Amount>
</PeriodAmount>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014002</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1002</Amount>
</PeriodAmount>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014003</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1003</Amount>
</PeriodAmount>
</PlanData>
<PlanData>
<CompanyID>MC10000</CompanyID>
<ChartOfAccountsItemCode>517300</ChartOfAccountsItemCode>
<CostCentreID>MC21000</CostCentreID>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1501</Amount>
</PeriodAmount>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014002</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1502</Amount>
</PeriodAmount>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014003</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1503</Amount>
</PeriodAmount>
</PlanData>
</FinancialPlanData>
</ns1:FinancialPlanDataBundleMaintainRequest>
You can also create or update a cost center plan for multiple companies or multiple fiscal years with a single Web service call. For example, create plan data for for cost center MC21000 and G/L account 500300 in company MC10000 as well as for cost center MC67200 and G/L account 500300 in company MC67200, for accounting periods 1 to 3 of fiscal year 2014 in both companies:
<ns1:FinancialPlanDataBundleMaintainRequest xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>WS_MSG_ID_2</ID>
</BasicMessageHeader>
<FinancialPlanData planDataListCompleteTransmissionIndicator="true">
<ID>CC_PLAN_MC_2014</ID>
<SetOfBooksID>0001</SetOfBooksID>
<Description>Multi-company cost center plan 2014</Description>
<DefaultIndicator>false</DefaultIndicator>
<ResponsibleEmployeeID>MC8080</ResponsibleEmployeeID>
<PlanData>
<CompanyID>MC10000</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<CostCentreID>MC21000</CostCentreID>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1001</Amount>
</PeriodAmount>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014002</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1002</Amount>
</PeriodAmount>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014003</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1003</Amount>
</PeriodAmount>
</PlanData>
<PlanData>
<CompanyID>MC67200</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<CostCentreID>MC67200</CostCentreID>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">501</Amount>
</PeriodAmount>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014002</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">502</Amount>
</PeriodAmount>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014003</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">503</Amount>
</PeriodAmount>
</PlanData>
</FinancialPlanData>
</ns1:FinancialPlanDataBundleMaintainRequest>
Note that the semantic key of a plan version is given by PlanID, SetOfBooksID, CompanyID and FiscalYear. The system will thus show two plan versions CC_PLAN_MC_2014 in the Cost and Revenue -> Planning view after this Web service call: one for company MC10000 and the other for company MC67200.
Deleting a plan:
<ns1:FinancialPlanDataBundleMaintainRequest xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>WS_MSG_ID_9</ID>
</BasicMessageHeader>
<FinancialPlanData actionCode="03">
<ID>SIMPLE_PLAN_2014</ID>
<SetOfBooksID>0001</SetOfBooksID>
<PlanData>
<CompanyID>MC10000</CompanyID>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014001</FiscalYearAccountingPeriodID>
</PeriodAmount>
</PlanData>
</FinancialPlanData>
</ns1:FinancialPlanDataBundleMaintainRequest>
As the semantic key of a plan is given by PlanID, SetOfBooksID, CompanyID and FiscalYear, you need to provide a PlanData/CompanyID element as well as a PlanData/PeriodAmount/FiscalYearAccountingPeriodID element to identify the Plan Version to be deleted. Providing just the PlanID is not sufficient.
Create or update a balance sheet plan, including an opening balance provided by the first PlanData element:
<ns1:FinancialPlanDataBundleMaintainRequest xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>WS_MSG_ID_3</ID>
</BasicMessageHeader>
<FinancialPlanData planDataListCompleteTransmissionIndicator="true">
<ID>BS_PLAN_2014</ID>
<SetOfBooksID>0001</SetOfBooksID>
<Description>Balance sheet plan for 2014</Description>
<DefaultIndicator>false</DefaultIndicator>
<ResponsibleEmployeeID>MC8080</ResponsibleEmployeeID>
<PlanData>
<CompanyID>MC10000</CompanyID>
<ChartOfAccountsItemCode>110000</ChartOfAccountsItemCode>
<ProfitCentreID>MC43000</ProfitCentreID>
<AccountingClosingStepCode>001</AccountingClosingStepCode>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">10000</Amount>
</PeriodAmount>
</PlanData>
<PlanData>
<CompanyID>MC10000</CompanyID>
<ChartOfAccountsItemCode>110000</ChartOfAccountsItemCode>
<ProfitCentreID>MC43000</ProfitCentreID>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1001</Amount>
</PeriodAmount>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014002</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1002</Amount>
</PeriodAmount>
<PeriodAmount>
<FiscalYearAccountingPeriodID>2014003</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1003</Amount>
</PeriodAmount>
</PlanData>
</FinancialPlanData>
</ns1:FinancialPlanDataBundleMaintainRequest>
| Description | Maintain financial plans |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To create, update, or delete financial plan data
The request message contains a BasicMessageHeader node element as well as a FinancialPlanData node element that contains the plan data to be created, updated, or deleted. The detailed structure of that node is explained in the following sub-chapters. The FinancialPlanData node can occur multiple times in the request message – this means that multiple plans can be created and updated through a single Web service request.
The response message type contains log items and a plan-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID and the ID of the affected plan.
The FinancialPlanData node element contains the general data of a plan.
The ID element contains the ID of the plan that is shown as Plan Version on the UI. The full semantic key of a plan version is given by ID, SetOfBooksID, CompanyID and FiscalYear, to support plans covering multiple companies and fiscal years. You can create such a plan with a single Web service call by providing multiple companies and/or fiscal years in the child elements. On the UI, each combination of ID, SetOfBooksID, CompanyID and FiscalYear will be shown as a seperate entry in the Cost and Revenue -> Planning view.
The DefaultIndicator corresponds to the Default UI element that can be changed by UI actions Set as Default and Reset Default.
The PlanData node element contains the characteristics of a plan data record.
The company of the plan is provided on this level to support plans covering multiple companies.
The G/L account is provided in element ChartOfAccountsItemCode. The chart of accounts is derived automatically from the company and set of books.
The profit center is derived automatically from the cost center (element CostCentreID). To plan costs or revenues on profit center level, you can omit the cost center and instead provide a profit center in element ProfitCentreID.
The functional area of a plan data record is derived from the cost center or G/L account. It cannot be provided by the Web service.
To create an opening balance for balance sheet planning, you need to provide element AccountingClosingStepCode with a value of 001. To create normal plan data entries, omit this element.
The PeriodAmount node element contains the fiscal year period and the amount of a plan data record.
The fiscal year period has to be provided in the format YYYYPPP (4-digit year and 3-digit period) in element FiscalYearAccountingPeriodID. For an opening balance plan data record, this element has to be provided as well because the fiscal year is derived from it. As the period is ignored in that case, the suggested value is YYYY001 for an opening balance.
You can repeat the PeriodAmount node element multiple times to provide plan data for different accounting periods for the same combination of company, cost center, and G/L account. Repeating the entire PlanData element is also possible but will result in a larger xml message.