Transactions

List transactions with filters

get/companies/{companyId}/transactions

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/companies/{companyId}/transactions
  • Auth: HTTP bearer

Query parameters

string uuid
OR
'consolidated'

Concrete legal entity. consolidated requires all-entity access; omitted scopes to the actor's grants.

status'needs_review' | 'categorized'
direction'in' | 'out'
dateFromstring date
dateTostring date
bankAccountIdstring uuid
sourceProviderstring

Source provider filter. Distinct from category filters.

string uuid
OR
string[]

Integration account or bank account source filter. Distinct from categoryGlAccountId. Accepts a single UUID, comma-separated UUIDs, or repeated params (OR semantics within dimension; max 50).

string uuid
OR
string[]

GL account category filter. Distinct from sourceAccountId. Accepts a single UUID, comma-separated UUIDs, or repeated params (OR semantics within dimension; max 50).

classIdstring uuid

Accounting class filter. Distinct from categoryGlAccountId.

string uuid
OR
string[]

Accounting tag filter (#1166). Comma-separated or repeated; a transaction matches when it carries ANY listed tag. ORed with untagged, ANDed with every other filter. An existence test, so a transaction with several selected tags appears once.

untagged'true' | 'false'

When true, include transactions with no tag (ORed with tagId).

categoryState'uncategorized'

Filters transactions by category assignment state. uncategorized keeps meaning "null category only" and ANDs with the other filters (with categoryGlAccountId ids it matches nothing, as before).

includeUnassignedSource'true' | 'false'

true also selects rows with no source (neither bank nor integration account). With sourceAccountId the source dimension is ids OR unassigned; alone it is unassigned-only. false or absent adds nothing.

includeUnassignedCategory'true' | 'false'

true also selects rows with no category GL account. With categoryGlAccountId the category dimension is ids OR unassigned; alone it is unassigned-only. false or absent adds nothing.

searchstring
sort'date_desc' | 'date_asc' | 'amount_desc' | 'amount_asc' | 'confidence_desc' | 'confidence_asc'

Ordering of the whole scan, applied identically to every page. The returned meta.nextCursor is bound to this sort: pass the same sort on every page, or the request is rejected with 422 instead of returning a page from a different order. Ties break on occurredOn descending then id; date_asc is fully ascending; NULL confidence sorts last under both confidence sorts.

limitinteger
cursorstring

Response

Paginated list of transactions

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.