---
title: "[DRAFT] Get Job Payment by ID"
method: GET
path: "/jobs/{jobId}/payments/{paymentId}"
tags: ["jobs"]
---

# \[DRAFT\] Get Job Payment by ID

`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

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.

## Path parameters

- `jobId` string, uuid, required
- `paymentId` string, uuid, required

## Response `200`

OK

- union
  - PaidPayment
    - `id` string, uuid: The GUID of the payment.
    - `paymentType` string: Indicates the category of this payment. One of: `Received Payment`, `Paid Payment`, or `Additional Expense`.
    - `isParent` boolean: Indicates whether this payment has sub-payments. `true` when one or more sub-payments exist; `false` otherwise.
    - `parentId` string, uuid, nullable: The unique identifier of the parent payment. Present only on sub-payments; `null` for top-level payments.
    - `lastEditedDate` string, date-time: The date and time the payment was last modified, in UTC.
    - `paymentMethod` string: Payment method (e.g., Check, Credit Card, ACH, Wire)
    - `refNumber` string: Reference number associated with the payment. Max 50 characters.
    - `isPaid` boolean: Indicates whether the payment has been paid in full.
    - `accountTypeId` string, uuid: The unique identifier of the account type associated with this payment.
    - `to` string: The entity or person to whom the payment was made. Max 250 characters.
    - `amount` number, float: The signed transaction amount.
    - `notes` string: Optional memo or notes associated with the payment.
    - `paymentDate` string, date-time: The date the payment was made. The time component is always midnight UTC (e.g. 2022-06-22T00:00:00Z).
    - `surchargeFee` SurchargeFee
      - `amount` number, float: Amount of surcharge payment
      - `percentage` number, float: The surcharge rate applied as a percentage of the transaction amount.
      - `description` string: An optional label or note describing this surcharge.
    - `convenienceFee` ConvenienceFee
      - `amount` number, float: Amount of convenience fee
      - `description` string: Optional note for the convenience fee
      - `source` string: The payment method used to process this convenience fee (e.g., ACH, Credit Card).
    - `convenienceFeeRefund` ConvenienceFeeRefund
      - `amount` number, float: The refunded convenience fee amount.
      - `description` string: An optional label or note for this refund.
      - `date` string, date-time: The date the convenience fee was refunded. The time component is always midnight UTC.
    - `system` string: Read-only. Identifies the integration system associated with this payment. Known values: 'AccuPay', 'Sage Intacct', 'QuickBooks Online', 'QuickBooks Desktop'. When multiple systems are active, values are combined as a comma-separated string. Null when no integration system is associated.
  - ReceivedPayment
    - `id` string, uuid: The GUID of the payment.
    - `paymentType` string: Indicates the category of this payment. One of: `Received Payment`, `Paid Payment`, or `Additional Expense`.
    - `isParent` boolean: Indicates whether this payment has sub-payments. `true` when one or more sub-payments exist; `false` otherwise.
    - `parentId` string, uuid, nullable: The unique identifier of the parent payment. Present only on sub-payments; `null` for top-level payments.
    - `lastEditedDate` string, date-time: The date and time the payment was last modified, in UTC.
    - `paymentMethod` string: Payment method (e.g., Check, Credit Card, ACH, Wire)
    - `checkNumber` string: The check or reference number associated with the payment. Max 50 characters.
    - `from` string: The entity or person from whom the payment was received. Max 250 characters.
    - `amount` number, float: The signed transaction amount.
    - `notes` string: Optional memo or notes associated with the payment.
    - `paymentDate` string, date-time: The date the payment was received. The time component is always midnight UTC (e.g. 2022-06-22T00:00:00Z).
    - `surchargeFee` SurchargeFee
      - `amount` number, float: Amount of surcharge payment
      - `percentage` number, float: The surcharge rate applied as a percentage of the transaction amount.
      - `description` string: An optional label or note describing this surcharge.
    - `convenienceFee` ConvenienceFee
      - `amount` number, float: Amount of convenience fee
      - `description` string: Optional note for the convenience fee
      - `source` string: The payment method used to process this convenience fee (e.g., ACH, Credit Card).
    - `convenienceFeeRefund` ConvenienceFeeRefund
      - `amount` number, float: The refunded convenience fee amount.
      - `description` string: An optional label or note for this refund.
      - `date` string, date-time: The date the convenience fee was refunded. The time component is always midnight UTC.
    - `system` string: Read-only. Identifies the integration system associated with this payment. Known values: 'AccuPay', 'Sage Intacct', 'QuickBooks Online', 'QuickBooks Desktop'. When multiple systems are active, values are combined as a comma-separated string. Null when no integration system is associated.
  - AdditionalExpense
    - `id` string, uuid: The GUID of the payment.
    - `paymentType` string: Indicates the category of this payment. One of: `Received Payment`, `Paid Payment`, or `Additional Expense`.
    - `isParent` boolean: Indicates whether this payment has sub-payments. `true` when one or more sub-payments exist; `false` otherwise.
    - `parentId` string, uuid, nullable: The unique identifier of the parent payment. Present only on sub-payments; `null` for top-level payments.
    - `lastEditedDate` string, date-time: The date and time the payment was last modified, in UTC.
    - `paymentMethod` string: Payment method (e.g., Check, Credit Card, ACH, Wire)
    - `refNumber` string: Reference number associated with the payment. Max 50 characters.
    - `isPaid` boolean: Indicates whether the payment has been paid in full.
    - `to` string: The entity or person to whom the payment was made. Max 250 characters.
    - `amount` number, float: The signed transaction amount.
    - `notes` string: Optional memo or notes associated with the payment.
    - `accountTypeId` string, uuid: The unique identifier of the account type associated with this payment.
    - `transactionDate` string, date-time: The date of the transaction. The time component is always midnight UTC (e.g. 2026-05-01T00:00:00Z).

## Other responses

- `400`: The request was malformed or contained invalid field values. Check the error response body for details.
- `401`: The API key provided is missing, invalid, or has been deactivated. Verify your API key and try again.
- `404`: The requested resource was not found. Verify the ID in the request path is correct and that the resource exists.
- `500`: Internal Server Error. The issue has been logged and will be reviewed as soon as possible.

## Changes

- **2026-11-03** `443924b00f43`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/acculynx/apis/acculynx-api-v2/changes/jobs/:jobId/payments/:paymentId/get.md)

---

[API](https://skmtc.dev/acculynx/apis/acculynx-api-v2.md) - [All operations](https://skmtc.dev/acculynx/apis/acculynx-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/acculynx/apis/acculynx-api-v2/revisions/443924b00f43?raw)