Show full documentation

 Show full documentation

Definition

An interface to create liquidity relevant planning items from a source system or file to a target system.

Business Context and Use

The web service interface Manage Expected Liquidity Item In enables you to connect external applications to your solution and to create liquidity relevant planning items in your system. The web service interface Manage Expected Liquidity Item In is relevant if your company wants to use Expected Liquidity Planning Items in the Liquidity Forecast that cannot be created in the SAP Financials Business ByDesign system.

The web service interface Manage Expected Liquidity Item In offers the operation MaintainBundle.

Here is an example of a simple web service request:

<n0:ExpectedLiquidityItemBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
  <BasicMessageHeader>
    <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID>
  </BasicMessageHeader>
  <ExpectedLiquidityItem ActionCode="04">
    <CompanyID>1000</CompanyID>
    <GroupCode>11</GroupCode>
    <OperationalProcessProgressCategoryCode>8</OperationalProcessProgressCategoryCode>
    <PropertyMovementDirectionCode>1</PropertyMovementDirectionCode>
    <HouseBankAccountID>BOA SWEEP</HouseBankAccountID>
    <Description languageCode="EN">Salary</Description>
    <TransactionCurrencyAmount currencyCode="USD">53990</TransactionCurrencyAmount>
    <ValueDate>2012-12-30</ValueDate>
    <ExpirationDate>2012-12-31</ExpirationDate>
  </ExpectedLiquidityItem>
</n0:ExpectedLiquidityItemBundleMaintainRequest_sync>

Prerequisites

Existence of referenced business objects:

The following business object is only referenced and will not be created by the service operation. It must exist in the system already at the time the web service is called:

• Company

Constraints and Integrity Conditions

Example

<n0:ExpectedLiquidityItemBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
  <BasicMessageHeader>
    <UUID>12345678-90AB-CDEF-0123-456789ABCDDD</UUID>
  </BasicMessageHeader>
  <ExpectedLiquidityItem ActionCode="04">
    <CompanyID>1000</CompanyID>
    <GroupCode>11</GroupCode>
    <OperationalProcessProgressCategoryCode>8</OperationalProcessProgressCategoryCode>
    <PropertyMovementDirectionCode>1</PropertyMovementDirectionCode>
    <TransactionCurrencyAmount currencyCode="USD">1067.54</TransactionCurrencyAmount>
    <ValueDate>2012-12-12</ValueDate>
    <ExpirationDate>2012-12-14</ExpirationDate>
  </ExpectedLiquidityItem>
</n0:ExpectedLiquidityItemBundleMaintainRequest_sync>

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:

• Create

  The MaintainBundle operation is used to create liquidity planning items.

Here is an example web service request that creates three liquidity planning items:

<n0:ExpectedLiquidityItemBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
  <BasicMessageHeader>
    <UUID>12345678-90AB-CDEF-0123-456789ABCJKL</UUID>
  </BasicMessageHeader>
  <ExpectedLiquidityItem ActionCode="01">
    <CompanyID>1000</CompanyID>
    <GroupCode>9</GroupCode>
    <OperationalProcessProgressCategoryCode>8</OperationalProcessProgressCategoryCode>
    <PaymentFormCode>04</PaymentFormCode>
    <PropertyMovementDirectionCode>1</PropertyMovementDirectionCode>
    <HouseBankAccountID>1100062588</HouseBankAccountID>
    <Description languageCode="EN">Fixed Deposit EFDT 123454 Disbursement</Description>
    <TransactionCurrencyAmount currencyCode="USD">580000</TransactionCurrencyAmount>
    <ValueDate>2012-12-15</ValueDate>
    <ExpirationDate>2012-12-16</ExpirationDate>
  </ExpectedLiquidityItem>
  <ExpectedLiquidityItem ActionCode="01">
    <CompanyID>1000</CompanyID>
    <GroupCode>9</GroupCode>
    <OperationalProcessProgressCategoryCode>8</OperationalProcessProgressCategoryCode>
    <PaymentFormCode>05</PaymentFormCode>
    <PropertyMovementDirectionCode>2</PropertyMovementDirectionCode>
    <HouseBankAccountID>1100062588</HouseBankAccountID>
    <Description languageCode="EN">Fixed Deposit EFDT 123454 Collection</Description>
    <TransactionCurrencyAmount currencyCode="USD">580000</TransactionCurrencyAmount>
    <ValueDate>2012-12-15</ValueDate>
    <ExpirationDate>2012-12-16</ExpirationDate>
  </ExpectedLiquidityItem>
  <ExpectedLiquidityItem ActionCode="01">
    <CompanyID>1000</CompanyID>
    <GroupCode>9</GroupCode>
    <OperationalProcessProgressCategoryCode>8</OperationalProcessProgressCategoryCode>
    <PaymentFormCode>05</PaymentFormCode>
    <PropertyMovementDirectionCode>2</PropertyMovementDirectionCode>
    <HouseBankAccountID>1100062588</HouseBankAccountID>
    <Description languageCode="EN">Fixed Deposit EFDT 123454 Interest</Description>
    <TransactionCurrencyAmount currencyCode="USD">8356.83</TransactionCurrencyAmount>
    <ValueDate>2012-12-15</ValueDate>
    <ExpirationDate>2012-12-16</ExpirationDate>
  </ExpectedLiquidityItem></n0:ExpectedLiquidityItemBundleMaintainRequest_sync>

 Show full documentation

 Show full documentation

Definition

To create and update expected liquidity planning items.

Business Context and Use

The request message of the operation MaintainBundle contains a Basic Message Header node element as well as a Expected Liquidity Item node element that contains the liquidity item data to be created. The detailed structure of the expected liquidity item node will be explained in the following sub-chapters. The expected liquidity item node can occur multiple times in the request message – this means that multiple liquidity planning items can be created through a single web service request.

The response message type of the operation MaintainBundle contains log items, processing information, and an expected liquidity item-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as expected liquidity item ID.

Structure

The Expected Liquidity Item node element contains specific information about the expected payment.

The following data is related to the General Data section found in the Forecast Planning Item view:

• PaymentFormCode is dependent on the scoping configuration in SAP Financials OnDemand system and corresponds to the payment methods allowed.

Payment Form Code	Description
04	Direct Debit
05	Bank Transfer
06	Check
12	Wire Transfer
13	Direct Debit (Authorization for Payer’s Bank)
21	Cash Outpayment

• TransactionCurrencyAmount consists of the positive amount and currency of the expected payment and is displayed in the Transaction Amount field (mandatory)

• PropertyMovementDirectionCode determines whether a company expects an incoming or outgoing payment and corresponds to the Cash Flow Direction (mandatory)

Property Movement Direction Code	Description
1	Decrease
2	Increase

• ValueDate defines the expected date the payment is credited or debited at the corresponding bank account and is displayed in the Expected Value Date field (mandatory)

• ExpirationDate determines the date when the liquidity planning item is not considered anymore for the liquidity forecast (mandatory)

The Bank Data consists of:

• CompanyID (mandatory)

• HouseBankAccountID corresponds to Bank Account ID

The Source Data section contains the following data:

• GroupCode determines the origin of the forecast planning item, for example, salary payments for employees and corresponds to the Transaction Source field (mandatory)

Group Code	Description
1	Seller
2	Domestic Seller
3	Foreign Seller
4	Sellers: Affiliated Company
5	Customers
6	Domestic Customers
7	Foreign Customers
8	Customers: Affiliated Company
9	Domestic Banks
10	Foreign Banks
11	Employees
12	Tax Authorities
13	Intra-/Intercompany
14	Undetermined
15	Banks

• OperationalProcessProgressCategoryCode defines the current state in the transaction life cycle of the forecast planning item. For example: Receiving a notification of a future payables item means to choose Receivable/Payable as progress code. The OperationalProcessProgressCategoryCode is displayed as the Transaction Progress field (mandatory)

OperationalProcessProgressCategoryCode	Description
1	Contract
2	Purchase Order/Sales Order
3	Invoice/Credit Memo
4	Receivable/Payable
5	Payment Request
6	Payment Order
7	Payment Confirmation
8	Payment Advice
9	Payment Medium
10	Payment Medium Settlement

The element Description corresponds to the Notes section.

{note:caution}The element CashStorageID must not be used since cash payments are not yet supported{note}

 Show full documentation

 Show full documentation

Definition

To check if forecast liquidity planning item data can be created without errors.

Business Context and Use

The web service request and response message types for the CheckMaintainBundle operation are the same as those of the MaintainBundle operation. The explanations given for MaintainBundle can therefore also be applied to the CheckMaintainBundle operation.