Documentation Index

Fetch the complete documentation index at: https://docs.restaurant365.com/llms.txt

Use this file to discover all available pages before exploring further.

/public/v1/accounting/accounts-payable/payments

  • Published on Jun 17, 2026
  • 3 minute(s) read
Prev Next
Get
/public/v1/accounting/accounts-payable/payments

Retrieves payments. If no date filters are provided, results default to transactions from the current day.

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Query parameters
ModifiedOnStart
string (date-time)

Modified date start (inclusive)

ModifiedOnEnd
string (date-time)

Modified date end (inclusive)

DateStart
string (date)

Payment date (GL posting date) start (inclusive). If omitted, defaults to the start of the current day

DateEnd
string (date)

Payment date (GL posting date) end (inclusive). If omitted, defaults to the end of the current day

Status
string

Status. Valid values: Approved, Unapproved

PaymentNumbers
string

Payment numbers (comma-separated)

PaymentIds
string

Payment IDs (comma-separated UUIDs)

PageSize
integer (int32)

Number of results per page. Default: 250, Max: 250

Minimum1.0
Maximum250.0
Default250
ContinuationToken
string

Continuation token for pagination. Use the nextLink from a previous response to get the next page of results

Responses
200

Payment query results.

Expand All
object

Paginated response containing queried payments.

payments
Array of object (R365.Accounting.Public.Contracts.Payments.Models.Payment) | null

The collection of payments for the current page.

object

Payment model for the query payments public API response.

id
string (uuid)

Unique identifier (GUID) of the payment.

number
string | null

Payment number.

location
object (R365.Accounting.Public.Contracts.Payments.Models.LocationReference)

Location reference with optional legal entity.

id
string (uuid)

Unique identifier (GUID) of the location.

name
string | null

Display name of the location.

number
string | null

Location number.

legalEntity
object (R365.Accounting.Public.Contracts.Payments.Models.LegalEntityReference)

Legal entity reference.

id
string (uuid)

Unique identifier (GUID) of the legal entity.

name
string | null

Display name of the legal entity.

number
string | null

Legal entity number.

vendor
object (R365.Accounting.Public.Contracts.Payments.Models.VendorReference)

Vendor reference with id, name (CheckName), and number (AccountNumber).

id
string (uuid)

Unique identifier (GUID) of the vendor.

name
string | null

Vendor display name (check name).

number
string | null

Vendor account number.

date
string (date) | null

Date the payment was issued.

amount
number (double)

Total amount of the payment.

comment
string | null

Free-text comment or memo on the payment.

status
string | null

Approval status of the payment. Values are "Approved", "Unapproved".

checkingAccount
object (R365.Accounting.Public.Contracts.Payments.Models.GlAccountReference)

GL Account reference.

id
string (uuid)

Unique identifier (GUID) of the GL account.

name
string | null

Display name of the GL account.

number
string | null

GL account number.

glType
string | null

GL type name for this account.

appliedInvoices
Array of object (R365.Accounting.Public.Contracts.Payments.Models.AppliedInvoiceReference) | null

Invoices applied to this payment, if any.

object

Reference to an invoice applied to a payment.

id
string (uuid)

Unique identifier (GUID) of the invoice.

invoiceNumber
string | null

Invoice number.

appliedAmount
number (double)

Amount applied from this invoice toward the payment.

invoiceTotal
number (double)

Total amount of the invoice.

distributions
Array of object (R365.Accounting.Public.Contracts.Payments.Models.DistributionLine) | null

GL distribution lines for this payment, included when IncludeDistributions is true in the request.

object

A single GL distribution line for a posted transaction.

glAccount
object (R365.Accounting.Public.Contracts.Payments.Models.GlAccountReference)

GL Account reference.

id
string (uuid)

Unique identifier (GUID) of the GL account.

name
string | null

Display name of the GL account.

number
string | null

GL account number.

glType
string | null

GL type name for this account.

debit
number (double)

Debit amount on this distribution line. Zero when the line is a credit.

credit
number (double)

Credit amount on this distribution line. Zero when the line is a debit.

comment
string | null

Comment on this distribution line.

location
object (R365.Accounting.Public.Contracts.Payments.Models.LocationReference)

Location reference with optional legal entity.

id
string (uuid)

Unique identifier (GUID) of the location.

name
string | null

Display name of the location.

number
string | null

Location number.

legalEntity
object (R365.Accounting.Public.Contracts.Payments.Models.LegalEntityReference)

Legal entity reference.

id
string (uuid)

Unique identifier (GUID) of the legal entity.

name
string | null

Display name of the legal entity.

number
string | null

Legal entity number.

createdOn
string (date-time) | null

Timestamp when the payment was created.

createdBy
object (R365.Accounting.Public.Contracts.Payments.Models.UserReference)

User reference.

id
string (uuid)

Unique identifier (GUID) of the entity.

name
string | null

Display name of the entity.

modifiedOn
string (date-time) | null

Timestamp of the most recent modification.

modifiedBy
object (R365.Accounting.Public.Contracts.Payments.Models.UserReference)

User reference.

id
string (uuid)

Unique identifier (GUID) of the entity.

name
string | null

Display name of the entity.

approvedOn
string (date-time) | null

Timestamp when the payment was approved.

approvedBy
object (R365.Accounting.Public.Contracts.Payments.Models.UserReference)

User reference.

id
string (uuid)

Unique identifier (GUID) of the entity.

name
string | null

Display name of the entity.

attachments
Array of object (R365.Accounting.Public.Contracts.Payments.Models.TransactionAttachment) | null

Files attached to this payment.

object

File attachment linked to an AP transaction.

id
integer (int32)

Numeric identifier of the attachment.

storageFileName
string | null

Internal storage key or path for the file.

filename
string | null

Original file name as uploaded.

linkType
string | null

Link type indicating how the attachment is associated with the transaction.

publicUrl
string | null

Public URL to download the full attachment.

publicThumbnailUrl
string | null

Public URL for a thumbnail preview of the attachment, if available.

nextLink
string | null

The URL to retrieve the next page of results, or null if this is the last page.