Service Directory > v31.2 > Revenue_Management > Get_Consolidated_Invoices
 

Operation: Get_Consolidated_Invoices

This service operation will get Consolidated Invoices for the specified criteria. Consolidated Invoice data includes Consolidated Invoice ID, Document Status, Document Payment Status, Company, Customer, Currency, Document Number, Invoice Date, Bill-To Address, Bill-To Contact, Payment Type, Payment Terms, Due Date, Memo, Invoice Currency, Net Invoice Amount, Tax Amount, Total Invoice Amount, Total Invoice Amount, Withholding Tax Amount, Amount Due and Customer Invoice Reference.


@ - 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: Get_Consolidated_Invoices_Request

This element is the top-level request element for all Consolidated Invoice "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Consolidated_Invoice_Request_References  [0..1]  This element content contains the Consolidated Invoice reference element used to return the Consolidated Invoice by unique identifier.   
Request_Criteria [Choice]   Consolidated_Invoice_Request_Criteria  [0..1]  This element content contains the wrapper element for the list of criteria representing the Consolidated Invoice specific criteria needed to search for instances. 
Validation Description
Invoice Due Date On or After must be earlier than Invoice Due Date On or Before.  Invoice Due Date On or After must be earlier than Invoice Due Date On or Before. 
 
Response_Filter  Response_Filter  [0..1]  Element Content containing Response Filter. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Consolidated_Invoice_Response_Group  [0..1]  Element content containing Consolidated Invoice Response Group element.   
top
 

Response Element: Get_Consolidated_Invoices_Response

Element containing Consolidated Invoice response elements including echoed request data and request result data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Consolidated_Invoice_Request_References  [0..1]  This element content contains the echoed Consolidated Invoice Request Reference Element.   
Request_Criteria  Consolidated_Invoice_Request_Criteria  [0..1]  This element content contains the echoed Consolidated Invoice Request Criteria Element. 
Validation Description
Invoice Due Date On or After must be earlier than Invoice Due Date On or Before.  Invoice Due Date On or After must be earlier than Invoice Due Date On or Before. 
 
Response_Filter  Response_Filter  [0..1]  This element content contains the echoed Response Filter Element. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Consolidated_Invoice_Response_Group  [0..1]  This element content contains the echoed Consolidated Invoice Response Group Element.   
Response_Results  Response_Results  [0..1]  This element content contains the Consolidated Invoice Response Results element, including total results and paging.   
Response_Data  Consolidated_Invoice_Response_Data  [0..1]  This element content contains the Consolidated Invoice Response Data element.   
top
 

Consolidated_Invoice_Request_References

part of: Get_Consolidated_Invoices_Request, Get_Consolidated_Invoices_Response
The Request References element contains the specific instance set that should be returned in the Get
 
Parameter name Type/Value Cardinality Description Validations
Consolidated_Invoice_Reference  Consolidated_InvoiceObject  [1..*]  Instance set containing the Consolidated Invoice object.   
top
 

Consolidated_InvoiceObject

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

Consolidated_InvoiceObjectID

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

Consolidated_Invoice_Request_Criteria

part of: Get_Consolidated_Invoices_Request, Get_Consolidated_Invoices_Response
This element is the wrapper around a list of elements representing the Customer Request specific criteria needed to search for instances. All of the elements are "AND" conditions. Show Subelement Content.
 
Parameter name Type/Value Cardinality Description Validations
Document_Status_Reference  Document_StatusObject  [0..*]  Reference to an existing Consolidate invoice Document Status. Examples of Document Statuses are Approved, Canceled, Denied.   
Document_Payment_Status_Reference  Document_Payment_StatusObject  [0..*]  Reference to an existing Payment Status. Examples of Payment Statuses are Draft, In Progress, Approved.   
Company_Reference  CompanyObject  [1..1]  Reference to Companies for a Consolidated Invoice.   
Customer_Reference  CustomerObject  [0..*]  Reference to Customer for a Consolidated Invoice.   
Payment_Types_Reference  Payment_TypeObject  [0..*]  Reference to Payment Types that are valid for a Consolidated Invoice.   
Payment_Terms_Reference  Payment_TermsObject  [0..1]  Reference to Payment Terms that are valid for a Consolidated Invoice.   
Currency_Reference  CurrencyObject  [0..1]  Reference to the Currency that is valid for a Consolidated Invoice.   
Invoice_Date_On_or_After  date  [0..1]  Invoice Date On or After   
Invoice_Date_On_or_Before  date  [0..1]  Invoice Date On or Before   
Invoice_Due_Date_On_or_After  date  [0..1]  Invoice Due Date On or After   
Invoice_Due_Date_On_or_Before  date  [0..1]  Invoice Due Date On or Before   
Validation Description
Invoice Due Date On or After must be earlier than Invoice Due Date On or Before.  Invoice Due Date On or After must be earlier than Invoice Due Date On or Before. 
top
 

Document_StatusObject

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

Document_StatusObjectID

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

Document_Payment_StatusObject

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

Document_Payment_StatusObjectID

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

CompanyObject

part of: Consolidated_Invoice_Request_Criteria, Consolidated_Invoice_WWS_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
 

CustomerObject

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

CustomerObjectID

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

Payment_TypeObject

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

Payment_TypeObjectID

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

Payment_TermsObject

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

Payment_TermsObjectID

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

Response_Filter

part of: Get_Consolidated_Invoices_Request, Get_Consolidated_Invoices_Response
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.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Consolidated_Invoice_Response_Group

part of: Get_Consolidated_Invoices_Request, Get_Consolidated_Invoices_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Consolidated Invoice response. If this element is not included then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Consolidated Invoice Reference data is to be included in the response.   
top
 

Response_Results

part of: Get_Consolidated_Invoices_Response
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.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Consolidated_Invoice_Response_Data

part of: Get_Consolidated_Invoices_Response
Documentation Wrapper element containing Consolidated Invoice Response Data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Consolidated_Invoice  Consolidated_Invoice  [0..*]  Element content containing Consolidated Invoice element.   
top
 

Consolidated_Invoice

part of: Consolidated_Invoice_Response_Data
Wrapper Element that includes Consolidated Invoice Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Consolidated_Invoice_Reference  Consolidated_InvoiceObject  [0..1]  Reference to an existing Consolidated Invoice.   
Consolidated_Invoice_Data  Consolidated_Invoice_WWS_Data  [0..*]  Consolidated Invoice Data 
Validation Description
Id field is not valid.   
Document Number field is not valid.   
Tax Amount field is not valid.   
Due Date field is not valid.   
Document Payment Status field is not valid.   
Document Status field is not valid.   
Amount Due field is not valid.   
Net Invoice Amount field is not valid   
Total Invoice Amount field is not valid.   
Withholding tax field is not valid.   
 
top
 

Consolidated_Invoice_WWS_Data

part of: Consolidated_Invoice
Represent a complete Consolidated Invoice
 
Parameter name Type/Value Cardinality Description Validations
Consolidated_Invoice_ID  string  [0..1]  Consolidated Invoice ID. This is the Consolidated Invoice unique identifier.   
Company_Reference  CompanyObject  [1..1]  Company for Consolidated Invoice   
Currency_Reference  CurrencyObject  [1..1]  Currency for Consolidated Invoice   
Customer_Reference  Billable_EntityObject  [1..1]  Customer for Consolidated Invoice   
Include_Child_Customers  boolean  [0..1]  Includes Child Customers boolean for consolidated invoice.   
Bill-To_Address_Reference  Address_ReferenceObject  [0..1]  Bill-To Address for Consolidated Invoice   
Bill-To_Contact_Reference  Business_Entity_ContactObject  [0..*]  Bill-To Contact for Consolidated Invoice   
Invoice_Number  string  [0..1]  This is the document number for the consolidated invoice.   
Invoice_Date  date  [1..1]  Consolidated Invoice Date for Consolidated Invoice   
Due_Date  date  [0..1]  Format is MM/DD/YYYY. If a date is provided, it will override the due date that Workday automatically determines based on the invoice date and payment terms.   
Payment_Terms_Reference  Payment_TermsObject  [1..1]  Payment Terms for Consolidated Invoice   
Payment_Type_Reference  Payment_TypeObject  [1..*]  Payment Type for Consolidated Invoice   
Document_Payment_Status_Reference  Document_Payment_StatusObject  [0..1]  Shows the Consolidated Invoice Document's Payment Status.   
Document_Status_Reference  Document_StatusObject  [0..1]  Shows the Consolidated Invoice Invoice Status.   
Amount_Due  decimal (26, 6)   [0..1]  Shows a Consolidated Invoice's Due Amount.   
Memo  string  [0..1]  Memo for Consolidated Invoice   
Net_Invoice_Amount  decimal (18, 3)   [0..1]  Shows a Consolidated Invoice's Net Invoice Amount.   
Tax_Amount  decimal (26, 6)   [0..1]  Shows a Consolidated Invoice's Tax Amount.   
Total_Invoice_Amount  decimal (18, 3)   [0..1]  Shows a Consolidated Invoice's Total Invoice Amount.   
Withholding_Tax_Amount  decimal (18, 3)   [0..1]  Shows a Consolidated Invoice's Withholding Tax Amount.   
Customer_Invoice_Reference  Customer_InvoiceObject  [1..*]  Customer Invoice for Consolidated Invoice 
Validation Description
The Company for the customer invoice must match the Company on the consolidated invoice.   
The Currency for the customer invoice must match the Currency on the consolidated invoice.   
The customer invoice must have a Payment Status of Unpaid.   
The customer invoice must have an Invoice Status of Approved.   
You can’t consolidate intercompany invoices.   
The consolidated invoice must include at least 2 customer invoices.   
This customer invoice is already part of another consolidated invoice.   
The Customer for the customer invoice must match the Customer on the consolidated invoice.   
Workday does not currently support consolidating retention invoices.   
 
Validation Description
Id field is not valid.   
Document Number field is not valid.   
Tax Amount field is not valid.   
Due Date field is not valid.   
Document Payment Status field is not valid.   
Document Status field is not valid.   
Amount Due field is not valid.   
Net Invoice Amount field is not valid   
Total Invoice Amount field is not valid.   
Withholding tax field is not valid.   
top
 

Billable_EntityObject

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

Billable_EntityObjectID

part of: Billable_EntityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Customer_ID, Customer_Reference_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Financial_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".   
top
 

Address_ReferenceObject

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

Address_ReferenceObjectID

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

Business_Entity_ContactObject

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

Business_Entity_ContactObjectID

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

Customer_InvoiceObject

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

Customer_InvoiceObjectID

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

Consolidated_InvoiceReferenceEnumeration

part of: Consolidated_InvoiceObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

Document_Payment_StatusReferenceEnumeration

part of: Document_Payment_StatusObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Payment_TermsReferenceEnumeration

part of: Payment_TermsObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Billable_EntityReferenceEnumeration

part of: Billable_EntityObjectID
Base Type
string
top
 

Address_ReferenceReferenceEnumeration

part of: Address_ReferenceObjectID
Base Type
string
top
 

Business_Entity_ContactReferenceEnumeration

part of: Business_Entity_ContactObjectID
Base Type
string
top
 

Customer_InvoiceReferenceEnumeration

part of: Customer_InvoiceObjectID
Base Type
string
top