Skip to main content

Python Client for the UltiPro SOAP API

Project description


A Python 3 library and command line tool for the UltiPro Soap API. At present, all functions are read-only against UltiPro.


pip install ultipro

Web Service User and Credentials:

  1. Ensure you have credentials for the UltiPro API endpoints you need to access. If you are pulling BI Reports, your Web Service User must have the Reports-as-a-service endpoint enabled with read access. Please see your UltiPro administrator if you do not have a web service user.

  2. Set up your credentials file. The default location is:

~/Library/Application Support/ultipro-soap-python/config.ini

You can find a sample config file in the root of this project's github repository, config.ini.sample.

To use this tool on the command line, install with pip, then:

$ ultipro --help

Pulling BI Reports:

You will need to log in to UltiPro and find the path for your desired report. It should look something like:

/content/folder[@name='_UltiPro Delivered Reports']/folder[@name='Human Resources Reports']/report[@name='Employee Birthdays']

You can find more information on page 7 of the WebServiceAPIGuide_BIService.doc

To execute, retrieve, and save a report to disk, use the following syntax:

$ ultipro report "/content/folder[@name='_UltiPro Delivered Reports']/"

If you'd like to use non-default locations for your config.ini file or output file, you can use the following syntax:

ultipro -f ~/some/other/path/to/config.ini -o ~/Desktop/fooreport.csv report "/content/folder[@name='_UltiPro Delivered Reports']/folder[@name='Human Resources Reports']/report[@name='Employee Birthdays']"

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ultipro, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size ultipro-0.0.3-py3-none-any.whl (12.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size ultipro-0.0.3.tar.gz (6.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page