Get contractor payments report

Returns the specified contractor payments report.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns a report of contractor payments for a company within a given date range, including pay period details, amounts, and reimbursements.

Response Columns/Fields

ColumnDescription
PayrollThe public ID of the payroll containing this payment
Period StartThe start date of the pay period
Period EndThe end date of the pay period
PaydayThe date the contractor payment is scheduled
First NameContractor's first name
Last NameContractor's last name
BusinessContractor's business name (if specified)
AmountThe gross payment amount
ReimbursementThe reimbursement amount included in this payment
Net PayThe net pay amount (Amount minus Reimbursement)

Notes

  • By default, only includes payments from approved payrolls (excludes drafts)
  • Use the preview parameter to include contractor payments from draft payrolls
Path Params
string
required

ID of the company with the contractor report to return

Query Params
date

Filter on payrolls with a payday on or after this date.

date

Filter on payrolls with a payday before or on this date.

string

Filter on payroll(s) with this ID. To specify multiple payrolls, repeat this query parameter. (For example: "&payroll=pay_123&payroll=pay_456&...")

boolean

Include to show the report for contractor payments on draft payrolls

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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