ACacculynx
jobs

[DRAFT] Get Job Payment by ID

Changed on

Retrieves a payment by its unique identifier for the given job. The response type is determined by the paymentType discriminator and will be one of Paid Payment, Received Payment, or Additional Expense. Surcharge fee, convenience fee, and convenience fee refund fields are only present in Paid Payment and Received Payment responses.

get/jobs/{jobId}/payments/{paymentId}

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/jobs/{jobId}/payments/{paymentId}
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

The job's unique identifier

paymentIdstring uuid required

The payment's unique identifier

Response

OK

OR
OR

Example response

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

Changes