v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Contractor Payment

post/contractorPayment

Request body

companyIDstring required

Company ID of employer

contractorIDstring required

ID of Contractor that needs to be paid out

approval_requiredboolean

Set to true if this payment requires manual approval by the employer. Otherwise, by default, Zeal will automatically process the payment two business days before the pay_date

pay_datestring date required

Pay date for this payment. Formatted as a date in ISO-8601 format (YYYY-MM-DD). If the pay_date falls on a weekend/bank holiday or the current time is after 2 PM two days before the given pay_date, please correct the date and resubmit. We will not roll forward the pay_date automatically

amountnumber float

Amount that needs to be paid out. Only required if no payment items are present.

payment_itemsobject[]

Array of payment item objects. If payment items are present, amount is not required.

Accepts two_day, one_day, one_day_no_reserve, zero_day,zero_day_no_reserve or instant as values (Early Access)

type'regular' | 'reimbursement'

Type of payment. Only regular payments are reported on a contractor's Form 1099-NEC.

customerAccountIDstring

ID of Customer Account associated with this Contractor Payment

apply_contractor_deductionsboolean

Applies a deduction to this check for each contractor deduction template that is effective at the time of the pay date for the contractor. Note: Only applicable when payment_items is provided

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "contractorPaymentID": "0987654321",
    "status": "pending",
    "disbursement_status": "pending",
    "first_name": "erlich",
    "last_name": "bachman",
    "companyID": "1b5n28nrideucd24",
    "contractorID": "123456789",
    "pay_date": "2023-10-01",
    "amount": "100",
    "metadata": {
      "example": "example"
    }
  }
}