Sign in
Job Payments

Update a Job Payment

OAuth Scope

This endpoint requires the following OAuth scope manage_job_payments.

post/jobpayment/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Job Payment

Request body

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

Example request

{
  "job_uuid": "123e4567-7a73-4e8b-8b79-23f9426e19eb",
  "actioned_by_uuid": "123e4567-054b-4281-8dc1-23f94dabec6b",
  "timestamp": "2026-03-01 12:00:00",
  "attachment_uuid": "123e4567-c48c-46e4-98a5-23f947b3a76b",
  "uuid": "123e4567-383d-4b1e-8e1e-23f945734a2b"
}

Response

Success - The record was updated successfully

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

Changed in 3 of the 50 revisions of this API.26

  • 638a8df09bf42See the full diff
    • ●

      removed the request property active

      request-property-removed

    • ●

      removed the request property is_deposit

      request-property-removed

  • ca9b053c43735See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

  • e859f8c27a211See the full diff
    • ○

      the security scope manage_job_payments was added to the endpoint's security scheme oauth2

      api-security-scope-added