Getting Started

Quick Start Guide

Get up and running with Payflo in minutes.

6 min read

The object model

Four objects carry most of the system. A company owns employees; employees belong to a pay schedule; a payroll run pays employees for one period on one schedule.

  • Company — legal entity, tax accounts, funding source
  • Employee — person, compensation, withholding elections
  • Pay schedule — frequency, pay dates, approval cutoffs
  • Payroll run — one period's calculation and payment

Environments

Sandbox and production are fully separate: different keys, different data, no shared state. Sandbox never moves money or files a return, and tax calculations there use the same engine as production.

Your first request

curl https://api.payflo.dev/v1/companies \
  -H "Authorization: Bearer $PAYFLO_API_KEY" \
  -d legal_name='Acme Corp' \
  -d ein='12-3456789'

Versioning

The API is versioned by URL path. Breaking changes ship as a new version; additive changes land in place. Versions are supported for 24 months after their successor is released.