How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OnPay

OnPay Company API

The Company API from OnPay — 17 operation(s) for company.

Documentation Provider Profile APIs.io OpenAPI GitHub

OnPay Company API is one of 6 APIs that OnPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Company. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 30 operations across 17 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://onpaydev.com/v2.

30 operations 17 paths 19 schemas 1 DELETE15 GET7 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.onpay.com/v2
Authentication
OAuth 2.0, API Key
Resource Areas
1

Authentication & Security 2

OnPay Company API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 6 scopes. An API key is passed in the header as Authorization (Bearer).

Paths & Operations 30

Across 17 paths, the API surfaces 30 operations — 1 DELETE, 15 GET, 7 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Company 30
GET
/company
Get company information
→ 200default
GET
/company/pay-schedules
list pay schedules for company
→ 200default
GET
/company/deductions
Get all deductions for company
→ 200default
POST
/company/deductions
create a new deduction
body → 200default
PATCH
/company/deductions/{deduction_id}
Patch deduction
1 param body → 200default
DELETE
/company/deductions/{deduction_id}
Delete deduction by Id.
1 param → 200default
GET
/company/deduction-groupings
→ 200default
POST
/company/deduction-groupings
body → 200default
PATCH
/company/deduction-groupings/{id}
1 param body → 200default
GET
/company/worksites
→ 200
POST
/company/worksites
body → 200
GET
/company/worksites/{id}
1 param → 200
PATCH
/company/worksites/{id}
1 param body → 200
GET
/company/locations
→ 200default
POST
/company/locations
body → 200
GET
/company/locations/{id}
1 param → 200
PATCH
/company/locations/{id}
1 param body → 200
GET
/company/departments
Get all departments for company
→ 200
POST
/company/departments
body → 200
GET
/company/departments/{id}
Get department by ID
1 param → 200
PATCH
/company/departments/{id}
1 param body → 200
GET
/company/positions
List all positions for company
→ 200
POST
/company/positions
Add a PositionItem to company
body → 200
GET
/company/positions/{id}
Get Position by ID
1 param → 200
PATCH
/company/positions/{id}
1 param body → 200
GET
/company/state-tax-fields/{fips}
Get state tax fields by fips code
1 param → 200
PATCH
/company/state-tax-fields/{fips}
1 param body → 200
GET
/company/unprocessed-hours
Get unproccessed hours
→ 200
PUT
/company/unprocessed-hours
body → 200
GET
/company/pay-schedule-dates
Get important dates for a pay schedule
3 params → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are EmployeeDeductionItemBatch (19 properties), Company (16 properties), EmployeeDeductionItem (14 properties), TaxFields (14 properties). Each schema is shown below with its type and property counts.

DepartmentItem
object
3 properties
StateDisplayFieldsObject
object
2 properties
PaySchedule
object
8 properties
DisplayFieldsObject
object
5 properties
DeleteSuccessful
object
1 property
EmployeeDeductionItemBatch
object
19 properties
DeductionGroupingItem
object
7 properties
Company
object
16 properties
DeductionIncludedIn401kReports
string
L For Standard Deductions: include as loan in 401k reports S report as safe harbor Y include in deferral amounts N exclude
PatchSuccessful
object
1 property
ErrorBadRequest
object
2 properties
StateInformationObject
object
1 property
InsertSuccessful
object
2 properties
TaxFields
object
14 properties
LocationItem
object
3 properties
EmployeeDeductionItem
object
14 properties
PositionItem
object
3 properties
WorksiteItem
object
7 properties
DeductionType
integer
1 Section 125 2 401K 3 403B 4 457 6 Roth 401K 7 Roth 403B 8 FSA 9 HSA 10 Simple IRA 21 Post-tax 22 Cash tips imputed 23 Union dues 24 Imputed 25 Union dues bas…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onpay-company-api-openapi.yml Raw ↑

Other APIs OnPay publishes across the network.

OnPay Deductions API
AE Profile APIs.io
OnPay Employees API
AE Profile APIs.io
OnPay Pay Runs API
AE Profile APIs.io
OnPay Reports API
AE Profile APIs.io
OnPay User API
AE Profile APIs.io
#Company
← Back to O APIs
API Details
ID
onpay:onpay-company-api
Base URL
https://api.onpay.com/v2
Docs
https://onpay.readme.io/reference/authorization
Provider
OnPay
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=onpay-company-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/onpay-company-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of OnPay Company API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.