--- title: "Get Job Payments" method: GET path: "/jobs/{jobId}/payments" tags: ["jobs"] --- # Get Job Payments `GET /jobs/{jobId}/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. ## Path parameters - `jobId` string, uuid, required ## Response `200` OK - JobPayments — All payment records for the job, organized by payment category. - `paidPayments` PaidPayments - `total` number, float — The total sum of all paid payment amounts in this group. - `paidPayments` 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. - `receivedPayments` ReceivedPayments - `total` number, float — The total sum of all received payment amounts in this group. - `receivedPayments` 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. - `additionalExpenses` AdditionalExpenses - `total` number, float — The total sum of all additional expense amounts in this group. - `additionalExpenses` 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` — Bad Request - The server cannot process the request due to a client error. Common causes: - Invalid request format - Missing required fields - Validation errors in the request data - `401` — Unauthorized - Authentication is required or has failed. Common causes: - Missing API key - Invalid API key - Expired or deactivated API key - `404` — Not Found - The requested resource does not exist. Common causes: - Invalid subscription ID - Subscription has been deleted - URL path contains typos or incorrect values --- [API](https://skmtc.net/acculynx/apis/acculynx-api-v2.md) · [All operations](https://skmtc.net/acculynx/apis/acculynx-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/acculynx/acculynx-api-v2/revisions/3a9e3886e400/schema)