Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
jobs

Create Received Payment

Use this endpoint to create a new payment received.

This endpoint is rate limited. Use the RateLimit-* response headers to check current limits and remaining quota.

post/jobs/{jobId}/payments/received

Path parameters

jobIdstring uuid required

The job's unique identifier

Request body

fromstring

Party from which the payment was received (e.g., Customer Name)

amountnumber required

The value of the received payment. Negative values are accepted (e.g., for adjustments).

paymentDatestring

Optional. An ISO 8601 string of the payment's datetime including the time component and ending with 'Z' (so in UTC). https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC). Only the date will be used, the time component will be ignored.

paymentMethodstring

Payment method (e.g., Check, Credit Card, ACH, Wire)

checkNumberstring

Reference number for the payment (e.g., Check Number, Transaction ID). Values exceeding 50 characters return a 400 validation error.

notesstring

Any notes or memo about the payment.

Example request

{
  "from": "Apex Roofing & Exteriors",
  "amount": 4250,
  "paymentDate": "2020-06-22T18:47:10Z",
  "paymentMethod": "Check",
  "checkNumber": "CHK-20482",
  "notes": "Initial deposit for insurance claim repair"
}

Response

Created

idstring uuid

The GUID of the payment.

paymentTypestring

Indicates the category of this payment. One of: Received Payment, Paid Payment, or Additional Expense.

isParentboolean

Indicates whether this payment has sub-payments. true when one or more sub-payments exist; false otherwise.

parentIdstring uuid nullable

The unique identifier of the parent payment. Present only on sub-payments; null for top-level payments.

lastEditedDatestring date-time

The date and time the payment was last modified, in UTC.

paymentMethodstring

Payment method (e.g., Check, Credit Card, ACH, Wire)

Example response

{
  "id": "68badf8c-ec30-4531-a357-ff57bf12717b",
  "paymentType": "Received Payment",
  "isParent": true,
  "parentId": "fd33bba2-cb19-4baa-b87c-47ee9e55d95e",
  "lastEditedDate": "2025-05-28T10:10:00Z",
  "paymentMethod": "Check"
}