Definition
An interface to manage partner company data from an external application.
Business Context and Use
The webservice interface ManageCompanyFinancialsProcessControlIn enables you to connect external applications to your SAP ByDesign system and create or update partner companies.
The webservice ManageCompanyFinancialsProcessControlIn offers the operations CheckMaintainbundle and MaintainBundle .
Here is an example of a simple request:
<n0:CompanyFinancialsProcessControlBundleMaintainRequest
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader></BasicMessageHeader>
<CompanyFinancialsProcessControl>
<CompanyID>MDEC10494</CompanyID>
<AffiliationPeriod>
<AffiliationPeriod>
<StartDate>1999-01-24</StartDate>
<EndDate>2018-01-24</EndDate>
</AffiliationPeriod>
</AffiliationPeriod>
</CompanyFinancialsProcessControl>
</n0:CompanyFinancialsProcessControlBundleMaintainRequest>
More Information
General Information
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.
Scenarios
Possible scenarios include the following:
The MaintainBundle operation is used to create partner companies
The MaintainBundle operation can be used to update partner companies
The MaintainBundle operation can be used to delete partner companies
Definition
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a CompanyFinancialsProcessControl node element that contains partner company data to be created or updated. The CompanyFinancialsProcessControl node can occur multiple times in the request message – this means that multiple partner companies can be created and updated through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a Partner Company specific node with SenderTechnicalID, ChangeStateID, as well as CompanyID.
Example
Here is an example of a valid message for the operation MAINTAIN BUNDLE :
<n0:CompanyFinancialsProcessControlBundleMaintainRequest
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader></BasicMessageHeader>
<CompanyFinancialsProcessControl textListCompleteTransmissionIndicator="true">
<CompanyID>MDEC10494</CompanyID>
<AffiliationPeriod>
<AffiliationPeriod>
<StartDate>1999-01-24</StartDate>
<EndDate>2018-01-24</EndDate>
</AffiliationPeriod>
</AffiliationPeriod>
<Text>
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<TypeCode>10001</TypeCode>
<ContentText>Note text</ContentText>
</Text>
<AttachmentFolder DocumentListCompleteTransmissionIndicator="true">
<Document>
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>3</CategoryCode>
<TypeCode>10001</TypeCode>
<Name>www.google.com</Name>
<AlternativeName>Google</AlternativeName>
<Description>Google website</Description>
<ExternalLinkWebURI>http://www.google.com</ExternalLinkWebURI>
<FileContentURI>http://www.google.com</FileContentURI>
</Document>
</AttachmentFolder>
</CompanyFinancialsProcessControl>
</n0:CompanyFinancialsProcessControlBundleMaintainRequest>
If the creation of the new partner company was successful, the response message will be similar to:
<n0:CompanyFinancialsProcessControlBundleMaintainConfirmation
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"
xmlns:prx="urn:sap.com:proxy:H3E:/1SAI/TAEA7B8A71A9869D30A3559:804">
<CompanyFinancialsProcessControlMaintainConfirmationBundle>
<ReferenceObjectNodeSenderTechnicalID></ReferenceObjectNodeSenderTechnicalID>
<ChangeStateID> 20170411144828.0864800</ChangeStateID>
<CompanyUUID>00163e15-de0a-1ed7-86c0-49c8ccf7d210</CompanyUUID>
<CompanyID>MDEC10494</CompanyID>
</CompanyFinancialsProcessControlMaintainConfirmationBundle>
<Log/>
</n0:CompanyFinancialsProcessControlBundleMaintainConfirmation>
In case of errors, a log will be sent:
<n0:CompanyFinancialsProcessControlBundleMaintainConfirmation
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"
xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAEA7B8A71A9869D30A3559:804">
<Log>
<MaximumLogItemSeverityCode>3</MaximumLogItemSeverityCode>
<Item>
<TypeID>038(/FIN_CFPC/)</TypeID>
<CategoryCode>INC.BOI</CategoryCode>
<SeverityCode>3</SeverityCode>
<Note>Partner Company MDEC10494 already exists</Note>
</Item>
</Log>
</n0:CompanyFinancialsProcessControlBundleMaintainConfirmation>
Text
Notes can be added as partner company notes.
If an update operation on the Text node is to be performed, the textListCompleteTransmissionIndicator must be set to "true", and the complete list has to be transmitted. Notes can be changed by the creator only.
The following typecodes are available for texts:
Type code |
Description |
10001 |
Additional External Comment |
10006 |
Detailed description |
Note: If a web service call is performed using a communication user, then created texts cannot be changed afterwards through the UI, because it is not possible to log on with the communication user.
Attachments
The AttachmentFolder node element can be used to add and remove attachments.
Data for this node can be found on the account UI as Attachments. On the user interface, Files and Links can be created. In the web service request, links and files are differentiated through the CategoryCode:
Category code |
Description |
2 |
Document |
3 |
Link |
The different types of attachments are differentiated by the TypeCode. For partner companies, only 10001 is supported.
Type code |
Description |
10001 |
Standard attachment |
To create link attachments, Document elements must be as follows:
Element |
Value |
VisibleIndicator |
"true" |
CategoryCode |
3 |
TypeCode |
10001 |
AlternativeName |
<Document Title> |
ExternalLinkWebURI |
<link URI> |
Description |
<Comment> |
To create file attachments, Document elements must be as follows:
Element |
Value |
VisibleIndicator |
"true" |
CategoryCode |
2 |
TypeCode |
10001 |
Name |
<Document Title> |
AlternativeName |
<Document Title> |
Description |
<Comment> |