Payment Item Object

Payment items represent individual line items within a contractor payment. They can reference a service type or be standalone. Payment items can only be added to contractor payment with the status pending

attributetypedescription
paymentItemIDstringUnique identifier representing this payment item
companyIDstringCompany ID that this customer account is under
contractorIDstringID of contractor
contractorPaymentIDstringID contractor payment that this payment item is associated with
work_infoobject

Contains:

work_description: Custom description of payment item (string)
service_date: Datetime of service completed (string)

earning_typestring

Can be one of the following:

hourly
per_unit
flat_fee
expense_reimbursement
bonus

ratefloatOnly required if earning_type is hourly or per_unit
rate_unitfloat

Only required if earning_type is hourly or per_unit. Can be one of the following:

hour
project
piece

quantityfloatOnly required if earning_type is hourly or per_unit
bill_ratefloatOnly applicable if earning_type is hourly or per_unit
gross_amountfloatOnly required if earning_type is flat_fee, expense_reimbursement, or bonus
bill_amountfloatOnly applicable if earning_type is flat_fee, expense_reimbursement, or bonus
{
  "paymentItemID": "a3f9c2d1e6b74a8f9c3d2b1e7f8a9c01",
  "companyID": "fc235f012bae46aa8a082f357715bcfa",
  "contractorID": "669fe6216d9eff8ca4c9f0de",
  "contractorPaymentID": "68ffb95239326ca8713eadb1",
  "work_info": {
    "work_description": "Bartending service",
    "service_date": "2026-03-20"
  },
  "earning_type": "hourly",
  "quantity": 8,
  "rate": 30.00,
  "bill_rate": 65.00
}