---
title: "Create Received Payment"
method: POST
path: "/jobs/{jobId}/payments/received"
tags: ["jobs"]
---

# Create Received Payment

`POST /jobs/{jobId}/payments/received`

## Request

- Base URL: `https://api.acculynx.com/api/v2`
- URL: `https://api.acculynx.com/api/v2/jobs/{jobId}/payments/received`
- Auth: HTTP bearer

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.

## Path parameters

- `jobId` string, uuid, required

## Request body

- PaymentReceived
  - `from` string: Party from which the payment was received (e.g., Customer Name)
  - `amount` number, required: The value of the received payment. Negative values are accepted (e.g., for adjustments).
  - `paymentDate` string: 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.
  - `paymentMethod` string: Payment method (e.g., Check, Credit Card, ACH, Wire)
  - `checkNumber` string: Reference number for the payment (e.g., Check Number, Transaction ID). Values exceeding 50 characters return a 400 validation error.
  - `notes` string: Any notes or memo about the payment.

## Response `201`

Created

- PaymentLink
  - `id` string, uuid: The GUID of the payment.
  - `paymentType` string: Indicates the category of this payment. One of: `Received Payment`, `Paid Payment`, or `Additional Expense`.
  - `isParent` boolean: Indicates whether this payment has sub-payments. `true` when one or more sub-payments exist; `false` otherwise.
  - `parentId` string, uuid, nullable: The unique identifier of the parent payment. Present only on sub-payments; `null` for top-level payments.
  - `lastEditedDate` string, date-time: The date and time the payment was last modified, in UTC.
  - `paymentMethod` string: Payment method (e.g., Check, Credit Card, ACH, Wire)

## Other responses

- `400`: The request was malformed or contained invalid field values. Check the error response body for details.
- `401`: The API key provided is missing, invalid, or has been deactivated. Verify your API key and try again.
- `404`: The requested resource was not found. Verify the ID in the request path is correct and that the resource exists.
- `429`: The rate limit for this operation has been exceeded. Use the RateLimit-* response headers to determine when you can retry.

---

[API](https://skmtc.dev/acculynx/apis/acculynx-api-v2.md) - [All operations](https://skmtc.dev/acculynx/apis/acculynx-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/acculynx/apis/acculynx-api-v2/revisions/443924b00f43?raw)