Sign in
Job Payments

Create a new Job Payment

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-c39e-4623-b7ab-230b7de19c1b",
  "edit_date": "2025-07-01 12:00:00",
  "job_uuid": "123e4567-b16c-4867-9a70-230b736fc07b",
  "actioned_by_uuid": "123e4567-8e63-4c13-8a26-230b704d719b",
  "attachment_uuid": "123e4567-7dce-4f04-ae7f-230b76eb6a6b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes