Get Contractor Payments

Time	Status	User Agent
Make a request to see history.

The URL for this request expired after 30 days.

Given the Contractor Payment ID, Zeal returns information for this Contractor Payment.

Return

Returns response status and the contractor payment.

attribute	type	description
success	boolean	Response status
data	object	Contractor Payment object
errors	array	If `success` is false, errors contains a list of error objects. Show child attributes message type: string description: Error message status type: number description: HTTP response code code type: number description: Error code (see Error codes)

companyID

string

required

Company ID of the employer

contractorID

string

Contractor ID of contractor

status

string

enum

Filter by status of contractor payment. Provide one of the following statuses: pending, pre-processed, processed

allowed:

pending pre-processed processed

paymentGroupID

string

Filter by contractor payment group

start_at

string

The pagination cursor to start at

limit

string

Limit the amount of data returned

Updated 2 months ago

ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request GET \

--url https://api.zeal.com/contractorPayment \

--header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200 - Result400 - Result

Updated 2 months ago