v50

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

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

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

errorCodenumber

messagestring

Example response

{
  "message": "OK"
}