Service Directory > v32.1 > Resource_Management > Put_Supplier_Invoice_History
 

Operation: Put_Supplier_Invoice_History

This web service operation will add or update Supplier Invoice Histories. This contains data for Reference ID, Company, Currency, Supplier, Total Invoice Amount, document Reference Number, Invoice Date, External PO Number, Document Number, and Source Integration System name.


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

This element is the top-level request element for all "Put" Supplier Invoice History operations.
 
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.   
Supplier_Invoice_History_Reference  Supplier_Invoice_HistoryObject  [0..1]  Reference to an existing Supplier Invoice History for update-only purposes.   
Supplier_Invoice_History_Data  Supplier_Invoice_History_Data  [0..1]  Wrapper element containing all the data fields for the Supplier Invoice History object. 
Validation Description
Supplier reference is for a supplier that can be used as a basic worktag only.   
 
Validation Description
The Web Service is set to Add Only; but the Supplier Invoice History already exists.   
top
 

Response Element: Put_Supplier_Invoice_History_Response

This element is the top-level response element for all "Put" Supplier Invoice History operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Supplier_Invoice_History_Reference  Supplier_Invoice_HistoryObject  [0..1]  Reference to the Supplier Invoice History that was added or updated by this web service operation.   
top
 

Supplier_Invoice_HistoryObject

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

Supplier_Invoice_HistoryObjectID

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

Supplier_Invoice_History_Data

part of: Put_Supplier_Invoice_History_Request
Wrapper element containing all the data fields for the Supplier Invoice History object.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Invoice_History_ID  string  [0..1]  Supplier Invoice History ID. This is the Supplier Invoice History unique identifier   
Company_Reference  CompanyObject  [1..1]  This is the company that tranasction is for. This is the reference id value of the company.   
Supplier_Reference  Resource_ProviderObject  [1..1]  Reference to the Supplier the Invoice History is for.   
Suppliers_Invoice_Number  string  [0..1]  Text value for Supplier Reference Number.   
Total_Invoice_Amount  decimal (26, 6)   [0..1]  Currency amount for the Total Invoice Amount. This amount corresponds with the Currency in Supplier Invoice History Currency Reference.   
Currency_Reference  CurrencyObject  [0..1]  Reference to the Currency used in this Supplier Invoice History. 
Validation Description
Supplier Invoice History Currency Reference is required if Supplier Invoice History Total Invoice Amount is specified.  Supplier Invoice History Currency Reference is required if Supplier Invoice History Total Invoice Amount is specified. 
 
Invoice_Date  date  [0..1]  Date value for the Supplier Invoice History date. Format is MM/DD/YYYY.   
External_PO_Number  string  [0..1]  Text value for an External Purchase Order Number recorded on the Supplier Invoice History.   
Invoice_Number  string  [0..1]  Text value for the Document Number of the Supplier Invoice History.   
Source_Integration_System  string  [0..1]  Text value of the Source Integration System of the Supplier Invoice History.   
Validation Description
Supplier reference is for a supplier that can be used as a basic worktag only.   
top
 

CompanyObject

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

Resource_ProviderObject

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

Resource_ProviderObjectID

part of: Resource_ProviderObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Supplier_ID, Supplier_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: Supplier_Invoice_History_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
 

Supplier_Invoice_HistoryReferenceEnumeration

part of: Supplier_Invoice_HistoryObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Resource_ProviderReferenceEnumeration

part of: Resource_ProviderObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top