Service Directory > v32.1 > Financial_Management > Put_Beginning_Balance_Translation_Amounts
 

Operation: Put_Beginning_Balance_Translation_Amounts

This service operation will add Translated Beginning Balance Amounts for the Beginning Balance Journal resolved from the criteria of: Company, Fiscal Year, Ledger Type. The Currency specified determines which amounts will be updated. The Beginning Balance Translation Amount Line Replacement Data updates values for lines that match the combination of Ledger Account, and Worktags. The Lines replace all lines defined for the beginning balance journal for the Currency that is specified on the request.


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


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Put_Beginning_Balance_Translation_Amounts_Request

This element contains data for updating the translated beginning balance amounts for existing beginning balance journals.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Beginning_Balance_Translation_Amounts_Data  Beginning_Balance_Translation_Amounts_Data  [0..1]  This Element stores criteria to resolve to a beginning balance journal based on Company, Fiscal Year, Ledger Type, and Book Code. Beginning Balance Translation Amounts are entered for a given Currency via the Beginning Balnace Translation Amount Replacement Data subelement. 
Validation Description
There is no beginning balance journal for the combination of Company, Fiscal Year, Ledger Type, and Book Code entered, please update at least one of the values.   
Multiple lines with the following combination of Currency, Ledger Account, Alternate Ledger Account, Unit of Measure, Unit of Measure 2, Worktags, Balancing Worktag, and Exclude from Spend Report for this Journal have been submitted: [lines]   
The combination of Currency, Ledger Account, Alternate Ledger Account, Unit of Measure, Unit of Measure 2, Worktags, Balancing Worktag, and Exclude from Spend Report for this Journal is not valid for these lines: [lines]   
Lines with the following combinations of Currency, Ledger Account, Alternate Ledger Account, Worktags, Balancing Worktags, and Exclude from Spend Report for this Journal are missing: [lines]   
 
top
 

Response Element: Put_Beginning_Balance_Translation_Amounts_Response

Element containing the Beginning Balance Journal that was updated from the Put Translated Beginning Balance Amount Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Beginning_Balance_Journal_Reference  Accounting_JournalObject  [0..1]  Reference to the Beginning Balance Journal that updated from the Put Translated Beginning Balance Amounts Request   
top
 

Beginning_Balance_Translation_Amounts_Data

part of: Put_Beginning_Balance_Translation_Amounts_Request
This Element stores criteria to resolve to a beginning balance journal based on Company, Fiscal Year, Ledger Type, and Book Code. Beginning Balance Translation Amounts are entered for a given Currency via the Beginning Balnace Translation Amount Replacement Data subelement.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  The Company Reference is used to resolve a beginning balance journal to Update the Translation Amounts.   
Fiscal_Year_Reference  Fiscal_YearObject  [1..1]  The Fiscal Year is used to resolve what year of beginning balance journal to update.   
Ledger_Type_Reference  Ledger_TypeObject  [1..1]  The Ledger Type is the type for the beginning balance journal (Actuals for example)   
Translation_Currency_Reference  CurrencyObject  [1..1]  The Translation Currency that will be used for the translation amount lines created in the web service.   
Book_Code_Reference  Book_CodeObject  [0..1]  The Book Code is used to resolve a specific beginning balance journal to update. The book code must match exactly.   
Beginning_Balance_Translation_Amount_Line_Replacement_Data  Beginning_Balance_Translation_Amount_Line_Data  [0..*]  Replaces all of the existing translation amounts for the currency specified with the new values that are populated in the web service request. 
Validation Description
Only one worktag for each type is allowed for each document line.  Only one worktag for each type is allowed for each document line. 
 
Validation Description
There is no beginning balance journal for the combination of Company, Fiscal Year, Ledger Type, and Book Code entered, please update at least one of the values.   
Multiple lines with the following combination of Currency, Ledger Account, Alternate Ledger Account, Unit of Measure, Unit of Measure 2, Worktags, Balancing Worktag, and Exclude from Spend Report for this Journal have been submitted: [lines]   
The combination of Currency, Ledger Account, Alternate Ledger Account, Unit of Measure, Unit of Measure 2, Worktags, Balancing Worktag, and Exclude from Spend Report for this Journal is not valid for these lines: [lines]   
Lines with the following combinations of Currency, Ledger Account, Alternate Ledger Account, Worktags, Balancing Worktags, and Exclude from Spend Report for this Journal are missing: [lines]   
top
 

CompanyObject

part of: Beginning_Balance_Translation_Amounts_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CompanyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CompanyObjectID

part of: CompanyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Fiscal_YearObject

part of: Beginning_Balance_Translation_Amounts_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Fiscal_YearObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Fiscal_YearObjectID

part of: Fiscal_YearObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Fiscal_Year_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Fiscal_Schedule_ID  [1..1]  The unique identifier type of a parent object   
top
 

Ledger_TypeObject

part of: Beginning_Balance_Translation_Amounts_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Ledger_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Ledger_TypeObjectID

part of: Ledger_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Ledger_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

CurrencyObject

part of: Beginning_Balance_Translation_Amounts_Data, Beginning_Balance_Translation_Amount_Line_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CurrencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CurrencyObjectID

part of: CurrencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Currency_ID, Currency_Numeric_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Book_CodeObject

part of: Beginning_Balance_Translation_Amounts_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Book_CodeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Book_CodeObjectID

part of: Book_CodeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Book_Code_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Beginning_Balance_Translation_Amount_Line_Data

part of: Beginning_Balance_Translation_Amounts_Data
Beginning Balance Translation Amount Line Replacement Data represents a translated beginning balance amount to be created for the beginning balance journal resolved from the criteria in the parent element.
 
Parameter name Type/Value Cardinality Description Validations
Currency_Reference  CurrencyObject  [1..1]  Currency Reference for the line to be updated with amount. If left blank, will default to the Company Currency.   
Ledger_Account_Reference  Ledger_AccountObject  [0..1]  Ledger Account Reference for the translation amount 
Validation Description
[ledger account] does not use Historic Translation Amounts for [company].   
 
Alternate_Ledger_Account_Reference  Ledger_AccountObject  [0..1]  Alternate Ledger Account Reference for the translation amount   
Unit_Of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Unit of Measure   
Unit_Of_Measure_2_Reference  Unit_of_MeasureObject  [0..1]  Additional Unit of Measure   
Accounting_Worktags_Reference  Accounting_WorktagObject  [0..*]  Accounting worktags for the line to be updated with amount. These must match the beginning balance line exactly.   
Affiliate_Balancing_Worktag_Reference  Balancing_WorktagObject  [0..1]  Interworktag Affiliate 
Validation Description
You must have Worktag Balancing enabled in order to define a Worktag Balancing Affiliate.   
 
Exclude_From_Spend_Report  boolean  [0..1]  Exclude from Spend Report   
Translated_Debit_Amount [Choice]   decimal (18, 3)   [1..1]  The Translated Debit Amount to be saved for the currency specified in the transaction.   
Translated_Credit_Amount [Choice]   decimal (26, 6)   [1..1]  The Translated Credit Amount to be saved for the currency specified in the transaction.   
Validation Description
Only one worktag for each type is allowed for each document line.  Only one worktag for each type is allowed for each document line. 
top
 

Ledger_AccountObject

part of: Beginning_Balance_Translation_Amount_Line_Data, Beginning_Balance_Translation_Amount_Line_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Ledger_AccountObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Ledger_AccountObjectID

part of: Ledger_AccountObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Ledger_Account_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Account_Set_ID  [1..1]  The unique identifier type of a parent object   
top
 

Unit_of_MeasureObject

part of: Beginning_Balance_Translation_Amount_Line_Data, Beginning_Balance_Translation_Amount_Line_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unit_of_MeasureObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unit_of_MeasureObjectID

part of: Unit_of_MeasureObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, UN_CEFACT_Common_Code_ID, UOM_EDI_Code_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Accounting_WorktagObject

part of: Beginning_Balance_Translation_Amount_Line_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Accounting_WorktagObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Alternate_Supplier_Contract_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Lease_Expense_Recognition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Balancing_WorktagObject

part of: Beginning_Balance_Translation_Amount_Line_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Balancing_WorktagObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Balancing_WorktagObjectID

part of: Balancing_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Fund_ID, Organization_Reference_ID, Region_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Accounting_JournalObject

part of: Put_Beginning_Balance_Translation_Amounts_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Accounting_JournalObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Accounting_JournalObjectID

part of: Accounting_JournalObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Accounting_Journal_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Fiscal_YearReferenceEnumeration

part of: Fiscal_YearObjectID
Base Type
string
top
 

Base Type
string

top
 

Ledger_TypeReferenceEnumeration

part of: Ledger_TypeObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Book_CodeReferenceEnumeration

part of: Book_CodeObjectID
Base Type
string
top
 

Ledger_AccountReferenceEnumeration

part of: Ledger_AccountObjectID
Base Type
string
top
 

Base Type
string

top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top
 

Balancing_WorktagReferenceEnumeration

part of: Balancing_WorktagObjectID
Base Type
string
top
 

Accounting_JournalReferenceEnumeration

part of: Accounting_JournalObjectID
Base Type
string
top