| Description | Query Company Payment File Register Outgoing Files Integration |
| Name | QueryCompanyPaymentFileRegisterOutgoingFileIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Payment Processing |
| Process Component Name | PaymentProcessing |
| Process Component Namespace | http://sap.com/xi/AP/Payment/Global |
| Deployment Unit Description | Financials |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to query outgoing payment files for a given company.
The Company Payment File Register Outgoing File In inbound service interface finds the outgoing payment files relevant for a company. The service interface offers an operation Find By Elements that receives a message containing the company information and other details and returns the relevant outgoing payment files.
The request structure is as follows:
Show full documentation
Show full documentation
<n0:CompanyPaymentFileRegisterOutgoingFileFindByElementsQuery_Sync>
<CompanyPaymentFileRegisterOutgoingFileFindByElements>
<CompanyID></CompanyID>
<LowerBoundaryFileCreationDate></LowerBoundaryFileCreationDate>
<UpperBoundaryFileCreationDate></UpperBoundaryFileCreationDate>
<LowerBoundaryFileID></LowerBoundaryFileID>
<UpperBoundaryFileID></UpperBoundaryFileID>
<LatestFileRequiredIndicator></LatestFileRequiredIndicator>
<FileContentTypeCode></FileContentTypeCode>
<ReleasedOnlyIndicator></ReleasedOnlyIndicator>
<FileStatus></FileStatus>
<FileStatus></FileStatus>
</CompanyPaymentFileRegisterOutgoingFileFindByElements>
</n0:CompanyPaymentFileRegisterOutgoingFileFindByElementsQuery_Sync>
1. The <ReleasedOnlyIndicator> takes the first precedence over all other file statuses.
Hence, when the <ReleasedOnlyIndicator> is set either to true or false, then all other status codes given in <FileStatus/> will be ignored and the query will return only files with status 'Released'.
2. The next priority is given to <FileStatus/>. i.e. the query will return the files with the status provided in this tag.
The valid status codes for this field is given below:
| Status code | Description |
|---|---|
| 3 | In Release |
| 5 | Released for Transfer |
| 7 | In Transfer |
| 8 | Confirmed |
3. Lastly, when none of the above two conditions are satisfied, then the query returns all files with statuses 'In Release', 'Release In Transfer' or 'In Transfer'.
Query for the company payment file register outgoing files can be done on the following parameters:
| Parameters | Description | Data Type | Integrity Condition |
|---|---|---|---|
| CompanyID | Internal identifier of the company to whom the outgoing file belongs | Identifier | Mandatory |
| LowerBoundaryFileCreationDate | Creation date of outgoing payment file that is used as the lower boundary for the selection | Date | Optional |
| UpperBoundaryFileCreationDate | Creation date of outgoing payment file that is used as the upper boundary for the selection | Date | Optional |
| LowerBoundaryFileID | Identifier of the outgoing payment file that is used as the lower boundary for the selection | Identifier | Optional |
| UpperBoundaryFileID | Identifier of the outgoing payment file that is used as the upper boundary for the selection | Identifier | Optional |
| LatestFileRequiredIndicator | Indicates if the latest outgoing payment file is required | Indicator | Mandatory |
| FileContentTypeCode | Coded representation of the type of the outgoing payment file | Code | Optional |
Response for the query would contain the following elements:
| Elements | Description | Data Type |
|---|---|---|
| CompanyID | Internal identifier of the company to whom the outgoing payment file belongs | Identifier |
| FileCreationDate | Date on which the outgoing payment file was created | Date |
| FileID | Identifier of the outgoing payment file | Identifier |
| FilePaymentAmount | Total payment amount of the outgoing payment file in payment currency | Amount |
| FileContentTypeCode | Coded representation of the type of the outgoing payment file | Code |
| FileName | Name of the outgoing payment file | Name |
| FileMIMECode | Coded representation of medium type of the binary content of the outgoing payment file according to the corresponding MIME type recommendations | Code |
| FileSizeMeasure | Size of the outgoing payment file | Measure |
| FileBinaryObject | File encoded in binary format | BinaryObject |
| FileContentTypeCode value | Description |
|---|---|
| 1 | Bank Transfer |
| 2 | Wire Transfer |
| 3 | Direct Debit |
| 4 | Outgoing Check |
| 5 | Bill of Exchange Commercial Transfer |
| 6 | Bill of Exchange Deposit |
| 7 | Bill of Exchange with Cashing Acceptance |
| 8 | Outgoing Boleto |
You can find general information about Web services, their structure and consumption in the Web Services documentation.
| Description | Find outgoing files |
| Name | FindByElements |
| Synchronous | yes |
| Release Status | Released |
To find outgoing payment files by elements.
The Company Payment File Register Outgoing File In inbound operation receives the request message to query for outgoing payment files and sends as response the corresponding outgoing payment file content.
The request structure is as follows:
<n0:CompanyPaymentFileRegisterOutgoingFileFindByElementsQuery_Sync>
<CompanyPaymentFileRegisterOutgoingFileFindByElements>
<CompanyID></CompanyID>
<LowerBoundaryFileCreationDate></LowerBoundaryFileCreationDate>
<UpperBoundaryFileCreationDate></UpperBoundaryFileCreationDate>
<LowerBoundaryFileID></LowerBoundaryFileID>
<UpperBoundaryFileID></UpperBoundaryFileID>
<LatestFileRequiredIndicator></LatestFileRequiredIndicator>
<FileContentTypeCode></FileContentTypeCode>
</CompanyPaymentFileRegisterOutgoingFileFindByElements>
</n0:CompanyPaymentFileRegisterOutgoingFileFindByElementsQuery_Sync>
Query for the company payment file register outgoing files can be done on the following parameters:
| Parameters | Description | Data Type |
|---|---|---|
| CompanyID | Internal identifier of the company to whom the outgoing file belongs | Identifier |
| LowerBoundaryFileCreationDate | Creation date of outgoing payment file that is used as the lower boundary for the selection | Date |
| UpperBoundaryFileCreationDate | Creation date of outgoing payment file that is used as the upper boundary for the selection | Date |
| LowerBoundaryFileID | Identifier of the outgoing payment file that is used as the lower boundary for the selection | Identifier |
| UpperBoundaryFileID | Identifier of the outgoing payment file that is used as the upper boundary for the selection | Identifier |
| LatestFileRequiredIndicator | Indicates if the latest outgoing payment file is required | Indicator |
| FileContentTypeCode | Coded representation of the type of the outgoing payment file | Code |
Response for the query would contain the following elements:
| Elements | Description | Data Type |
|---|---|---|
| CompanyID | Internal identifier of the company to whom the outgoing payment file belongs | Identifier |
| FileCreationDate | Date on which the outgoing payment file was created | Date |
| FileID | Identifier of the outgoing payment file | Identifier |
| FilePaymentAmount | Total payment amount of the outgoing payment file in payment currency | Amount |
| FileContentTypeCode | Coded representation of the type of the outgoing payment file | Code |
| FileName | Name of the outgoing payment file | Name |
| FileMIMECode | Coded representation of medium type of the binary content of the outgoing payment file according to the corresponding MIME type recommendations | Code |
| FileSizeMeasure | Size of the outgoing payment file | Measure |
| FileBinaryObject | File encoded in binary format | BinaryObject |
| FileContentTypeCode value | Description |
|---|---|
| 1 | Bank Transfer |
| 2 | Wire Transfer |
| 3 | Direct Debit |
| 4 | Outgoing Check |
| 5 | Bill of Exchange Commercial Transfer |
| 6 | Bill of Exchange Deposit |
| 7 | Bill of Exchange with Cashing Acceptance |
| 8 | Outgoing Boleto |
An example for a request message for the latest outgoing payment file of Company MC10000 and outgoing file type 1 - Bank Transfer
<n0:CompanyPaymentFileRegisterOutgoingFileFindByElementsQuery_Sync> <CompanyPaymentFileRegisterOutgoingFileFindByElements> <CompanyID>MC10000</CompanyID> <LowerBoundaryFileCreationDate></LowerBoundaryFileCreationDate> <UpperBoundaryFileCreationDate></UpperBoundaryFileCreationDate> <LowerBoundaryFileID></LowerBoundaryFileID> <UpperBoundaryFileID></UpperBoundaryFileID> <LatestFileRequiredIndicator>true</LatestFileRequiredIndicator> <FileContentTypeCode>1</FileContentTypeCode> </CompanyPaymentFileRegisterOutgoingFileFindByElements> </n0:CompanyPaymentFileRegisterOutgoingFileFindByElementsQuery_Sync>
And an example response message for the above request message
<nm:CompanyPaymentFileRegisterOutgoingFileFindByElementsResponse_Sync> <CompanyPaymentFileRegisterOutgoingFileFindByElementsResponseMessage> <CompanyID>MC10000</CompanyID> <FileCreationDate>2012-09-08</FileCreationDate> <FileID>82</FileID> <FilePaymentAmount currencyCode="EUR">-510467.41</FilePaymentAmount> <FileContentTypeCode>1</FileContentTypeCode> <FileName>PayFile_82_DE_DTAUS0_MDECB002_20120908_105825.TXT</FileName> <FileMIMECode>text/plain</FileMIMECode> <FileSizeMeasure unitCode="AD">512.0</FileSizeMeasure> <FileBinaryObject mimeCode="text/plain">MDEyOEFHSzI1MTkwMDAxMDAwMDAwMDBBS1JPTiBIRUlaVEVDSE5JSyBHTUJIICAgICAwODA5MTIg
ICAgMDMyODU2ODU4NTAwMDAwMDAwNzIgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg
ICAgICAgICAgICAgIDEwMTg3QzI1MTkwMDAxMjUxOTAwMDE0MTk1NTk5MjIyMDAwMDAwMDAwMDAw
MDUxMDAwIDAwMDAwMDAwMDAwMjUxOTAwMDEwMzI4NTY4NTg1MDAwNTEwNDY3NDEgICBBTVMgICAg
ICAgICAgICAgICAgICAgICAgICAgICAgICAgIEFLUk9OIEhFSVpURUNITklLIEdNQkggICAgICAg
ICAgICAgICAgICAgICAgICAgICAgICAgIDEgIDAwICAgICAgICAgICAgICAgICAgICAgICAgICAg
ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgMDEyOEUgICAgIDAwMDAw
MDEwMDAwMDAwMDAwMDAwMDAwMDAwMDQxOTU1OTkyMjIwMDAwMDAwMDAyNTE5MDAwMTAwMDAwNTEw
NDY3NDEgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA=</FileBinaryObject> </CompanyPaymentFileRegisterOutgoingFileFindByElementsResponseMessage> </nm:CompanyPaymentFileRegisterOutgoingFileFindByElementsResponse_Sync>