jobs
Get Job Payments
Returns all payment records associated with the specified job, organized into three groups: received payments (amounts collected from the customer), paid payments (amounts paid to vendors or subcontractors), and additional expenses. Each group includes the total sum of its item amounts. Payments may be structured as parent payments with one or more sub-payments; sub-payments reference their parent via the parentId field.
get/jobs/{jobId}/payments
Path parameters
jobIdstring uuid required
The job's unique identifier
Response
OK
Example response
{
"paidPayments": {
"total": 100,
"paidPayments": [
{
"id": "68badf8c-ec30-4531-a357-ff57bf12717b",
"paymentType": "Received Payment",
"isParent": true,
"parentId": "fd33bba2-cb19-4baa-b87c-47ee9e55d95e",
"lastEditedDate": "2025-05-28T10:10:00Z",
"paymentMethod": "Check",
"refNumber": "3423",
"isPaid": true,
"accountTypeId": "a646a794-4265-4b2b-bf01-1aa4afe127de",
"to": "Company name",
"amount": 100,
"notes": "Payment for labor and materials per contract",
"paymentDate": "2022-06-22T00:00:00Z",
"surchargeFee": {
"amount": 2,
"percentage": 3,
"description": "Credit card surcharge"
},
"convenienceFee": {
"amount": 2,
"description": "Convenience fee note",
"source": "ACH"
},
"convenienceFeeRefund": {
"amount": 2,
"description": "ACH convenience fee refund",
"date": "2025-07-14T00:00:00Z"
},
"system": "QuickBooks Online"
}
]
},
"receivedPayments": {
"total": 100,
"receivedPayments": [
{
"id": "68badf8c-ec30-4531-a357-ff57bf12717b",
"paymentType": "Received Payment",
"isParent": true,
"parentId": "fd33bba2-cb19-4baa-b87c-47ee9e55d95e",
"lastEditedDate": "2025-05-28T10:10:00Z",
"paymentMethod": "Check",
"checkNumber": "3423",
"from": "Company name",
"amount": 100,
"notes": "Initial deposit for roof replacement",
"paymentDate": "2022-06-22T00:00:00Z",
"surchargeFee": {
"amount": 2,
"percentage": 3,
"description": "Credit card surcharge"
},
"convenienceFee": {
"amount": 2,
"description": "Convenience fee note",
"source": "ACH"
},
"convenienceFeeRefund": {
"amount": 2,
"description": "ACH convenience fee refund",
"date": "2025-07-14T00:00:00Z"
},
"system": "AccuPay"
}
]
},
"additionalExpenses": {
"total": 100,
"additionalExpenses": [
{
"id": "68badf8c-ec30-4531-a357-ff57bf12717b",
"paymentType": "Received Payment",
"isParent": true,
"parentId": "fd33bba2-cb19-4baa-b87c-47ee9e55d95e",
"lastEditedDate": "2025-05-28T10:10:00Z",
"paymentMethod": "Check",
"refNumber": "3423",
"to": "Company name",
"amount": 100,
"notes": "Building permit fee for storm damage repair",
"accountTypeId": "a646a794-4265-4b2b-bf01-1aa4afe127de",
"transactionDate": "2026-05-01T00:00:00Z"
}
]
}
}