Service Directory > v32.1 > Revenue_Management > Put_Consolidated_Invoice
 

Operation: Put_Consolidated_Invoice

Creates a new Consolidated Invoice with the information supplied in 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_Consolidated_Invoice_Request

Wrapper Element for Put Consolidated Invoice Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Consolidated_Invoice_Reference  Consolidated_InvoiceObject  [0..1]  Reference to an existing Consolidated Invoice for update only purposes. 
Validation Description
Updating an existing Consolidated Invoice is not currently supported.   
 
Consolidated_Invoice_Data  Consolidated_Invoice_WWS_Data  [1..1]  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.   
 
Validation Description
The web service is set to add only, but the Consolidated Invoice already exists.   
top
 

Response Element: Put_Consolidated_Invoice_Response

Element containing Put Consolidated Invoice Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Consolidated_Invoice_Reference  Consolidated_InvoiceObject  [0..1]  Reference to an existing Consolidated Invoice   
top
 

Consolidated_InvoiceObject

part of: Put_Consolidated_Invoice_Request, Put_Consolidated_Invoice_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  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_WWS_Data

part of: Put_Consolidated_Invoice_Request
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
 

CompanyObject

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

CurrencyObject

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

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
 

Payment_TermsObject

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

Payment_TypeObject

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

Document_Payment_StatusObject

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

Document_StatusObject

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

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
 

CompanyReferenceEnumeration

part of: CompanyObjectID
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
 

Payment_TermsReferenceEnumeration

part of: Payment_TermsObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Document_Payment_StatusReferenceEnumeration

part of: Document_Payment_StatusObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

Customer_InvoiceReferenceEnumeration

part of: Customer_InvoiceObjectID
Base Type
string
top