Search transactions

Search transactions

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringOptional
Filter transactions by the ID or foreign ID of the entity that created the transaction.
entityGroupIdstringOptional
Filter transactions by the ID or foreign ID of the entity group that the entity belongs to.
startDatedatetimeOptional

CREATED_AT Start date filter.

endDatedatetimeOptional

CREATED_AT End date filter.

limitintegerOptional
Number of transactions to return. Limit can range between 1 and 100, and the default is 10.
startingAfterstringOptional
The ID of the transactions to start after. If not provided, the first page of transactions will be returned.
searchstringOptional
Find transactions by vendor name, invoice number, check number, or amount. Partial matches are supported.
metadataobjectOptional
Filter transactions by invoice metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
lineItemMetadataobjectOptional
Filter transactions by invoice line item metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
lineItemGlAccountIdstringOptional
Filter transactions by invoice line item GL account ID. Each filter will be applied as an OR condition. Duplicate keys will be ignored.
payerIdstringOptional
Filter transactions by payer ID or payer foreign ID.
vendorIdstringOptional
Filter transactions by vendor ID or vendor foreign ID.
invoiceIdstringOptional
Filter transactions by invoice ID or invoice foreign ID.
transactionIdstringOptional
Filter transactions by transaction ID.
statusenumOptional
Transaction status to filter on
transactionTypeenumOptional
Filter transactions by transaction type
creatorUserIdstringOptionalDeprecated
Filter transactions by creator user ID. Does not work, do not use.

Response

This endpoint returns an object.
countinteger
hasMoreboolean
datalist of objects

Errors