AP Payments

Prev Next
Patch
/public/v1/accounting/accounts-payable/payments

Partial update AP Payments in batch

Security

The requesting user must have the following permission to approve AP payments:

  • Accounts Payable → AP Payments → Approve AP Payments

Approve and create are separate permissions — this permission does not grant create rights.

Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Body parameters
Expand All
object
payments
Array of object (PaymentPatchItem)

The collection of AP payments to approve or reject.

object
id
string (uuid)

Payment identifier to approve or reject.

approvalStatus
string

Approval status to set on the payment. Valid values: Approved, Rejected.

invoiceIds
Array of string

Invoices to associate with this payment.

string (uuid)
creditMemoIds
Array of string

Credit memos to associate with this payment.

string (uuid)
Responses
207

Multi-Status – Batch operation result containing status for each payment in the request.

Expand All
object
results
Array of object (PaymentPatchResult)

The result for each payment in the request.

object
requestIndex
integer (int32)

Zero-based index of the payment in the original request.

id
string (uuid)

Payment identifier.

status
string

Result status of the operation. Valid values: Unknown, Succeeded, Failed.

errorCode
string | null

Error code if the operation failed, otherwise null.

errorMessage
string | null

Error message if the operation failed, otherwise null.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.