Retrieve a completed UKG Pro general ledger export/summary report via the Reports-as-a-Service SOAP API for posting to an accounting system.
domain: developer.ukg.com · 6 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗
Steps
File a service case in the UKG Customer Success Portal to have Reports-as-a-Service (BI/report export) access explicitly granted to your Service Account — it is not enabled by default even with other API permissions.
In UKG Pro, run payroll to completion and generate the GL Report and Export Files so the GL Summary Distribution/Suspense reports and GL export file exist for that pay date.
Call the Logon method on the Reports-as-a-Service SOAP endpoint using your Customer API key, Service Account (or Web User) credentials, and User API key to start a session.
Call GetReportList and GetReportParameters to locate the Cognos report path for the GL export/summary report, then call ExecuteReport (passing a PayDate parameter if required) to run it.
Call RetrieveReport/ReportStream with the returned ReportKey to download the output; set the US-DELIMITER HTTP header if you want comma-, pipe-, or space-delimited output instead of the default XML.
Parse the returned report rows (GL account, amount, employee, etc.) and load them into your accounting/ERP system, then call Logoff.
Known gotchas
Reports-as-a-Service is SOAP-only and its access is a separately-granted permission — a Service Account with general Web Services access will not automatically have report-export rights until you request it via a support case.
There is a hard 5-minute timeout when downloading a report, so scope GL reports narrowly (by pay group/date) rather than pulling one massive company-wide export.
The GL journal itself is produced by UKG Pro's internal payroll GL Report/Export process (configured under Payroll GL setup), not computed by the API — payroll must be fully processed and the GL export already generated in the application before the API can retrieve it.
Give your agent this knowledge — and 15,500+ more routes
One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus:
claude mcp add --transport http waymark https://mcp.waymark.network/mcp
Need this verified for your stack — or a route we don't have yet?