Service Directory > v31.2 > Cash_Management > Put_Bank_Statement_Custom_Code_Set
 

Operation: Put_Bank_Statement_Custom_Code_Set

This service operation will add or update Bank Statement Custom Code Sets. Bank Statement Custom Code Set data includes the Custom Code Set ID, Custom Code Set Name, Associated Bank Statement Format, Custom Code Set Description, Comment and Custom Balance Type Codes and Custom Transaction Type Codes. The Custom Balance Type Code data includes Balance/Summary indicator, Type Code, Debit/Credit Flag, Type Description, Associated Bank Statement Type Category and whether its a opening balance or a closing balance if its a balance type code. The Custom Transaction Type Code data includes Type Code, Debit/Credit Flag, Type Description and Associated Bank Statement Type Category.


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

Contains data for adding or updating a Bank Statement Custom Code Set
 
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.   
Bank_Statement_Custom_Code_Set_Reference  Bank_Statement_Custom_Code_SetObject  [0..1]  Reference to an existing Bank Statement Custom Code Set for update only purposes   
Bank_Statement_Custom_Code_Set_Data  Bank_Statement_Custom_Code_Set_Data  [1..1]  Contains data for a Bank Statement Custom Code Set 
Validation Description
A Type Code can only be used once across all balance, summary and transaction type code records within this bank statement custom code set.   
Enter only one Balance Type Code within each bank statement custom code set where the Reconciliation Balance Type is either the Beginning Balance or Ending Balance.   
Enter only one Balance Type Code within each bank statement custom code set where the Reconciliation Balance Type is either the Beginning Balance or Ending Balance.   
A Transaction Type Code can only be used once within the bank statement custom code set.   
A Balance/Summary Type Code can only be used once within the same bank statement custom code set.   
Balance Type Code [code] cannot be deleted because it is used in a Bank Statement.   
Transaction Type Code [code] cannot be deleted because it is used in a Bank Statement.   
 
Validation Description
The Web Service is set to Add Only; but the Bank Statement Custom Code Set already exists.   
top
 

Response Element: Put_Bank_Statement_Custom_Code_Set_Response

Element containing Put Bank Statement Custom Code Set Response data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Bank_Statement_Custom_Code_Set_Reference  Bank_Statement_Custom_Code_SetObject  [0..1]  Reference to an existing Bank Statement Custom Code Set   
top
 

Bank_Statement_Custom_Code_SetObject

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

Bank_Statement_Custom_Code_SetObjectID

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

Bank_Statement_Custom_Code_Set_Data

part of: Put_Bank_Statement_Custom_Code_Set_Request
Element containing all Bank Statement Custom Code Set Data including the subelements balance type data & transaction type data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Bank Statement Custom Code Set ID. This is the bank statement custom code set unique identifier.   
Name  string  [1..1]  Custom Code Set Name 
Validation Description
Enter a Bank Statement Custom Code Set Name that isn't already in use.   
 
Bank_Statement_Format_Reference  Bank_Statement_FormatObject  [1..1]  Bank Statement Format 
Validation Description
Bank Statement Format cannot be changed for the existing Custom Code Set.   
 
Description  string  [0..1]  Description   
Comment  string  [0..1]  Comment   
Bank_Statement_Balance_Type_Data  Bank_Statement_Balance_Type_Data  [0..*]  Custom Balance Type Codes 
Validation Description
Summary/Balance field can only be 'Summary' or 'Balance'  Summary/Balance field can only be 'Summary' or 'Balance' 
Debit/Credit field can only be 'CR' or 'DR'  Debit/Credit field can only be 'CR' or 'DR' 
Both Beginning Balance and Ending Balance cannot be Yes  Both Beginning Balance and Ending Balance cannot be Yes 
Beginning Balance field can only be 'Yes' or 'No'  Beginning Balance field can only be 'Yes' or 'No' 
Ending Balance field can only be 'Yes' or 'No'  Ending Balance field can only be 'Yes' or 'No' 
BAI2 Type Codes can not be all zeroes (e.g. 000).   
BAI2 Type Codes may contain only numeric characters.   
The field Type Code is required and must have a value.   
[type code]: The Balance Type Code defined is a duplicate of an existing standard Balance, Summary, or Transaction type code.   
[type code]: Enter a Bank Statement Type Category with a Bank Statement Format that matches the Custom Code Set’s Bank Statement Format.   
[type code]: The field Debit/Credit is required and must have a value.   
[type code]: The Balance Type Code defined is a duplicate of an existing standard Balance, Summary, or Transaction type code.   
 
Bank_Statement_Transaction_Type_Data  Bank_Statement_Transaction_Type_Data  [0..*]  Custom Transaction Type Codes 
Validation Description
Debit/Credit field can only be 'CR' or 'DR'  Debit/Credit field can only be 'CR' or 'DR' 
BAI2 Type Codes may contain only numeric characters.   
BAI2 Type Codes can not be all zeroes (e.g. 000).   
The field Type Code is required and must have a value.   
[type code]: The Transaction Type Code defined is a duplicate of an existing standard Balance, Summary, or Transaction type code.   
[type code]: Enter a Bank Statement Type Category with a Bank Statement Format that matches the Custom Code Set’s Bank Statement Format.   
[type code]: The field Debit/Credit is required and must have a value.   
[type code]: The Transaction Type Code defined is a duplicate of an existing standard Balance, Summary, or Transaction type code.   
 
Validation Description
A Type Code can only be used once across all balance, summary and transaction type code records within this bank statement custom code set.   
Enter only one Balance Type Code within each bank statement custom code set where the Reconciliation Balance Type is either the Beginning Balance or Ending Balance.   
Enter only one Balance Type Code within each bank statement custom code set where the Reconciliation Balance Type is either the Beginning Balance or Ending Balance.   
A Transaction Type Code can only be used once within the bank statement custom code set.   
A Balance/Summary Type Code can only be used once within the same bank statement custom code set.   
Balance Type Code [code] cannot be deleted because it is used in a Bank Statement.   
Transaction Type Code [code] cannot be deleted because it is used in a Bank Statement.   
top
 

Bank_Statement_FormatObject

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

Bank_Statement_FormatObjectID

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

Bank_Statement_Balance_Type_Data

part of: Bank_Statement_Custom_Code_Set_Data
Element containing Bank Statement Balance Type Data
 
Parameter name Type/Value Cardinality Description Validations
Bank_Statement_Balance_Type_Reference  Bank_Statement_Balance_TypeObject  [0..1]  Bank Statement Balance Type Reference   
ID  string  [0..1]  Bank Statement Balance Type ID. This is the bank statement balance type unique identifier.   
Summary_Balance  string  [1..1]  Bank Statement Balance Type Indicator 
Validation Description
Balance/Summary Type Indicator cannot be changed for Type Code [code] because the Type Code is used in a Bank Statement.   
 
Type_Code  string  [1..1]  Bank Statement Balance Type Code 
Validation Description
Type Code for Balance Type Code [code] cannot be changed because it is used in a Bank Statement.   
 
Debit_Credit  string  [0..1]  Debit/Credit Type 
Validation Description
Debit/Credit must be blank for non-BAI2 type code.   
Debit/Credit must be null for BAI2 Balance type code.   
BAI2 Summary type codes require Debit/Credit.   
Debit/Credit cannot be changed for Balance Type Code [code] because the Type Code is used in a Bank Statement.   
 
Description  string  [1..1]  Bank Statement Type Description   
Bank_Statement_Type_Category_Reference  Bank_Statement_Type_CategoryObject  [1..1]  Bank Statement Type Category   
Beginning_Balance  string  [0..1]  Beginning Balance   
Ending_Balance  string  [0..1]  Ending Balance   
Validation Description
Summary/Balance field can only be 'Summary' or 'Balance'  Summary/Balance field can only be 'Summary' or 'Balance' 
Debit/Credit field can only be 'CR' or 'DR'  Debit/Credit field can only be 'CR' or 'DR' 
Both Beginning Balance and Ending Balance cannot be Yes  Both Beginning Balance and Ending Balance cannot be Yes 
Beginning Balance field can only be 'Yes' or 'No'  Beginning Balance field can only be 'Yes' or 'No' 
Ending Balance field can only be 'Yes' or 'No'  Ending Balance field can only be 'Yes' or 'No' 
BAI2 Type Codes can not be all zeroes (e.g. 000).   
BAI2 Type Codes may contain only numeric characters.   
The field Type Code is required and must have a value.   
[type code]: The Balance Type Code defined is a duplicate of an existing standard Balance, Summary, or Transaction type code.   
[type code]: Enter a Bank Statement Type Category with a Bank Statement Format that matches the Custom Code Set’s Bank Statement Format.   
[type code]: The field Debit/Credit is required and must have a value.   
[type code]: The Balance Type Code defined is a duplicate of an existing standard Balance, Summary, or Transaction type code.   
top
 

Bank_Statement_Balance_TypeObject

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

Bank_Statement_Balance_TypeObjectID

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

Bank_Statement_Type_CategoryObject

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

Bank_Statement_Type_CategoryObjectID

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

Bank_Statement_Transaction_Type_Data

part of: Bank_Statement_Custom_Code_Set_Data
Element containing Bank Statement Transaction Type Data
 
Parameter name Type/Value Cardinality Description Validations
Bank_Statement_Transaction_Type_Reference  Bank_Statement_Transaction_TypeObject  [0..1]  Bank Statement Transaction Type Reference   
ID  string  [0..1]  Bank Statement Transaction Type ID. This is the bank statement transaction type unique identifier.   
Type_Code  string  [1..1]  Bank Statement Type Code 
Validation Description
Type Code for Transaction Type [code] cannot be changed because it is used in a Bank Statement.   
 
Debit_Credit  string  [0..1]  Debit/Credit Type 
Validation Description
Debit/Credit for Transaction Type Code [code] cannot be changed because it is used in a Bank Statement.   
 
Description  string  [1..1]  Bank Statement Type Description   
Bank_Statement_Type_Category_Reference  Bank_Statement_Type_CategoryObject  [1..1]  Bank Statement Type Category   
Validation Description
Debit/Credit field can only be 'CR' or 'DR'  Debit/Credit field can only be 'CR' or 'DR' 
BAI2 Type Codes may contain only numeric characters.   
BAI2 Type Codes can not be all zeroes (e.g. 000).   
The field Type Code is required and must have a value.   
[type code]: The Transaction Type Code defined is a duplicate of an existing standard Balance, Summary, or Transaction type code.   
[type code]: Enter a Bank Statement Type Category with a Bank Statement Format that matches the Custom Code Set’s Bank Statement Format.   
[type code]: The field Debit/Credit is required and must have a value.   
[type code]: The Transaction Type Code defined is a duplicate of an existing standard Balance, Summary, or Transaction type code.   
top
 

Bank_Statement_Transaction_TypeObject

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

Bank_Statement_Transaction_TypeObjectID

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

Bank_Statement_Custom_Code_SetReferenceEnumeration

part of: Bank_Statement_Custom_Code_SetObjectID
Base Type
string
top
 

Bank_Statement_FormatReferenceEnumeration

part of: Bank_Statement_FormatObjectID
Base Type
string
top
 

Bank_Statement_Balance_TypeReferenceEnumeration

part of: Bank_Statement_Balance_TypeObjectID
Base Type
string
top
 

Bank_Statement_Type_CategoryReferenceEnumeration

part of: Bank_Statement_Type_CategoryObjectID
Base Type
string
top
 

Bank_Statement_Transaction_TypeReferenceEnumeration

part of: Bank_Statement_Transaction_TypeObjectID
Base Type
string
top