AP Payments

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

Create AP Payments in batch

Security

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

  • Accounts Payable → AP Payments → Create Manual AP Payments

Create and approve are separate permissions — this permission does not grant approval 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 (PaymentCreateItem) Required

The list of AP payments to create.

object
locationId
string (uuid) Required

The identifier of the location for the payment. Required.

vendorId
string (uuid) Required

The identifier of the vendor being paid. Required.

bankGlAccountId
string (uuid) Required

The identifier of the bank GL account used for the payment. Required.

paymentDate
string (date) Required

The date of the payment. Required.

paymentAmount
number (decimal) Required

The amount of the payment. Required.

comment
string | null

Optional comment for the payment.

checkNumber
string | null

Optional check number associated with the payment.

Responses
207

Multi-Status – batch operation result containing per-payment success or failure.

Expand All
object
results
Array of object (PaymentCreateResult)

Per-payment results for the batch operation.

object
requestIndex
integer (int32)

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

vendorId
string (uuid)

The vendor identifier from the original request.

status
string

Result status of this payment. Valid values: Unknown, Succeeded, Failed.

errorCode
string | null

Error code if the payment failed, otherwise null.

errorMessage
string | null

Human-readable error message if the payment failed, otherwise null.

id
string (uuid) | null

The identifier of the created payment if succeeded, 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.