Search transactions
Search transactions
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
entityId
Filter transactions by the ID or foreign ID of the entity that created the transaction.
entityGroupId
Filter transactions by the ID or foreign ID of the entity group that the entity belongs to.
startDate
CREATED_AT Start date filter.
endDate
CREATED_AT End date filter.
limit
Number of transactions to return. Limit can range between 1 and 100, and the default is 10.
startingAfter
The ID of the transactions to start after. If not provided, the first page of transactions will be returned.
search
Find transactions by vendor name, invoice number, check number, or amount. Partial matches are supported.
metadata
Filter transactions by invoice metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
lineItemMetadata
Filter transactions by invoice line item metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
lineItemGlAccountId
Filter transactions by invoice line item GL account ID. Each filter will be applied as an OR condition. Duplicate keys will be ignored.
payerId
Filter transactions by payer ID or payer foreign ID.
vendorId
Filter transactions by vendor ID or vendor foreign ID.
invoiceId
Filter transactions by invoice ID or invoice foreign ID.
transactionId
Filter transactions by transaction ID.
status
Transaction status to filter on
transactionType
Filter transactions by transaction type
creatorUserIdDeprecated
Filter transactions by creator user ID. Does not work, do not use.
Response
This endpoint returns an object.
count
hasMore
data