v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB

jobs

Create Paid Payment

Use this endpoint to create a new payment paid.

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

post/jobs/{jobId}/payments/paid

Path parameters

jobIdstring uuid required

The job's unique identifier

Request body

tostring

Payment paid to

paymentMethodstring

Payment method used to perform the payment

amountnumber float required

Amount of payment paid

paymentDatestring date-time

An ISO 8601 string of the payment's datetime including the time component and ending with 'Z' (so in UTC). Note: Only the date is taken into account. The time component is discarded. https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)

notesstring

Optional note for the payment.

accountTypeIdstring uuid

Id of account type

refNumberstring

isPaidboolean

Is Paid?

Example request

{
  "to": "John Doe",
  "paymentMethod": "Credit Card",
  "amount": 5000,
  "paymentDate": "2020-06-22T00:00:00Z",
  "notes": "Note for the payment",
  "accountTypeId": "67f032b0-4780-40c3-b907-76635115b735",
  "refNumber": "AA11BB2233"
}

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"
}