Contractor Payment Object

The Contractor Payment Object represents a payment made out to a Contractor Object

attribute

type

description

contractorPaymentID

string

Zeal Contractor Payment ID

contractorID

string

Zeal Contractor ID

companyID

string

Zeal Company ID

status

string

Holds one of the following values:
pending
pre-processed
processed

approval_required

boolean

optionaloptional - optional, default is false

Whether manual approval is required for this payment or not. By default, Zeal automatically processes the payment the day before the pay date. However, if approval is required and the payment is not approved by time of processing, Zeal will NOT process the payment.

approved

boolean

optionaloptional - optional, default is false

Whether this payment has been manually approved or not (only relevant if approval_required is true)

pay_date

date

Date of Pay Date for this contractor payment, in the ISO-8601 format in UTC. Zeal will pay this contractor on this date. Example 2019-10-01

amount

number

Amount to be paid to the contractor

disbursement

string

The disbursement method in which the contractor will be paid. Options are:
prepaid
direct_deposit

{
 "contractorPaymentID": "246863894",
 "contractorID": "1234567890",
 "companyID": "0987654321",
 "status": "pending",
 "approval_required": false,
 "approved": false,
 "pay_date": "2019-10-01",
 "amount": 100,
 "disbursement": "direct_deposit",
}