Create Received Payment

post

https://api.acculynx.com/api/v2/jobs/{jobId}/payments/received

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

jobId

uuid

required

The job's unique identifier

Body Params

from

string

length ≤ 250

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_UniversalTime(UTC). Only the date will be used, the time component will be ignored.

paymentMethod

string

length ≤ 50

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

checkNumber

string

length ≤ 50

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

notes

string

length ≤ 250

Any notes or memo about the payment.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

201Created

400Bad Request

401API Key is invalid or deactivated

404Requested resource does not exist.

429Too Many Requests