Create Payroll Payment

curl --request POST \ --url https://sandbox.withclasp.com/payroll_payments \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "member": "<string>", "payday": "2023-12-25", "period_start": "2023-12-25", "period_end": "2023-12-25", "hours_worked": "<string>", "gross_pay": "<string>", "payroll_provider_external_id": "<string>" } '

{ "id": "<string>", "member": "<string>", "payday": "2023-12-25", "period_start": "2023-12-25", "period_end": "2023-12-25", "hours_worked": "<string>", "gross_pay": "<string>", "payroll_provider_external_id": "<string>" }

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

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