Description | Query Journal Entries |
Name | QueryJournalEntryIn |
Namespace | http://sap.com/xi/A1S/Global |
Product | SAP Business ByDesign |
Process component | Financial Accounting |
Process component namespace | http://sap.com/xi/AP/FinancialAccounting/Global |
Deployment unit | Financials |
Endpoint Activation | By Scoping of Process Component | Operations |
|
Release Status | Released |
Technical documentation on the SAP API Business Hub | Query Journal Entries |
General web service documentation | A2X Web Services (SOAP) |
An interface to query journal entries.
The web service interface Query Journal Entry In enables you to connect external applications to your solution and to query and read journal entries in your system. The web service interface Query Journal Entry In is relevant if your company wants to extract or transfer financial accounting transaction data to an external system.
The web service interface Query Journal Entry In offers the operations Find By Elements.
Here is an example of a simple web service request, which seeks for a journal entry for Source Document 234517 with source document type 7
<glob:JournalEntryByElementsQuery> <JournalEntrySelectionByElements> <SelectionByOriginalEntryDocumentObjectReferenceObjectTypeCode> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryCode>7</LowerBoundaryCode> </SelectionByOriginalEntryDocumentObjectReferenceObjectTypeCode> <SelectionByOriginalEntryDocumentContainingObjectReferenceFormattedID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>234517</LowerBoundaryIdentifier> </SelectionByOriginalEntryDocumentContainingObjectReferenceFormattedID> </JournalEntrySelectionByElements> </glob:JournalEntryByElementsQuery>
Here is an excerpt of the response of the request:
<JournalEntry> <ID>2345734574</ID> <OriginalEntryDocumentReference> <FormattedID>234517</FormattedID> <ObjectTypeCode>7</ObjectTypeCode> <ObjectNodeTypeCode>1072</ObjectNodeTypeCode> </OriginalEntryDocumentReference> <CompanyID>MC10000</CompanyID> <SetOfBooksID>0001</SetOfBooksID> <PostingDate>2013-03-22</PostingDate> <FiscalYearID>2013</FiscalYearID> <AccountingPeriodID>003</AccountingPeriodID> <SystemAdministrativeDataCreationDateTime>2013-03-22T14:07:56.248162Z</SystemAdministrativeDataCreationDateTime> <SystemAdministrativeDataCreationIdentityID>DSILVER_BC</SystemAdministrativeDataCreationIdentityID> <SystemAdministrativeDataLastChangeDateTime>2013-03-22T14:07:56.248162Z</SystemAdministrativeDataLastChangeDateTime> <SystemAdministrativeDataLastChangeIdentityID>DSILVER_BC</SystemAdministrativeDataLastChangeIdentityID> ... <Item> <ID>1</ID> <ChartOfAccountsCode>CAUS</ChartOfAccountsCode> <ChartOfAccountsItemCode listID="CAUS">518000</ChartOfAccountsItemCode> <LocalCurrencyAmount currencyCode="USD">10.0</LocalCurrencyAmount> ... </Item> <Item> <ID>2</ID> ... </Item> </JournalEntry>
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.
Description | Find journal entries |
Name | FindByElements |
Synchronous | yes |
Release Status | Released |
To find journal entries by elements.
The request message of the operation FindByElements contains the JournalEntrySelectionByElements node that groups all possible selection parameters.
This node groups all selection parameters. The selection parameters are as follows:
Selection Parameter | Remark |
---|---|
SelectionByID | Selection by internal journal entry ID - identifier of the accounting document that is unique for the combination of company, set of books and fiscal year |
SelectionByUUID | Selection by UUID - unique identifier of the accounting document |
SelectionByOriginalEntryDocumentContainingObjectReferenceUUID | Selection by UUID of the original reference object that contains the source document of the business transaction that caused the accounting document |
SelectionByOriginalEntryDocumentContainingObjectReferenceID | Selection by scheme ID of the original reference object that contains the source document of the business transaction that caused the accounting document |
SelectionByOriginalEntryDocumentContainingObjectReferenceIDSchemeAgencyID | Selection by Scheme Agency ID of the original reference object that contains the source document of the business transaction that caused the accounting document |
SelectionByOriginalEntryDocumentContainingObjectReferenceFormattedID | Selection by formatted ID of the original reference object that contains the source document of the business transaction that caused the accounting document |
SelectionByOriginalEntryDocumentContainingObjectReferenceObjectTypeCode | Selection by object type code of the original reference object that contains the source document of the business transaction that caused the accounting document e.g. 86 for manual payment; 127 for supplier invoice etc. |
SelectionByOriginalEntryDocumentContainingObjectReferenceObjectNodeTypeCode | Selection by object node type code of the original reference object that contains the source document of the business transaction that caused the accounting document e.g. 821 for payment order root; 1029 for line item etc. |
SelectionByOriginalEntryDocumentObjectReferenceUUID | Selection by UUID of the source document |
SelectionByOriginalEntryDocumentObjectReferenceID | Selection by scheme ID of the source document |
SelectionByOriginalEntryDocumentObjectReferenceIDSchemeAgencyID | Selection by Scheme Agency ID of the source document |
SelectionByOriginalEntryDocumentObjectReferenceFormattedID | Selection by formatted ID of the source document |
SelectionByOriginalEntryDocumentObjectReferenceObjectTypeCode | Selection by object type code of the source document e.g. 86 for manual payment; 127 for supplier invoice etc. |
SelectionByOriginalEntryDocumentObjectReferenceObjectNodeTypeCode | Selection by object node type code of the source document e.g. 821 for payment order root; 1029 for line item etc. |
SelectionByOriginalEntryTransactionUUID | Selection by unique identifier of the transaction during which the original entry document was created or changed |
SelectionByOriginalEntryDocumentPartnerID | Selection by the identifier of the original entry document as assigned by the business partner, e.g. the ID of the supplier invoice assigned by the supplier |
SelectionByCompanyUUID | Selection by unique identifier of the company for which the accounting document is posted |
SelectionByCompanyID | Selection by formatted ID of the company for which the accounting document is posted |
SelectionByAccountingDocumentTypeCode | Selection by journal entry type code i.e. coded representation of the type of the accounting document e.g. 00027 for clearing, 00047 for manual journal entry voucher etc. |
SelectionByCancellationDocumentIndicator | Selection by cancellation indicator which represents whether the accounting document refers to a cancellation document for a business transaction |
SelectionByNote | Selection by note which contains explanations on the document |
SelectionByAccountingClosingStepCode | Selection by closing step of the accounting document e.g. 010 for operational postings, 020 for closing entries etc. |
SelectionBySetOfBooksID | Selection by the ID of the set of books according to the specifications of which the accounting document was posted |
SelectionByOriginalEntryDocumentDate | Selection by the issue date of the original source document |
SelectionByAccountingBusinessTransactionDate | Selection by the date on which the business transaction occurred in terms of the accounting criteria applied |
SelectionByPostingDate | Selection by the date with which the business transaction was effectively recorded in accounting |
SelectionByCurrencyConversionDate | Selection by the date used for currency conversion applied to amounts in the accounting document |
SelectionByFiscalYearVariantCode | Selection by the coded representation of the fiscal year variant of which the fiscal year definition (begin, end, period definition) is used to derive the Fiscal Year ID and Accounting Period ID |
SelectionByFiscalYearID | Selection by the ID of the fiscal year in which the accounting document was posted |
SelectionByAccountingPeriodID | Selection by the ID of the posting period of the accounting document within the fiscal year |
SelectionBySystemAdministrativeDataCreationDateTime | Selection by the date and time of the creation of the accounting document in the format YYYY-MM-DDT00:00:00.0000000Z |
SelectionBySystemAdministrativeDataCreationIdentityID | Selection by the ID of the user who created the accounting document |
SelectionBySystemAdministrativeDataLastChangeDateTime | Selection by the date and time of the last change of the accounting document in the format YYYY-MM-DDT00:00:00.0000000Z |
SelectionBySystemAdministrativeDataLastChangeIdentityID | Selection by the ID of the user who last changed the accounting document |
SelectionByOriginalEntryDocumentCreationDateTime | Selection by the date and time when the source document was created |
SelectionByOriginalEntryDocumentCreationIdentityUUID | Selection by the unique identifier of the user that created the source document |
SelectionBySearchText | Selection by freetext search |
The response message will contain root level data, such as journal entry ID, posting date, set of books and company, as well as item nodes which detail the GL accounts used, subledger type (ARP, Cash, etc.) and will detail the amounts involved, as well as lots of other data like organisational assignment, product details etc.