CData Sync App は、Workday データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Workday コネクタはCData Sync アプリケーションから使用可能で、Workday からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Workday への接続を作成します。Workday アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからWorkday コネクタをダウンロードおよびインストールします。
必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。
認証するには、User、Password、Tenant およびHost を設定します。これらを設定すると、接続の準備が整います。次に例を示します。
To obtain the Host, log into Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example: https://wd3-impl-services1.workday.com/ccx/api/v1/mycompany. In this case, the Host would be https://wd3-impl-services1.workday.com.
While connecting, you may receive an error stating "Invalid Request". This error comes from Workday. While not terribly informative, it can often mean that your user account has not been granted the permissions to either connect via the API, or to obtain the specific information you have requested. The tables and columns are retrieved from a publicly available service that requires no authentication, so this error may come up while either testing the connection, or when trying to retrieve data after retrieving metadata.
While connecting, you may receive an error stating "Processing error occurred. The task submitted is not authorized". This error comes from Workday. While not terribly informative, it can often mean that your Workday account does not have the module activated to access the table or Service you are attempting to connect to. Please ensure the correct module is activated if you receive this error. We are unable to dynamically determine which modules are available to you at runtime, but you may control which services show up as available via the Service connection property.
次のプロパティを設定して、Sync App がOData API をデータベースとしてモデル化する方法を制御します。
このセクションでは、Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定される仮想テーブルを定義できます。カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、証明書のネゴシエーションをSync App がどのように扱うかを調整します。SSL で使用する証明書を指定することもできます。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、Workday API へのSQL の実行について詳しく説明します。
This section describes the Data Model for the AbsenceManagement API.
ビュー are tables that cannot be modified. Typically, read-only data are shown as views.
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。テーブルおよびストアドプロシージャの詳細については、このヘルプドキュメントの該当エントリを参照してください。
| Name | Description |
| AbsenceInputs | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| CarryoverOverride | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| OverrideBalances | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| OverrideBalances_Override_Balance_Units_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| TimeOffPlanBalances | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| TimeOffPlanBalances_Time_Off_Plan_Balance_Record | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Absence_Input_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Absence_Input_Reference_Absence_Input_ID | String | Contains a unique identifier for an instance of an object. | |
| Absence_Input_ID | String | Absence Input ID (Used as a Lookup ID to perform an update. If not provided, the web service will add a new instance). | |
| Batch_ID | String | Batch ID is the unique identifier. | |
| Worker_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Position_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Position_Reference_Position_ID | String | Contains a unique identifier for an instance of an object. | |
| Absence_Component_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Absence_Component_Reference_Accrual_Code | String | Contains a unique identifier for an instance of an object. | |
| Absence_Component_Reference_Time_Off_Code | String | Contains a unique identifier for an instance of an object. | |
| Start_Date | Date | Start Date of Start Period | |
| End_Date | Date | End Date of End Period | |
| Reference_Date | Date | Reference Date is required for Time Off and Accrual. | |
| Hours | Decimal | Absence Hours | |
| Adjustment | Bool | Adjustment (1=True, 0=False) | |
| Comment | String | Comment |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Carryover_Override_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Carryover_Override_Reference_Carryover_Override_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | Reference ID | |
| Worker_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Absence_Plan_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Absence_Plan_Reference_Absence_Plan_ID | String | Contains a unique identifier for an instance of an object. | |
| Absence_Plan_Reference_Workday_Absence_Plan_ID | String | Contains a unique identifier for an instance of an object. | |
| Carryover_Date | Date | Carryover Date | |
| Position_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Position_Reference_Position_ID | String | Contains a unique identifier for an instance of an object. | |
| Carryover_Override_Amount | Decimal | Carryover Limit Override Amount | |
| Carryover_Expiration_Date | Date | Carryover Expiration Date | |
| Comments | String | Comments |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Override_Balance_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Override_Balance_Reference_Calculated_and_Override_Balance_Index | String | Contains a unique identifier for an instance of an object. | |
| ID | String | Reference ID | |
| Batch_ID | String | Batch ID | |
| Worker_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Position_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Position_Reference_Position_ID | String | Contains a unique identifier for an instance of an object. | |
| Time_Off_Plan_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Time_Off_Plan_Reference_Absence_Plan_ID | String | Contains a unique identifier for an instance of an object. | |
| Time_Off_Plan_Reference_Workday_Absence_Plan_ID | String | Contains a unique identifier for an instance of an object. | |
| Override_Balance_Date | Date | Override Balance Date | |
| Override_Balance_Units | Decimal | Override Balance Units | |
| Comments | String | Comments |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| OverrideBalance_Override_Balance_Reference_WID | String |
OverrideBalances.Override_Balance_Reference_WID | The unique identifier type. Each |
| Carryover_Date | Date | Carryover Date | |
| Carryover_Expiration_Date | Date | Carryover Expiration Date | |
| Carryover_Override_Balance_Units | Decimal | Carryover Override Balance Units |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Employee_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Employee_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Employee_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| TimeOffPlanBalance_Employee_Reference_WID | String |
TimeOffPlanBalances.Employee_Reference_WID | The unique identifier type. Each |
| Time_Off_Plan_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Time_Off_Plan_Reference_Absence_Plan_ID | String | Contains a unique identifier for an instance of an object. | |
| Time_Off_Plan_Reference_Workday_Absence_Plan_ID | String | Contains a unique identifier for an instance of an object. | |
| Unit_of_Time_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Unit_of_Time_Reference_Unit_of_Time_ID | String | Contains a unique identifier for an instance of an object. | |
| Time_Off_Plan_Balance_Position_Record | String | Time Off Plan Balance Position Record |
This section describes the Data Model for the AcademicAdvising API.
ビュー are tables that cannot be modified. Typically, read-only data are shown as views.
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。テーブルおよびストアドプロシージャの詳細については、このヘルプドキュメントの該当エントリを参照してください。
| Name | Description |
| AcademicAdvisingNotes | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicProgressforStudent | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicRequirementOverrides | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicRequirementOverrides_Add_Course_Override_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicRequirementOverrides_Add_Course_to_Eligibility_Rule_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicRequirementOverrides_Adjust_Units_Override_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicRequirementOverrides_Assign_Course_Override_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicRequirementOverrides_Assign_Course_to_Eligibility_Rule_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicRequirementOverrides_Course_Override_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicRequirementsEffectiveDate | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Advisors | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| CriteriaBasedStudentCohorts | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EducationTestTransferCreditRules | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EducationTestTransferCreditRules_Education_Test_Rule_Snapshot_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentCohortMemberships | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentCohorts | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentTransferCreditRules | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentTransferCreditRules_Student_Articulation_Rule_Snapshot_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| TransferCreditReasons | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Reference ID for Get Note data Task | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Record_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Record_Reference_Student_Record_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Topic_Reference | String | Engagement Conversation Topic Reference | |
| Student_Note_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Type_Reference_Student_Note_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Date | Datetime | Student Note Date | |
| Public | Bool | Public |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Record_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Student_Record_Reference_Student_Record_ID | String | Contains a unique identifier for an instance of an object. | |
| Program_of_Study_Student_Academic_Progress_Data | String | Program of Study Student Academic Progress Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Academic_Requirement_Override_Reference_IID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Requirement_Override_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Record_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Record_Reference_Student_Record_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Requirement_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Requirement_Reference_Academic_Requirement_ID | String | Contains a unique identifier for an instance of an object. | |
| Override_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Override_Type_Reference_Academic_Requirement_Override_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Override_Reason_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Override_Reason_Reference_Academic_Requirement_Override_Reason_ID | String | Contains a unique identifier for an instance of an object. | |
| Competency_Reference | String | The competencies for the academic requirement override. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| AcademicRequirementOverride_Academic_Requirement_Override_Reference_IID | String |
AcademicRequirementOverrides.Academic_Requirement_Override_Reference_IID | The unique identifier type. Each |
| Course_To_Add_Reference | String | The course(s) to be added. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| AcademicRequirementOverride_Academic_Requirement_Override_Reference_IID | String |
AcademicRequirementOverrides.Academic_Requirement_Override_Reference_IID | The unique identifier type. Each |
| Student_Eligibility_Rule_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Eligibility_Rule_Reference_Application_Additional_Educational_Interest_Eligibility_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Eligibility_Rule_Reference_Eligibility_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Eligibility_Rule_Reference_Student_Condition_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Add_Course_Override_Data | String | Add Course Override Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| AcademicRequirementOverride_Academic_Requirement_Override_Reference_IID | String |
AcademicRequirementOverrides.Academic_Requirement_Override_Reference_IID | The unique identifier type. Each |
| Student_Eligibility_Rule_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Eligibility_Rule_Reference_Application_Additional_Educational_Interest_Eligibility_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Eligibility_Rule_Reference_Eligibility_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Eligibility_Rule_Reference_Student_Condition_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Adjust_Units | Decimal | The units to be adjusted to. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| AcademicRequirementOverride_Academic_Requirement_Override_Reference_IID | String |
AcademicRequirementOverrides.Academic_Requirement_Override_Reference_IID | The unique identifier type. Each |
| Student_Registration_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Registration_Reference_Student_Course_Registration_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Registration_Reference_Student_Prospect_Record_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Progress_Satisfiable_Assignment_Units_Applied | Decimal | The units that should be applied for the academic progress satisfiable. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| AcademicRequirementOverride_Academic_Requirement_Override_Reference_IID | String |
AcademicRequirementOverrides.Academic_Requirement_Override_Reference_IID | The unique identifier type. Each |
| Student_Eligibility_Rule_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Eligibility_Rule_Reference_Application_Additional_Educational_Interest_Eligibility_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Eligibility_Rule_Reference_Eligibility_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Eligibility_Rule_Reference_Student_Condition_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Assign_Course_Override_Data | String | Assign Course Override Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| AcademicRequirementOverride_Academic_Requirement_Override_Reference_IID | String |
AcademicRequirementOverrides.Academic_Requirement_Override_Reference_IID | The unique identifier type. Each |
| Course_To_Override_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Course_To_Override_Reference_Student_Course_ID | String | Contains a unique identifier for an instance of an object. | |
| Alternate_Course_Sub_Edit_Data | String | Alternate Course Sub Edit Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | The Reference ID for the Student Program of Study Record | |
| Requirements_Effective | Date | The Requirements Effective Date for the Student Program of Study Record |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Reference ID | |
| Academic_Affiliate_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Affiliate_Reference_Academic_Affiliate_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_Universal_Identifier_ID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Ref ID for Criteria Based Student Cohort. | |
| Student_Cohort_Name | String | Name for Criteria Based Student Cohort. | |
| Student_Cohort_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Cohort_Type_Reference_Student_Cohort_Types_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_Hierarchy_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference | String | Academic Level Nonsingular Workset | |
| Evaluate_Security_by_Cohort | Bool | Evaluate Security by Cohort | |
| Custom_Report_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Custom_Report_Reference_Custom_Report_ID | String | Contains a unique identifier for an instance of an object. | |
| Saved_Search_Reference_IID | String | Contains a unique identifier for an instance of an object. | |
| Saved_Search_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_LearningUserName | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_RecruitingUserName | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_StudentUserName | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_SupplierUserName | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_System_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_System_User_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_System_User_OpenID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_System_User_OpenID_Connect_Internal | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_System_User_OpenID_Internal | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_WorkdayUserName | String | Contains a unique identifier for an instance of an object. | |
| Refresh_Membership_Automatically | Bool | Refresh Membership Automatically boolean for Criteria Based Student Cohort. | |
| Ending_Automatic_Refresh_Academic_Period_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Ending_Automatic_Refresh_Academic_Period_Reference_Academic_Period_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Education_Test_Rule_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Education_Test_Rule_Reference_Education_Test_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | ID | |
| Institution_Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Institution_Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Education_Test_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Education_Test_Reference_Education_Test_ID | String | Contains a unique identifier for an instance of an object. | |
| Education_Test_Reference_Workday_Education_Test_ID | String | Contains a unique identifier for an instance of an object. | |
| Education_Test_Section_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Education_Test_Section_Reference_Education_Test_Section_ID | String | Contains a unique identifier for an instance of an object. | |
| Education_Test_Section_Reference_Workday_Education_Test_Section_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| EducationTestRule_Education_Test_Rule_Reference_WID | String |
EducationTestTransferCreditRules.Education_Test_Rule_Reference_WID | The unique identifier type. Each |
| ID | String | ID | |
| Effective_Date | Date | Effective Date | |
| No_Internal_Equivalent | Bool | No Internal Equivalent | |
| Transfer_Credit_Reason_Reference | String | Transfer Credit Reason Reference | |
| Education_Test_Rule_Snapshot_Line_Data | String | Education Test Rule Snapshot Line Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | ID | |
| Student_Cohort_Assignment_Data | String | Student Cohort Assignment Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | ID | |
| Student_Cohort_Name | String | Student Cohort Name | |
| Student_Cohort_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Cohort_Type_Reference_Student_Cohort_Types_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_Hierarchy_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference | String | Academic Level Nonsingular Workset | |
| Evaluate_Security_by_Cohort | Bool | Evaluate Security by Cohort |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Articulation_Rule_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Student_Articulation_Rule_Reference_Student_Articulation_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | ID | |
| Institution_Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Institution_Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_CCD_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Federal_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_IPEDS_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_OPEID_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_NCES_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Course_Reference | String | Educational Institution Course Reference | |
| Preferred_Unit_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Preferred_Unit_Type_Reference_Student_Course_Unit_Type_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentArticulationRule_Student_Articulation_Rule_Reference_WID | String |
StudentTransferCreditRules.Student_Articulation_Rule_Reference_WID | The unique identifier type. Each |
| ID | String | ID | |
| Effective_Date | Date | Effective Date | |
| No_Internal_Equivalent | Bool | No Internal Equivalent | |
| Minimum_Unit_Threshold | Decimal | Sets the minimum threshold of units earned from the external courses taken to award credit from the transfer credit rule. | |
| Transfer_Credit_Reason_Reference | String | Transfer Credit Reason Reference | |
| Student_Articulation_Course_Data | String | Student Articulation Course Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Transfer_Credit_Reason_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Transfer_Credit_Reason_Reference_Transfer_Credit_Reason_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | ID | |
| Institution_Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Institution_Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Transfer_Credit_Reason_Name | String | Transfer Credit Reason Name | |
| Transfer_Credit_Reason_Description | String | Transfer Credit Reason Description |
This section describes the Data Model for the AcademicFoundation API.
ビュー are tables that cannot be modified. Typically, read-only data are shown as views.
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。テーブルおよびストアドプロシージャの詳細については、このヘルプドキュメントの該当エントリを参照してください。
| Name | Description |
| AcademicContacts | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicContacts_Address_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicContacts_Email_Address_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicContacts_Instant_Messenger_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicContacts_Phone_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicContacts_Web_Address_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AcademicPeriodDateControls | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AccommodationsforStudent | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EducationalInstitutionAttendances | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EducationalInstitutionCourse | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EducationalInstitutionGradingSchemes | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EducationalTaxonomySchemes | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EducationalTaxonomySchemes_Educational_Taxonomy_Code_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EducationTestResults | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| ExternalAssociations | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| ExternalAssociations_Contact_Information_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| ExtracurricularActivities | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| ExtracurricularActivities_Academic_Unit_Shareable_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| MaintainedAcademicPeriods | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| PrimaryDisabilityforStudents | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| ProgramofStudyExplorationDetails | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| ProgramsofStudy | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| ProgramsofStudy_Addable_Configuration_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| ProspectiveStudents | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentEducationalInstitution | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentEducationalInstitutionDistricts | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentFriendsandFamily | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentGradingSchemes | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentHoldAssignments | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentHoldAssignments_Student_Hold_Assignment_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentHoldAssignments_Student_Hold_Assignment_Override_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentHoldReasons | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentHousingAssignments | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentImmigrationDatas | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentNoteTopics | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentResidencies | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Students | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Students_Student_Additional_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Students_Student_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentTagCategories | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentTags | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentVeteransBenefits | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| UniversalIdentifiers | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Academic_Contact_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Academic_Contact_Reference_Academic_Contact_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | Academic Contact (also known as Representative) Reference ID | |
| Has_Academic_Contact_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_CCD_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_Postsecondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_Postsecondary_Federal_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_Postsecondary_IPEDS_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_Postsecondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_Postsecondary_OPEID_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_Postsecondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_Postsecondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_Secondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_Secondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_Secondary_NCES_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_Secondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Educational_Institution_Secondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_External_Association_ID | String | Contains a unique identifier for an instance of an object. | |
| Has_Academic_Contact_Reference_Student_Recruiting_Event_Series_ID | String | Contains a unique identifier for an instance of an object. | |
| Job_Title | String | Academic Contact Job Title | |
| Country_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_2_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Numeric_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Title_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Title_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Title_Descriptor | String | The description of the reference to the Title of a person. | |
| Salutation_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Salutation_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Name_Detail_First_Name | String | The First Name (Given Name) for a person. | |
| Name_Detail_Middle_Name | String | The Middle Name for a person. | |
| Name_Detail_Last_Name | String | The Last Name (Family Name) for a person. | |
| Name_Detail_Secondary_Last_Name | String | The Secondary Last Name (Secondary Family Name) for a person. | |
| Tertiary_Last_Name | String | The Tertiary Last Name for a person. | |
| Local_Name_Detail_First_Name | String | Contains First Name in local script, which is generally configured to as Given Name, for supporting Countries. | |
| Local_Name_Detail_Middle_Name | String | Contains Middle Name in local script for supporting Countries. | |
| Local_Name_Detail_Last_Name | String | Contains Last Name in local script, which is generally configured as Family Name, for supporting Countries. | |
| Local_Name_Detail_Secondary_Last_Name | String | Contains Secondary Last Name in local script, which is generally configured as Maternal Family Name, for supporting Countries. | |
| First_Name_2 | String | Contains First Name in second local script, which is generally configured as Given Name, for supporting Countries. | |
| Middle_Name_2 | String | Contains Middle Name in second local script for supporting Countries. | |
| Last_Name_2 | String | Contains Last Name in second local script, which is generally configured as Given Name, for supporting Countries. | |
| Secondary_Last_Name_2 | String | Contains Secondary Last Name in second local script, which is generally configured as Maternal Family Name, for supporting Countries. | |
| Social_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Social_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Social_Suffix_Descriptor | String | A reference to the description of Social Suffix for a person. | |
| Academic_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Hereditary_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Hereditary_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Honorary_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Honorary_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Professional_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Professional_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Religious_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Religious_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Royal_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Royal_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Full_Name_for_Singapore_and_Malaysia | String | Full Person Name is used by Malaysia and Singapore. It is designed for (eliminate space between these two words) Workers in these countries to enter their Full Legal Name. It is an attribute of Global Person Name Class and is not a concatenation of First and Last Names. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| AcademicContact_Academic_Contact_Reference_WID | String |
AcademicContacts.Academic_Contact_Reference_WID | The unique identifier type. Each |
| Country_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_2_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Numeric_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Last_Modified | Datetime | The moment when the address was last modified. | |
| Address_Line_Data | String | The address line for the address. This typically contains Street name, street number, apartment, suite number. | |
| Municipality | String | City part of the address. | |
| Country_City_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_City_Reference_Country_Subregion_Code_In_Country | String | Contains a unique identifier for an instance of an object. | |
| Country_City_Reference_Country_Subregion_Internal_ID | String | Contains a unique identifier for an instance of an object. | |
| Submunicipality_Data | String | The submunicipality of the address. | |
| Country_Region_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_Region_Reference_Country_Region_ID | String | Contains a unique identifier for an instance of an object. | |
| Country_Region_Reference_ISO_3166_2_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Region_Descriptor | String | The region part of the address. Typically this contains the state/province information. | |
| Subregion_Data | String | The subregion part of the address. | |
| Postal_Code | String | The postal code part of the address. | |
| Usage_Data | String | Encapsulating element for all Communication Method Usage data. | |
| Number_of_Days | Decimal | Tracks the number of days an employee works from home per week. | |
| Municipality_Local | String | City in local script part of the address. | |
| Address_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Address_Reference_Address_ID | String | Contains a unique identifier for an instance of an object. | |
| Address_ID | String | New ID value used in address updates. The ID cannot already be in use by another address. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| AcademicContact_Academic_Contact_Reference_WID | String |
AcademicContacts.Academic_Contact_Reference_WID | The unique identifier type. Each |
| Email_Address | String | Email Address Information | |
| Email_Comment | String | Email comments. | |
| Usage_Data | String | Encapsulating element for all Communication Method Usage data. | |
| Email_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Email_Reference_Email_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | New ID value used in email address updates. The ID cannot already be in use by another email address. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| AcademicContact_Academic_Contact_Reference_WID | String |
AcademicContacts.Academic_Contact_Reference_WID | The unique identifier type. Each |
| Instant_Messenger_Address | String | Instant Messenger Address. | |
| Instant_Messenger_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Instant_Messenger_Type_Reference_Instant_Messenger_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Instant_Messenger_Comment | String | Instant messenger comment. | |
| Usage_Data | String | Encapsulating element for all Communication Method Usage data. | |
| Instant_Messenger_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Instant_Messenger_Reference_Instant_Messenger_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | New ID value used in instant messenger updates. The ID cannot already be in use by another instant messenger. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| AcademicContact_Academic_Contact_Reference_WID | String |
AcademicContacts.Academic_Contact_Reference_WID | The unique identifier type. Each |
| Country_ISO_Code | String | Country ISO code. If the Country ISO code is specified, then this ISO code will be used to determine the Country Phone Code for (eliminate space between f and o) the phone. Pass this ISO code to distinguish between multiple countries sharing the same Country Phone Code. (For example, 1 is the Country Phone Code that is shared by USA, Canada, Dominican Republic, Bermuda, Jamaica, and Puerto Rico.) | |
| International_Phone_Code | String | International phone code number. | |
| Phone_Number | String | Full phone number. | |
| Phone_Extension | String | Phone extension. | |
| Phone_Device_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Phone_Device_Type_Reference_Phone_Device_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Usage_Data | String | Encapsulating element for all Communication Method Usage data. | |
| Phone_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Phone_Reference_Phone_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | New ID value used in phone updates. The ID cannot already be in use by another phone. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| AcademicContact_Academic_Contact_Reference_WID | String |
AcademicContacts.Academic_Contact_Reference_WID | The unique identifier type. Each |
| Web_Address | String | Web address (Example: URL). | |
| Web_Address_Comment | String | Web address comment. | |
| Usage_Data | String | Encapsulating element for all Communication Method Usage data. | |
| Web_Address_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Web_Address_Reference_Web_Address_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | New ID value used in web address updates. The ID cannot already be in use by another web address. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Academic_Period_ID | String | Reference ID for the Academic Period | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference_Academic_Level_ID | String | Contains a unique identifier for an instance of an object. | |
| Program_of_Study_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Program_of_Study_Reference_Program_of_Study_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Period_Date_Control | String | Wrapper element for each Academic Period Control Date |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Accommodation_Assignment_Data | String | Student Accommodation Assignment Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | The ID Attribute for the Educational Institution Attendance WS | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_Universal_Identifier_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_CCD_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Federal_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_IPEDS_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_OPEID_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_NCES_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Start_Date | Date | The Start Date for the Educational Institution Attendance WS | |
| Exit_Date | Date | The Exit Date for the Educational Institution Attendance WS |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Educational_Institution_Course_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Course_Reference_Educational_Institution_Course_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | Reference ID for the Educational Institution Course | |
| Educational_Institution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_CCD_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Federal_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_IPEDS_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_OPEID_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_NCES_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Course_Number | String | Specifies the Course Number for the Educational Institution Course | |
| Educational_Institution_Course_Academic_Area_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Course_Academic_Area_Reference_Educational_Institution_Course_Academic_Area_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Course_Title | String | Specifies the Title of the Educational Institution Course | |
| Educational_Institution_Course_Designations_Reference | String | References the Course Designation for the Educational Institution Course | |
| Educational_Institution_Course_Credits | Decimal | Specifies the Credits for the Educational Institution Course | |
| Educational_Institution_Course_Unit_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Course_Unit_Type_Reference_Student_Course_Unit_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Course_Description | String | Specifies the Description for the Educational Institution Course | |
| Educational_Institution_Course_Notes | String | Specifies the Notes for the Educational Institution Course |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Reference ID for the Educational Institution Grading Scheme | |
| Grading_Scheme_Code | String | Educational Institution Grading Scheme Code | |
| Grading_Scheme_Description | String | Educational Institution Grading Scheme Description | |
| Educational_Institution_Grading_Scheme_Component_Data | String | Element Container for Educational Institution Grading Scheme Component |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Educational_Taxonomy_Scheme_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Educational_Taxonomy_Scheme_Reference_Educational_Taxonomy_Scheme_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | Reference ID for Educational Taxonomy Scheme | |
| Country_Country_Region_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_Country_Region_Reference_Country_Region_ID | String | Contains a unique identifier for an instance of an object. | |
| Country_Country_Region_Reference_Country_Subregion_Code_In_Country | String | Contains a unique identifier for an instance of an object. | |
| Country_Country_Region_Reference_Country_Subregion_Internal_ID | String | Contains a unique identifier for an instance of an object. | |
| Country_Country_Region_Reference_ISO_3166_1_Alpha_2_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Country_Region_Reference_ISO_3166_1_Alpha_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Country_Region_Reference_ISO_3166_1_Numeric_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Country_Region_Reference_ISO_3166_2_Code | String | Contains a unique identifier for an instance of an object. | |
| Name | String | Educational Taxonomy Scheme Name | |
| Description | String | Educational Taxonomy Scheme Description | |
| Inactive | Bool | Educational Taxonomy Scheme Inactive | |
| Educational_Taxonomy_Code_Format_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Taxonomy_Code_Format_Reference_Educational_Taxonomy_Code_Format_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| EducationalTaxonomyScheme_Educational_Taxonomy_Scheme_Reference_WID | String |
EducationalTaxonomySchemes.Educational_Taxonomy_Scheme_Reference_WID | The unique identifier type. Each |
| Educational_Taxonomy_Code_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Taxonomy_Code_Reference_Educational_Taxonomy_Code_ID | String | Contains a unique identifier for an instance of an object. | |
| Code | String | Educational Taxonomy Code | |
| Description | String | Educational Taxonomy Code Description (Optional) | |
| ID | String | ID for Educational Taxonomy Code |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Id of Education Test Result | |
| Pending | Bool | Education Test Result Pending | |
| Has_Academic_Unit_Data | String | Has Academic Unit Data | |
| Date_Taken | Date | Date the test was taken for all test results except AP - Advanced Placement Exam, where this field is named Score Report Date. | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_Universal_Identifier_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Prospect_Person_ID | String | The ID of an existing Student or the ID to set for a new Student. | |
| Legal_Name_Data | String | Contains the legal name for a person. A person must name one and only one legal name. | |
| Contact_Information_Data | String | All of the person's contact data (address, phone, email, instant messenger, web address). | |
| Student_Prospect_Personal_Profile_Data | String | Contains personal information of the Student Prospect. | |
| Person_Identification_Data | String | Wrapper for Person Identification Data. Includes National Identifiers, Government Identifiers, Visa Identifiers, Passport Identifiers, License Identifiers and Custom Identifiers. | |
| Self_Identification_Data | String | Contains Self Identification Data (Gender Identity, Sexual Orientation, and Pronoun) for a Student Prospect. | |
| Test_Administration_Site_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_CCD_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_Postsecondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_Postsecondary_Federal_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_Postsecondary_IPEDS_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_Postsecondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_Postsecondary_OPEID_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_Postsecondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_Postsecondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_Secondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_Secondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_Secondary_NCES_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_Secondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Educational_Institution_Secondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_External_Association_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Location_ID | String | Contains a unique identifier for an instance of an object. | |
| Test_Administration_Site_Reference_Student_Recruiting_Event_Ad_Hoc_Location_ID | String | Contains a unique identifier for an instance of an object. | |
| Registration_Number | String | Registration ID for all test results except AP - Advanced Placement Exam, where this field is named AP Number. | |
| Official | Bool | Whether test result is official or not | |
| Received_Date | Date | Date the test score report was received. This date defaults to the current date if there was no date given. | |
| Education_Test_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Education_Test_Reference_Education_Test_ID | String | Contains a unique identifier for an instance of an object. | |
| Education_Test_Reference_Workday_Education_Test_ID | String | Contains a unique identifier for an instance of an object. | |
| Education_Test_Section_Result_Data | String | Contains Education Test Score information for an Education Test Result |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| External_Association_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| External_Association_Reference_External_Association_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | The External Affiliation's Reference ID | |
| External_Association_Name | String | The Name of the External Affiliation. Must be unique. | |
| External_Association_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| External_Association_Type_Reference_External_Association_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| External_Association_Status_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| External_Association_Status_Reference_External_Association_Status_ID | String | Contains a unique identifier for an instance of an object. | |
| Designation_Reference | String | The Designations of the External Association. | |
| Academic_Contact_Reference | String | The Academic Contacts for this External Association. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ExternalAssociation_External_Association_Reference_WID | String |
ExternalAssociations.External_Association_Reference_WID | The unique identifier type. Each |
| Address_Data | String | Address information | |
| Phone_Data | String | Phone Information | |
| Email_Address_Data | String | Email Address Information | |
| Instant_Messenger_Data | String | Instant Messenger Information | |
| Web_Address_Data | String | Web Address Information |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Extracurricular_Activity_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Extracurricular_Activity_Reference_Extracurricular_Activity_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | ID attribute of the Extracurricular Activity | |
| Extracurricular_Activity_Name | String | The Name of the Extracurricular Activity | |
| Extracurricular_Activity_Category_Reference | String | The Extracurricular Activity Category of the Extracurricular Activity |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Reference ID for the Academic Period | |
| Academic_Period_Name | String | Academic Period Name | |
| Academic_Period_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Period_Type_Reference_Academic_Periods_Offered_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Calendar_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Calendar_Reference_Academic_Calendar_ID | String | Contains a unique identifier for an instance of an object. | |
| Standard_Start_Date | Date | Standard Start Date | |
| Academic_Period_Start_Date | Date | Academic Period Start Date | |
| Academic_Period_End_Date | Date | Academic Period End Date | |
| Standard_End_Date | Date | Standard End Date | |
| Display_Date_Range | Bool | If checked, date range is displayed | |
| Academic_Period_Weeks_of_Instruction | Decimal | Academic Period Weeks of Instruction | |
| Academic_Period_Usage_Reference | String | Academic Period Usage Reference | |
| Inactive | Bool | Inactive flag | |
| Time_Zone_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Time_Zone_Reference_Time_Zone_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Period_Weight_Data | String | Wrapper element for the Maintained Academic Period data. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Institutional_Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Institutional_Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Primary_Student_Disability_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Primary_Student_Disability_Reference_Student_Disability_for_Accommodation_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Program_of_Study_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Program_of_Study_Reference_Program_of_Study_ID | String | Contains a unique identifier for an instance of an object. | |
| Overview | String | Overview for Program of Study Exploration Details Data | |
| Description | String | Description for Program of Study Exploration Details Data | |
| URL | String | URL for Program of Study Exploration Details Data | |
| Worker_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Program_of_Study_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Program_of_Study_Reference_Program_of_Study_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | Reference ID for Program of Study Data | |
| Effective_Date | Date | Program of Study Effective Date | |
| Program_of_Study_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Program_of_Study_Type_Reference_Program_of_Study_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Program_Minimum_Coursework_Credit | Decimal | Program Minimum Coursework Credit Hours | |
| Program_Minimum_Coursework_Clock | Decimal | Program Minimum Coursework Clock Hours | |
| Program_Duration_Weeks | Decimal | Financial Aid Criteria Program Weeks | |
| Program_Duration_Months | Decimal | Financial Aid Criteria Program Months | |
| Program_Duration_Years | Decimal | Financial Aid Criteria Program Years | |
| Program_of_Study_Code | String | Program of Study Code | |
| Primary_Program_of_Study_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Primary_Program_of_Study_Reference_Program_of_Study_ID | String | Contains a unique identifier for an instance of an object. | |
| Secondary_Program_of_Study_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Secondary_Program_of_Study_Reference_Program_of_Study_ID | String | Contains a unique identifier for an instance of an object. | |
| Parent_Program_of_Study_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Parent_Program_of_Study_Reference_Program_of_Study_ID | String | Contains a unique identifier for an instance of an object. | |
| Program_Name | String | Program of Study Name | |
| CIP_Code_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| CIP_Code_Reference_Cip_Code_ID | String | Contains a unique identifier for an instance of an object. | |
| CIP_Code_Reference_CIP_Code_ID_2020 | String | Contains a unique identifier for an instance of an object. | |
| Educational_Taxonomy_Codes_Reference | String | Educational Taxonomy Code for Program of Study | |
| Allowed_Locations_Reference | String | Allowed Locations for Program of Study | |
| Admission_Response_Not_Required | Bool | Program of Study Admission Response Not Required | |
| Fast_Path_Enabled | Bool | Program of Study Fast Path Enabled | |
| Include_Type_in_Name | Bool | Include Type in Name | |
| First_Entry_Date | Date | First Entry Date | |
| Last_Entry_Date | Date | Last Entry Date | |
| Academic_Level_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference_Academic_Level_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Coordinating_Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Coordinating_Academic_Unit_Reference_Academic_Unit_Hierarchy_ID | String | Contains a unique identifier for an instance of an object. | |
| Coordinating_Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Route_by_Coordinating_Academic_Unit | Bool | Route by Coordinating Academic Unit | |
| Route_by_Owning_Academic_Unit | Bool | Route by Owning Academic Unit | |
| Program_Focus_Required | Bool | Program Focus Required | |
| Evaluate_Academic_Requirements_Prior_to_Program_Change | Bool | Evaluate Academic Requirements Prior to Program Change | |
| Program_Area_Reference | String | Program Areas | |
| Educational_Credentials_Reference | String | Educational Credentials Reference |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ProgramofStudy_Program_of_Study_Reference_WID | String |
ProgramsofStudy.Program_of_Study_Reference_WID | The unique identifier type. Each |
| Additional_Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Additional_Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Additional_Academic_Level_Reference | String | Academic Level Reference for an Addable Configuration | |
| Additional_Program_of_Study_Type_Reference | String | Program of Study Type Reference for an Addable Configuration | |
| Additional_Include_All | Bool | Include All Addable Programs of Study boolean | |
| Included_Additional_Reference | String | Included Addable Programs of Study Reference | |
| Excluded_Additional_Reference | String | Excluded Addable Programs of Study Reference | |
| Stackable_Include_All | Bool | Include All Stackable Programs of Study boolean | |
| Included_Stackable_Reference | String | Included Stackable Programs of Study Reference | |
| Excluded_Stackable_Reference | String | Excluded Stackable Programs of Study Reference |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Opt_Out | Bool | Engagement Opt Out | |
| Student_Person_Data | String | Contains Legal Name and Contact Information | |
| Student_Personal_Portfolio_Data | String | Extracurricular Activities and External Affiliations associated with a Student Prospect. | |
| Student_Personal_Information_Data | String | Personal Information data for a Student Applicant | |
| Student_School_Data | String | Contains Institution and Institution Attendance information | |
| Student_Recruitment_Data | String | Contains Recruitment, Academic Unit, Academic Period, Student Prospect Stage, Educational Interests, and Prospect Source information for a Student Prospect | |
| Student_Application_Data | String | Contains Application, Academic Unit, Academic Period, Student Prospect Stage information about a Student Applicant | |
| Education_Test_Result_Data | String | Education Test Result Subedit Data | |
| Student_Transcript_Data | String | Contains all data related to a Student Transcript. | |
| Student_Proxy_Data | String | Contains Student Proxy information for a Student Prospect |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Educational Institution Reference ID | |
| Educational_Institution_Name | String | Educational Institution Name | |
| Educational_Institution_School_Level_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_School_Level_Reference_Educational_Institution_School_Level_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Category_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Category_Reference_Educational_Institution_Category_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Type_Reference_Student_Educational_Institution_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Inactive | Bool | Educational Institution Inactive | |
| Educational_Institution_Students_In_Grade_Data | String | Students in Grade Data for Educational Institution | |
| Educational_Institution_Locale_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Locale_Reference_Educational_Institution_Locale_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Designation_Reference | String | Educational Institution Designations | |
| Educational_Institution_Ethnicity_Information_Data | String | Ethnicity Information Data for Educational Institution | |
| Educational_Institution_Religious_Orientation_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Religious_Orientation_Reference_Educational_Institution_Religious_Orientation_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Representative_Reference | String | Educational Institution Academic Contact/Representative | |
| Contact_Information_Data | String | Contact Information Data for Educational Institution | |
| Educational_Institution_Operational_Status_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Operational_Status_Reference_Educational_Institution_Operational_Status_ID | String | Contains a unique identifier for an instance of an object. | |
| External_Institution_Grading_Scheme_Reference | String | External Institution Grading Scheme | |
| Educational_Institution_Session_Type_Reference | String | Educational Institution Session Type | |
| Educational_Institution_Student_Body_Data | String | Student Body Data for Educational Institution | |
| Educational_Institution_Secondary_CEEB_ATP_ID | String | Educational Institution Secondary CEEB/ATP ID | |
| Educational_Institution_Secondary_NCES_ID | String | Educational Institution Secondary NCES ID | |
| Educational_Institution_Secondary_State_ID | String | Educational Institution Secondary State ID | |
| Educational_Institution_Secondary_Local_ID | String | Educational Institution Secondary Local ID | |
| Educational_Institution_Secondary_Other_ID | String | Educational Institution Secondary Other ID | |
| Educational_Institution_Secondary_District_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Secondary_District_Reference_Educational_Institution_District_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Secondary_District_Reference_Educational_Institution_District_NCES_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Secondary_District_Reference_Educational_Institution_District_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Secondary_Grade_Offered_Reference | String | Educational Institution Secondary Grades Offered | |
| Educational_Institution_Postsecondary_CEEB_ATP_ID | String | Educational Institution Post-Secondary CEEB/ATP ID | |
| Educational_Institution_Postsecondary_IPEDS_ID | String | Educational Institution Post-Secondary IPEDS ID | |
| Educational_Institution_Postsecondary_OPEID_ID | String | Educational Institution Post-Secondary OPEID ID | |
| Educational_Institution_Postsecondary_Federal_ID | String | Educational Institution Post-Secondary Federal ID | |
| Educational_Institution_Postsecondary_State_ID | String | Educational Institution Post-Secondary State ID | |
| Educational_Institution_Postsecondary_Local_ID | String | Educational Institution Post-Secondary Local ID | |
| Educational_Institution_Postsecondary_Other_ID | String | Educational Institution Post-Secondary Other ID | |
| Educational_Institution_Postsecondary_Carnegie_Classification_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Postsecondary_Carnegie_Classification_Reference_Educational_Institution_Carnegie_Classification_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Postsecondary_Award_Levels_Offered_Reference | String | Educational Institution Postsecondary Award Levels Offered | |
| Educational_Institution_Accreditation_Data | String | Contains Educational Institution Accreditation data | |
| Educational_Institution_Alternate_Name_Data | String | Contains Educational Institution Alternate Name Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Educational Institution District Reference ID | |
| Educational_Institution_District_Name | String | Educational Institution District Name | |
| Educational_Institution_District_NCES_ID | String | Educational Institution District NCES ID | |
| Educational_Institution_District_State_ID | String | Educational Institution District State ID |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | ID for Student Proxy | |
| Relationship_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Relationship_Reference_Association_to_Applicant_ID | String | Contains a unique identifier for an instance of an object. | |
| Relationship_Reference_Student_Proxy_Relationship_ID | String | Contains a unique identifier for an instance of an object. | |
| Relationship_Types_Reference | String | Student Proxy Type for Student Proxy | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_Universal_Identifier_ID | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_2_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Numeric_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Title_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Title_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Title_Descriptor | String | The description of the reference to the Title of a person. | |
| Salutation_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Salutation_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Name_Detail_First_Name | String | The First Name (Given Name) for a person. | |
| Name_Detail_Middle_Name | String | The Middle Name for a person. | |
| Name_Detail_Last_Name | String | The Last Name (Family Name) for a person. | |
| Name_Detail_Secondary_Last_Name | String | The Secondary Last Name (Secondary Family Name) for a person. | |
| Tertiary_Last_Name | String | The Tertiary Last Name for a person. | |
| Local_Name_Detail_First_Name | String | Contains First Name in local script, which is generally configured to as Given Name, for supporting Countries. | |
| Local_Name_Detail_Middle_Name | String | Contains Middle Name in local script for supporting Countries. | |
| Local_Name_Detail_Last_Name | String | Contains Last Name in local script, which is generally configured as Family Name, for supporting Countries. | |
| Local_Name_Detail_Secondary_Last_Name | String | Contains Secondary Last Name in local script, which is generally configured as Maternal Family Name, for supporting Countries. | |
| First_Name_2 | String | Contains First Name in second local script, which is generally configured as Given Name, for supporting Countries. | |
| Middle_Name_2 | String | Contains Middle Name in second local script for supporting Countries. | |
| Last_Name_2 | String | Contains Last Name in second local script, which is generally configured as Given Name, for supporting Countries. | |
| Secondary_Last_Name_2 | String | Contains Secondary Last Name in second local script, which is generally configured as Maternal Family Name, for supporting Countries. | |
| Social_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Social_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Social_Suffix_Descriptor | String | A reference to the description of Social Suffix for a person. | |
| Academic_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Hereditary_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Hereditary_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Honorary_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Honorary_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Professional_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Professional_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Religious_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Religious_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Royal_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Royal_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Full_Name_for_Singapore_and_Malaysia | String | Full Person Name is used by Malaysia and Singapore. It is designed for (eliminate space between these two words) Workers in these countries to enter their Full Legal Name. It is an attribute of Global Person Name Class and is not a concatenation of First and Last Names. | |
| Address_Data | String | Address information | |
| Phone_Data | String | Phone Information | |
| Email_Address_Data | String | Email Address Information | |
| Instant_Messenger_Data | String | Instant Messenger Information | |
| Web_Address_Data | String | Web Address Information |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Name | String | Grading Scheme Name | |
| Effective_Date | Date | Effective as of Date | |
| Student_Grade_Data | String | Subelement of Student Grades |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Hold_Assignment_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Student_Hold_Assignment_Reference_Student_Hold_Assignment_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentHoldAssignment_Student_Hold_Assignment_Reference_WID | String |
StudentHoldAssignments.Student_Hold_Assignment_Reference_WID | The unique identifier type. Each |
| ID | String | Unique identifier of the Student Hold Assignment | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_Universal_Identifier_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Hold_Reason_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Hold_Reason_Reference_Student_Hold_Reason_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Hold_Reason_Reference_Tenanted_Student_Hold_Reason_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Hold_Type_and_Context_Data | String | Reference to Hold Type Context | |
| Remove | Bool | Set this to True if in order to remove this hold assignment. This is for existing hold assignments only. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentHoldAssignment_Student_Hold_Assignment_Reference_WID | String |
StudentHoldAssignments.Student_Hold_Assignment_Reference_WID | The unique identifier type. Each |
| ID | String | Unique identifier of the Student Hold Assignment Override Event | |
| Student_Hold_All_Reference | String | Reference to the Student Hold (All) being overridden | |
| Override_Start_Date | Date | The start date for the hold override | |
| Override_End_Date | Date | The end date for the hold override |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | ID for Student Hold Reason | |
| Has_Academic_Unit_With_Shareable_Subordinates_Data | String | Academic Unit Data with Shareable with Subordinates Data | |
| Name | String | Student Hold Reason Name | |
| Hold_Reference | String | Hold for Student Hold Reason | |
| Inactive | Bool | Inactive Student Hold Reason Boolean |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | The ID of a Student Housing Assignment | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_Universal_Identifier_ID | String | Contains a unique identifier for an instance of an object. | |
| Location_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Location_Reference_Location_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Housing_Assignment_Room_Number | String | The Student Housing Assignment Room Number for a Student Housing Assignment Reference | |
| Student_Housing_Assignment_Room_Type | String | The Student Housing Assignment Room Type for a Student Housing Assignment Reference | |
| Student_Housing_Assignment_Status_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Housing_Assignment_Status_Reference_Student_Housing_Assignment_Status_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Period_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Period_Reference_Academic_Period_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Housing_Assignment_Check_In_Date | Datetime | The Student Housing Assignment Check in Date associated with a Student Housing Assignment Reference | |
| Student_Housing_Assignment_Check_Out_Date | Datetime | The Student Housing Assignment Check Out Date associated with a Student Housing Assignment Reference |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Student Immigration Data ID for Student Immigration Data Data. | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Immigration_Status_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Immigration_Status_Reference_Student_Immigration_Status_ID | String | Contains a unique identifier for an instance of an object. | |
| Institution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Institution_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| SEVIS_ID | String | Student SEVIS ID for Student Immigration Data Data. | |
| Inactive_SEVIS | Bool | SEVIS is Inactive | |
| SEVIS_Creation_Date | Date | Student SEVIS Creation Date for Student Immigration Data Data. | |
| SEVIS_Expiration_Date | Date | Student SEVIS Expiration Date for Student Immigration Data Data. | |
| SEVIS_Record_Transfer_Sent_Date | Date | Student SEVIS Record Transfer Sent Date for Student Immigration Data Data. | |
| SEVIS_Record_Transfer_Received_Date | Date | Student SEVIS Record Transfer Received Date for Student Immigration Data Data | |
| I_94_Number | String | Student I-94 Number for Student Immigration Data Data. | |
| I_94_Entry_Date | Date | Student I-94 Entry Date for Student Immigration Data Data. | |
| I_94_Exit_Date | Date | Student I-94 Exit Date for Student Immigration Data Data. | |
| I_20_Number | String | Student I-20 Number for Student Immigration Data Data. | |
| I_20_Issue_Date | Date | Student I-20 Creation Date for Student Immigration Data Data. | |
| I_20_Expiration_Date | Date | Student I-20 Expiration Date for Student Immigration Data Data. | |
| I_20_Creation_Reason | String | Student I-20 Creation Reason for Student Immigration Data Data. | |
| I_20_URL | String | I-20 URL for Student Immigration Data Data. | |
| I_20_Attachment_Data | String | I-20 Attachment Data for Student Immigration Data Data. | |
| International_Student_Document_Data | String | International Student Document Data element | |
| I_20_Program_Extension_Expiration_Date | Date | Student I-20 Program Extension Expiration Date for Student Immigration Data Data. | |
| I_20_Reprint_Date | Date | Student I-20 Reprint Date for Student Immigration Data Data. | |
| Travel_Signature_Signed | Bool | Student Travel Signature Signed boolean for Student Immigration Data Data. | |
| Travel_Signature_Date | Date | Student Travel Signature Signature Date for Student Immigration Data Data. | |
| Travel_Signer_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Travel_Signer_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Travel_Signer_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Practical_Training_Edit_Data | String | Optional Practical Training Reference for Student Immigration Data Data. | |
| Student_Immigration_Sponsorship_Status_Data | String | Student Immigration Sponsorship Status Data for an International Student's Active Academic Records. | |
| Student_Dependent_Immigration_Data | String | Student Dependent Immigration Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Note_Topic_Name | String | Unique Name for Engagement Conversation Tag | |
| Student_Note_Topic_Category_Reference | String | Category for Engagement Conversation Tag |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Academic_Period_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Academic_Period_Reference_Academic_Period_ID | String | Contains a unique identifier for an instance of an object. | |
| Effective_Date | Date | Effective Date | |
| Institutional_Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Institutional_Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_Universal_Identifier_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Residency_Status_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Residency_Status_Reference_Student_Application_Residency_Status_ID | String | Contains a unique identifier for an instance of an object. | |
| Resident_Detail_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Resident_Detail_Reference_Resident_Details_ID | String | Contains a unique identifier for an instance of an object. | |
| Residency_Reason_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Residency_Reason_Reference_Residency_Reason_ID | String | Contains a unique identifier for an instance of an object. | |
| Residency_Declaration_Date | Date | Residency Declaration Date | |
| Student_Prospect_Stage_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Prospect_Stage_Reference_Student_Prospect_Stage_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Residency_Document_Data | String | Student Residency Document Data element |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Student_Reference_WID | String |
Students.Student_Reference_WID | The unique identifier type. Each |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Student_Reference_WID | String |
Students.Student_Reference_WID | The unique identifier type. Each |
| ID | String | Student Reference ID | |
| Student_ID | String | Student ID | |
| Universal_ID | String | Universal ID for Person. | |
| Account_User_Name | String | The Workday Account User Name | |
| Student_Person_Data | String | Element containing Student Prospect Person Data | |
| Student_Friends_and_Family_Data | String | Element containing Student Friends and Family Data | |
| Other_Student_Information_Data | String | Element containing Other Student Information such as First Generation College Student | |
| Financial_Aid_Record_for_Student_Data | String | Element containing Financial Aid Record for Student Data | |
| Student_Housing_Assignment_Data | String | The Element Holding All Information Relevant to Student Housing Assignments for the Web Service | |
| Student_Deceased_Data | String | Student Deceased Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Tag_Category_Name | String | Student Tag Category Name. | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_Hierarchy_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference | String | Academic Level for Has Academic Unit with Shareable Subordinates Data element | |
| Student_Tag_Category_Inactive | Bool | Student Tag Category Active (true or false) |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Tag_Name | String | Student Tag Name. | |
| Student_Tag_Category_Reference | String | Student Tag Categories the Student Tag is in. | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_Hierarchy_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference | String | Academic Level for Has Academic Unit with Shareable Subordinates Data element | |
| Student_Tag_Inactive | Bool | The Status of the Student Tag. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | ID for Student Veteran Benefits | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Military_Relationship | Bool | Military Relationship for Student Veteran Benefits | |
| Military_Status_for_Benefits_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Military_Status_for_Benefits_Reference_Military_Status_for_Benefits_ID | String | Contains a unique identifier for an instance of an object. | |
| Parent_on_Active_Duty | Bool | Parent on Active Duty for Student Veteran Benefits | |
| Spouse_on_Active_Duty | Bool | Spouse on Active Duty for Student Veteran Benefits | |
| Veterans_Bill_Benefit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Veterans_Bill_Benefit_Reference_Veterans_Bill_Benefit_ID | String | Contains a unique identifier for an instance of an object. | |
| Eligible_for_the_Post_9_11_GI_Bill | Bool | Eligible for the Post 9/11 GI Bill for Student Veteran Benefits | |
| Service_History_for_Benefits_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Service_History_for_Benefits_Reference_Service_History_for_Benefits_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Person_Reference | String | Person Reference | |
| Universal_ID | String | Universal ID |
This section describes the Data Model for the Admissions API.
ビュー are tables that cannot be modified. Typically, read-only data are shown as views.
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。テーブルおよびストアドプロシージャの詳細については、このヘルプドキュメントの該当エントリを参照してください。
| Name | Description |
| AdmissionsCommittees | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AdmissionsNotes | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| ApplicationActionItemAssignments | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| ApplicationGroupings | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EvaluationViews | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EvaluationViews_Application_Assessments_Configuration_Subedit_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EvaluationViews_Evaluation_View_Configuration_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| ExternalStudentTranscripts | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| RecommenderAccountCreationPageConfiguration | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplicantScore | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplicantScoreScales | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplicationAdmissionResponses | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplicationGPAEligibilityRules | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplicationGPAs | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Academic_Period_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Non_Effective_Dated_Web_Service_Additional_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Questionnaire_Response_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Student_Application_Details_Candidate_Experience_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Student_Application_Details_Certification_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Student_Application_Details_Post_Secondary_Education_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Student_Application_Details_Recruitable_Language_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Student_Application_Details_Secondary_Education_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Student_Application_Program_of_Study_Line_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Student_Application_Recommender_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Student_Document_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Student_Prospect_Friends_and_Family_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentApplications_Student_Prospect_Person_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Admissions Committee Reference ID | |
| Admissions_Committee_Name | String | Admissions Committee Name | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Pools_Reference | String | Application Pools to Evaluate | |
| Required_Number_of_Evaluations | Decimal | Required Number of Evaluations to progress Committee Evaluation BP Step |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | ID | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_Universal_Identifier_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Reference_Student_Application_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Reference_Student_Prospect_Recruitment_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Reference_Student_Record_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Topic_Reference | String | Engagement Conversation Topic Reference | |
| Student_Note_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Type_Reference_Student_Note_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Date | Datetime | Student Note Date | |
| Public | Bool | Public |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | The Engagement Action Item Assignment Reference ID | |
| Engagement_Action_Item_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Engagement_Action_Item_Reference_Engagement_Action_Item_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Engagement_Action_Item_Assignable_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Engagement_Action_Item_Assignable_Reference_Legacy_Student_Award_ID | String | Contains a unique identifier for an instance of an object. | |
| Engagement_Action_Item_Assignable_Reference_Receivable_Contract_Line_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Engagement_Action_Item_Assignable_Reference_Student_Aid_ID | String | Contains a unique identifier for an instance of an object. | |
| Engagement_Action_Item_Assignable_Reference_Student_Application_ID | String | Contains a unique identifier for an instance of an object. | |
| Engagement_Action_Item_Assignable_Reference_Student_Award_ID | String | Contains a unique identifier for an instance of an object. | |
| Engagement_Action_Item_Assignable_Reference_Student_Sponsor_Contract_Line_ID | String | Contains a unique identifier for an instance of an object. | |
| Engagement_Action_Item_Assignable_Reference_Student_Waiver_ID | String | Contains a unique identifier for an instance of an object. | |
| Assignment_Status_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Assignment_Status_Reference_Engagement_Action_Item_Assignment_Status_ID | String | Contains a unique identifier for an instance of an object. | |
| Completion_Date | Date | The Completion Date of the Assignment | |
| Engagement_Action_Item_Waiver_Reason_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Engagement_Action_Item_Waiver_Reason_Reference_Engagement_Action_Item_Waiver_Reason_ID | String | Contains a unique identifier for an instance of an object. | |
| Engagement_Action_Item_Notes | String | Engagement Action Item Waiver Reason Notes | |
| External_URL_Data | String | Personal URL associated with the Assignment | |
| Student_Attachment_Data | String | Attachment associated with the Action Item Assignment | |
| Questionnaire_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Questionnaire_Reference_Questionnaire_ID | String | Contains a unique identifier for an instance of an object. | |
| Questionnaire_Answer_Data | String | Contains the questions and answers on the questionnaire response. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Reference ID for the Application Grouping. | |
| Application_Grouping_Name | String | Name of the Application Grouping. If left blank, this value will default to the Academic Unit - Level | |
| Academic_Level_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference_Academic_Level_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_Hierarchy_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Period_Reference | String | References a set of Academic Periods for an Application Grouping | |
| Academic_Period_Start_Date | Date | References an Academic Period Start Date for an Application Grouping | |
| Academic_Period_End_Date | Date | References an Academic Period End Date for an Application Grouping | |
| Student_Applicant_Type_Reference | String | Reference to the Student Applicant Types for the Application Grouping | |
| Campus_Location_Reference | String | Reference to the Campus Locations for the Application Grouping | |
| Application_Grouping_Open_On_Date | Date | Open Date for Applications | |
| Application_Grouping_Close_Date | Date | Close Date for the Application Grouping | |
| Application_Received_Deadline_Date | Date | The deadline date for receiving applications. | |
| Application_Grouping_Materials_Due_Date | Date | Due Date for Application Grouping Materials | |
| Application_Decision_Deadline_Date | Date | The deadline date for application decisions. | |
| Application_Decision_Published_Deadline_Date | Date | The deadline date for application decisions to be published. | |
| Application_Decision_Response_Deadline_Date | Date | The deadline date for application responses. | |
| Admissions_Counselor_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Admissions_Counselor_Reference_Student_Recruiter_ID | String | Contains a unique identifier for an instance of an object. | |
| Application_Grouping_Hide_Important_Dates | Bool | Toggles whether the Important Dates section is hidden on the App Status page on the External Site. | |
| Application_Grouping_Application_Pool_Data | String | Application Pool Data for the Application Grouping | |
| External_Site_Content_Data | String | External Site Content Data for the Application Grouping |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Evaluation_View_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Evaluation_View_Reference_Application_Evaluation_Configuration_Rule_Set_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | Reference ID for Evaluation View | |
| Academic_Level_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference_Academic_Level_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_Hierarchy_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Evaluation_Name | String | Name for Evaluation View |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| EvaluationView_Evaluation_View_Reference_WID | String |
EvaluationViews.Evaluation_View_Reference_WID | The unique identifier type. Each |
| Application_Evaluation_Configuration_Assessment_Reference_IID | String | Contains a unique identifier for an instance of an object. | |
| Application_Evaluation_Configuration_Assessment_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Eligibility_Rule_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Eligibility_Rule_Reference_Application_Additional_Educational_Interest_Eligibility_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Eligibility_Rule_Reference_Eligibility_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Eligibility_Rule_Reference_Student_Condition_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Questionnaire_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Questionnaire_Reference_Questionnaire_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| EvaluationView_Evaluation_View_Reference_WID | String |
EvaluationViews.Evaluation_View_Reference_WID | The unique identifier type. Each |
| Evaluation_Tab_Data | String | Evaluation Tab Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | The ID of an existing Transcript or the ID value to set for the Transcript. | |
| Student_Prospect_Data | String | Contains information about the Student. | |
| Name | String | The Name of the Educational Institution. | |
| Educational_Institution_School_Level_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_School_Level_Reference_Educational_Institution_School_Level_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_ID_Data | String | Contains all the IDs for an Educational Institution. | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_Hierarchy_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Official | Bool | Whether the Student Transcript official or not | |
| Self_Reported | Bool | Whether or not a Student External Transcript is self-reported. | |
| Student_External_Transcript_Issued_Date | Date | The Date the Transcript was Issued. | |
| Student_External_Transcript_Received_Date | Date | The Date the Transcript was received. | |
| Academic_Start_Date | Date | The Start Date of the Student for the Student Transcript | |
| Academic_End_Date | Date | The End Date of the Student for the Student Transcript | |
| Exit_Code_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Exit_Code_Reference_Transcript_Exit_Code_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_External_Transcript_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_External_Transcript_Type_Reference_Student_External_Transcript_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Entry_Date | Date | The Date that Transcript was entered into the system. | |
| Last_Updated | Date | The date on which the Transcript was last updated. | |
| Updated_By | String | The name of the user who last updated the Transcript. | |
| Transcript_URL | String | The URL for the Student Transcript. | |
| Attendance_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Attendance_Reference_Student_Educational_Institution_Attendance_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_External_Transcript_Academic_Level_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_External_Transcript_Academic_Level_Reference_Student_External_Transcript_Academic_Level_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Class_Rank | Decimal | The Class Rank for the Student Transcript | |
| Class_Size | Decimal | The Class Size for the Student Transcript | |
| Student_External_Transcript_External_Credential_Data | String | Contains data related to the Credentials earned by a Student. | |
| Student_External_Transcript_Course_History_Data | String | Contains data about the courses taken at the Educational Institution that this Transcript is for. | |
| Student_External_Transcript_Attachment_Data | String | The wrapper for Attachments for a Transcript | |
| Edit_Course_Start_Date | Bool | Enables Course Start Date to be edited if in use for student articulation, bypassing the validation error that prevents this action. If this boolean is selected, only the Course Start Date will be edited. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Delete | Bool | Delete | |
| ID | String | ID | |
| Recommender_Password_Reset_Header | String | Recommender Password Reset Header | |
| Recommender_Reset_Confirmation_Header | String | Recommender Reset Confirmation Header |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | The Reference ID for Student Applicant Score. | |
| Student_Application_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Reference_Student_Application_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Applicant_Score_Scale_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Applicant_Score_Scale_Reference_Student_Applicant_Score_Scale_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Applicant_Rating_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Applicant_Rating_Reference_Student_Recruiting_Rating_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Applicant_Score_Value | Decimal | Applicant Score Value for Student Applicant Score Scale |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | The reference ID for the Student Applicant Score Scale. | |
| Student_Applicant_Score_Scale_Name | String | The Name for the Student Applicant Score Scale. | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_Hierarchy_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference | String | Academic Level for Has Academic Unit with Shareable Subordinates Data element | |
| Student_Applicant_Score_Scale_Inactive | Bool | Is Student Applicant Score Scale Inactive | |
| Student_Applicant_Score_Rating_Data | String | Element Container for Student Applicant Score Rating Data. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Application_Admission_Response_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Admission_Response_Reference_Student_Application_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | The Reference ID of the Student Application | |
| Admission_Response_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Admission_Response_Reference_Student_Application_Admission_Response_ID | String | Contains a unique identifier for an instance of an object. | |
| Admission_Response_Reasons_Reference | String | The Admission Response Reason(s) for the Student Application. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | ID of the Student Application GPA Eligibility Rule. | |
| Rule_Name | String | Name of the Student Application GPA Eligibility Rule. | |
| Academic_Level_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference_Academic_Level_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_Hierarchy_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Excludes | Bool | Boolean indicating whether Student Application GPA Eligibility Rule excludes. | |
| Student_Application_GPA_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_GPA_Reference_Student_Application_GPA_ID | String | Contains a unique identifier for an instance of an object. | |
| Relational_Operator_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Relational_Operator_Reference_Relational_Operator_Name | String | Contains a unique identifier for an instance of an object. | |
| GPA_comparable | Decimal | The comparable GPA of the Student Application GPA Eligibility Rule. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Index ID for Student Application GPA | |
| Student_Application_GPA_Name | String | Name for Student Application GPA | |
| Student_Application_GPA_Inactive | Bool | Inactive Boolean for Student Application GPA | |
| Academic_Unit_Data | String | Academic Unit Data | |
| Educational_Institution_Course_Academic_Area_Reference | String | References to Educational Institution Course Academic Area | |
| Student_External_Transcript_Course_Record_Level_Reference | String | References to Student External Transcript Course Record Level. | |
| Educational_Institution_Course_Designation_Reference | String | References to Educational Institution Course Designation. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Application_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Reference_Student_Application_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_ID | String | The Reference ID of the Student Application | |
| Active | Bool | Whether the Student Application is Active. | |
| Student_Prospect_Stage_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Prospect_Stage_Reference_Student_Prospect_Stage_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Applicant_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Applicant_Type_Reference_Tenanted_Student_Applicant_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Application_Date | Date | Date of the Student Applicant | |
| Anticipated_Load_Status_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Anticipated_Load_Status_Reference_Student_Load_Status_ID | String | Contains a unique identifier for an instance of an object. | |
| Location_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Location_Reference_Location_ID | String | Contains a unique identifier for an instance of an object. | |
| Learning_Mode_Reference | String | Reference to Learning Modes | |
| Student_Tags_Reference | String | Reference to Student Tags | |
| Payment_Date | Date | Student Application Payment Date | |
| Payment_Amount | Decimal | Student Application Payment Amount | |
| Student_Application_Payment_Status_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Payment_Status_Reference_Student_Application_Payment_Status_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payment_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Payment_Type_Reference_Payment_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference | String | Reference to a Currency for an Application Fee. | |
| Student_Application_Source_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Source_Reference_Student_Application_Source_ID | String | Contains a unique identifier for an instance of an object. | |
| Previous_College_Attendance | Bool | Indicates if an Applicant has previously attended college. | |
| First_Generation_College_Student | Bool | Marks if Applicant is a First-Generation College Student | |
| Application_Identifier | String | External ID | |
| Attended_this_Institution | Bool | Indicates whether the Applicant has attended this institution before. | |
| Legacy | Bool | Indicates that the Applicant is a Legacy student. | |
| Criminal_History | Bool | Indicates if the applicant has a criminal history. | |
| Criminal_History_Comments | String | Comments about the applicant's criminal history | |
| Academic_Disciplinary_History | Bool | Indicates whether the applicant has academic disciplinary history. | |
| Academic_Disciplinary_History_Comments | String | Comments about the applicant's academic disciplinary history | |
| Homeschooled | Bool | Whether the Student was homeschooled | |
| Graduation_or_Equivalency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Graduation_or_Equivalency_Reference_Student_Graduation_or_Equavalency_ID | String | Contains a unique identifier for an instance of an object. | |
| Selective_Service | Bool | Whether the Applicant is required to enroll in the Selective Service | |
| Veteran_Benefits_Eligibility_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Veteran_Benefits_Eligibility_Reference_Veteran_Benefits_Eligibility_ID | String | Contains a unique identifier for an instance of an object. | |
| Intended_Immigration_Status_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Intended_Immigration_Status_Reference_Student_Immigration_Status_ID | String | Contains a unique identifier for an instance of an object. | |
| Immigration_ID | String | The Immigration ID Number for a Student Application | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Universal_ID_Reference_Universal_Identifier_ID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Application_Prospect_Subedit_ID | String | ID for Student Prospect | |
| Student_ID | String | This is the Student ID for the Student Application Prospect Subedit Data element. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
| Academic_Period_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Period_Reference_Academic_Period_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Period_Start_Date | Date | References an Academic Period Start Date for a Student Prospect | |
| Academic_Period_End_Date | Date | References an Academic Period End Date for a Student Prospect |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
| ID | String | ID for Student Application Questionnaire Response Context Data | |
| Questionnaire_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Questionnaire_Reference_Questionnaire_ID | String | Contains a unique identifier for an instance of an object. | |
| Questionnaire_Answer_Data | String | Contains the questions and answers on the questionnaire response. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
| Candidate_Experience_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Candidate_Experience_Reference_CANDIDATE_EXPERIENCE_ID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Job_History_Company_ID | String | Contains a unique identifier for an instance of an object. | |
| Start_Date | Date | Start Date | |
| End_Date | Date | End Date | |
| Job_Title | String | Job Title | |
| Country_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_2_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Numeric_3_Code | String | Contains a unique identifier for an instance of an object. | |
| State_Province_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| State_Province_Reference_Country_Region_ID | String | Contains a unique identifier for an instance of an object. | |
| State_Province_Reference_ISO_3166_2_Code | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
| Recruitable_Certification_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Recruitable_Certification_Reference_RECRUITABLE_CERTIFICATION_ID | String | Contains a unique identifier for an instance of an object. | |
| Certification_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Certification_Reference_Certification_ID | String | Contains a unique identifier for an instance of an object. | |
| Certification_Number | String | Certification Number | |
| Issued_Date | Date | Issued Date | |
| Expiration_Date | Date | Expiration Date |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
| Educational_Institution_Attendance_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Attendance_Reference_Student_Educational_Institution_Attendance_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_CCD_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Federal_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_IPEDS_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_OPEID_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_NCES_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Start_Date | Date | Start Date | |
| Exit_Date | Date | Exit Date | |
| Credentials_Reference | String | Reference to types of Credentials earned at the Institution. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
| Recruitable_Language_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Recruitable_Language_Reference_RECRUITABLE_LANGUAGE_SKILL_ID | String | Contains a unique identifier for an instance of an object. | |
| Language_Skill_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Language_Skill_Reference_Language_ID | String | Contains a unique identifier for an instance of an object. | |
| Native_Language | Bool | Native Language | |
| Student_Application_Details_Language_Ability_Data | String | Student Application Details Language Ability Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
| Educational_Institution_Attendance_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Attendance_Reference_Student_Educational_Institution_Attendance_ID | String | Contains a unique identifier for an instance of an object. | |
| Graduation_Date | Date | Completion Date | |
| Educational_Institution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_CCD_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Federal_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_IPEDS_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_OPEID_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Postsecondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_CEEB_ATP_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_Local_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_NCES_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_Other_ID | String | Contains a unique identifier for an instance of an object. | |
| Educational_Institution_Reference_Educational_Institution_Secondary_State_ID | String | Contains a unique identifier for an instance of an object. | |
| Start_Date | Date | Start Date | |
| Exit_Date | Date | Exit Date | |
| Most_Recently_Attended | Bool | Most Recently Attended |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
| ID | String | Reference ID for Student Application Program of Study Line Data | |
| Order | String | The order of this Program of Study Line in the POS grid | |
| Program_of_Study_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Program_of_Study_Reference_Program_of_Study_ID | String | Contains a unique identifier for an instance of an object. | |
| Program_Focus_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Program_Focus_Reference_Program_of_Study_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Period_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Period_Reference_Academic_Period_ID | String | Contains a unique identifier for an instance of an object. | |
| Campus_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Campus_Reference_Location_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
| ID | String | The Recommender's Reference ID | |
| Country_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_2_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Numeric_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Title_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Title_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Title_Descriptor | String | The description of the reference to the Title of a person. | |
| Salutation_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Salutation_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Name_Detail_First_Name | String | The First Name (Given Name) for a person. | |
| Name_Detail_Middle_Name | String | The Middle Name for a person. | |
| Name_Detail_Last_Name | String | The Last Name (Family Name) for a person. | |
| Name_Detail_Secondary_Last_Name | String | The Secondary Last Name (Secondary Family Name) for a person. | |
| Tertiary_Last_Name | String | The Tertiary Last Name for a person. | |
| Local_Name_Detail_First_Name | String | Contains First Name in local script, which is generally configured to as Given Name, for supporting Countries. | |
| Local_Name_Detail_Middle_Name | String | Contains Middle Name in local script for supporting Countries. | |
| Local_Name_Detail_Last_Name | String | Contains Last Name in local script, which is generally configured as Family Name, for supporting Countries. | |
| Local_Name_Detail_Secondary_Last_Name | String | Contains Secondary Last Name in local script, which is generally configured as Maternal Family Name, for supporting Countries. | |
| First_Name_2 | String | Contains First Name in second local script, which is generally configured as Given Name, for supporting Countries. | |
| Middle_Name_2 | String | Contains Middle Name in second local script for supporting Countries. | |
| Last_Name_2 | String | Contains Last Name in second local script, which is generally configured as Given Name, for supporting Countries. | |
| Secondary_Last_Name_2 | String | Contains Secondary Last Name in second local script, which is generally configured as Maternal Family Name, for supporting Countries. | |
| Social_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Social_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Social_Suffix_Descriptor | String | A reference to the description of Social Suffix for a person. | |
| Academic_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Hereditary_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Hereditary_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Honorary_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Honorary_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Professional_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Professional_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Religious_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Religious_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Royal_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Royal_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Full_Name_for_Singapore_and_Malaysia | String | Full Person Name is used by Malaysia and Singapore. It is designed for (eliminate space between these two words) Workers in these countries to enter their Full Legal Name. It is an attribute of Global Person Name Class and is not a concatenation of First and Last Names. | |
| Association_to_Applicant_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Association_to_Applicant_Reference_Association_to_Applicant_ID | String | Contains a unique identifier for an instance of an object. | |
| Contact_Information_Data | String | All of the person's contact data (address, phone, email). |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
| Student_Document_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Document_Reference_Student_Application_Supporting_Material_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | The ID for the Student Application Supporting Material | |
| Student_Document_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Document_Type_Reference_Student_Supporting_Material_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Document_Category_Reference | String | The Categories for the Student Document Type | |
| Provided_By_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Provided_By_Reference_Student_Proxy_ID | String | Contains a unique identifier for an instance of an object. | |
| Upload_Date | Datetime | The date and time at which the Student Application Supporting Material was uploaded | |
| Date_Received | Date | The date on which the Student Application Supporting Material attachment was received | |
| Official | Bool | Whether or not the Student Application Supporting Material is Official | |
| Student_Document_Attachment_Data | String | Student Application Supporting Material Attachment Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
| Student_Proxy_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Proxy_Reference_Student_Proxy_ID | String | Contains a unique identifier for an instance of an object. | |
| Relationship_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Relationship_Reference_Student_Proxy_Relationship_ID | String | Contains a unique identifier for an instance of an object. | |
| Relationship_Types_Reference | String | References the Student Proxy Type for the Student Prospect. | |
| Legal_Name_Data | String | The name of the Student Proxy for the Student Prospect | |
| Contact_Information_Data | String | The contact information for the Student Proxy for the Student Prospect | |
| Student_Friends_and_Family_Details_Data | String | Contains Friends and Family Details information for the Friends and Family for the Student. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| StudentApplication_Student_Application_Reference_WID | String |
StudentApplications.Student_Application_Reference_WID | The unique identifier type. Each |
| Legal_Name_Data | String | Contains the legal name for a person. A person must name one and only one legal name. | |
| Country_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_2_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Numeric_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Title_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Title_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Title_Descriptor | String | The description of the reference to the Title of a person. | |
| Salutation_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Salutation_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Name_Detail_First_Name | String | The First Name (Given Name) for a person. | |
| Name_Detail_Middle_Name | String | The Middle Name for a person. | |
| Name_Detail_Last_Name | String | The Last Name (Family Name) for a person. | |
| Name_Detail_Secondary_Last_Name | String | The Secondary Last Name (Secondary Family Name) for a person. | |
| Tertiary_Last_Name | String | The Tertiary Last Name for a person. | |
| Local_Name_Detail_First_Name | String | Contains First Name in local script, which is generally configured to as Given Name, for supporting Countries. | |
| Local_Name_Detail_Middle_Name | String | Contains Middle Name in local script for supporting Countries. | |
| Local_Name_Detail_Last_Name | String | Contains Last Name in local script, which is generally configured as Family Name, for supporting Countries. | |
| Local_Name_Detail_Secondary_Last_Name | String | Contains Secondary Last Name in local script, which is generally configured as Maternal Family Name, for supporting Countries. | |
| First_Name_2 | String | Contains First Name in second local script, which is generally configured as Given Name, for supporting Countries. | |
| Middle_Name_2 | String | Contains Middle Name in second local script for supporting Countries. | |
| Last_Name_2 | String | Contains Last Name in second local script, which is generally configured as Given Name, for supporting Countries. | |
| Secondary_Last_Name_2 | String | Contains Secondary Last Name in second local script, which is generally configured as Maternal Family Name, for supporting Countries. | |
| Social_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Social_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Social_Suffix_Descriptor | String | A reference to the description of Social Suffix for a person. | |
| Academic_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Hereditary_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Hereditary_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Honorary_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Honorary_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Professional_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Professional_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Religious_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Religious_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Royal_Suffix_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Royal_Suffix_Reference_Predefined_Name_Component_ID | String | Contains a unique identifier for an instance of an object. | |
| Full_Name_for_Singapore_and_Malaysia | String | Full Person Name is used by Malaysia and Singapore. It is designed for (eliminate space between these two words) Workers in these countries to enter their Full Legal Name. It is an attribute of Global Person Name Class and is not a concatenation of First and Last Names. | |
| Contact_Information_Data | String | All of the person's contact data (address, phone, email, instant messenger, web address). | |
| Personal_Profile_Data | String | Contains personal information of the Student Prospect. | |
| Person_Identification_Data | String | Wrapper for Person Identification Data. Includes National Identifiers, Government Identifiers, Visa Identifiers, Passport Identifiers, License Identifiers and Custom Identifiers. | |
| Personal_Information_Data | String | Contains personal information for a Student Applicant | |
| Self_Identification_Data | String | Contains Self Identification Data (Gender Identity, Sexual Orientation, and Pronoun) for a Student Prospect. |
This section describes the Data Model for the Adoption API.
ビュー are tables that cannot be modified. Typically, read-only data are shown as views.
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。テーブルおよびストアドプロシージャの詳細については、このヘルプドキュメントの該当エントリを参照してください。
| Name | Description |
| AdoptionItems | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Adoption_Item_Name | String | Name of the Adoption Item. | |
| Adoption_Item_Order | String | Order of the Adoption Item. | |
| Adoption_Item_Description | String | Description of the Adoption Item. | |
| Adoption_Item_Assigned_To_Reference | String | Worker assigned to Adoption Item. | |
| Adoption_Item_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Type_Reference_Adoption_Item_Type_Workday_Owned_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Type_Reference_Adoption_Item_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Status_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Status_Reference_Adoption_Item_Status_Workday_Owned_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Status_Reference_Adoption_Item_Status_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Functional_Area_Reference | String | Functional Areas of the Adoption Item. | |
| Adoption_Item_Domain_Reference | String | Domains of the Adoption Item. Must be part of Functional Areas selected. | |
| Adoption_Item_Inactive | Bool | Indicates if Adoption Item is inactive. | |
| Adoption_Item_Requested_By_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Requested_By_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Requested_By_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Custom_Date_1 | Date | Custom Date 1 of the Adoption Item. | |
| Adoption_Item_Custom_Date_2 | Date | Custom Date 2 of the Adoption Item. | |
| Adoption_Item_Priority_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Priority_Reference_Adoption_Item_Priority_Workday_Owned_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Priority_Reference_Adoption_Item_Priority_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Urgency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Urgency_Reference_Adoption_Item_Urgency_Workday_Owned_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Value_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Value_Reference_Adoption_Item_Value_Workday_Owned_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Value_Reference_Adoption_Item_Value_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Setup_Effort_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Setup_Effort_Reference_Setup_Effort_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Work_Effort_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Work_Effort_Reference_Adoption_Item_Work_Effort_Workday_Owned_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Work_Effort_Reference_Adoption_Item_Work_Effort_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Business_Risk_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Business_Risk_Reference_Adoption_Item_Business_Risk | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Business_Risk_Reference_Adoption_Item_Business_Risk_Workday_Owned_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Impact | String | Impact of the Adoption Item. | |
| Adoption_Item_Planned_Start_Date | Date | Planned Start Date of the Adoption Item. | |
| Adoption_Item_Planned_End_Date | Date | Planned End Date of the Adoption Item. | |
| Adoption_Item_Customer_Release_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Customer_Release_Reference_Adoption_Customer_Release_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Tied_to_Workday_Release_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Tied_to_Workday_Release_Reference_Workday_Release_ID | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Tied_to_Workday_Release_Reference_Workday_Release_Name | String | Contains a unique identifier for an instance of an object. | |
| Adoption_Item_Reason | String | Reason for the Adoption Item. | |
| What_s_New_Item_Reference | String | What's New Item linked to Adoption Item. | |
| Adoption_Item_URLs_Reference | String | External URLs linked to the Adoption Item. | |
| Adoption_Item_Attachment | String | Element container for Attachment data of the Adoption Item. |
This section describes the Data Model for the BenefitsAdministration API.
ビュー are tables that cannot be modified. Typically, read-only data are shown as views.
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。テーブルおよびストアドプロシージャの詳細については、このヘルプドキュメントの該当エントリを参照してください。
| Name | Description |
| BenefitAnnualCredits | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BenefitAnnualRates | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BenefitIndividualRates | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EmployeeDefinedContributionElections | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| EmployeeDefinedContributionElections_Defined_Contribution_Election_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| HealthCareRates | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Benefit_Annual_Credit_Reference_IID | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Credit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Effective_Date | Date | The effective date for the Benefit Annual Credit. | |
| Worker_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Credit | Decimal | The amount value for the Benefit Annual Credit. | |
| Benefit_Annual_Credit_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Credit_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Credit_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Credit_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Credit_Type_Reference_Benefit_Annual_Credit_Type_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Benefit_Annual_Rate_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Rate_Reference_Benefit_Annual_Rate_ID | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Rate_ID | String | The reference identifier for the Benefit Annual Rate. | |
| Effective_Date | Date | The effective date for the Benefit Annual Rate. | |
| Worker_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Rate | Decimal | The amount value for the Benefit Annual Rate. | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Rate_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Rate_Type_Reference_Benefit_Annual_Rate_Type_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Benefit_Individual_Rate_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Individual_Rate_Reference_Benefit_Individual_Rate_ID | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Individual_Rate_ID | String | Benefit Individual Rate ID | |
| Employee_Cost_PreTax | Decimal | Employee Cost PreTax | |
| Employee_PostTax_Amount | Decimal | Employee PostTax Amount | |
| Employer_Cost_NonTaxable | Decimal | Employer Cost NonTaxable | |
| Employer_Cost_Taxable | Decimal | Employer Cost Taxable |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Employee_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Employee_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Takes_Effect_On_Date | Date | The date the retirement savings elections take effect for the employee. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Defined_Contribution_Plan_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Defined_Contribution_Plan_Reference_Defined_Contribution_Plan_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Frequency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Frequency_Reference_Frequency_ID | String | Contains a unique identifier for an instance of an object. | |
| Beneficiary_Allocation_Data | String | Defines the Beneficiary recipient and the allocation percentage for the Retirement Savings Election. This is required when the retirement savings plan requires beneficiaries and the election amount or election percentage is populated (i.e. greater than 0). |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Health_Care_Rate_ID | String | Reference ID For Health Care Rate Data | |
| Name | String | Benefit Name of the Health Care Rate | |
| Description | String | Description of the Benefit Rate | |
| Use_Minimum_Cost | Bool | Minimum Cost of Health Care Rate | |
| Use_Maximum_Cost | Bool | Maximum Cost of Health Care Rate | |
| Frequency_Reference_Frequency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Frequency_Reference_Frequency_Reference_Frequency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Health_Care_Coverage_Target_Reference | String | Health Care Coverage Target for Health Care Rate | |
| Age_in_Years_Specific_Month | Decimal | Specific Month As of Date | |
| Age_in_Years_Specific_Day | Decimal | Specific Day As of Date | |
| Age_in_Years_Of_Prior_Plan_Year | Bool | Prior Plan Year As of Date | |
| Age_in_Years_Benefit_As_Of_Rule_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Age_in_Years_Benefit_As_Of_Rule_Reference_Benefit_As_Of_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Length_of_Service_Specific_Month | Decimal | Specific Month As of Date | |
| Length_of_Service_Specific_Day | Decimal | Specific Day As of Date | |
| Length_of_Service_Of_Prior_Plan_Year | Bool | Prior Plan Year As of Date | |
| Length_of_Service_Benefit_As_Of_Rule_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Length_of_Service_Benefit_As_Of_Rule_Reference_Benefit_As_Of_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Combine_All_Jobs_for_Salary_Source | Bool | Combine all jobs for Salary Source | |
| Benefit_Salary_Source_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Salary_Source_Reference_Benefit_Salary_Source_ID | String | Contains a unique identifier for an instance of an object. | |
| Compensation_Element_Reference | String | Salary Calculated by Compensation Pay Earning | |
| Salary_Frequency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Salary_Frequency_Reference_Frequency_ID | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Rate_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Benefit_Annual_Rate_Type_Reference_Benefit_Annual_Rate_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Salary_Specific_Month | Decimal | Specific Month As of Date | |
| Salary_Specific_Day | Decimal | Specific Day As of Date | |
| Salary_Of_Prior_Plan_Year | Bool | Prior Plan Year As of Date | |
| Salary_Benefit_As_Of_Rule_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Salary_Benefit_As_Of_Rule_Reference_Benefit_As_Of_Rule_ID | String | Contains a unique identifier for an instance of an object. | |
| Health_Care_Rate_Flat_Data | String | Flat Health Care Rate | |
| Health_Care_Rate_Percent_Salary_Data | String | Health Care Rate Percent Salary Data for Health Care Rate Data | |
| Consider_Tobacco | Bool | Consider Tobacco for Health Care Rate Data |
This section describes the Data Model for the CampusEngagement API.
ビュー are tables that cannot be modified. Typically, read-only data are shown as views.
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。テーブルおよびストアドプロシージャの詳細については、このヘルプドキュメントの該当エントリを参照してください。
| Name | Description |
| StudentAudiences | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| StudentNotes | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Audience_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Student_Audience_Reference_Audience_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Audience_Reference_Student_Audience_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Audience_Reference_Student_Cohort_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | The Student Audience Reference ID can be used to uniquely identify a Student Audience | |
| Name | String | Name of the Student Audience | |
| Category_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Category_Reference_Engagement_Category_ID | String | Contains a unique identifier for an instance of an object. | |
| Used_For_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Used_For_Reference_Engagement_Category_Used_For_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Level_Reference_Academic_Level_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_Hierarchy_ID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Unit_Reference_Academic_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| Custom_Report_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Custom_Report_Reference_Custom_Report_ID | String | Contains a unique identifier for an instance of an object. | |
| Saved_Search_Reference_IID | String | Contains a unique identifier for an instance of an object. | |
| Saved_Search_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Academic_Affiliate_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Academic_Contact_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Applicant_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Beneficiary_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Business_Entity_Contact_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Candidate_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Cost_Center_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Custom_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Dependent_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Emergency_Contact_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Extended_Enterprise_Learner_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_External_Committee_Member_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_External_Learning_Instructor_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_External_Learning_User_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Former_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Instructor_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Learning_Assessor_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Learning_Instructor_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_LearningUserName | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Recruiting_Agency_User_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_RecruitingUserName | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Referee_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Region_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Service_Center_Representative_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Student_Proxy_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_Student_Recruiter_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_StudentUserName | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_SupplierUserName | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_System_User_ID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_System_User_OpenID | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_System_User_OpenID_Connect_Internal | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_System_User_OpenID_Internal | String | Contains a unique identifier for an instance of an object. | |
| Run_As_User_Reference_WorkdayUserName | String | Contains a unique identifier for an instance of an object. | |
| Inactive | Bool | Inactive attribute for the Student Audience. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Student_Note_ID | String | Uses a reference ID, if provided. Generates a new reference ID if one is not provided. | |
| Student_Note_Creator_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Academic_Affiliate_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Academic_Contact_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Applicant_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Beneficiary_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Business_Entity_Contact_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Candidate_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Cost_Center_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Custom_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Dependent_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Emergency_Contact_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Extended_Enterprise_Learner_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_External_Committee_Member_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_External_Learning_Instructor_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_External_Learning_User_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Former_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Instructor_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Learning_Assessor_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Learning_Instructor_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_LearningUserName | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Recruiting_Agency_User_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_RecruitingUserName | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Referee_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Region_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Service_Center_Representative_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Student_Proxy_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_Student_Recruiter_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_StudentUserName | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_SupplierUserName | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_System_User_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_System_User_OpenID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_System_User_OpenID_Connect_Internal | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_System_User_OpenID_Internal | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creator_Reference_WorkdayUserName | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Creation_Moment | Datetime | The moment the student note was created. | |
| Student_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Topic_Reference | String | The student note topics for the student note. | |
| Student_Note_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Type_Reference_Student_Note_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Student_Note_Date | Datetime | The date of the student note. If no value is provided, Workday will default to today. | |
| Academic_Period_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Academic_Period_Reference_Academic_Period_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Aid_Award_Year_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Aid_Award_Year_Reference_Financial_Aid_Award_Year_ID | String | Contains a unique identifier for an instance of an object. | |
| Relates_To_Reference | String | Other instances (application, academic record, etc.) the note relates to. | |
| Delete | Bool | If the student note should be deleted. |
This section describes the Data Model for the CashManagement API.
ビュー are tables that cannot be modified. Typically, read-only data are shown as views.
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。テーブルおよびストアドプロシージャの詳細については、このヘルプドキュメントの該当エントリを参照してください。
| Name | Description |
| AdhocBankTransactions | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AdHocPayees | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AdhocPayments | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AdHocPaymentTemplates | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| AuthorityTypes | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankAccounts | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankAccountSignatories | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankAccountTransferforSettlementTemplates | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankAccountTransfers | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankAccountTransfersforSettlement | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankAccountTransferTemplates | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankBranches | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankFeeServiceCodes | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankFeeServiceContracts | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankFeeStatementFiles | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankFeeStatements | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankStatementCustomCodeSets | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankStatementCustomCodeSets_Bank_Statement_Balance_Type_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankStatementCustomCodeSets_Bank_Statement_Transaction_Type_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankStatementFile | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BankStatements | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| BusinessEntityContacts | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| CashActivityCategories | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| CashPools | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| DonorContributions | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Donors | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Donors_Address_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Donors_Email_Address_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Donors_Instant_Messenger_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Donors_Phone_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Donors_Web_Address_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| ExternalCashActivities | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| FinancialInstitutions | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| IntradayBankStatements | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| InvestmentPoolAdjustments | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| InvestmentPoolPurchases | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| InvestmentPoolPurchases_Investment_Pool_Purchase_Line_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| InvestmentPoolSales | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| InvestmentPoolTransfers | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| InvestmentStatements | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| InvestmentStatements_Attachment_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| InvestmentStatements_Investment_Statement_Line_Data | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| PaymentElectionEnrollments | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| PaymentElectionOptions | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| PaymentMessages | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Payments | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| PettyCashAccounts | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| SignatureMethods | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Signers | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
| Signers_Secured_Attachment | Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Ad_hoc_Bank_Transaction_ID | String | This is the unique identifier for the Ad hoc Bank Transaction. If you do not specify an ID, Workday generates one automatically. | |
| Ad_Hoc_Bank_Transaction_Number | String | This is the unique identifier for the Ad Hoc Bank Transaction Number. You must set up sequence generation for Workday to generate and assign a number automatically. If not, the number remains blank. | |
| Submit | Bool | Submit for Approval is a boolean flag indicating if the transaction is to be submitted or saved in draft mode. If this flag is set, the transaction will be submitted, otherwise the transaction is saved in draft. | |
| Cancel_Accounting_Date | Date | Cancel Accounting Date | |
| Locked_in_Workday | Bool | Locked in Workday is a boolean flag controlling user ability to edit the transaction. If the flag is set the user can't edit, cancel or change the transaction inside the Workday application, however the user can submit a draft transaction. The transaction can only be updated from the web service. | |
| Transaction_Date | Date | Ad hoc Bank Transaction Date | |
| Transaction_Memo | String | Free form text field foran Ad hoc Bank Transaction memo | |
| Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Reference_Petty_Cash_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Rate_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Rate_Type_Reference_Currency_Rate_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Rate_Override_12_Decimal | Decimal | Transaction to Bank Account Currency Conversion Rate | |
| Transaction_Amount | Decimal | Transaction Amount | |
| Deposit | Bool | Boolean Flag indicates if the Ad hoc Bank Transaction is a deposit | |
| Withdrawal | Bool | Boolean Flag indicates if the Ad hoc Transaction is a withdrawal | |
| Ad_hoc_Bank_Transaction_Purpose_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Ad_hoc_Bank_Transaction_Purpose_Reference_Ad_hoc_Bank_Transaction_Purpose_ID | String | Contains a unique identifier for an instance of an object. | |
| Transaction_ID | String | Free-form Text for any reference notes | |
| External_Reference | String | External Reference for the Ad Hoc Bank Transaction | |
| Include_in_IRS_1099 | Bool | As of w18, this functionality has been deprecated. Ad hoc Bank Transaction lines with a valid IRS 1099 Suppliers and a spend category mapped to a 1099 MISC category will automatically be included in 1099 MISC reporting. | |
| Journal_Source_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Journal_Source_Reference_Journal_Source_ID | String | Contains a unique identifier for an instance of an object. | |
| Remove_Bank_Account_Worktag_on_Offset | String | When this attribute is yes, it excludes the Bank Account worktag on Offset journal entries | |
| Eliminate_FX_Gain_Loss | String | When this attribute is yes, the foreign exchange gain/loss is eliminated from the transaction | |
| Transaction_Line_Replacement_Data | String | Ad hoc Bank Transaction Transaction Lines | |
| Tax_Code_Data | String | Encapsulating element containing Tax Details data | |
| Attachment_Data | String | Encapsulating element containing all Business Document Attachment data. | |
| Auto_Complete | Bool | When set to | |
| Skip | Bool | When set to | |
| Comment | String | Free form comment regarding the business process. | |
| Worker_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Worker_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Business_Process_Attachment_Data | String | Element for the attachments pertaining to a Event entered through a web service. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Ad_Hoc_Payee_ID | String | Ad Hoc Payee ID | |
| Ad_Hoc_Payee_Name | String | Ad Hoc Payee Name | |
| Ad_Hoc_Payee_Phonetic_Name | String | Ad Hoc Payee Phonetic Name | |
| Inactive | Bool | Ad Hoc Payee is Inactive | |
| Single_Use | Bool | Ad Hoc Payee is Single Use | |
| Tax_Authority_Form_Type_Reference | String | Tax form used by the appropriate taxing authority for the Payee. | |
| TIN_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| TIN_Type_Reference_Taxpayer_ID_Number_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Tax_ID | String | Tax ID for Ad Hoc Payee | |
| Tax_Document_Date | Date | This is the date the Tax Document (e.g. W-9, etc) was received. | |
| Address_Data | String | Address information | |
| Bank_Data | String | Bank Account Type becomes required when using v30.1 of the web service. | |
| Payee_Alternate_Name_Data | String | Business Entity Alternate Name Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Ad_hoc_Payment_ID | String | Ad hoc Payment ID | |
| Submit | Bool | Save and Submit | |
| Cancel_Accounting_Date | Date | Cancel Accounting Date | |
| Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Reference_Petty_Cash_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Ad_hoc_Payee_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Applicant_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Corporate_Credit_Card_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Customer_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Customer_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Deduction_Recipient_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_External_Committee_Member_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_External_Sourceable_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Internal_Service_Provider_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Internal_Service_Provider_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Investor_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Miscellaneous_Payee_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Sponsor_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Sponsor_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Student_Proxy_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Supplier_Connection_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Supplier_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Supplier_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Tax_Authority_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Tax_Authority_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Create_new_Ad_hoc_Payee_Name | String | Create new Ad hoc Payee Name. Use this value for a new Ad hoc Payee. | |
| Ad_Hoc_Payee_Phonetic_Name | String | Ad Hoc Payee Phonetic Name | |
| Single_Use | Bool | New Ad Hoc Payee is Single Use. Use this value to specify that the new ad hoc payee will be a single use payee. | |
| Tax_Authority_Form_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Authority_Form_Type_Reference_Tax_Authority_Form_Type | String | Contains a unique identifier for an instance of an object. | |
| IRS_1099_MISC_Payee | Bool | 1099 Payee Flag for Ad hoc Payment Payee | |
| TIN_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| TIN_Type_Reference_Taxpayer_ID_Number_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Tax_ID | String | Tax ID for Ad hoc Payment Payee | |
| Tax_Payment | Bool | Use this value to specify whether the Ad Hoc Payment is a Tax Payment. | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Currency_Rate_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Rate_Type_Reference_Currency_Rate_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Conversion_Rate | Decimal | Overrides the Transaction to Bank Account Currency Conversion Rate. Added in web service v27.0. | |
| Eliminate_Foreign_Exchange_Gain_or_Loss | Bool | Gives the user the option to eliminate the Foreign Exchange Gain or Loss. Added in web service v27.0. | |
| Default_Tax_Option_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Default_Tax_Option_Reference_Tax_Option_ID | String | Contains a unique identifier for an instance of an object. | |
| Ship_To_Address_ID_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Ship_To_Address_ID_Reference_Address_ID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Code_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Code_Reference_Tax_Code_ID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Code_Reference_Withholding_Tax_Code_ID | String | Contains a unique identifier for an instance of an object. | |
| Payment_Date | Date | Payment Date | |
| Payment_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Payment_Type_Reference_Payment_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Memo | String | Memo | |
| Document_Link | String | Document Link | |
| Reference_Number | String | Reference Number | |
| Control_Total_Amount | Decimal | Control Total Amount | |
| Tax_Amount | Decimal | Tax Amount | |
| Freight_Amount | Decimal | Freight Amount | |
| Other_Charges | Decimal | Other Charges | |
| Handling_Code_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Handling_Code_Reference_Handling_Code_ID | String | Contains a unique identifier for an instance of an object. | |
| Addenda_Lines_as_Text | String | Addenda Lines as Text | |
| External_Reference_as_Text | String | External Reference | |
| Invoice_Line_Replacement_Data | String | Invoice Line Data | |
| Tax_Code_Data | String | Tax Data by Tax Authority and Tax Code. For Customer Invoice Documents and Cash Sales tax data will always be calculated from the line data regardless of what is populated in Tax Rate Application Data. For Purchase Orders, Supplier Invoice Documents and Ad hoc Payments, if data is in Tax Rate Application Data, then that will be the tax information that is saved. Otherwise, the tax will be calculated from the lines. | |
| Address_Data | String | Address Data | |
| Bank_Data | String | Bank Data | |
| Payee_Alternate_Name_Data | String | Payee Alternate Name Data | |
| Attachment_Data | String | Attachment Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Ad_Hoc_Payment_Template_ID | String | ID | |
| Name | String | Name of the Ad Hoc Payment Template | |
| Inactive | Bool | Denotes whether the Template is inactive. If the Template is inactive, you cannot create transactions from it. | |
| Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Reference_Petty_Cash_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Academic_Person_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Ad_hoc_Payee_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Applicant_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Contingent_Worker_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Corporate_Credit_Card_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Customer_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Customer_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Deduction_Recipient_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Employee_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_External_Committee_Member_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_External_Sourceable_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Internal_Service_Provider_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Internal_Service_Provider_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Investor_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Miscellaneous_Payee_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Sponsor_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Sponsor_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Student_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Student_Proxy_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Supplier_Connection_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Supplier_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Supplier_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Tax_Authority_ID | String | Contains a unique identifier for an instance of an object. | |
| Payee_Reference_Tax_Authority_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Create_new_Ad_hoc_Payee_Name | String | Create new Ad hoc Payee Name. Use this value for a new Ad hoc Payee. | |
| Ad_Hoc_Payee_Phonetic_Name | String | Ad Hoc Payee Phonetic Name | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Eliminate_Foreign_Exchange_Gain_or_Loss | Bool | When this attribute is yes, the foreign exchange gain/loss is eliminated from the transaction | |
| Payment_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Payment_Type_Reference_Payment_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Memo | String | Memo | |
| Addenda | String | Addenda | |
| Tax_Authority_Form_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Authority_Form_Type_Reference_Tax_Authority_Form_Type | String | Contains a unique identifier for an instance of an object. | |
| TIN_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| TIN_Type_Reference_Taxpayer_ID_Number_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Tax_ID | String | Tax ID for Ad hoc Payment Payee | |
| Tax_Payment | Bool | Tax Payment Flag | |
| Line_Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Line_Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Line_Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Item_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Item_Reference_Catalog_Item_ID | String | Contains a unique identifier for an instance of an object. | |
| Item_Reference_Purchase_Item_ID | String | Contains a unique identifier for an instance of an object. | |
| Item_Reference_Supplier_Item_ID | String | Contains a unique identifier for an instance of an object. | |
| Item_Description | String | An optional description of the item, especially useful if only a Spend Category is selected for this line. | |
| Spend_Category_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Spend_Category_Reference_Spend_Category_ID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Applicability_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Applicability_Reference_Tax_Applicability_ID | String | Contains a unique identifier for an instance of an object. | |
| Worktags_Reference | String | Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval. | |
| Address_Data | String | Address information | |
| Bank_Data | String | Bank Account Type becomes required when using v30.1 of the web service. | |
| Payee_Alternate_Data | String | Business Entity Alternate Name Data | |
| Attachment_Data | String | Encapsulating element containing all Business Document Attachment data. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Authority_Type_ID | String | This is the Authority Type unique identifier. | |
| Authority_Type | String | This is the Authority Type in text. | |
| Authority_Designation_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Authority_Designation_Reference_Authority_Designation_ID | String | Contains a unique identifier for an instance of an object. | |
| Description | String | This is the description of the Authority Type. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Account_ID | String | Bank Account ID. This is the bank account unique identifier. | |
| Account_Name | String | Bank Account Name | |
| Financial_Institution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_Financial_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_Financial_Institution_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Party_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Party_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Party_Reference_Cost_Center_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Party_Reference_Custom_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Party_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Party_Reference_Region_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Default_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Default_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Default_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Accepted_Currencies_Reference | String | Accepted Currencies Reference. When no accepted currencies are passed in the web service, the bank account will accept all currencies. | |
| Bank_Branch_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Branch_Reference_Bank_Branch_ID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Open_Date | Date | Bank Account Open Date | |
| Account_Closed | Bool | Boolean value indicating the Bank Account should be closed. The Bank Account will not longer be available for payments. | |
| Bank_Account_Close_Date | Date | Bank Account Close Date | |
| Country_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_2_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Numeric_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Routing_Transit_or_Institution_Number | String | Routing Transit or Institution Number | |
| Financial_Account_Number | String | Financial Account Number | |
| Bank_Identifier_Code | String | Bank Identifier Code | |
| IBAN | String | IBAN | |
| Bank_Account_Format_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Format_Reference_Bank_Statement_Format_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Custom_Code_Set_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Custom_Code_Set_Reference_Bank_Statement_Custom_Code_Set_ID | String | Contains a unique identifier for an instance of an object. | |
| Branch_Name | String | Branch Name | |
| Branch_Phonetic_Name | String | Branch Phonetic Name | |
| Check_Digit | String | Collects the check digit when it is not part of the bank id number | |
| Bank_Account_Name | String | Collects the bank account name | |
| Bank_Account_Phonetic_Name | String | Bank Account Phonetic Name | |
| Roll_Number | String | Collects the Roll number | |
| Fraction | String | Collects the Bank Account Fraction that will be printed on checks. | |
| Formatted_MICR | String | F = Floating On-US | |
| Target_Balance | Decimal | Bank Account Target Balance | |
| Payment_Type_Reference | String | Reference to an existing Payment Type | |
| Default_Payment_Type_for_Ad_Hoc_Payments_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Default_Payment_Type_for_Ad_Hoc_Payments_Reference_Payment_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Security_Segment_Reference | String | This is the bank account security segment for the bank account. If segmented security is set up for bank accounts, these segments indicate the security for the bank account. | |
| Check_Print_Layout_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Check_Print_Layout_Reference_Check_Print_Layout_ID | String | Contains a unique identifier for an instance of an object. | |
| Check_Print_Layout_Reference_Check_Print_Layout_with_Report_Design_ID | String | Contains a unique identifier for an instance of an object. | |
| Use_Branch_Address | Bool | Use Branch Address | |
| Advanced_Mode | Bool | Identifies whether the account performs simple based reconciliation or advanced rule based reconciliation. | |
| Parsing_Rule_Set_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Parsing_Rule_Set_Reference_Parsing_Rule_Set_ID | String | Contains a unique identifier for an instance of an object. | |
| Perform_Automatic_Reconciliation_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Perform_Automatic_Reconciliation_Reference_Auto_Recon_Initiation_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Reconciliation_Rule_Set_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Reconciliation_Rule_Set_Reference_Reconciliation_Rule_Set | String | Contains a unique identifier for an instance of an object. | |
| Inactive_for_Automatic_Bank_Reconciliation | Bool | Set the Reconciliation Rule Set to be inactive for this bank account. | |
| Reconciliation_Matching_Rule_Set_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Reconciliation_Matching_Rule_Set_Reference_Matching_Rule_Set | String | Contains a unique identifier for an instance of an object. | |
| Perform_Automatic_First_Notice_Reconciliation_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Perform_Automatic_First_Notice_Reconciliation_Reference_Auto_Recon_Initiation_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| First_Notice_Rule_Set_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| First_Notice_Rule_Set_Reference_Reconciliation_Rule_Set | String | Contains a unique identifier for an instance of an object. | |
| Batch_Electronic_Payments | Bool | Identifies whether to consolidate electronic payments into a single batch for reconciliation. | |
| Batch_Electronic_Customer_Payment_Deposits | Bool | Identifies whether to consolidate customer electronic payments into a single deposits for customer payments settled through a settlement run. | |
| Group_Student_Electronic_Payment_into_a_Deposit | Bool | Identifies whether to consolidate Student electronic payments into a single deposits for Student Payments settled through a settlement run. | |
| Submit_Reconciled_Statements_Automatically | Bool | Identifies whether to automatically submit fully reconciled statements. | |
| Bank_Statement_Worktag_Rule_Set_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Statement_Worktag_Rule_Set_Reference_Bank_Statement_Worktag_Rule_Set_ID | String | Contains a unique identifier for an instance of an object. | |
| Used_by_Cash | Bool | Indicates that the account can be used for cash transactions | |
| Used_by_Customer_Payments | Bool | Indicates that the account can be used for Customer Payments | |
| Used_by_Customer_Refunds | Bool | Indicates that the account can be used for Customer Refunds | |
| Used_by_Expense_Payments | Bool | Indicates that the account can be used for Expense Payments | |
| Used_by_Payroll_On_Cycle | Bool | Indicates that the account can be used for Payroll on-cycle | |
| Used_by_Supplier_Payments | Bool | Indicates that the account can be used for Supplier Payments | |
| Used_by_Intercompany_Payments | Bool | Indicates that the account can be used for Inter-company Payments | |
| Used_by_Ad_hoc_Payments | Bool | Indicates that the account can be used for Ad Hoc Payments | |
| Used_by_Bank_Account_Transfers_for_Settlement | Bool | Indicates that the account can be used for Bank Account Transfer for Settlement | |
| Used_By_Payroll_Off_Cycle | Bool | Indicates that the account can be used for Payroll Off-Cycle | |
| Used_By_Prenote_Payments | Bool | Indicates that the account can be used for Prenote Payments | |
| Used_By_Procurement_Card_Payments | Bool | Indicates that the account can be used for Procurement Card Payments. | |
| Used_By_Tax_Payments | Bool | Indicates that the account may be used by Tax Payments. | |
| Used_by_Cash_Advances | Bool | Indicates that the account can be used for Cash Advances. | |
| Used_by_Expense_Credit_Card_Payments | Bool | Indicated that the account is used by Expense Credit Card Payments. | |
| Used_by_Student_Refund | Bool | Refers if Student Refund Usage is a valid for the Bank Account. | |
| Used_By_Student_Payment | Bool | Refers if Student Payment Usage is a valid for the Bank Account. | |
| Used_by_Student_Sponsor_Refund | Bool | Refers if Student Sponsor Refund Usage is valid for the Bank Account. | |
| Last_Check_Number_Used | Decimal | Numeric value of the last check number used. This value can be set to the next check number to use. | |
| Enable_Positive_Pay | Bool | Boolean value indicating positive pay should be enabled. | |
| Outsourced | Bool | Boolean value indicating if the bank account is outsourced | |
| Account_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Account_Type_Reference_Bank_Account_Type_Code | String | Contains a unique identifier for an instance of an object. | |
| Allow_Additional_Usage | Bool | Boolean indicating if the bank account can be used for additional usages | |
| Default_Bank_Statement_Beginning_Balance | Bool | If selected, defaults this statement's beginning balance from the previous statement's balance (if no beginning balance is provided). | |
| Outsourced_Bank_Provider_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Outsourced_Bank_Provider_Reference_Outsourced_Bank_Provider_ID | String | Contains a unique identifier for an instance of an object. | |
| Payment_Integration_Data | String | Element containing payment integration data | |
| Lockbox_Data | String | Element containing Lockbox Data | |
| Check_Sorting_Setup_Reference_IID | String | Contains a unique identifier for an instance of an object. | |
| Check_Sorting_Setup_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Check_Sorting_Setup_Line_Data | String | Sets 0 or more configuration rules for sorting checks. | |
| Attachment_Data | String | Encapsulating element containing all Business Document Attachment data. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Signatory_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Signatory_Reference_Signatory_ID | String | Contains a unique identifier for an instance of an object. | |
| Signatory_ID | String | This is the Signatory Details unique identifier. | |
| Bank_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Override_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Override_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Override_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Minimum_Currency | Decimal | The minimum amount that can be signed for. | |
| Maximum_Currency | Decimal | The maximum amount that can be signed for. | |
| Signer_Reference | String | Reference element representing a set of Signers. | |
| Payment_Type_Reference | String | Reference element representing a set of Payment Types. | |
| Authority_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Authority_Type_Reference_Authority_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Signature_Method_Reference | String | Reference element representing a set of Signature Methods. | |
| Start_Date | Date | The effective start date for the Signatory. | |
| End_Date | Date | The effective end date for the Signatory. | |
| Notes | String | Notes for the Signatory. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Account_Transfer_for_Settlement_Template_ID | String | ID | |
| Name | String | Name of the Bank Account Transfer for Settlement Template | |
| Transaction_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Transaction_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Transaction_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Payment_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Payment_Type_Reference_Payment_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Eliminate_Foreign_Exchange_Gain_or_Loss | Bool | Whether to eliminate fx gain or loss | |
| Memo | String | Memo | |
| Inactive | Bool | Denotes whether the Template is inactive. If the Template is inactive, you cannot create transactions from it. | |
| From_Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Financial_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Financial_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Financial_Account_Reference_Petty_Cash_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| From_Currency_Rate_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Currency_Rate_Type_Reference_Currency_Rate_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_Business_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_Cost_Center_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_Custom_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_Fund_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_Region_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Optional_Balancing_Worktags_From_Account_Reference | String | Optional Balancing Worktag from Account | |
| To_Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Financial_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Financial_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Financial_Account_Reference_Petty_Cash_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| To_Currency_Rate_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Currency_Rate_Type_Reference_Currency_Rate_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_Business_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_Cost_Center_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_Custom_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_Fund_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_Region_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Optional_Balancing_Worktags_To_Account_Reference | String | Optional Balancing Worktag to Account |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Account_Transfer_ID | String | Bank Account Transfer ID. | |
| Submit | Bool | Save and Submit | |
| Date | Date | Bank Account Transfer date. | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Amount | Decimal | Bank Account Transaction Amount | |
| Eliminate_Foreign_Exchange_Gain_or_Loss | Bool | Gives the user the option to eliminate the Foreign Exchange Gain or Loss. Added in web service v27.0. | |
| Memo | String | Bank Account Transfer memo. | |
| Transaction | String | Bank Account Transaction Reference | |
| From_Company_Cancel_Accounting_Date | Date | From Company Cancel Accounting Date | |
| To_Company_Cancel_Accounting_Date | Date | To Company Cancel Accounting Date | |
| Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Reference_Petty_Cash_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Rate_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Rate_Type_Reference_Currency_Rate_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Conversion_Rate | Decimal | Reference to the source transfer currency conversion rate. | |
| From_Account_Balancing_Worktag_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Balancing_Worktag_Reference_Business_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Balancing_Worktag_Reference_Cost_Center_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Balancing_Worktag_Reference_Custom_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Balancing_Worktag_Reference_Fund_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Balancing_Worktag_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Balancing_Worktag_Reference_Region_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Optional_Balancing_Worktags_from_Account_Reference | String | Optional Balancing Worktag from Account | |
| To_Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Reference_Petty_Cash_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Rate_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Rate_Type_Reference_Currency_Rate_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Conversion_Rate | Decimal | Reference to the destination account currency conversion rate for bank account transfer. | |
| To_Account_Balancing_Worktag_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Balancing_Worktag_Reference_Business_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Balancing_Worktag_Reference_Cost_Center_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Balancing_Worktag_Reference_Custom_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Balancing_Worktag_Reference_Fund_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Balancing_Worktag_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Balancing_Worktag_Reference_Region_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Optional_Balancing_Worktags_To_Account_Reference | String | Optional Balancing Worktag to Account | |
| Attachment_Data | String | Encapsulating element containing all Business Document Attachment data. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Account_Transfer_for_Settlement_ID | String | Bank Account Transfer Settlement ID | |
| Submit | Bool | Save and Submit | |
| Date | Date | Bank Account Transfer date. | |
| From_Company_Cancel_Accounting_Date | Date | From Company Cancel Accounting Date | |
| To_Company_Cancel_Accounting_Date | Date | To Company Cancel Accounting Date | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Amount | Decimal | Bank Account Transaction Amount | |
| Payment_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Payment_Type_Reference_Payment_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Eliminate_FX_Gain_or_Loss | Bool | Gives the user the option to eliminate the Foreign Exchange Gain or Loss. Added in web service v27.0. | |
| Memo | String | Bank Account Transfer memo. | |
| Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Reference_Petty_Cash_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Rate_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Rate_Type_Reference_Currency_Rate_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Conversion_Rate | Decimal | Reference to the source transfer currency conversion rate. | |
| From_Account_Balancing_Worktag_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Balancing_Worktag_Reference_Business_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Balancing_Worktag_Reference_Cost_Center_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Balancing_Worktag_Reference_Custom_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Balancing_Worktag_Reference_Fund_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Balancing_Worktag_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Balancing_Worktag_Reference_Region_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Optional_Balancing_Worktags_Reference | String | Optional Balancing Worktag from Account | |
| To_Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Rate_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Rate_Type_Reference_Currency_Rate_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Conversion_Rate | Decimal | Reference to the destination account currency conversion rate for bank account transfer. | |
| To_Account_Balancing_Worktag_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Balancing_Worktag_Reference_Business_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Balancing_Worktag_Reference_Cost_Center_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Balancing_Worktag_Reference_Custom_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Balancing_Worktag_Reference_Fund_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Balancing_Worktag_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Balancing_Worktag_Reference_Region_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Optional_Worktags_Reference | String | Optional Balancing Worktag to Account | |
| Attachment | String | Encapsulating element containing all Business Document Attachment data. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Account_Transfer_Template_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Transfer_Template_Reference_Bank_Account_Transfer_Template_ID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Transaction_Template_ID | String | Reference ID | |
| Name | String | Bank Account Transfer Template Name | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Eliminate_Foreign_Exchange_Gain_or_Loss | Bool | Whether to eliminate fx gain or loss | |
| Memo | String | Bank Account Transfer Template transaction memo | |
| Inactive | Bool | Inactivate the Bank Account Transfer Template | |
| From_Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Financial_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Financial_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Financial_Account_Reference_Petty_Cash_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Account_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| From_Currency_Rate_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Currency_Rate_Type_Reference_Currency_Rate_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_Business_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_Cost_Center_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_Custom_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_Fund_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| From_Balancing_Worktag_Reference_Region_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Optional_Balancing_Worktags_from_Account_Reference | String | Optional Balancing Worktag from Account | |
| To_Company_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Financial_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Financial_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Financial_Account_Reference_Petty_Cash_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Account_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| To_Currency_Rate_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Currency_Rate_Type_Reference_Currency_Rate_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_Business_Unit_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_Cost_Center_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_Custom_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_Fund_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| To_Balancing_Worktag_Reference_Region_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Optional_Balancing_Worktags_To_Account_Reference | String | Optional Balancing Worktag to Account |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Branch_ID | String | Bank Branch Reference ID. This is the Bank Branch unique identifier | |
| Financial_Institution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_Financial_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_Financial_Institution_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Branch_ID_Number | String | Free form text field for a Bank Branch ID Number. Generally used to reference a banks own Branch ID. | |
| Business_Entity_Name | String | Business Entity Name is the name for the business entity. Business entities can not be duplicated across different business entity types, ie: a Customer can not have the same name as a Financial Institution unless they share the Business Entity. | |
| Business_Entity_Phonetic_Name | String | Business Entity Furigana | |
| Business_Entity_Tax_ID | String | Business Entity Tax ID | |
| External_Entity_ID | String | External Entity ID. The External Entity ID can be used as a non unique reference to the same Business Entity in an external system. | |
| Address_Data | String | Address information | |
| Phone_Data | String | Phone Information | |
| Email_Address_Data | String | Email Address Information | |
| Instant_Messenger_Data | String | Instant Messenger Information | |
| Web_Address_Data | String | Web Address Information | |
| Filename | String | Text attribute identifying Filename of the Attachment. | |
| Image | String | File content in binary format. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Fee_Service_Code_ID | String | This is the Bank Fee Service Code unique identifier. | |
| Financial_Institution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_Financial_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_Financial_Institution_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Fee_Service_Code | String | This is the Bank Fee Service Code in text. | |
| Description | String | This is the description of the Bank Fee Service Code. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Fee_Service_Contract_ID | String | The reference ID for the Bank Fee Service Contract. | |
| Financial_Institution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_Financial_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_Financial_Institution_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Accounts_Reference | String | The bank accounts associated with the service contract. | |
| Service_Contract_Description | String | The service contract description. | |
| Bank_Fee_Service_Contract_Lines_Data | String | The element container of the bank fee service contract line data. | |
| Attachment_Data | String | Encapsulating element containing all Business Document Attachment data. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Bank Fee Statement File Reference ID. This field is a unique identifier. | |
| Sender_Identification | String | Sender Identification. | |
| Receiver_Identification | String | Receiver Identification. | |
| File_Creation_Date | Date | File Creation Date. | |
| File_Identification_Number | String | File Identification Number. | |
| Skip_Validations | Bool | Skips duplicate file validation. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Fee_Statement_ID | String | This is the Bank Fee Statement unique identifier. | |
| Bank_Fee_Statement_File_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Fee_Statement_File_Reference_Bank_Fee_Statement_File_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Statement_Date | Date | The date on which the Bank Fee Statement is entered. | |
| Statement_Begin_Date | Date | The start date for the Bank Fee Statement period. | |
| Statement_End_Date | Date | The end date for the Bank Fee Statement period. | |
| Customer_Account_Number | String | Customer Account Number. | |
| Tax_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Settlement_Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Settlement_Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Settlement_Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Tax_Region | String | The Tax Region name. | |
| Bank_Fee_Statement_Currency_Conversion_Rate_Data | String | Specifies details related to currency exchange data. | |
| Bank_Fee_Statement_Compensation_Data | String | Element containing the compensation data, rate information. | |
| Bank_Fee_Statement_Transaction_Data | String | Element containing the Bank Fee Statement line data. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Statement_Custom_Code_Set_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Bank_Statement_Custom_Code_Set_Reference_Bank_Statement_Custom_Code_Set_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | Bank Statement Custom Code Set ID. This is the bank statement custom code set unique identifier. | |
| Name | String | Custom Code Set Name | |
| Bank_Statement_Format_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Statement_Format_Reference_Bank_Statement_Format_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Description | String | Description | |
| Comment | String | Comment |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| BankStatementCustomCodeSet_Bank_Statement_Custom_Code_Set_Reference_WID | String |
BankStatementCustomCodeSets.Bank_Statement_Custom_Code_Set_Reference_WID | The unique identifier type. Each |
| Bank_Statement_Balance_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Statement_Balance_Type_Reference_Bank_Statement_Balance_Type_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | Bank Statement Balance Type ID. This is the bank statement balance type unique identifier. | |
| Summary_Balance | String | Bank Statement Balance Type Indicator | |
| Type_Code | String | Bank Statement Balance Type Code | |
| Debit_Credit | String | Debit/Credit Type | |
| Description | String | Bank Statement Type Description | |
| Bank_Statement_Type_Category_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Statement_Type_Category_Reference_Bank_Statement_Type_Category_Name | String | Contains a unique identifier for an instance of an object. | |
| Beginning_Balance | String | Beginning Balance | |
| Ending_Balance | String | Ending Balance |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| BankStatementCustomCodeSet_Bank_Statement_Custom_Code_Set_Reference_WID | String |
BankStatementCustomCodeSets.Bank_Statement_Custom_Code_Set_Reference_WID | The unique identifier type. Each |
| Bank_Statement_Transaction_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Statement_Transaction_Type_Reference_Bank_Statement_Transaction_Type_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | Bank Statement Transaction Type ID. This is the bank statement transaction type unique identifier. | |
| Type_Code | String | Bank Statement Type Code | |
| Debit_Credit | String | Debit/Credit Type | |
| Description | String | Bank Statement Type Description | |
| Bank_Statement_Type_Category_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Statement_Type_Category_Reference_Bank_Statement_Type_Category_Name | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Statement_File_Reference_ID | String | Bank Statement File Reference ID. This field is a unique identifier. | |
| Sender_Identification | String | Sender Identification. | |
| Receiver_Identification | String | Receiver Identification. | |
| File_Creation_Date | Date | File Creation Date. | |
| File_Identification_Number | String | File Identification Number. | |
| Skip_Validations | Bool | Skips duplicate file validation. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Statement_Reference_ID | String | Bank Statement Reference ID. This is the Bank Statement Data unique identifier. | |
| Bank_Statement_File_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Statement_File_Reference_Bank_Statement_File_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Customer_Account_Number | String | Customer Account Number. | |
| Routing_Number | String | Routing Number. | |
| Bank_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Statement_Begin_Date | Date | Statement Begin Date. | |
| Statement_End_Date | Date | Statement End Date. | |
| Same_Day_Bank_Statement | Bool | Same Day Bank Statement? | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Bank_Statement_Summary_Data | String | Bank Statement Summary Data. | |
| Bank_Statement_Transaction_Data | String | Bank Statement Transaction Data | |
| Bank_Identification_Code | String | Bank Identification Code | |
| IBAN | String | IBAN |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Primary_Bill_To_Contact | Bool | Primary Bill To Contact to choose one contact to be as primary. | |
| Default_Bill_To_Contact | Bool | Sets Contact as the default Bill-To Contact for the Billable Entity. | |
| Business_Entity_Contact_ID | String | Business Entity Contact ID. This is the Business Entity Contact unique identifier | |
| Supplier_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Supplier_Reference_External_Sourceable_ID | String | Contains a unique identifier for an instance of an object. | |
| Supplier_Reference_Supplier_ID | String | Contains a unique identifier for an instance of an object. | |
| Supplier_Reference_Supplier_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Billable_Entity_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Billable_Entity_Reference_Customer_ID | String | Contains a unique identifier for an instance of an object. | |
| Billable_Entity_Reference_Customer_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Billable_Entity_Reference_Sponsor_ID | String | Contains a unique identifier for an instance of an object. | |
| Billable_Entity_Reference_Sponsor_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Billable_Entity_Reference_Student_Financial_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_Financial_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_Financial_Institution_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Authority_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Authority_Reference_Tax_Authority_ID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Authority_Reference_Tax_Authority_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Name_Data | String | Encapsulating element for all of the Name data for a person. | |
| Address_Data | String | Address information | |
| Phone_Data | String | Phone Information | |
| Email_Address_Data | String | Email Address Information | |
| Instant_Messenger_Data | String | Instant Messenger Information | |
| Web_Address_Data | String | Web Address Information | |
| External_ID_Data | String | External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Cash_Activity_Category_ID | String | This is the Cash Activity Category unique identifier. | |
| Cash_Activity_Category | String | This is the Cash Activity Category in text. | |
| Description | String | This is the description of the Cash Activity Category. | |
| Inactive | String | Y represents Inactive Worktag and N represents Active worktag |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Cash_Pool_ID | String | This is the Cash Pool unique identifier. | |
| Name | String | The name for this Cash Pool | |
| Description | String | The description for this Cash Pool | |
| Inactive | Bool | This is to mark the Cash Pool as inactive. | |
| Master_Bank_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Master_Bank_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Master_Bank_Account_Reference_Petty_Cash_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Sub_Bank_Accounts_Data | String | Sub Bank Accounts data. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Donor Contribution ID | |
| Submit | Bool | Save and Submit | |
| Donor_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Donor_Reference_Donor_ID | String | Contains a unique identifier for an instance of an object. | |
| Gift_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Gift_Reference_Gift_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Date_Received | Date | The date the Donor Contribution was received | |
| Date_Recorded | Date | The date the Donor Contribution was recorded | |
| Amount | Decimal | The currency value of the Donor Contribution | |
| Designation | String | Contribution Reference | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Attachment_Data | String | Attachment Data |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Donor_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Donor_Reference_Donor_ID | String | Contains a unique identifier for an instance of an object. | |
| Donor_ID | String | Donor ID. This is the Donor unique identifier. | |
| Donor_Name | String | Name for Donor which is also a Business Entity. | |
| Customer_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Customer_Reference_Customer_ID | String | Contains a unique identifier for an instance of an object. | |
| Customer_Reference_Customer_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_Financial_Institution_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Institution_Reference_Financial_Institution_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Investor_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Investor_Reference_Investor_ID | String | Contains a unique identifier for an instance of an object. | |
| Sponsor_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Sponsor_Reference_Sponsor_ID | String | Contains a unique identifier for an instance of an object. | |
| Sponsor_Reference_Sponsor_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Authority_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Authority_Reference_Tax_Authority_ID | String | Contains a unique identifier for an instance of an object. | |
| Tax_Authority_Reference_Tax_Authority_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Donor_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Donor_Type_Reference_Donor_Type_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Donor_Donor_Reference_WID | String |
Donors.Donor_Reference_WID | The unique identifier type. Each |
| Country_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_2_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Alpha_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Reference_ISO_3166_1_Numeric_3_Code | String | Contains a unique identifier for an instance of an object. | |
| Last_Modified | Datetime | The moment when the address was last modified. | |
| Address_Line_Data | String | The address line for the address. This typically contains Street name, street number, apartment, suite number. | |
| Municipality | String | City part of the address. | |
| Country_City_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_City_Reference_Country_Subregion_Code_In_Country | String | Contains a unique identifier for an instance of an object. | |
| Country_City_Reference_Country_Subregion_Internal_ID | String | Contains a unique identifier for an instance of an object. | |
| Submunicipality_Data | String | The submunicipality of the address. | |
| Country_Region_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Country_Region_Reference_Country_Region_ID | String | Contains a unique identifier for an instance of an object. | |
| Country_Region_Reference_ISO_3166_2_Code | String | Contains a unique identifier for an instance of an object. | |
| Country_Region_Descriptor | String | The region part of the address. Typically this contains the state/province information. | |
| Subregion_Data | String | The subregion part of the address. | |
| Postal_Code | String | The postal code part of the address. | |
| Usage_Data | String | Encapsulating element for all Communication Method Usage data. | |
| Number_of_Days | Decimal | Tracks the number of days an employee works from home per week. | |
| Municipality_Local | String | City in local script part of the address. | |
| Address_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Address_Reference_Address_ID | String | Contains a unique identifier for an instance of an object. | |
| Address_ID | String | New ID value used in address updates. The ID cannot already be in use by another address. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Donor_Donor_Reference_WID | String |
Donors.Donor_Reference_WID | The unique identifier type. Each |
| Email_Address | String | Email Address Information | |
| Email_Comment | String | Email comments. | |
| Usage_Data | String | Encapsulating element for all Communication Method Usage data. | |
| Email_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Email_Reference_Email_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | New ID value used in email address updates. The ID cannot already be in use by another email address. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Donor_Donor_Reference_WID | String |
Donors.Donor_Reference_WID | The unique identifier type. Each |
| Instant_Messenger_Address | String | Instant Messenger Address. | |
| Instant_Messenger_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Instant_Messenger_Type_Reference_Instant_Messenger_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Instant_Messenger_Comment | String | Instant messenger comment. | |
| Usage_Data | String | Encapsulating element for all Communication Method Usage data. | |
| Instant_Messenger_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Instant_Messenger_Reference_Instant_Messenger_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | New ID value used in instant messenger updates. The ID cannot already be in use by another instant messenger. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Donor_Donor_Reference_WID | String |
Donors.Donor_Reference_WID | The unique identifier type. Each |
| Country_ISO_Code | String | Country ISO code. If the Country ISO code is specified, then this ISO code will be used to determine the Country Phone Code for (eliminate space between f and o) the phone. Pass this ISO code to distinguish between multiple countries sharing the same Country Phone Code. (For example, 1 is the Country Phone Code that is shared by USA, Canada, Dominican Republic, Bermuda, Jamaica, and Puerto Rico.) | |
| International_Phone_Code | String | International phone code number. | |
| Phone_Number | String | Full phone number. | |
| Phone_Extension | String | Phone extension. | |
| Phone_Device_Type_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Phone_Device_Type_Reference_Phone_Device_Type_ID | String | Contains a unique identifier for an instance of an object. | |
| Usage_Data | String | Encapsulating element for all Communication Method Usage data. | |
| Phone_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Phone_Reference_Phone_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | New ID value used in phone updates. The ID cannot already be in use by another phone. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Donor_Donor_Reference_WID | String |
Donors.Donor_Reference_WID | The unique identifier type. Each |
| Web_Address | String | Web address (Example: URL). | |
| Web_Address_Comment | String | Web address comment. | |
| Usage_Data | String | Encapsulating element for all Communication Method Usage data. | |
| Web_Address_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Web_Address_Reference_Web_Address_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | New ID value used in web address updates. The ID cannot already be in use by another web address. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Company_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Company_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Company_Reference_Organization_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Financial_Account_Reference_Petty_Cash_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Cash_Activity_Date | Date | Date of the external cash activity | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Cash_Activity_Amount | Decimal | Amount of the external cash activity | |
| Debit_Credit | String | Whether the external cash activity is DR or CR | |
| Counterparty_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Counterparty_Reference_Ad_hoc_Counterparty_ID | String | Contains a unique identifier for an instance of an object. | |
| Counterparty_Reference_Customer_ID | String | Contains a unique identifier for an instance of an object. | |
| Counterparty_Reference_Customer_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Counterparty_Reference_External_Sourceable_ID | String | Contains a unique identifier for an instance of an object. | |
| Counterparty_Reference_Investor_ID | String | Contains a unique identifier for an instance of an object. | |
| Counterparty_Reference_Supplier_ID | String | Contains a unique identifier for an instance of an object. | |
| Counterparty_Reference_Supplier_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Processed | Bool | The external cash activity is already processed | |
| Description | String | Description of the external cash activity | |
| Worktags_Reference | String | Worktags for external cash activity |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Financial_Institution_ID | String | Financial Institution ID. This is a unique identifier for the Financial Institution | |
| Financial_Institution_Reference_ID | String | Financial Institution Reference ID. The Financial Institution Reference ID can be used to uniquely identify a Financial Institution. Unlike Financial Institution ID, Workday will not automatically generate a Financial Institution Reference ID if one is not received. The recommended use for Financial Institution Reference ID is where Workday is not the source system of the Financial Institution. | |
| Financial_Institution_Name | String | Financial Institution Name. | |
| Create_Financial_Institution_from_Customer_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Customer_Reference_Customer_ID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Customer_Reference_Customer_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Customer_Reference_Sponsor_ID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Customer_Reference_Sponsor_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Customer_Reference_Student_Financial_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Tax_Authority_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Tax_Authority_Reference_Tax_Authority_ID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Tax_Authority_Reference_Tax_Authority_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Supplier_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Supplier_Reference_External_Sourceable_ID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Supplier_Reference_Supplier_ID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Supplier_Reference_Supplier_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Investor_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Create_Financial_Institution_from_Investor_Reference_Investor_ID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Identifier_Code | String | Bank Identifier Code | |
| Bank_Code | String | Bank Code | |
| Business_Entity_Name | String | Business Entity Name is the name for the business entity. Business entities can not be duplicated across different business entity types, ie: a Customer can not have the same name as a Financial Institution unless they share the Business Entity. | |
| Business_Entity_Phonetic_Name | String | Business Entity Furigana | |
| Business_Entity_Tax_ID | String | Business Entity Tax ID | |
| External_Entity_ID | String | External Entity ID. The External Entity ID can be used as a non unique reference to the same Business Entity in an external system. | |
| Address_Data | String | Address information | |
| Phone_Data | String | Phone Information | |
| Email_Address_Data | String | Email Address Information | |
| Instant_Messenger_Data | String | Instant Messenger Information | |
| Web_Address_Data | String | Web Address Information | |
| Filename | String | Text attribute identifying Filename of the Attachment. | |
| Image | String | File content in binary format. | |
| Attachment_Data | String | Encapsulating element containing all Business Document Attachment data. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Bank_Statement_Reference_ID | String | Bank Statement Reference ID. This is the Bank Statement Data unique identifier. | |
| Bank_Statement_File_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Statement_File_Reference_Bank_Statement_File_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Customer_Account_Number | String | Customer Account Number. | |
| Routing_Number | String | Routing Number. | |
| Bank_Identification_Code | String | Bank Identification Code | |
| IBAN | String | IBAN | |
| Bank_Account_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Bank_Account_Reference_Bank_Account_ID | String | Contains a unique identifier for an instance of an object. | |
| Statement_Date | Date | Statement Date | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Intraday_Bank_Statement_Summary_Data | String | Bank Statement Summary Data | |
| Intraday_Bank_Statement_Transaction_Data | String | Bank Statement Transaction Data. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Transaction_Date | Date | Transaction Date is the day the units were transferred | |
| ID | String | Investment Pool Adjustment ID | |
| Gift_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Gift_Reference_Gift_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Units_to_Adjust | Decimal | Number of units to adjust | |
| Status_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Status_Reference_Document_Status_ID | String | Contains a unique identifier for an instance of an object. | |
| Adjustment_Fair_Market_Value | Decimal | Adjustment Fair Market Value | |
| Original_Total_Units | Decimal | Original Total Units | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Investment_Pool_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Investment_Pool_Reference_Investment_Pool_ID | String | Contains a unique identifier for an instance of an object. | |
| Unit_Price | Decimal | Unit Price | |
| Investment_Pool_Adjustment_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Investment_Pool_Adjustment_Reference_Investment_Pool_Adjustment_ID | String | Contains a unique identifier for an instance of an object. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Investment_Pool_Purchase_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Investment_Pool_Purchase_Reference_Investment_Pool_Purchase_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | Investment Pool Purchase ID | |
| Submit | Bool | Save and Submit | |
| Gift_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Gift_Reference_Gift_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Transaction_Date | Date | Transaction Date is the day the investment pool units were purchased. | |
| Purchase_Date | Date | Purchase Date determines the default unit price for the purchase by selecting the Investment Pool Valuation for that date. | |
| Worktags_Reference | String | Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval. | |
| Status | String | Status of the Investment Pool Purchase Record | |
| Investment_Pool_Valuation_Reference_IID | String | Contains a unique identifier for an instance of an object. | |
| Investment_Pool_Valuation_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Default_Unit_Price | Decimal | Default Unit Price is the unit price on the referenced Investment Pool Valuation. | |
| Units_Purchased | Decimal | Total Units Purchased for the referenced Gift. | |
| Total_Amount_Purchased | Decimal | Total Amount Purchased for the referenced Gift. | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Reinvestment | Bool | Indicates that the units were purchased using distributed income when set |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| InvestmentPoolPurchase_Investment_Pool_Purchase_Reference_WID | String |
InvestmentPoolPurchases.Investment_Pool_Purchase_Reference_WID | The unique identifier type. Each |
| Donor_Contribution_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Donor_Contribution_Reference_Donor_Contribution_ID | String | Contains a unique identifier for an instance of an object. | |
| Override_Default_Unit_Price | Bool | If Override Default Unit Price is set, the line Purchase Date and Unit Price overrides the default values from the header. | |
| Purchase_Date | Date | Purchase Date determines the unit price to use on the line by selecting the Investment Pool Valuation for that date. | |
| Unit_Price | Decimal | If provided, the line Unit Price overrides the unit price selected by the line Purchase Date. |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | ID | |
| Transaction_Date | Date | Transaction Date | |
| Status_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Status_Reference_Document_Status_ID | String | Contains a unique identifier for an instance of an object. | |
| Cancel_Accounting_Date | Date | Cancel Accounting Date | |
| Investment_Pool_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Investment_Pool_Reference_Investment_Pool_ID | String | Contains a unique identifier for an instance of an object. | |
| Investment_Pool_Valuation_Reference_IID | String | Contains a unique identifier for an instance of an object. | |
| Investment_Pool_Valuation_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Gift_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Gift_Reference_Gift_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Units_to_Sell | Decimal | Units to Sell | |
| Unit_Price | Decimal | Unit Price | |
| Memo | String | Memo | |
| Net_Book_Value | Decimal | Net Book Value | |
| Unit_Selection_Method_Reference_IID | String | Contains a unique identifier for an instance of an object. | |
| Unit_Selection_Method_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Fair_Market_Value | Decimal | Fair Market Value | |
| Net_Asset_Accounting_Worktags_Reference | String | Net Asset Accounting Worktags | |
| Unit_Source_Data | String | Investment Pool Sale Line Data Element |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| ID | String | Investment Pool Transfer ID | |
| Transaction_Date | Date | Transaction Date is the day the units were transferred | |
| Status | String | Indicates the status of the transfer | |
| Cancel_Accounting_Date | Date | Cancel Accounting Date | |
| Source_Gift_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Source_Gift_Reference_Gift_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Destination_Gift_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Destination_Gift_Reference_Gift_Reference_ID | String | Contains a unique identifier for an instance of an object. | |
| Investment_Pool_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Investment_Pool_Reference_Investment_Pool_ID | String | Contains a unique identifier for an instance of an object. | |
| Investment_Pool_Valuation_Reference_IID | String | Contains a unique identifier for an instance of an object. | |
| Investment_Pool_Valuation_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_ID | String | Contains a unique identifier for an instance of an object. | |
| Currency_Reference_Currency_Numeric_Code | String | Contains a unique identifier for an instance of an object. | |
| Unit_Price | Decimal | The fair market value of each transferred unit | |
| Total_Units_Transferred | Decimal | The total number of transferred units | |
| Fair_Market_Value | Decimal | The total fair market value of the transferred units | |
| Net_Book_Value | Decimal | The total book value transferred | |
| Unit_Selection_Method_Reference_IID | String | Contains a unique identifier for an instance of an object. | |
| Unit_Selection_Method_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Memo | String | memo | |
| Worktags_Reference | String | Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval. | |
| Unit_Source_Data | String | Unit Source Data contains essential information on one unit source for the Investment Pool Transfer |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| Investment_Statement_Reference_WID [KEY] | String | Contains a unique identifier for an instance of an object. | |
| Investment_Statement_Reference_Investment_Statement_ID | String | Contains a unique identifier for an instance of an object. | |
| ID | String | Donor Contribution ID | |
| Submit | Bool | Save and Submit | |
| Cancel_Accounting_Date | Date | Cancel Accounting Date | |
| Investment_Profile_Reference_WID | String | Contains a unique identifier for an instance of an object. | |
| Investment_Profile_Reference_Investment_Profile_ID | String | Contains a unique identifier for an instance of an object. | |
| Statement_Beginning_Date | Date | The Investment Statement covers activity starting on this date. | |
| Statement_Date | Date | The Investment Statement covers activity until this date. | |
| Ending_Balance | Decimal | The net activity amount including the Investment Statement activity. | |
| Memo | String | Memo for the Investment Statement |
Tables are dynamically determined at runtime based on the Version connection property. This table is presented as an example of what is available, but more may be available due to newer API releases.
| Name | Type | References | Description |
| InvestmentStatement_Investment_Statement_Reference_WID | String |
InvestmentStatements.Investment_Statement_Reference_WID | The unique identifier type. Each |
| File_Content | String | File content in binary format. | |
| Comment | String | Comment |