| Description | Financial Plan Release Create |
| Name | ManagePlanReleaseIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Financial Accounting |
| Process Component Name | Accounting |
| Process Component Namespace | http://sap.com/xi/AP/FinancialAccounting/Global |
| Deployment Unit Description | Financials |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to maintain financial plan release data from an external system.
The web service interface "Manage Financial Plan Release Data In" enables you to connect an external application to your system, and to create, update or delete financial plan releases in your system. For a financial plan release to be created, a default financial plan for the same combination of company, set of books, and fiscal year must exist in the system. When a financial plan release for this combination is created, the system derives the default financial plan and associates the plan release to the default plan. The system also checks that for every unique combination of the key characteristics such as G/L account, Budget Category, Cost Center, Project Task, Profit Center, Fund and Function, the total amount in plan release does not exceed the amount in plan. Relevant error message gets raised if the plan release amount exceeds.
The Web service interface Manage Financial Plan Release Data In offers the operation Maintain As Bundle.
Here is a sample of a simple web service request:
Show full documentation
Show full documentation
<ns1:FinancialPlanReleaseDataBundleMaintainRequest_sync xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>WS_MSG_ID_0</ID>
</BasicMessageHeader>
<FinancialPlanReleaseData>
<ID>Release_01</ID>
<SetOfBooksID>PS01</SetOfBooksID>
<Description>First new Plan Release version</Description>
<DefaultIndicator>true</DefaultIndicator>
<ResponsibleEmployeeID>11</ResponsibleEmployeeID>
<ReleaseData>
<CompanyID>PS10000</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<CostCentreID>PS20000</CostCentreID>
<FundID>TRAVEL_FUND</FundID>
<FunctionID>DEMO_FUNC</FunctionID>
<PeriodAmount actionCode="01">
<FiscalYearAccountingPeriodID>2021001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1000</Amount>
</PeriodAmount>
<BudgetCategoryID>TRAVEL</BudgetCategoryID>
</ReleaseData>
</FinancialPlanReleaseData>
</ns1: FinancialPlanReleaseDataBundleMaintainRequest_sync >
Financial Planning with third-party software along with the active budget control scoping must be 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 release for cost center PS20000, G/L account 500300, and accounting periods 1 to 3 of fiscal year 2020:
<ns1: FinancialPlanReleaseDataBundleMaintainRequest_sync xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>WS_MSG_ID_1</ID>
</BasicMessageHeader>
<FinancialPlanReleaseData actionCode="01">
<ID>PV3_02</ID>
<SetOfBooksID>PS01</SetOfBooksID>
<Description>First new Plan Release version</Description>
<DefaultIndicator>false</DefaultIndicator>
<ResponsibleEmployeeID>11</ResponsibleEmployeeID>
<ReleaseData>
<CompanyID>PS10000</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<CostCentreID>PS20000</CostCentreID>
<FundID>TRAVEL_FUND</FundID>
<FunctionID>DEMO_FUNC</FunctionID>
<PeriodAmount actionCode="01">
<FiscalYearAccountingPeriodID>2020001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">900</Amount>
</PeriodAmount>
<PeriodAmount actionCode="01">
<FiscalYearAccountingPeriodID>2020002</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">20</Amount>
</PeriodAmount>
<PeriodAmount actionCode="01">
<FiscalYearAccountingPeriodID>2020003</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">10</Amount>
</PeriodAmount>
<BudgetCategoryID>TRAVEL</BudgetCategoryID>
</ReleaseData>
</FinancialPlanReleaseData>
</ns1: FinancialPlanReleaseDataBundleMaintainRequest_sync >
You can also create a plan release by providing a project task element:
<ns1:FinancialPlanReleaseDataBundleMaintainRequest_sync xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>WS_MSG_ID_3</ID>
</BasicMessageHeader>
<FinancialPlanReleaseData actionCode="01">
<ID>PD1_02</ID>
<SetOfBooksID>PS01</SetOfBooksID>
<Description> Plan release creation with project task </Description>
<DefaultIndicator>false</DefaultIndicator>
<ResponsibleEmployeeID>11</ResponsibleEmployeeID>
<ReleaseData>
<CompanyID>PS10000</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<ProfitCentreID>PS10000</ProfitCentreID>
<FundID>STS03</FundID>
<FunctionID>FCRE_FUNC</FunctionID>
<ProjectElementID>GFP1</ProjectElementID>
<PeriodAmount actionCode="01">
<FiscalYearAccountingPeriodID>2019001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">100</Amount>
</PeriodAmount>
<BudgetCategoryID>TRAVEL</BudgetCategoryID>
</ReleaseData>
</FinancialPlanReleaseData>
</ns1:FinancialPlanReleaseDataBundleMaintainRequest_sync >
Note: Either project task or cost center can be entered depending upon the plan information while creating a plan release. Plan releases cannot be created with project tasks with Closed, Stopped, On Hold or In planning status. Only project tasks whose projects have Process Variant Type as "Project Processing - For Direct Cost Projects" must be used in plan release.
With a single web service call, you can create/update multiple plan releases for cost center/project tasks:
<ns1:FinancialPlanReleaseDataBundleMaintainRequest_sync xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>WS_MSG_ID_2</ID>
</BasicMessageHeader>
<FinancialPlanReleaseData actionCode="01">
<ID>1</ID>
<SetOfBooksID>PS01</SetOfBooksID>
<Description>Creating release for one plan</Description>
<DefaultIndicator>false</DefaultIndicator>
<ResponsibleEmployeeID>11</ResponsibleEmployeeID>
<ReleaseData>
<CompanyID>PS10000</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<CostCentreID>PS20000</CostCentreID>
<FundID>TRAVEL_FUND</FundID>
<FunctionID>DEMO_FUNC</FunctionID>
<PeriodAmount actionCode="01">
<FiscalYearAccountingPeriodID>2020001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1000</Amount>
</PeriodAmount>
<BudgetCategoryID>TRAVEL</BudgetCategoryID>
</ReleaseData>
</FinancialPlanReleaseData>
<FinancialPlanReleaseData actionCode="01">
<ID>2</ID>
<SetOfBooksID>PS01</SetOfBooksID>
<Description>Creating release for another plan</Description>
<DefaultIndicator>false</DefaultIndicator>
<ResponsibleEmployeeID>11</ResponsibleEmployeeID>
<ReleaseData>
<CompanyID>PS10000</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<CostCentreID>PS20000</CostCentreID>
<FundID>TRAVEL_FUND</FundID>
<FunctionID>DEMO_FUNC</FunctionID>
<PeriodAmount actionCode="01">
<FiscalYearAccountingPeriodID>2021001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1000</Amount>
</PeriodAmount>
<BudgetCategoryID>TRAVEL</BudgetCategoryID>
</ReleaseData>
</FinancialPlanReleaseData>
<FinancialPlanReleaseData actionCode="01">
<ID>PD1_03</ID>
<SetOfBooksID>PS01</SetOfBooksID>
<Description> Plan release creation with project task </Description>
<DefaultIndicator>false</DefaultIndicator>
<ResponsibleEmployeeID>11</ResponsibleEmployeeID>
<ReleaseData>
<CompanyID>PS10000</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<ProfitCentreID>PS10000</ProfitCentreID>
<FundID>STS03</FundID>
<FunctionID>FCRE_FUNC</FunctionID>
<ProjectElementID>GFP1</ProjectElementID>
<PeriodAmount actionCode="01">
<FiscalYearAccountingPeriodID>2019001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">200</Amount>
</PeriodAmount>
<BudgetCategoryID>TRAVEL</BudgetCategoryID>
</ReleaseData>
</FinancialPlanReleaseData>
<FinancialPlanReleaseData actionCode="01">
<ID>PD1_04</ID>
<SetOfBooksID>PS01</SetOfBooksID>
<Description> Plan release creation with project task </Description>
<DefaultIndicator>false</DefaultIndicator>
<ResponsibleEmployeeID>11</ResponsibleEmployeeID>
<ReleaseData>
<CompanyID>PS10000</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<ProfitCentreID>PS10000</ProfitCentreID>
<FundID>STS03</FundID>
<FunctionID>FCRE_FUNC</FunctionID>
<ProjectElementID>GFP1</ProjectElementID>
<PeriodAmount actionCode="01">
<FiscalYearAccountingPeriodID>2020001</FiscalYearAccountingPeriodID>
<Amount currencyCode="Euro">300</Amount>
</PeriodAmount>
<BudgetCategoryID>TRAVEL</BudgetCategoryID>
</ReleaseData>
</FinancialPlanReleaseData>
<FinancialPlanReleaseData actionCode="02">
<ID>PV3_01</ID>
<SetOfBooksID>PS01</SetOfBooksID>
<Description>Updating existing release</Description>
<DefaultIndicator>false</DefaultIndicator>
<ResponsibleEmployeeID>11</ResponsibleEmployeeID>
<ReleaseData>
<CompanyID>PS10000</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<CostCentreID>PS20000</CostCentreID>
<FundID>TRAVEL_FUND</FundID>
<FunctionID>DEMO_FUNC</FunctionID>
<PeriodAmount actionCode="01">
<FiscalYearAccountingPeriodID>2020001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">300</Amount>
</PeriodAmount>
<BudgetCategoryID>TRAVEL</BudgetCategoryID>
</ReleaseData>
</FinancialPlanReleaseData>
</ns1:FinancialPlanReleaseDataBundleMaintainRequest_sync >
Deletion of a plan release:
<ns1:FinancialPlanReleaseDataBundleMaintainRequest_sync xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>WS_MSG_ID_4</ID>
</BasicMessageHeader>
<FinancialPlanReleaseData actionCode="03">
<ID>PV3_02</ID>
<SetOfBooksID>PS01</SetOfBooksID>
<Description>Deletion of a plan release</Description>
<DefaultIndicator>false</DefaultIndicator>
<ResponsibleEmployeeID>11</ResponsibleEmployeeID>
<ReleaseData>
<CompanyID>PS10000</CompanyID>
<ChartOfAccountsItemCode>500300</ChartOfAccountsItemCode>
<CostCentreID>PS20000</CostCentreID>
<FundID>TRAVEL_FUND</FundID>
<FunctionID>DEMO_FUNC</FunctionID>
<PeriodAmount actionCode="01">
<FiscalYearAccountingPeriodID>2020001</FiscalYearAccountingPeriodID>
<Amount currencyCode="USD">1000</Amount>
</PeriodAmount>
<BudgetCategoryID>TRAVEL</BudgetCategoryID>
</ReleaseData>
</FinancialPlanReleaseData>
</ns1:FinancialPlanReleaseDataBundleMaintainRequest_sync >
| Description | Manage plan release |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To create, update, or delete financial plan release data
The request message contains a BasicMessageHeader node element as well as a FinancialPlanReleaseData node element that contains the plan release data to be created, updated, or deleted. The detailed structure of that node is explained in the following sub-chapters. The FinancialPlanReleaseData node can occur multiple times in the request message – this means that multiple plan releases can be created and updated through a single Web service request.
The response message type contains log items and a release-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID and the ID of the affected release.
The FinancialPlanReleaseData node element contains the general data of a plan release.
The ID element contains the ID of the release that is shown as Release Version on the UI. For a financial plan release to be created, a default financial plan for the same combination of company, set of books, and fiscal year must exist in the system. You can create such a plan release 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 -> Release view.
The DefaultIndicator corresponds to the Default UI element that can be changed by UI actions Set as Default and Reset Default.
The ReleaseData node element contains the characteristics of a plan release data record.
The company of the plan release is provided on this level to support releases 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 release costs or revenues on profit center level, you can omit the cost center and instead provide a profit center in element ProfitCentreID.
Project task of the plan release is provided in element ProjectElementID. Either project task or cost center can be entered depending upon the plan information while creating a plan release.
The functional area of a plan release data record is derived from the cost center or G/L account. It cannot be provided by the Web service.
The PeriodAmount node element contains the fiscal year period and the amount of a release 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 release 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 release data for different accounting periods for the same combination of company, cost center, and G/L account. Repeating the entire ReleaseData element is also possible but will result in a larger xml message.