Sign in

v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Update Contractor Payment

patch/contractorPayment

Request body

companyIDstring required

companyID of the company

contractorPaymentIDstring required

ID of the contractor payment to be updated

contractorIDstring

ID of the contractor

approval_requiredboolean

Boolean determining if approval is required for a contractor payment

approvedboolean

Boolean determining if contractor payment is approved or not

pay_datestring date

Pay date of the contractor payment

amountinteger

Pay amount of the contractor payment

type'regular' | 'reimbursement'

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

metadataobject

Custom metadata object

customerAccountIDstring

ID of Customer Account associated with Contractor Payment

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "contractorPaymentID": "6sd3382d4232390024d3f627",
    "disbursement": {
      "method": "direct_deposit"
    },
    "status": "pending",
    "approval_required": true,
    "approved": true,
    "contractorID": "6283dqqe2391cc2a00257e2342",
    "companyID": "fc2323ccbae46aa8a083347715bcfa",
    "first_name": "Erlich",
    "last_name": "Bachman",
    "amount": 200,
    "pay_date": "2023-07-22",
    "metadata": {
      "example": "example"
    }
  }
}