Skip to main content
PATCH
Update Payment Item
Updates an existing Payment Item.
earning_type cannot be changed from rate-based to fixed amount or vice versa.

Authorizations

Authorization
string
header
required

Body

application/json
companyID
string
required

ID of company

paymentItemID
string
required

ID of payment item

contractorPaymentID
string

ID of contractor payment that this payment item will be added to

work_info
object
earning_type
enum<string>

Note: earning_type cannot be changed from rate-based to fixed amount or vice versa.

Available options:
hourly,
per_unit,
flat_fee,
expense_reimbursement,
bonus
quantity
number<float>

Only required if earning_type is hourly or per_unit

rate
number<float>

Only required if earning_type is hourly or per_unit

bill_rate
number<float>

Only applicable if earning_type is hourly or per_unit

gross_amount
number<float>

Only required if earning_type is flat_fee, expense_reimbursement, or bonus

bill_amount
string

Only applicable if earning_type is flat_fee, expense_reimbursement, or bonus

Response

200 - application/json
success
boolean
data
object

Contains Payment Item object

testMode
boolean