Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Body

member
string
required
payday
string<date>
required
period_start
string<date>
required
period_end
string<date>
required
hours_worked
string<decimal>
required
Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
gross_pay
string<decimal>
required
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
payroll_provider_external_id
string | null
required

Unique identifier for the payroll payment in the payroll system.

Maximum string length: 255

Response

201 - application/json
id
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
member
string
required
payday
string<date>
required
period_start
string<date>
required
period_end
string<date>
required
hours_worked
string<decimal>
required
Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
gross_pay
string<decimal>
required
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
payroll_provider_external_id
string | null
required

Unique identifier for the payroll payment in the payroll system.

Maximum string length: 255