canonical: https://jentic.com/apis/onesourcevirtual.io/onesourcevirtual # Onesourcevirtual OSV Customer Payroll Portal API The OSV Customer Payroll Portal API from OneSource Virtual gives payroll customers programmatic access to their payroll and settlement data. It lists companies and available payroll options, searches payroll runs, and returns payroll details and statistics. It also retrieves settlements, searches and requests settlement actions, exposes same-day ACH banking information, and returns distribution shipping details for a settlement. ## For AI agents Read a customer's companies, payroll runs, details, and statistics, and retrieve, search, and request settlements through the OSV Customer Payroll Portal API. ## Scope Does not run payroll or onboard employees. Use it to read payroll runs, details, and statistics and to retrieve, search, and request settlements only. ## Capabilities - List the companies and payroll options available to a customer - Search payroll runs and return payroll details and statistics - Retrieve settlements and search them by criteria - Request a settlement action and read its distribution shipping details - Read same-day ACH banking information and custom metadata ## Use cases ### AI Agent Payroll Access Give an AI agent read access to a customer's payroll portal. The agent discovers the payroll and settlement operations through Jentic, stores the OneSource Virtual credentials once, and answers questions about runs, details, and statistics without bespoke HTTP wiring. Sensitive actions stay behind the operations you allow. Example prompt: Search a company's recent payroll runs and summarize the payroll statistics for the latest period ### Payroll Reporting Report on payroll activity across a customer's companies. The API searches payroll runs and returns per-run details and aggregate statistics, so a reporting job can roll up spend and headcount figures by company and period. Example prompt: List a customer's companies, search each one's payroll runs, and compile a statistics report ### Settlement Management Track and act on payroll settlements. The API retrieves settlements, searches them by criteria, requests a settlement action, and returns the distribution shipping details for a settlement, so a finance workflow can follow funds through to delivery. Example prompt: Search settlements for a company, request a settlement action, and return its distribution shipping details ### Banking Details Lookup Surface the banking information behind payroll funding. The same-day ACH banking information operation returns the account details tied to a customer's payroll, so an agent can confirm funding routes before a run. Example prompt: Retrieve the same-day ACH banking information for a customer and return the funding account details ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/api/v1/companies` | List a customer's companies | | POST | `/api/v1/payroll/search` | Search payroll runs | | GET | `/api/v1/payroll/details` | Retrieve payroll details | | GET | `/api/v1/settlements` | List settlements | | POST | `/api/v1/settlements/request` | Request a settlement action | ## Key resources - **Companies** — List the companies and payroll options available to a customer. - **Payroll** — Search payroll runs and return details and statistics. - **Settlements** — Retrieve, search, request, and read distribution shipping for settlements. - **Banking** — Read same-day ACH banking information and custom metadata. ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 62 / 100 - **Maturity:** AI-Aware - **Dimensions:** - Foundational Compliance: 93 / 100 - Developer Experience & Jentic Compatibility: 62 / 100 - AI-Readiness & Agent Experience: 38 / 100 - Agent Usability: 94 / 100 - Security: 63 / 100 - AI Discoverability: 79 / 100 - **View full report:** https://jentic.com/apis/onesourcevirtual.io/onesourcevirtual/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring the OSV Customer Payroll Portal API by hand means learning its bearer-token and encrypted-request-key auth and threading payroll and settlement searches together yourself. Through Jentic you install once, import the API from the API Directory, store the credentials, and your agent calls the operation it needs. - **Permission scoping:** You decide which OSV operations your agent may call. A rule can grant payroll reads and reporting while withholding settlement requests, so the agent can report on payroll without moving funds, and the rule bounds operations rather than a single record. - **Credential handling:** Your OneSource Virtual credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'search a customer's payroll runs', and Jentic returns the matching OSV operation with its input schema so the agent calls the right endpoint without reading the reference docs. ## Related APIs - **ADP** — Runs payroll and workforce management at enterprise scale. - **Gusto** — Runs payroll, benefits, and HR for small businesses. - **Rippling** — Unifies payroll, HR, and IT provisioning. - **Workday** — Manages HR, finance, and workforce records. ## FAQ ### What authentication does the OSV Customer Payroll Portal API use? The API authenticates with a bearer token in the Authorization header, and also accepts an X-Encrypted-Request-Key header for encrypted requests, as declared by its OpenAPI spec. Through Jentic these credentials are stored encrypted by your own Jentic One instance and injected when a call runs, so they never enter the agent's prompt or logs. ### Can the OSV Customer Payroll Portal API return payroll statistics? Yes. It searches payroll runs, returns per-run details, and provides aggregate payroll statistics, so an agent can report on payroll activity for a company and period. ### What are the rate limits for the OSV Customer Payroll Portal API? The OpenAPI spec does not publish specific rate limits. Check the OneSource Virtual documentation for current limits, and have your agent back off and retry when it receives a throttling response. ### How do I read payroll data with the OSV Customer Payroll Portal API through Jentic? Search Jentic for an intent like 'search a customer's payroll runs', and it returns the matching OSV operation with its input schema. Import the connector once, store your credentials, and your agent reads payroll and settlement data without hand-written HTTP code. To run it on your own infrastructure, install Jentic One from its GitHub repo. ### Is there a OneSource Virtual MCP server? You don't need an MCP server to give your agent the OSV Customer Payroll Portal API. Jentic connects it directly from the Jentic API Directory: import the API, store your credentials once, and your agent calls the payroll and settlement operations. Operations are discovered on demand, so no extra tool definitions are loaded into the agent's context. ### Can I limit what my agent is allowed to do with the OSV Customer Payroll Portal API? Yes. You choose the operations the agent may call, so a rule can allow payroll reads and reporting while withholding settlement requests unless you add them. A rule bounds which operations run rather than which individual record is touched, and every call is logged.