Retrieves credit memos. If no filter of any kind is supplied, results are limited to the current day (UTC).
Security
The requesting user must have one of the following permissions to retrieve AP credit memos:
- Accounts Payable → AP Credit Memos → View AP Credit Memos Within Accounting
- Food → AP Credit Memos → View AP Credit Memos Within Food
Restricted-record access: the response excludes records that reference a restricted GL account or a restricted vendor unless the user also has:
- General Ledger → GL Accounts → Access Restricted GL Accounts
- Accounts Payable → Vendors → Access Restricted Vendors
Identifies the R365 tenant the request applies to. Required on every request.
Modified date start (inclusive)
Modified date end (inclusive)
Document date start (inclusive).
Document date end (inclusive).
Status. Valid values: Approved, Unapproved
Credit memo numbers (comma-separated)
Credit memo IDs (comma-separated UUIDs)
Maximum number of top-level objects to return in one page.
Continuation token for pagination. Use the nextLink from a previous response to get the next page of results
Credit memo query results.
Paginated response containing queried credit memos.
The collection of credit memos for the current page.
Credit memo model for the query credit memos public API response.
Unique identifier (GUID) of the credit memo.
Vendor-assigned credit memo number.
Location reference with optional legal entity.
Unique identifier (GUID) of the location.
Display name of the location.
Location number.
Legal entity reference.
Unique identifier (GUID) of the legal entity.
Display name of the legal entity.
Legal entity number.
Vendor reference with id, name (CheckName), and number (AccountNumber).
Unique identifier (GUID) of the vendor.
Vendor display name (check name).
Vendor account number.
How the vendor's transactions are entered. Present on every credit memo.
Date printed on the credit memo document.
GL posting date for the credit memo.
Total amount of the credit memo.
Free-text comment or memo on the credit memo.
Approval status. Always populated: "Approved" or "Unapproved".
Line items for this credit memo. Returned whenever the credit memo has lines; there is no request parameter controlling inclusion.
Credit memo detail line for the query credit memos public API response. Covers both item-based and GL-based entries.
Unique identifier of the detail line.
GL Account reference.
Unique identifier (GUID) of the GL account.
Display name of the GL account.
GL account number.
GL type name for this account.
Location reference with optional legal entity.
Unique identifier (GUID) of the location.
Display name of the location.
Location number.
Legal entity reference.
Unique identifier (GUID) of the legal entity.
Display name of the legal entity.
Legal entity number.
Free-text comment on this line.
Total amount for this line.
Inventory item reference.
Unique identifier (GUID) of the inventory item.
Display name of the inventory item.
Inventory item number.
Unit of measure reference.
Unique identifier (GUID) of the entity.
Display name of the entity.
Quantity for this line. Populated for item-based entries only.
Unit cost for this line. Populated for item-based entries only.
Vendor-specific item number. Populated for item-based entries only.
GL distribution lines for this credit memo. Always returned; an empty array when there are none. There is no request parameter controlling inclusion.
A single GL distribution line for a posted transaction.
GL Account reference.
Unique identifier (GUID) of the GL account.
Display name of the GL account.
GL account number.
GL type name for this account.
Debit amount on this distribution line. Zero when the line is a credit.
Credit amount on this distribution line. Zero when the line is a debit.
Comment on this distribution line.
Location reference with optional legal entity.
Unique identifier (GUID) of the location.
Display name of the location.
Location number.
Legal entity reference.
Unique identifier (GUID) of the legal entity.
Display name of the legal entity.
Legal entity number.
Timestamp when the credit memo was created.
User reference.
Unique identifier (GUID) of the entity.
Display name of the entity.
Timestamp of the most recent modification.
User reference.
Unique identifier (GUID) of the entity.
Display name of the entity.
Timestamp when the credit memo was approved.
User reference.
Unique identifier (GUID) of the entity.
Display name of the entity.
Files attached to this credit memo.
File attachment linked to an AP transaction.
Numeric identifier of the attachment.
Internal storage key or path for the file.
Original file name as uploaded.
Link type indicating how the attachment is associated with the transaction.
Public URL to download the full attachment.
Public URL for a thumbnail preview of the attachment, if available.
The URL to retrieve the next page of results, or null if this is the last page.
Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.
Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.
Forbidden — the caller lacks the permission required for this operation.
Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.
Conflict — the request conflicts with the current state of the resource and cannot be applied.
Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.
Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.
Internal Server Error — an unexpected error occurred while processing the request.