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: |
approval_required | boolean optional | Whether manual approval is required for this payment or not. By default, Zeal automatically processes the payment two business days 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 optional | Whether this payment has been manually approved or not (only relevant if |
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 |
amount | number | Amount to be paid to the contractor |
disbursement_status | string |
Show disbursement_status values
|
disbursement | object | This object includes information regarding how the pay is disbursed to the contractor. Zeal supports the following disbursement methods for contractors: Direct Deposit, Direct Deposit (Same Day), Physical Check, Prepaid, and Paycards (Early Access).
|
type | string | Type of payment. Only |
speed | string | The ACH speed of the check, accepts |
triggered | boolean | Whether a disbursement has been triggered for this contractor payment. Only applicable to contractor payments of disbursement method |
triggered_at | datetime | Timestamp of when the disbursement was triggered, in the ISO-8601 format in UTC. |
customerAccountID (Early Access) | string | Can be used to attach a customer account to a contractor payment |
{
"contractorPaymentID": "246863894",
"contractorID": "1234567890",
"companyID": "0987654321",
"status": "pending",
"approval_required": false,
"approved": false,
"pay_date": "2024-10-01",
"amount": "100",
"disbursement_status": "pending",
"disbursement": {
"method": "direct_deposit"
},
"type": "regular",
"triggered": true,
"triggered_at": "2025-03-04T23:18:09Z",
"customerAccountID": null
}