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/credit-memos

Prev Next
Get
/public/v1/accounting/accounts-payable/credit-memos

Retrieves credit memos. 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)

Document date start (inclusive). If omitted, defaults to the start of the current day

DateEnd
string (date)

Document date end (inclusive). If omitted, defaults to the end of the current day

Status
string

Status. Valid values: Approved, Unapproved

CreditMemoNumbers
string

Credit memo numbers (comma-separated)

CreditMemoIds
string

Credit memo 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

Credit memo query results.

Expand All
object

Paginated response containing queried credit memos.

creditMemos
Array of object (R365.Accounting.Public.Contracts.CreditMemos.Models.CreditMemo) | null

The collection of credit memos for the current page.

object

Credit memo model for the query credit memos public API response.

id
string (uuid)

Unique identifier (GUID) of the credit memo.

creditMemoNumber
string | null

Vendor-assigned credit memo number.

location
object (R365.Accounting.Public.Contracts.CreditMemos.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.CreditMemos.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.CreditMemos.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.

documentDate
string (date) | null

Date printed on the credit memo document.

glDate
string (date) | null

GL posting date for the credit memo.

documentAmount
number (double)

Total amount of the credit memo.

comment
string | null

Free-text comment or memo on the credit memo.

status
string | null

Approval status of the credit memo. Values are "Approved", "Unapproved".

details
Array of object (R365.Accounting.Public.Contracts.CreditMemos.Models.CreditMemoDetail) | null

Line items for this credit memo, included when IncludeDetails is true in the request.

object

Credit memo detail line for the query credit memos public API response. Covers both item-based and GL-based entries.

id
string (uuid)

Unique identifier of the detail line.

glAccount
object (R365.Accounting.Public.Contracts.CreditMemos.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.

location
object (R365.Accounting.Public.Contracts.CreditMemos.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.CreditMemos.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.

comment
string | null

Free-text comment on this line.

total
number (double) | null

Total amount for this line.

inventoryItem
object (R365.Accounting.Public.Contracts.CreditMemos.Models.InventoryItemReference)

Inventory item reference.

id
string (uuid) | null

Unique identifier (GUID) of the inventory item.

name
string | null

Display name of the inventory item.

itemNumber
string | null

Inventory item number.

uom
object (R365.Accounting.Public.Contracts.CreditMemos.Models.UomReference)

Unit of measure reference.

id
string (uuid)

Unique identifier (GUID) of the entity.

name
string | null

Display name of the entity.

quantity
number (double) | null

Quantity for this line. Populated for item-based entries only.

eachAmount
number (double) | null

Unit cost for this line. Populated for item-based entries only.

vendorItemNumber
string | null

Vendor-specific item number. Populated for item-based entries only.

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

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

object

A single GL distribution line for a posted transaction.

glAccount
object (R365.Accounting.Public.Contracts.CreditMemos.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.CreditMemos.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.CreditMemos.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 credit memo was created.

createdBy
object (R365.Accounting.Public.Contracts.CreditMemos.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.CreditMemos.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 credit memo was approved.

approvedBy
object (R365.Accounting.Public.Contracts.CreditMemos.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.CreditMemos.Models.TransactionAttachment) | null

Files attached to this credit memo.

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.