Service Directory > v32.1 > Revenue_Management > Put_Customer_Payment
 

Operation: Put_Customer_Payment

This service operation will Record a Customer Payment. Record Customer Payment is used to enter Customer Payment data into the system to be applied to Customer Invoices either automatically or manually. Customer Payment Data includes the Customer Payment for Invoices ID, Locked in Workday Flag, Company, Currency, Payment Date, Payment Type, Payment Amount, Remit-from Customer, Check Number, Payment Memo, Ready to Auto-Apply Flag (if flagged for auto-apply, Do Not Apply Payment to Invoices on Hold, Remit-from Customer must be included), Electronic File Information, Reference to an existing Customer Deposit and Customer Payment Remittance Advice Data.


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

Wrapper Element for Put Customer Payment 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.   
Customer_Payment_for_Invoices_Reference  Customer_Payment_for_InvoicesObject  [0..1]  Reference to an existing Customer Payment for Invoices fur update only purposes.   
Customer_Payment_Data  Customer_Payment_for_Invoices_WWS_Data  [1..1]  Customer Payment for Invoices Data 
Validation Description
Payment Amount must be greater than 0.  Payment Amount must be greater than 0. 
Ready to Auto-Apply cannot be true unless a Remit-From Customer is provided, and the Payment Type selected is not a Credit Card or Direct Debit type.  Ready to Auto-Apply cannot be true unless a Remit-From Customer is provided, and the Payment Type selected is not a Credit Card or Direct Debit type. 
The customer selected does not have credit card information setup, selecting a payment type with a payment method of Credit Card where no credit card information is setup will not perform integrations with any payment provider.  The customer selected does not have credit card information setup, selecting a payment type with a payment method of Credit Card where no credit card information is setup will not perform integrations with any payment provider. 
Direct Debit can only be utilized if Customer has a Settlement Bank Account configured.  Direct Debit can only be utilized if Customer has a Settlement Bank Account configured. 
Payment Type must be valid for Bank Account entered.  Payment Type must be valid for Bank Account entered. 
The Payment Date cannot be greater than the Deposit Date.  The Payment Date cannot be greater than the Deposit Date. 
Cannot deposit payment into a Customer Deposit that isn't part of Payment Company.  Cannot deposit payment into a Customer Deposit that isn't part of Payment Company. 
Customer Payment Currency is not accepted by Customer Deposit's Financial Account.  Customer Payment Currency is not accepted by Customer Deposit's Financial Account. 
Remit from Customer is required when Locked-in-Workday is enabled.   
Payment currency is the same as invoice currency. Currency Rate Manual Override is not allowed. Remove this value.   
 
Validation Description
The Web Service is set to Add Only; but the object being updated already exists.  Add Only Flag. Indicates that the service is an add only, not an update. If an existing instance is found and this flag is set there will be an error. 
The Customer Payment is canceled and cannot be resubmitted.  The Customer Payment is canceled and cannot be resubmitted. 
The Customer Invoice Payment cannot be updated.  The Customer Invoice Payment cannot be updated as it does not meet one of the following conditions: It must have a Customer Transaction or Settlement Run. It must not be Applied (Draft or Approved), Canceled, Returned, or have a Refund or Deposit in progress. 
top
 

Response Element: Put_Customer_Payment_Response

Wrapper Element for the Put Customer Payment Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Customer_Payment_Reference  Customer_PaymentObject  [0..1]  Reference to an existing Customer Payment.   
top
 

Customer_Payment_for_InvoicesObject

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

Customer_Payment_for_InvoicesObjectID

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

part of: Put_Customer_Payment_Request
Data Element for Put and Get Customer Payment for Invoices.
 
Parameter name Type/Value Cardinality Description Validations
Customer_Payment_for_Invoices_Reference_ID  string  [0..1]  Customer Payment for Invoices ID. This is the Customer Payment unique identifier.   
Locked_in_Workday  boolean  [0..1]  Set to True to disable editing and canceling the Customer Payment inside the Workday Application. Customer Payment can only be updated from the web service is this is set.   
Company_Reference  CompanyObject  [1..1]  Reference to an existing Company which holds the asset 
Validation Description
Cannot change the Company for this payment because it is already included in a deposit or has been applied.   
 
Payment_Currency_Reference  CurrencyObject  [1..1]  This is the reference id of currency of the payment If no currency is specified, Workday will first look to see if the customer has a preferred currency and if not, currency will be populated with the company base currency. If the company base currency is not allowed currency for customer then payment will not be able to be submitted for approval. 
Validation Description
Cannot change the Currency for this payment because it is already included in a deposit or has been applied.   
 
Payment_Date  date  [1..1]  Transaction date of the Customer Payment. 
Validation Description
Cannot change the Payment Date for this payment because it is already included in a deposit.   
 
Payment_Type_Reference  Payment_TypeObject  [1..1]  This is the payment type for the transaction and needs to be the reference id value of the payment type. Payment Type establishes methods of making payments, such as cash, check, or electronic transfer. Workday supplies the payment methods. Usually there is a one-to-one relationship between payment type (which you define) and Workday's provided payment methods. If no payment type is specified, Workday will populate this with the customer's default payment type if one is defined. Typically this is only populated when it is an electronic payment type whose collection would be initiated by Workday.   
Payment_Status  string  [0..1]  Payment Status.   
Cancel_Accounting_Date  date  [0..1]  Cancel Accounting Date for Customer Payment for Invoices   
Payment_Application_Status  string  [0..1]  Application Status for Customer Payment for Invoices.   
Payment_Number  string  [0..1]  Sequence number for customer payments. To sequence customer payments, set up the ID Generator for Customer Payment for Invoices in the Edit Tenant Setup - Financials task. This field is ignored in a Put Customer Payment request.   
Payment_Amount  decimal (18, 3)   [1..1]  Total Payment Amount for the Customer Payment 
Validation Description
Cannot change the Payment Amount for this payment because it is already included in a deposit or has been applied.   
Cannot change the Payment Amount for this payment because it is already included in a deposit or has been applied.   
 
Remit-from_Customer_Reference  Billable_EntityObject  [0..1]  Reference to the Remit-from Customer that is funding this payment .   
Check_Number  string  [0..1]  Check Number   
Payment_Memo  string  [0..1]  This transaction header memo will print on the delivered transaction. It is optional freeform text   
Ready_to_Auto-Apply  boolean  [0..1]  Ready to Auto-Apply makes this Customer Payment available to the Auto-Application process if it is run prior to this payment being applied manually. Remit-from Customer is required if Ready to Auto-Apply is checked.   
Invoice_Currency_Reference  CurrencyObject  [0..1]  This is the reference id of currency of the customer invoice. If no currency is specified, payment currency will be used. 
Validation Description
Cannot change the Invoice Currency for this payment because it is already included in a deposit or has been applied or has remittance advice specified.   
 
Currency_Rate_Type_Override_Reference  Currency_Rate_TypeObject  [0..1]  For a foreign currency payment, this allows you to override the default Rate Type used to look up the currency conversion rate.   
Currency_Rate_Date_Override  date  [0..1]  For a foreign currency payment, this allows you to override the date used to look up the currency conversion rate. The default date is normally the same as the transaction date.   
Currency_Rate_Manual_Override_Reference  decimal (18, 6)   [0..1]  For a foreign currency payment, this allows you to directly override the currency conversion rate that will be used.   
Electronic_File_Information  string  [0..1]  Electronic File Information is free form text that may be entered to identify the Electronic File that initiated this web service integration.   
Customer_Deposit_Reference  Customer_DepositObject  [0..1]  The optional reference identification for an existing Workday Customer Deposit that matches Payment Company and Currency, and is still in draft and able to accept more customer payments. 
Validation Description
Payments using payment methods of Credit Card, Direct Debit, or Direct Deposit cannot be included in a Customer Deposit.   
Cannot change the Customer Deposit for this payment because it is already included in another In Progress or Approved deposit.   
If a Customer Deposit is referenced, it must be in Draft Status.  If a Customer Deposit is referenced, it must be in Draft Status. 
 
Do_Not_Apply_Payment_to_Invoices_on_Hold  boolean  [0..1]  If set to True, Do Not Apply Payment to Invoices on Hold indicates whether this payment should be used to apply to Customer Invoices that are On Hold from Payment.   
Show_Only_Matched_Invoices_when_Applying  boolean  [0..1]  If true, the customer payment will show only customer invoice documents that match the remittance criteria during application of payment.   
Customer_Payment_Remittance_Advice_Data  Customer_Payment_Remittance_Advice_WWS_Data  [0..*]  Remittance Advice for this Customer Payment, utilized in Workday's Auto-Application logic in determining which Customer Invoices to apply this payment to.   
Validation Description
Payment Amount must be greater than 0.  Payment Amount must be greater than 0. 
Ready to Auto-Apply cannot be true unless a Remit-From Customer is provided, and the Payment Type selected is not a Credit Card or Direct Debit type.  Ready to Auto-Apply cannot be true unless a Remit-From Customer is provided, and the Payment Type selected is not a Credit Card or Direct Debit type. 
The customer selected does not have credit card information setup, selecting a payment type with a payment method of Credit Card where no credit card information is setup will not perform integrations with any payment provider.  The customer selected does not have credit card information setup, selecting a payment type with a payment method of Credit Card where no credit card information is setup will not perform integrations with any payment provider. 
Direct Debit can only be utilized if Customer has a Settlement Bank Account configured.  Direct Debit can only be utilized if Customer has a Settlement Bank Account configured. 
Payment Type must be valid for Bank Account entered.  Payment Type must be valid for Bank Account entered. 
The Payment Date cannot be greater than the Deposit Date.  The Payment Date cannot be greater than the Deposit Date. 
Cannot deposit payment into a Customer Deposit that isn't part of Payment Company.  Cannot deposit payment into a Customer Deposit that isn't part of Payment Company. 
Customer Payment Currency is not accepted by Customer Deposit's Financial Account.  Customer Payment Currency is not accepted by Customer Deposit's Financial Account. 
Remit from Customer is required when Locked-in-Workday is enabled.   
Payment currency is the same as invoice currency. Currency Rate Manual Override is not allowed. Remove this value.   
top
 

CompanyObject

part of: Customer_Payment_for_Invoices_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: Customer_Payment_for_Invoices_WWS_Data, Customer_Payment_for_Invoices_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
 

Payment_TypeObject

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

Billable_EntityObject

part of: Customer_Payment_Remittance_Advice_WWS_Data, Customer_Payment_for_Invoices_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
 

Currency_Rate_TypeObject

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

Currency_Rate_TypeObjectID

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

Customer_DepositObject

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

Customer_DepositObjectID

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

part of: Customer_Payment_for_Invoices_WWS_Data
Customer Payment Remittance Advice is used in Workday's Auto-Application logic to determine which Customer Invoices a Customer Payment should be applied to, and how they should be applied. Included in Remittance Advice can be specific Customer Invoice(s) references, an Amount to Pay, the Bill-to Customer reference, and Customer Payment Remittance Advice Details which include Customer Name, Customer ID, PO Number, Invoice Number and Other.
 
Parameter name Type/Value Cardinality Description Validations
Customer_Invoice_Reference  Customer_Billable_DocumentObject  [0..*]  Reference to a Customer Invoice that should be paid by the Customer Payment this Remittance Advice is for. 
Validation Description
Remittance advice Invoice does not match customer payment Invoice Currency.   
The invoices selected must not be invoices from student sponsor contract   
Remittance advice Invoice cannot have an Active or Draft Direct Debit Mandate.   
 
Amount_to_Pay_in_Invoice_Currency  decimal (18, 3)   [0..1]  Customer invoice amount to pay in payment currency.   
Amount_to_Pay  decimal (18, 3)   [0..1]  Suggested amount to pay in this remittance advice.   
Bill-to_Customer_Reference  Billable_EntityObject  [0..1]  Suggested Bill-to Customer to pay, which will help determine which invoice(s) should be paid.   
Customer_Payment_Remittance_Advice_Details_Replacement_Data  Customer_Payment_Remittance_Advice_Details_WWS_Data  [0..*]  Remittance Advice Details are any of the following chosen, along with free-form text for each: Customer Name, Customer ID, PO Number, Invoice Number and Other.   
top
 

Customer_Billable_DocumentObject

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

Customer_Billable_DocumentObjectID

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

part of: Customer_Payment_Remittance_Advice_WWS_Data
Remittance Advice Details are any of the following chosen, along with free-form text for each: Customer Name, Customer ID, PO Number, Invoice Number and Other.
 
Parameter name Type/Value Cardinality Description Validations
Remittance_Advice_Type_Reference  Customer_Payment_Remittance_Advice_TypeObject  [1..1]  Remittance Advice Type Reference is a metadata reference to either: Customer Name, Customer ID, Invoice Number, PO Number or Other.   
Detail_Information  string  [1..1]  Customer Remittance Advice Detail Information is free form text that describes the Remittance Advice Type it is paired with.   
top
 

Customer_Payment_Remittance_Advice_TypeObject

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

Customer_Payment_Remittance_Advice_TypeObjectID

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

Customer_PaymentObject

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

Customer_PaymentObjectID

part of: Customer_PaymentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Cash_Sale_ID, Customer_Payment_for_Invoices_Reference_ID, Student_Application_Fee_Payment_ID, Student_Disbursement_Payment_ID, Student_Historical_Payment_ID, Student_Payment_ID, Student_Sponsor_Payment_ID, Student_Waiver_Payment_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_Payment_for_InvoicesReferenceEnumeration

part of: Customer_Payment_for_InvoicesObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Billable_EntityReferenceEnumeration

part of: Billable_EntityObjectID
Base Type
string
top
 

Currency_Rate_TypeReferenceEnumeration

part of: Currency_Rate_TypeObjectID
Base Type
string
top
 

Customer_DepositReferenceEnumeration

part of: Customer_DepositObjectID
Base Type
string
top
 

Customer_Billable_DocumentReferenceEnumeration

part of: Customer_Billable_DocumentObjectID
Base Type
string
top
 

Customer_Payment_Remittance_Advice_TypeReferenceEnumeration

part of: Customer_Payment_Remittance_Advice_TypeObjectID
Base Type
string
top
 

Customer_PaymentReferenceEnumeration

part of: Customer_PaymentObjectID
Base Type
string
top