Service Directory > v31.2 > Revenue_Management > Put_Customer_Invoice_Collection_Information
 

Operation: Put_Customer_Invoice_Collection_Information

This web service gives the user the ability to add Notes, Disputes, and Collections to an invoice.


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

Customer Invoice Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Customer_Invoice_Reference  Customer_InvoiceObject  [1..1]  Reference to an existing Customer Invoice for update only purposes90$7410   
Customer_Invoice_Collection_Information_Data  Customer_Invoice_Collection_Information_Data  [1..*]  Customer Invoice Attributes Data 
Validation Description
Collection And Dispute are chosen at the same time.   
 
top
 

Response Element: Put_Customer_Invoice_Collection_Information_Response

Customer Invoice Collection Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Customer_Invoice_Reference  Customer_InvoiceObject  [0..1]  Reference to an existing customer invoice.   
top
 

Customer_InvoiceObject

part of: Put_Customer_Invoice_Collection_Information_Request, Put_Customer_Invoice_Collection_Information_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  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
 

Customer_Invoice_Collection_Information_Data

part of: Put_Customer_Invoice_Collection_Information_Request
Customer Invoice Attributes Data
 
Parameter name Type/Value Cardinality Description Validations
On_Hold  boolean  [0..1]  TRUE or FALSE If this is set to 'TRUE' the invoice will be put on hold.   
Is_Excluded_from_Dunning_Letter  boolean  [0..1]  TRUE or FALSE If this is set to 'TRUE' the invoice will be excluded from Print Dunning Letters.   
Followup_Date  date  [0..1]  The date the Customer Invoice should be followed up. This field is optional and can be entered in maintain collection, maintain dispute or put on hold. 
Validation Description
Followup Date cannot be in the past.  Followup Date cannot be in the past. 
 
Dispute_Data  Customer_Invoice_Dispute_Data  [0..1]  Customer Invoice Dispute Date   
Collection_Data  Customer_Invoice_Collection_Data  [0..1]  Customer Invoice Collection Data   
Note_Data  Note_WWS_Data  [0..*]  Includes Notes that have been made for a business object. On a Get operation, all existing Notes will be populated. On a Put or Submit operation, any note information on the request will be added as new notes. Existing notes cannot be updated on a Put or Submit request.   
top
 

Customer_Invoice_Dispute_Data

part of: Customer_Invoice_Collection_Information_Data
Customer Invoice Dispute Date
 
Parameter name Type/Value Cardinality Description Validations
Dispute_Date  date  [1..1]  The date the Customer Invoice is put into dispute. If this field is populated when updating an existing invoice, the invoice will be put into dispute.   
Dispute_Amount  decimal (26, 6)   [0..1]  The amount the Customer Invoice is in dispute over. It is optional. 
Validation Description
A dispute amount can only be entered if there is a dispute date.  A dispute amount can only be entered if there is a dispute date. 
Dispute amount cannot be greater than the amount due.  Dispute amount cannot be greater than the amount due. 
 
Dispute_Reason_Reference  Dispute_ReasonObject  [0..*]  The reason the Customer Invoice is put into dispute. 
Validation Description
A dispute reason can only be entered if there is a dispute date.  A dispute reason can only be entered if there is a dispute date. 
 
top
 

Dispute_ReasonObject

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

Dispute_ReasonObjectID

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

part of: Customer_Invoice_Collection_Information_Data
Customer Invoice Collection Data
 
Parameter name Type/Value Cardinality Description Validations
Collection_Date  date  [1..1]  The date the Customer Invoice is put into collection. If this field is populated when updating an existing invoice, the invoice will be put into collection.   
Payment_Amount_Promised  decimal (26, 6)   [0..1]  The amount the customer promised to pay when the Customer Invoice is put into collection. It is optional. 
Validation Description
Payment amount promised cannot be greater than the amount due.  Payment amount promised cannot be greater than the amount due. 
Promise to pay amount can only be entered if there is a collection date.  Promise to pay amount can only be entered if there is a collection date. 
 
Collection_Code_Reference  Collection_CodeObject  [0..1]  The reason the Customer Invoice is put into collection. It is optional. 
Validation Description
A Collection Code can only be entered if there is a collection date.  A Collection Code can only be entered if there is a collection date. 
 
top
 

Collection_CodeObject

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

Collection_CodeObjectID

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

Note_WWS_Data

part of: Customer_Invoice_Collection_Information_Data
Includes Notes that have been made for a business object. On a Get operation, all existing Notes will be populated. On a Put or Submit operation, any note information on the request will be added as new notes. Existing notes cannot be updated on a Put or Submit request.
 
Parameter name Type/Value Cardinality Description Validations
Created  dateTime  [0..1]  The date and time this Note was created. On a Put or Submit operation, this field is ignored, and will be overwritten with the current date and time.   
Last_Updated  dateTime  [0..1]  The date and time this Note was last updated. On a Put or Submit operation, this field is ignored, and will be overwritten with the current date and time.   
Worker_Reference  WorkerObject  [0..1]  The Worker who created this Note (if the person who created it is a Worker). On a Put or Submit operation, this field is ignored, and will be overwritten by the person processing the request.   
Business_Entity_Contact_Reference  Business_Entity_ContactObject  [0..1]  The Business Entity Contact who created this Note (if the person who created it is a Business Entity Contact and not a Worker). On a Put or Submit operation, this field is ignored, and will be overwritten with the person processing the request.   
System_User_Reference  System_UserObject  [0..1]  The System User who created this Note (if the person who created it is neither a Business Entity Contact nor a Worker). On a Put or Submit operation, this field is ignored, and will be overwritten with the person processing the request.   
Note_Content  RichText  [0..1]  The main text content for this Note.   
top
 

WorkerObject

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

WorkerObjectID

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

System_UserObject

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

System_UserObjectID

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

part of: Customer_InvoiceObjectID
Base Type
string
top
 

Dispute_ReasonReferenceEnumeration

part of: Dispute_ReasonObjectID
Base Type
string
top
 

Collection_CodeReferenceEnumeration

part of: Collection_CodeObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Business_Entity_ContactReferenceEnumeration

part of: Business_Entity_ContactObjectID
Base Type
string
top
 

System_UserReferenceEnumeration

part of: System_UserObjectID
Base Type
string
top
 

RichText

part of: Note_WWS_Data
Base Type
string
top