Sign in
Job Payments

Create a new Job Payment

OAuth Scope

This endpoint requires the following OAuth scope manage_job_payments.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/jobpayment.json

Request body

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

job_uuidstring uuid
actioned_by_uuidstring uuid
timestampstring
amountstring
methodstring
notestring
attachment_uuidstring uuid
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 request

{
  "uuid": "123e4567-098f-4703-af52-2329b805621b",
  "edit_date": "2025-08-01 12:00:00",
  "job_uuid": "123e4567-a45c-4c44-8303-2329bb578bab",
  "actioned_by_uuid": "123e4567-111d-4a26-9bc2-2329bff5523b",
  "timestamp": "2025-08-01 12:00:00",
  "attachment_uuid": "123e4567-3424-473e-ad0d-2329be281a6b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes