Integrations
Common integration patterns for the Netchex External API
These guides walk through the most common integration scenarios with complete code examples.
Guides
- Sync Employees — Pull employee roster data into your system
- Payroll Export — Export pay run data for GL, BI, or payroll reporting
- Time Data — Pull time punches and direct entry earnings for a pay period
Common Concepts
Know your company IDs
Most integrations start by discovering which companies your API key has access to. Use the organization structure endpoints:
GET /organizations?api-version=3.0The response includes companies nested under each organization. Store the companyId values — you'll pass them as filters to almost every other endpoint.
Use date ranges
Time-based endpoints (punches, earnings, payroll) require a start-date and end-date. Always align these to your pay period boundaries to avoid double-counting or missing records.
Page through large results
For any endpoint that returns a PagedResponse<T>, keep fetching until you've consumed all pages. See Pagination.
Handle access control silently
If a company-id or employee-id is not accessible to your key, it is silently excluded from results — you won't get a 403. Build your integration to handle empty responses gracefully.