Service Directory > v31.2 > Financial_Management > Put_Ledger_Year_and_Ledger_Periods
 

Operation: Put_Ledger_Year_and_Ledger_Periods

This web service creates a new ledger year and new ledger periods for a fiscal year on an existing company.


@ - 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_Ledger_Year_and_Ledger_Periods_Request

Request element for Put Ledger Year and Ledger Periods WS
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Add_Only  boolean  [0..1]  A boolean flag indicating if the request is an add only.   
Company_Reference  OrganizationObject  [1..1]  Reference to an existing Company   
Ledger_Data  Ledger_Year_Container__Public_  [1..1]  Container for ledger year data   
Validation Description
Ledger Year and Periods are already created for [Company] for [Fiscal Year]   
The company hierarchy you have provided does not have any subordinate companies with a fiscal schedule and an actuals ledger configured.   
The company does not have associated ledgers. Please set up ledger types before you use the Put Ledger Year and Ledger Periods web service.   
top
 

Response Element: Put_Ledger_Year_and_Ledger_Periods_Response

Response element for Put Ledger Year and Ledger Periods WS
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Ledger_Year_Reference  Unique_IdentifierObject  [0..*]  Reference(s) to relevant Ledger Year(s) for Company and Fiscal Year specified.   
top
 

OrganizationObject

part of: Put_Ledger_Year_and_Ledger_Periods_Request
 
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  OrganizationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

OrganizationObjectID

part of: OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_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
 

Ledger_Year_Container__Public_

part of: Put_Ledger_Year_and_Ledger_Periods_Request
Container for ledger year data
 
Parameter name Type/Value Cardinality Description Validations
Ledger_Year_Data  Ledger_Year_Data__Public_  [1..1]  Ledger Year Data   
top
 

Ledger_Year_Data__Public_

part of: Ledger_Year_Container__Public_
Ledger Year Data
 
Parameter name Type/Value Cardinality Description Validations
Fiscal_Year_Reference  Schedule_YearObject  [1..1]  Reference to a fiscal year 
Validation Description
[schedule] is not valid for these companies: [company].   
 
Ledger_Year_Status_Reference  Ledger_Year_StatusObject  [0..1]  Reference to a Ledger Year status 
Validation Description
Ledger Year Status Reference cannot be entered in the request.   
 
Ledger_Period_Data  Ledger_Period_Data__Public_  [0..*]  Ledger Period Data   
top
 

Schedule_YearObject

part of: Ledger_Year_Data__Public_
 
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  Schedule_YearObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Schedule_YearObjectID

part of: Schedule_YearObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Award_Year_Reference_ID, 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_Year_StatusObject

part of: Ledger_Year_Data__Public_
 
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_Year_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Ledger_Year_StatusObjectID

part of: Ledger_Year_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Ledger_Year_Status_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
 

Ledger_Period_Data__Public_

part of: Ledger_Year_Data__Public_
Ledger Period Data
 
Parameter name Type/Value Cardinality Description Validations
Fiscal_Period_Reference_Data  Fiscal_Period_Reference__Public_  [0..1]  Fiscal Period Reference Data (non-enterable)   
Ledger_Period_Status_Reference  Ledger_Period_StatusObject  [0..1]  Reference to a Ledger Period Status (non-enterable) 
Validation Description
Ledger Period Status Reference cannot be entered in the request.   
 
Closed_Activity_Reference  Period_Close_Activity_Group__Tenanted_Object  [0..*]  Reference to Closed Activity (non-enterable) 
Validation Description
Closed Activity Reference cannot be entered in the request.   
When ledger period status is 'Close in Progress', Closed Activity is required. Closed Activity is not allowed for any other ledger period status.   
 
top
 

Fiscal_Period_Reference__Public_

part of: Ledger_Period_Data__Public_
Fiscal Period Reference Data (non-enterable)
 
Parameter name Type/Value Cardinality Description Validations
Fiscal_Posting_Interval_Reference  Fiscal_Posting_IntervalObject  [1..1]  Reference to a Fiscal Posting Interval (non-enterable) 
Validation Description
Fiscal Period does not exist.   
Fiscal Posting Interval Reference cannot be entered in the request.   
 
top
 

Fiscal_Posting_IntervalObject

part of: Fiscal_Period_Reference__Public_
 
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_Posting_IntervalObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Fiscal_Posting_IntervalObjectID

part of: Fiscal_Posting_IntervalObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Fiscal_Posting_Interval_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
 

Ledger_Period_StatusObject

part of: Ledger_Period_Data__Public_
 
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_Period_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Ledger_Period_StatusObjectID

part of: Ledger_Period_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Ledger_Period_Status_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
 

Period_Close_Activity_Group__Tenanted_Object

part of: Ledger_Period_Data__Public_
 
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  Period_Close_Activity_Group__Tenanted_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Period_Close_Activity_Group__Tenanted_ObjectID

part of: Period_Close_Activity_Group__Tenanted_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Period_Close_Activity_Group_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
 

Unique_IdentifierObject

part of: Put_Ledger_Year_and_Ledger_Periods_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  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [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
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Schedule_YearReferenceEnumeration

part of: Schedule_YearObjectID
Base Type
string
top
 

Base Type
string

top
 

Ledger_Year_StatusReferenceEnumeration

part of: Ledger_Year_StatusObjectID
Base Type
string
top
 

Fiscal_Posting_IntervalReferenceEnumeration

part of: Fiscal_Posting_IntervalObjectID
Base Type
string
top
 

Ledger_Period_StatusReferenceEnumeration

part of: Ledger_Period_StatusObjectID
Base Type
string
top
 

Period_Close_Activity_Group__Tenanted_ReferenceEnumeration

part of: Period_Close_Activity_Group__Tenanted_ObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top