v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-211931021.7 MB

Job Payments

Retrieve a Job Payment

OAuth Scope

This endpoint requires the following OAuth scope read_job_payments.

get/jobpayment/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Job Payment

Response

Job Payment record retrieved successfully

job_uuidstring uuid

UUID of the job this payment is associated with. Each payment must be linked to a valid job in the system.

actioned_by_uuidstring uuid

UUID of the staff member who recorded or processed this payment. Used for tracking which staff member handled the transaction.

timestampstring

The date and time when this payment was recorded or processed. Format is YYYY-MM-DD HH:MM:SS. Used for payment reconciliation and reporting.

amountstring

The payment amount in the account's currency.

methodstring

The payment method used for this transaction. Examples include 'Cash', 'Credit Card', 'Bank Transfer', 'Stripe', etc.

notestring

Optional text field for storing additional information about the payment. Can be used to record reference numbers, transaction IDs, or other payment-specific details.

attachment_uuidstring uuid

UUID linking to a stored attachment related to this payment, such as a receipt image. This is an optional reference to an Attachment record.

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

is_deposit0 | 1

Boolean flag indicating whether this payment represents a deposit against future work (true) rather than a payment for completed work (false). Read-only in the API. (Read only). Valid values are [0,1]

Example response

{
  "job_uuid": "123e4567-52d9-4ebf-90e2-23f94becbc6b",
  "actioned_by_uuid": "123e4567-8da6-4ee1-80d7-23f94bef2c5b",
  "timestamp": "2026-03-01 12:00:00",
  "attachment_uuid": "123e4567-87d1-48a8-b9eb-23f94e2b2dbb",
  "uuid": "123e4567-94c7-49a9-bdc8-23f942f1a29b",
  "edit_date": "2026-03-01 12:00:00"
}