GuidesAPI Reference
Log In
API Reference

/companies/{company_id}/submit-payroll/

Submit payroll for a company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

A Payroll File is a single payroll for a company with many pay lines, one for each participant.

There are a couple dates that can be provided for a payroll file, but check_date is the only required one. is_off_cycle can be true if this is not a regular payroll. For example, it could be a one-off correction.

date | null
date | null
date
required
boolean
payroll_lines
array of objects
required
payroll_lines*
Headers
string

Supply a key to safely retry requests without the server duplicating the action. Will be remembered for 24 hours.

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

Bad Request: Invalid payroll data

401

Unauthorized: Missing or invalid authentication

403

Forbidden: Insufficient permissions or scopes

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json