The contractor payment object

Contractor payments are created during payroll creation, or via directly creating one via the Contractor Payment API.

Note only one contractor payment is allowed per contractor per payroll.

{
    "id": "cpa_TVtTrPuPOgLuMDlt7FqJ",
    "payroll": "pay_jIjPJa7Q8cG6s0TWUdLm",
    "contractor": "ctr_90QzaH9xPRI7JRLXnRoU",
    "status": "pending",
    "payment_method": "direct_deposit",
    "amount": "2100.00",
    "reimbursement_amount": "0.00",
    "net_pay": "2100.00",
    "paper_check_number": null,
    "workplace": "wrk_qbCnBhUIDzduGrwLJ83p",
    "metadata": {}
}

Attribute	Description
id string	Unique identifier for the contractor payment.
payroll string	ID of the payroll object that this contractor payment relates to.
contractor string	ID of the contractor that this contractor payment relates to.
status string	Status of the contractor payment. One of `draft`, `pending`, `processing`, `failed`, `partially_paid`, or `paid`.
payment_method string	Payment method for the contractor payment. Possible values are `manual` and `direct_deposit`.
amount string	Amount paid to the contractor for this payment.
reimbursement_amount string	Reimbursement amount paid to the contractor for this payment. Note: *This field will not be included on the contractor’s 1099.
net_pay string	Read only. The total amount of net pay earned by the contractor for this payroll item. The formula for net pay is `amount` + `reimbursement_amount`. This will be `null` except during payroll preview and/or after approval.
paper_check_number string	For accounting. The check number associated with any printed checks. Can be updated even after the associated payroll has been approved. See Get a paper check for more details.
workplace string	The Workplace ID associated with this payment.
metadata object	Additional loosely structured information to associate with this contractor payment.