Operation: Get_Journals

This service operation will get Journal Entries for the specified criteria. Journal data includes the Journal Entry Reference, Journal Entry Status, Company, Currency, Ledger Period, Accounting Date, Journal Source, Transaction Date, Operational Transaction, Memo, Book Code, Journal Entry Line data and Attachment Data. Journal Entry Line data includes Inter Company Affiliate, Ledger Account, Debit Amount, Credit Amount, Currency, Ledger Debit Amount, Ledger Credit Amount, Memo, and Worktags. The request criteria can be for a single transaction based on Reference, or all transaction can be retrieved if no criteria is specified.

@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.

Response_Filter

Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.

Parameter name

Type/Value

Cardinality

Description

Validations

As_Of_Effective_Date

date

[0..1]

Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.

As_Of_Entry_DateTime

dateTime

[0..1]

Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.

Page

decimal (12, 0) >0

[0..1]

Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data.
Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.

Count

decimal (3, 0) >0

[0..1]

Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.

Response_Results

The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.

Parameter name

Type/Value

Cardinality

Description

Validations

Total_Results

decimal (12, 0) >0

[0..1]

The total number of results that have been returned from your request.

Total_Pages

decimal (12, 0) >0

[0..1]

The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset.
Each page contains a maximum of 100 entries.

The Ledger Accounts for each Journal Line must be of a Balance Sheet Type.

The Ledger Accounts for each Journal Line must be of a Balance Sheet Type.

Only one worktag for each type is allowed for each document line.

Only one worktag for each type is allowed for each document line.

Line Company should be the same as the company for Beginning Balance journals.

Line Company should be the same as the company for Beginning Balance journals.

Cannot have an Employee Worktag along with a Contingent Worker Worktag for the same line.

Can not have any combination of Project, Project Phase or Project Task worktags for the same line.

Can not have any combination of Project, Project Phase or Project Task worktags for the same line.

If the View Budget Date flag is not set on the Ledger, Journal Line Budget Date cannot be submitted.

The worktag selected is a Position for a Supervisory Organization whose staffing model is Position Management. Please select a Position Restriction or select a Position for the Job Management staffing model.

Grant Worktag selected: [grant] does not match Company: [company] on an Award Line in effect

Ledger Debit Amount and Ledger Credit Amount must be zero when Round Ledger Amounts is specified.

Line Company Reference must match the header company when Round Ledger Amounts is specified.

The following worktag type(s) are required: [missing]

If the Display Account set is defined, then the Ledger Accounts must come from that account set.

You are attempting to submit a journal for [company] which does not have a resulting ledger account mapped or specified.

Enter the Unit of Measure for the Quantity.

Enter the Quantity for the Unit of Measure.

Enter Unit of Measure 2 for Quantity 2.

Enter Quantity 2 for Unit of Measure 2.

[missing worktags message]

[non-allowed worktags message]

Tax Details can only be entered for an Accounting Journal.

Tax Details can only be entered for an Accounting Journal.

Enter the same Supplier in the Worktag field and on the Tax Details.

Enter the same Customer in the Worktag field and on the Tax Details.

The External Reference ID should not be specified

Journal Line contains invalid worktag types for an accounting journal or contains tax worktags that should be on tax details.

The Credit and Debit Amounts are both zero.

The Credit and Debit Amounts are both zero.

The Credit and Debit Amounts are both zero.

The Credit and Debit Amounts are both zero.

Transaction credits or debits must be populated if the line companies have different ledger currencies.

The company for the line for intercompany journals.If field is left blank, it will default to the same company as the header company. For non-intercompany journals this field should be left blank or have the same value as the header company. For beginning balance journal loads, this field should always be blank or the same as the header company. For journals that are intercompany beginning balances, the other company should only be referenced as an intercompany affiliate worktag.

Validation

Description

[2] is not configured to allow intercompany transactions with [1]

The company is not configured for intercompany transactions with the company specified

Update the status of the ledger period for journal entries of the company [company] using one of the Update Ledger Period Status tasks.

The company specified has a ledger period with an invalid status.

Journal must be an Adjustment Journal to be submitted in an Adjustment Period for [company].

Journal must be an Adjustment Journal to be submitted in an Adjustment Period.

The date selected does not have a valid ledger period associated with it.

The date selected does not have a valid ledger period associated with it.

Reversal cannot be created because the ledger period for the reversal date and the affiliate company does not exist. Please use one of the Ledger/Ledger Period tasks for the company to create the period.

Reversal cannot be created because the ledger period for the reversal date and the affiliate company does not exist. Please use one of the Ledger/Ledger Period tasks for the company to create the period.

Alternate Ledger Account (ALA) provides the ability, when Alternate Account Set is enabled for the header company, to override the account to which the Ledger Account is mapped by the Alternate Account Set Mapping rules.
I.E. - if the Ledger Account is 1000 Cash, and the mapping rules map the journal to the 1100 Alternate Cash account, setting the ALA to 1200: Other Cash Account will cause the journal to use Other Cash rather than Alternate Cash.

Validation

Description

Alternate Ledger Account: [ala] is not a member of [company]'s Primary or Alternate Account Sets.

At least one of the Ledger Accounts entered is retired. Only non retired accounts are allowed.

The given ledger account has restrictions that do not allow it to be used by this company.

Reference to the currency of the company. If entered, this field is not processed on inbound Workday Web Services requests.

Validation

Description

Currency Conversion Rates between currency and company's default currency are not defined.

Currency Conversion Rates between the currency on the Journal Line and company's default currency must be defined for the selected Currency Rate Type, effective as of the Accounting Date for the Journal. This validation only applies to Accounting Journals.

Currency_Rate

decimal (18, 6)

[0..1]

Currency Rate for line

Validation

Description

The Currency Rate cannot be negative.

If the base currency is equal to the transaction currency, the currency rate cannot be entered.

Ledger_Debit_Amount

decimal (18, 3)

[0..1]

Ledger Debit Amount

Validation

Description

If the base currency and the transaction currency are equal, the transaction amount must equal the ledger amount.

If the base currency and the transaction currency are equal, the transaction amount must equal the ledger amount.

Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval.

Validation

Description

The intercompany affiliate [worktag] may not be chosen when specifying header company [header company] and line company [line company].

You have chosen an invalid combination of header company, line company, and intercompany affiliate.

Select a balancing worktag for Worktags of the following type: [type]

A balancing worktag is required if worktag balancing has been enabled for the tenant.

Only one worktag of each type is allowed

Only one worktag of each type is allowed

One and only one Spend Category worktag or Pay Component worktag needed when using a Grant worktag.

One and only one Spend Category worktag or Pay Component worktag needed when using a Grant worktag.

The [type] is/are not available for use with the company/s: [partitionable] [company]

The following worktag type and value pairs are invalid because the worktag is inactive: [worktag and type].

You must have Worktag Balancing enabled in order to define a Worktag Balancing Affiliate.

You must have Worktag Balancing enabled in order to define a Worktag Balancing Affiliate.

Enter an Interworktag Affiliate that is the type [tenant type].

The Interworktag Affiliate Type must be of the same type as defined for Balancing Worktags at the tenant level.

The Balancing Worktag in the Worktags field is not allowed to be the same as the Interworktag Affiliate.

When an Intercompany Affiliate is present in the Worktags field you are not allowed to have a Interworktag Affiliate.

Exclude_from_Spend_Report

boolean

[0..1]

For expense report and supplier invoice transactions tied to a capital project worktag, Workday creates special accounting to appropriately debit the Work in Progress account, while also recording the amount as a debit into the Spend account. This is necessary to reflect correct amounts for the purposes of Budget Checking/Reporting, and any other custom spend reports.

Both Customer and Supplier cannot be entered together. Choose one to keep and remove the other.

Both Customer and Supplier cannot be entered together. Choose one to keep and remove the other.

External business parameters cannot be entered when a Customer or Supplier has been entered. Remove either the external business parameters or the customer or supplier selected.

External business parameters cannot be entered when a Customer or Supplier has been entered. Remove either the external business parameters or the customer or supplier selected.

Include Tax Lines should be selected to add Journal Line Tax Detail Data.

Include Tax Lines should be selected to add Journal Line Tax Detail Data.

The field Tax Applicability is required and must have a value.

The field Tax Applicability is required and must have a value.

You can’t enter Tax Recoverability for a Tax Type of Tax Collected.

You can’t enter Tax Recoverability for a Tax Type of Tax Collected.

You must enter a Tax Recoverability Type when the Tax Recoverability is partially recoverable.

You must enter a Tax Recoverability Type when the Tax Recoverability is partially recoverable.

The Tax Recoverability Type must be Nonrecoverable when the Tax Recoverability is nonrecoverable.

The Tax Recoverability Type must be Nonrecoverable when the Tax Recoverability is nonrecoverable.

You can’t enter Tax Recoverability for a Withholding Tax Code.

You can’t enter Tax Recoverability for a Withholding Tax Code.

The Tax Recoverability Type must be Fully Recoverable when the Tax Recoverability is fully recoverable.

The Tax Recoverability Type must be Fully Recoverable when the Tax Recoverability is fully recoverable.

Enter a Tax Recoverability or select a Tax Applicability that has a default Tax Recoverability.

Enter a Tax Recoverability or select a Tax Applicability that has a default Tax Recoverability.

You can’t enter a Tax Applicability for a Withholding Tax Code.

You can’t enter a Tax Applicability for a Withholding Tax Code.

You can’t enter a Tax Recoverability Type for a Withholding Tax Code.

You can’t enter a Tax Recoverability Type for a Withholding Tax Code.

When you enter a Tax Point Date Type, you must specify a Transaction Tax Code.

You can only enter the Tax Point Date Type when you select the Enable Tax Point Date Configuration check box on the Edit Tenant Setup - Financials task.

Enter a Tax Recoverability Type or select a Tax Applicability that has a default Tax Recoverability.

Enter a Tax Recoverability Type or select a Tax Applicability that has a default Tax Recoverability.

Validation

Description

The Credit and Debit Amount both have values.

The Credit and Debit Amount both have values.

The Ledger Accounts for each Journal Line must be of a Balance Sheet Type.

The Ledger Accounts for each Journal Line must be of a Balance Sheet Type.

Only one worktag for each type is allowed for each document line.

Only one worktag for each type is allowed for each document line.

Line Company should be the same as the company for Beginning Balance journals.

Line Company should be the same as the company for Beginning Balance journals.

Cannot have an Employee Worktag along with a Contingent Worker Worktag for the same line.

Can not have any combination of Project, Project Phase or Project Task worktags for the same line.

Can not have any combination of Project, Project Phase or Project Task worktags for the same line.

If the View Budget Date flag is not set on the Ledger, Journal Line Budget Date cannot be submitted.

The worktag selected is a Position for a Supervisory Organization whose staffing model is Position Management. Please select a Position Restriction or select a Position for the Job Management staffing model.

Grant Worktag selected: [grant] does not match Company: [company] on an Award Line in effect

Ledger Debit Amount and Ledger Credit Amount must be zero when Round Ledger Amounts is specified.

Line Company Reference must match the header company when Round Ledger Amounts is specified.

The following worktag type(s) are required: [missing]

If the Display Account set is defined, then the Ledger Accounts must come from that account set.

You are attempting to submit a journal for [company] which does not have a resulting ledger account mapped or specified.

Enter the Unit of Measure for the Quantity.

Enter the Quantity for the Unit of Measure.

Enter Unit of Measure 2 for Quantity 2.

Enter Quantity 2 for Unit of Measure 2.

[missing worktags message]

[non-allowed worktags message]

Tax Details can only be entered for an Accounting Journal.

Tax Details can only be entered for an Accounting Journal.

Enter the same Supplier in the Worktag field and on the Tax Details.

Enter the same Customer in the Worktag field and on the Tax Details.

The External Reference ID should not be specified

Journal Line contains invalid worktag types for an accounting journal or contains tax worktags that should be on tax details.

The Credit and Debit Amounts are both zero.

The Credit and Debit Amounts are both zero.

The Credit and Debit Amounts are both zero.

The Credit and Debit Amounts are both zero.

Transaction credits or debits must be populated if the line companies have different ledger currencies.