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

attribute type description
paymentItemID string Unique identifier representing this payment item
companyID string Company ID that this customer account is under
contractorID string ID of contractor
contractorPaymentID string ID contractor payment that this payment item is associated with
work_info object Contains:
work_description: Custom description of payment item (string)
service_date: Datetime of service completed (string)
earning_type string Can be one of the following:
hourly
per_unit
flat_fee
expense_reimbursement
bonus
rate float Only required if earning_type is hourly or per_unit
rate_unit float Only required if earning_type is hourly or per_unit. Can be one of the following:
hour
project
piece
quantity float Only required if earning_type is hourly or per_unit
bill_rate float Only applicable if earning_type is hourly or per_unit
gross_amount float Only required if earning_type is flat_fee, expense_reimbursement, or bonus
bill_amount float Only applicable if earning_type is flat_fee, expense_reimbursement, or bonus

Example JSON

{
  "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
}