Skip to main content

Workday Web Services Data Source

Follow the instructions below to create a new data flow that ingests data from a Workday Web Services source in Nexla.
wdayws_api.png

Workday Web Services

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Workday Web Services connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Workday Web Services instance, and click Next; or, create a new Workday Web Services credential for use in this flow.

  3. In Nexla, Workday Web Services data sources can be created using pre-built endpoint templates, which expedite source setup for common Workday Web Services endpoints. Each template is designed specifically for the corresponding Workday Web Services endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

Workday Web Services sources can also be configured manually, allowing you to ingest data from Workday Web Services endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
• To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Workday Web Services endpoints. Each template is designed specifically for the corresponding Workday Web Services endpoint, making data source setup easy and efficient.

Workday Web Services are SOAP-based APIs that use XML format for requests and responses. All endpoint templates use SOAP envelopes with WS-Security authentication. The endpoints automatically handle pagination and authentication using your credential configuration.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get Journal Sources

    This endpoint template fetches all Journal Sources from your Workday account. Use this template when you need to access journal source information, journal source metadata, or journal source structures for analysis, reporting, or integration purposes.

    • This endpoint automatically fetches all Journal Sources from your Workday account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically.

    This endpoint returns all Journal Sources from your Workday account, including journal source IDs, names, and other journal source metadata. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically to retrieve all journal sources.

    For detailed information about journal sources, API response structures, and available journal source data, see the Workday Web Services API documentation.

    Get Ledger Account Summaries

    This endpoint template fetches all Ledger Account Summaries from your Workday account. Use this template when you need to access ledger account summary information, account balances, or financial summary data for analysis, reporting, or integration purposes.

    • This endpoint automatically fetches all Ledger Account Summaries from your Workday account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically.

    This endpoint returns all Ledger Account Summaries from your Workday account, including account IDs, names, balances, and other financial summary metadata. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically to retrieve all ledger account summaries.

    For detailed information about ledger account summaries, API response structures, and available financial data, see the Workday Web Services API documentation.

    Get Customers

    This endpoint template fetches all Customers from your Workday account. Use this template when you need to access customer information, customer details, or customer metadata for analysis, reporting, or integration purposes.

    • This endpoint automatically fetches all Customers from your Workday account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically.

    This endpoint returns all Customers from your Workday account, including customer IDs, names, contact information, and other customer metadata. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically to retrieve all customers.

    For detailed information about customers, API response structures, and available customer data, see the Workday Web Services API documentation.

    Get Journals

    This endpoint template fetches Journal Entries for the specified accounting period from your Workday account. Use this template when you need to access journal entry information, journal transactions, or accounting period data for analysis, reporting, or integration purposes.

    • Enter the Accounting From Date in the Accounting From Date field. This should be the start date of the accounting period in YYYY-MM-DD format. The From date must be less than or equal to the To date. The Accounting From Date determines the start of the accounting period for which journal entries will be retrieved.
    • Enter the Accounting To Date in the Accounting To Date field. This should be the end date of the accounting period in YYYY-MM-DD format. The From date must be less than or equal to the To date. The Accounting To Date determines the end of the accounting period for which journal entries will be retrieved.

    This endpoint returns Journal Entries for the specified accounting period from your Workday account, including journal entry IDs, transaction details, amounts, and other journal entry metadata. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically to retrieve all journal entries for the specified period.

    For detailed information about journals, API response structures, and available journal entry data, see the Workday Web Services API documentation.

    Get Journals (By Update Datetime)

    This endpoint template fetches all journals with status updates between the entered datetime from your Workday account. Use this template when you need to access journal entries that have been updated within a specific time range for analysis, reporting, or integration purposes.

    • Enter the Updated From DateTime in the Updated From DateTime field. This should be the start datetime for retrieving all journals after the entered datetime. The Updated From DateTime determines the start of the time range for which updated journal entries will be retrieved.
    • Enter the Updated To DateTime in the Updated To DateTime field. This should be the end datetime for retrieving all journals before the entered datetime. The Updated To DateTime determines the end of the time range for which updated journal entries will be retrieved.

    This endpoint returns all journals with status updates between the entered datetime from your Workday account, including journal entry IDs, update timestamps, transaction details, and other journal entry metadata. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically to retrieve all updated journal entries within the specified time range.

    For detailed information about journals, API response structures, and available journal entry data, see the Workday Web Services API documentation.

    Get Account Sets

    This endpoint template fetches all Account Sets from your Workday account. Use this template when you need to access account set information, account groupings, or account set metadata for analysis, reporting, or integration purposes.

    • This endpoint automatically fetches all Account Sets from your Workday account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically.

    This endpoint returns all Account Sets from your Workday account, including account set IDs, names, and other account set metadata. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically to retrieve all account sets.

    For detailed information about account sets, API response structures, and available account set data, see the Workday Web Services API documentation.

    Get Customer Invoices (Enter Criteria)

    This endpoint template fetches Customer Invoices for the specified company reference and invoice dates from your Workday account. Use this template when you need to access customer invoice information, invoice details, or billing data for a specific company for analysis, reporting, or integration purposes.

    • Enter the Company Reference in the Company Reference field. This should be the reference to an existing Company which holds the asset. The Company Reference determines which company's invoices will be retrieved.
    • Enter the Invoice Date On or After in the Invoice Date On or After field. This should be the start date for filtering invoices in YYYY-MM-DD format. Invoice Date On or After must be before Invoice Date On or Before. The Invoice Date On or After determines the start of the date range for which invoices will be retrieved.
    • Enter the Invoice Date On or Before in the Invoice Date On or Before field. This should be the end date for filtering invoices in YYYY-MM-DD format. Invoice Date On or After must be before Invoice Date On or Before. The Invoice Date On or Before determines the end of the date range for which invoices will be retrieved.

    This endpoint returns Customer Invoices for the specified company reference and invoice dates from your Workday account, including invoice IDs, invoice numbers, amounts, dates, and other invoice metadata. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically to retrieve all invoices matching the specified criteria.

    For detailed information about customer invoices, API response structures, and available invoice data, see the Workday Web Services API documentation.

    Get Customer Payments

    This endpoint template fetches Customer Payments from your Workday account. Use this template when you need to access customer payment information, payment details, or payment transaction data for analysis, reporting, or integration purposes.

    • Enter the Payment Date on Date or After in the Payment Date on Date or After field. This should be the start date for filtering payments in YYYY-MM-DD format. Payment Date on Date or After must be before Payment Date on Date or Before. The Payment Date on Date or After determines the start of the date range for which payments will be retrieved.
    • Enter the Payment Date on Date or Before in the Payment Date on Date or Before field. This should be the end date for filtering payments in YYYY-MM-DD format. Payment Date on Date or After must be before Payment Date on Date or Before. The Payment Date on Date or Before determines the end of the date range for which payments will be retrieved.

    This endpoint returns Customer Payments from your Workday account, including payment IDs, payment amounts, payment dates, and other payment metadata. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically to retrieve all payments matching the specified date range.

    For detailed information about customer payments, API response structures, and available payment data, see the Workday Web Services API documentation.

    Get Organizations

    This endpoint template fetches all organizations from your Workday account. Use this template when you need to access organization information, organization details, or organization metadata for analysis, reporting, or integration purposes.

    • This endpoint automatically fetches all organizations from your Workday account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically.

    This endpoint returns all organizations from your Workday account, including organization IDs, names, codes, and other organization metadata. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically to retrieve all organizations.

    For detailed information about organizations, API response structures, and available organization data, see the Workday Web Services API documentation.

    Get Customer Invoices (All Company References)

    This endpoint template fetches Customer Invoices for all company references with the specified invoice dates from your Workday account. Use this template when you need to access customer invoice information across all companies for analysis, reporting, or integration purposes.

    • Enter the Invoice Date On or After in the Invoice Date On or After field. This should be the start date for filtering invoices in YYYY-MM-DD format. Invoice Date On or After must be before Invoice Date On or Before. The Invoice Date On or After determines the start of the date range for which invoices will be retrieved.
    • Enter the Invoice Date On or Before in the Invoice Date On or Before field. This should be the end date for filtering invoices in YYYY-MM-DD format. Invoice Date On or After must be before Invoice Date On or Before. The Invoice Date On or Before determines the end of the date range for which invoices will be retrieved.

    This endpoint returns Customer Invoices for all company references with the specified invoice dates from your Workday account, including invoice IDs, invoice numbers, amounts, dates, company references, and other invoice metadata. The endpoint uses a two-step process: first, it retrieves all organizations, then it fetches invoices for each organization. The endpoint uses SOAP format with WS-Security authentication and handles pagination automatically to retrieve all invoices matching the specified date range across all companies.

    For detailed information about customer invoices, API response structures, and available invoice data, see the Workday Web Services API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Workday Web Services data sources can be manually configured to ingest data from any valid Workday Web Services SOAP endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Workday Web Services sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom SOAP body templates or request parameters.

Workday Web Services are SOAP-based APIs that use XML format for requests and responses. Manual configuration requires SOAP envelope construction with WS-Security authentication headers. The API endpoints typically follow the pattern https://{hostname}.myworkday.com/ccx/service/{tenant}/{service_name}.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Workday Web Services API from the Method pulldown menu. The most common methods are:

    • POST: For retrieving data from the API (most common for Workday Web Services data sources, as SOAP APIs use POST requests with XML body)

API Endpoint URL​

  1. Enter the URL of the Workday Web Services SOAP endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and the service path. The URL format typically follows: https://{hostname}.myworkday.com/ccx/service/{tenant}/{service_name} where {hostname} is your Workday hostname, {tenant} is your Workday tenant, and {service_name} is the service name (e.g., Financial_Management or Revenue_Management).

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires SOAP format with WS-Security authentication, which is handled automatically by your credential configuration.

Path to Data​

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a SOAP request call is used to fetch journal entries, the API will typically return an XML envelope with journal entry data, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to extract the specific information you need.

Path to Data is essential when Workday Web Services API responses have nested XML structures. Without specifying the correct XPath, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in XML format (most common for SOAP APIs), enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /env:Envelope/env:Body/wd:Get_Journal_Sources_Response/wd:Response_Data/wd:Journal_Source to access journal source elements within a response envelope).

    • For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data.items[*] to access an array of items within a response object).

    Path to Data Example:

    If the Workday Web Services API response is in XML format and includes a nested structure like /env:Envelope/env:Body/wd:Get_Journal_Sources_Response/wd:Response_Data/wd:Journal_Source that contains the relevant data, the path to the response would be entered as /env:Envelope/env:Body/wd:Get_Journal_Sources_Response/wd:Response_Data/wd:Journal_Source.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Endpoint Testing (Manual Configuration)​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Workday Web Services data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.