| Description | Query Direct Debit Mandate |
| Name | QueryDirectDebitMandateIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Business Partner Data Management |
| Process Component Name | BusinessPartnerDataManagement |
| Process Component Namespace | http://sap.com/xi/AP/FO/BusinessPartner/Global |
| Deployment Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An Interface to query Direct Debit Mandates
The webservice interface Query Direct Debit Mandate enables you to query and read direct debit mandates in your system.
The web service interface Query Direct Debit Mandate offers the operation Find By Elements.
Here is an example of a simple web service request, which seeks for a direct debit mandate with mandate ID 11223344 for business partner MDEC3000
<n0:DirectDebitMandateByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <DirectDebitMandateSelectionByElements> <SelectionByMandateID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>11223344</LowerBoundaryIdentifier> </SelectionByMandateID> </DirectDebitMandateSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID/> </ProcessingConditions> <RequestedElements directDebitMandateTransmissionRequestCode="1"> <DirectDebitMandate amendmentHistoryItemTransmissionRequestCode="1" attachmentFolderTransmissionRequestCode="1">String 156</DirectDebitMandate> </RequestedElements> </n0:DirectDebitMandateByElementsQuery_sync>
Here is an excerpt of the response of the request:
Show full documentation
Show full documentation
<?xml version="1.0"?>
<n0:DirectDebitMandateByElementsResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<DirectDebitMandate>
<ChangeStateID>20180223132651.4982140</ChangeStateID>
<UUID>00163e07-3d68-1ee8-8693-91e60745b3a4</UUID>
<MandateID>11223344</MandateID>
<CompanyUUID>00300571-ce9b-1ded-89c5-e116d7288211</CompanyUUID>
<CompanyID>MDEC10000</CompanyID>
<CompanyName>SAMPLE COMP GmbH</CompanyName>
<SEPACreditorID>DE98ZZZ09999999999</SEPACreditorID>
<PayerUUID>00163e01-1068-1def-aca1-580429d10e46</PayerUUID>
<PayerID>MDEC3000</PayerID>
<DebtorIdentificationCode>123456</DebtorIdentificationCode>
<PayerBankDetailsID>0001</PayerBankDetailsID>
<PayerBankStandardID>DEUTDEFF100</PayerBankStandardID>
<PayerBankAccountStandardID>DE999999999999</PayerBankAccountStandardID>
<PayerBankName>SAMPLE Bank</PayerBankName>
<Description>DescriptionText</Description>
<MandateType>2</MandateType>
<ValidityPeriod>
<StartDate>2018-02-23</StartDate>
<EndDate>2018-03-24</EndDate>
</ValidityPeriod>
<SignatureDate>2018-02-23</SignatureDate>
<SignatureCityName>Galway</SignatureCityName>
<Status>
<LifeCycleStatusCode>2</LifeCycleStatusCode>
<RequestIssuingStatusCode>1</RequestIssuingStatusCode>
</Status>
<AlternatePayerName>Test_AlternativePayerName</AlternatePayerName>
<AddressInformation>
<CompanyAddressInformation>
<UUID>00300571-ce9b-1ded-89c5-e12131c24211</UUID>
<Address>
<FormattedAddress>
<FormattedAddress>
<FirstLineDescription>SAMPLE COMP</FirstLineDescription>
<SecondLineDescription>Street 1</SecondLineDescription>
<ThirdLineDescription>Block X</ThirdLineDescription>
<FourthLineDescription>Ireland</FourthLineDescription>
</FormattedAddress>
</FormattedAddress>
</Address>
</CompanyAddressInformation>
<PayerAddressInformation>
<UUID>00163e01-1068-1def-aca1-580429d14e46</UUID>
<Address>
<FormattedAddress>
<FormattedAddress>
<FirstLineDescription>SAMPLE Tech GmbH</FirstLineDescription>
<SecondLineDescription>Street 2</SecondLineDescription>
<ThirdLineDescription>Block Y</ThirdLineDescription>
<FourthLineDescription>Ireland</FourthLineDescription>
</FormattedAddress>
</FormattedAddress>
</Address>
</PayerAddressInformation>
<AlternativePayerAddressInformation>
<UUID>ad000000-0000-0000-0000-000000000000</UUID>
<Address>
<PostalAddress>
<HouseNumber>350</HouseNumber>
<StreetName>Graphite Road</StreetName>
<CityName>Galway</CityName>
<CountryCode>IE</CountryCode>
<RegionCode>02</RegionCode>
<PostalCode>56004</PostalCode>
</PostalAddress>
</Address>
</AlternativePayerAddressInformation>
</AddressInformation>
<SystemAdministrativeData>
<CreationDateTime>2018-02-23T13:26:51.498214Z</CreationDateTime>
<CreationIdentityUUID>00300571-ce9b-1ded-93d0-b805e068c466</CreationIdentityUUID>
<LastChangeDateTime>2018-04-25T10:51:14.475422Z</LastChangeDateTime>
<LastChangeIdentityUUID>00300571-ce9b-1ded-93d0-b805e068c466</LastChangeIdentityUUID>
</SystemAdministrativeData>
<AttachmentFolder>
<UUID>00163e07-3d62-1ed8-9191-c47d256e9fd7</UUID>
<Document>
<UUID>00163e07-3d62-1ed8-9191-c5379628dfd7</UUID>
<VersionID>0</VersionID>
<SystemAdministrativeData>
<CreationDateTime>2018-04-20T11:30:05.727168Z</CreationDateTime>
<CreationIdentityUUID>00300571-ce9b-1ded-93d0-b805e068c466</CreationIdentityUUID>
<LastChangeDateTime>2018-04-20T11:30:05.727168Z</LastChangeDateTime>
<LastChangeIdentityUUID>00300571-ce9b-1ded-93d0-b805e068c466</LastChangeIdentityUUID>
</SystemAdministrativeData>
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>2</CategoryCode>
<MIMECode>image/jpg</MIMECode>
<PathName>/BOAttachments/00163E073D621ED89191C47D256E9FD7/1001_payord.JPG</PathName>
<Name>1001_payord.JPG</Name>
<AlternativeName>1001_payord.JPG</AlternativeName>
<FileContentURI>http://ldai01acl.wdf.sap.corp:50000/sap/ap/ds/wd/doc/00163E073D621ED89191C5379628DFD7/1001_payord.JPG?sap-client=120</FileContentURI>
<FilesizeMeasure unitCode="AD">100056.0</FilesizeMeasure>
</Document>
</AttachmentFolder>
</DirectDebitMandate>
<ProcessingConditions>
<ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue>
<MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator>
<LastReturnedObjectID>00163E073D681EE8869391E60745B3A4</LastReturnedObjectID>
</ProcessingConditions>
</n0:DirectDebitMandateByElementsResponse_sync>
You can find general information about Web services, their structure and consumption in the Web Services documentation.
| Description | Find direct debit mandates |
| Name | FindByElements |
| Synchronous | yes |
| Release Status | Released |
To find customer direct debit mandates by elements.
The request message of the operation Find By Elements contains the DirectDebitMandateSelectionByElements node that groups all possible selection parameters.
This node groups all selection parameters. The selection parameters are as follows:
| Selection Parameter | Remark |
|---|---|
| SelectionByUUID | Selection by UUID |
| SelectionByMandateID | Selection by Mandate ID |
| SelectionByCompanyUUID | Selection by Company UUID |
| SelectionByCompanyID | Selection by Company's Org Unit ID |
| SelectionByCompanyName | Selection by Company's Org Unit Name |
| SelectionByPayerID | Selection by Payer's Account ID |
| SelectionByPayerUUID | Selection by Payer UUID |
| SelectionBySEPACreditorID | Selection by SEPA Creditor ID |
| SelectionByPayerBankDetailsID | Selection by the ID of the bank account (0001,0002, etc in the Bank Data for the customer) of the mandate |
| SelectionByPayerBankAccountStandardID | Selection by the IBAN of the bank of the mandate |
| SelectionByPayerBankStandardID | Selection by the SWIFT/BIC of the bank of the mandate |
| SelectionByPayerBankName | Selection by Bank Name |
| SelectionByDescription | Selection by Description |
| SelectionBySingleUseIndicator | Selection by Single Use Indicator |
| SelectionByMandateType | Selection by Mandate Type(1 - SEPA Core, 2 - SEPA B2B, 3 - SEPA COR1) |
| SelectionByValidityPeriodStartDate | Selection by Validity Period Start Date |
| SelectionByValidityPeriodEndDate | Selection by Validity Period End Date |
| SelectionByBlockedIndicator | Selection by Blocked Indicator |
| SelectionBySignatureCityName | Selection by Signature City Name |
| SelectionBySignatureDate | Selection by Signature Date |
| SelectionBySystemAdministrativeDataCreationDateTime | Selection by Creation Date Time |
| SelectionBySystemAdministrativeDataLastChangeDateTime | Selection by Last Change Date Time |
| SelectionByLifeCycleStatusCode | Selection by Status (2 - Active, 5 - Obsolete, 6 - In Preparation) |
| SelectionByRequestIssuingStatusCode | Selection by Request Issuing Status (1 - Not Issued, 2 - Issue Requested, 3 - Issued, 4 - Void) |
| SelectionBySearchText | Selection by Search Text |
The response contains the list of found accounts, log items, and processing conditions.
In this node, all found mandates are contained, including their mandate data according to the RequestedElements provided in the query request. This includes the ChangeStateID that may be needed for subsequent change requests via web services as well.