API Reference

Get Contractor Payments

get
https://api.zeal.com/contractorPayment
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

Return

Returns response status and the contractor payment.

attributetypedescription
successbooleanResponse status
dataobjectContractor Payment object
errorsarrayIf 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)

Query Params
string
required

Company ID of the employer

string

Contractor ID of contractor

string
enum

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

Allowed:
string

Filter by contractor payment group

string

The pagination cursor to start at

string

Limit the amount of data returned

Responses

Updated about 2 months ago

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

Updated about 2 months ago