Retrieves transactions. At least one complete date range must be provided: ModifiedOn (ModifiedOnStart and ModifiedOnEnd) or DateOfBusiness (DateOfBusinessStart and DateOfBusinessEnd)
Security
Access is evaluated per transaction type. The requesting user must have the View permission for each transaction type they want included in the response:
| Transaction type | Permission |
|---|---|
| AP Invoice | Accounts Payable → AP Invoices → View AP Invoices Within Accounting (or Food equivalent) |
| AP Credit Memo | Accounts Payable → AP Credit Memos → View AP Credit Memos Within Accounting (or Food equivalent) |
| AP Payment | Accounts Payable → AP Payments → View AP Payments |
| AR Invoice | Accounts Receivable → AR Invoices → View AR Invoices |
| AR Credit Memo | Accounts Receivable → AR Credit Memos → View AR Credit Memos |
| AR Payment | Accounts Receivable → AR Payments → View AR Payments |
| Journal Entry | General Ledger → Journal Entries → View Journal Entries |
| Bank Deposit | Banking → Bank Deposits → View Bank Deposits |
| Bank Transfer | Banking → Bank Transfers → View Bank Transfers |
| Bank Expense | Banking → Bank Withdrawals → View Bank Withdrawals |
| Inventory Count | Food → Inventory Counts → View Inventory Counts |
| Item Transfer | Food → Item Transfers → View Item Transfers |
| Waste Log | Food → Waste Logs → View Waste Logs |
| Donation | Food → Donations → View Donations |
| Commissary Fulfilment | Commissary → Commissary Orders → View Commissary Orders |
If the request omits TransactionTypes, the response silently drops types the user cannot view. If the request explicitly names a type the user cannot view, the request fails with 422 Unprocessable Entity. Restricted GL accounts and restricted vendors also apply.
Identifies the R365 tenant the request applies to. Required on every request.
Location. Required. Only a single location is supported for v1
Modified date start (inclusive)
Modified date end (inclusive)
Date of business start (inclusive)
Date of business end (inclusive)
Approval status. Valid values: Unapproved, Approved
Transaction types to include. Repeat the parameter to supply more than one.
Include transaction detail lines in the response
Include distribution information in the response
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
Transactions query results.
Paginated response containing queried transactions.
The collection of transactions for the current page.
Transaction model for the query transactions public API response.
Unique identifier (GUID) of the transaction.
Transaction type name (e.g., "APInvoice", "JournalEntry").
Transaction number.
Business date of the transaction.
Name of the template used to generate this transaction, if any.
Total debit amount across all distribution lines.
Total credit amount across all distribution lines.
Legal entity reference for transaction responses.
Unique identifier (GUID) of the legal entity.
Display name of the legal entity.
Legal entity number.
Location reference for transaction responses.
Unique identifier (GUID) of the location.
Display name of the location.
Location number.
Free-text comment or memo on the transaction.
Spread type applied when the transaction spans multiple periods.
Approval status of the transaction.
Timestamp of the most recent modification.
Transaction detail lines. Only included when includeDetails is true.
Transaction detail line for the query transactions public API response.
Unique identifier of the detail line.
GL account reference for transaction responses.
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 line. Zero when the line is a credit.
Credit amount on this line. Zero when the line is a debit.
Location reference for transaction responses.
Unique identifier (GUID) of the location.
Display name of the location.
Location number.
Legal entity reference for transaction responses.
Unique identifier (GUID) of the legal entity.
Display name of the legal entity.
Legal entity number.
Free-text comment on this detail line.
Distribution summary for the query transactions public API response.
Total debit amount across all distribution lines.
Total credit amount across all distribution lines.
Individual GL distribution lines.
Individual distribution line within a transaction distribution.
GL account reference for transaction responses.
Unique identifier (GUID) of the GL account.
Display name of the GL account.
GL account number.
GL type name for this account.
Location reference for transaction responses.
Unique identifier (GUID) of the location.
Display name of the location.
Location number.
Legal entity reference for transaction responses.
Unique identifier (GUID) of the legal entity.
Display name of the legal entity.
Legal entity number.
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.
Custom reporting attribute 1.
Custom reporting attribute 2.
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.