View as Markdown
Brex icon

Brex ACTION

Search Expenses

Searches expenses across card, bill pay, and reimbursement spend by merchant, amount, date, person, type, or status. Covers every payment method and carries receipt and approval state; use Search Card Transactions for settled card postings only. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Brex account once, then configure and run Search Expenses from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "brex-search-expenses",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    brex: { authProvisionId: "apn_xxxxxxx" },
    purchasedAtStart: "Purchased At Start",
    purchasedAtEnd: "Purchased At End",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Search Expenses inputs
Property Type Description
purchasedAtStart Purchased At Start string
Only return expenses purchased on or after this date-time, in RFC 3339 format, e.g. 2024-01-01T00:00:00.000Z.
Optional
purchasedAtEnd Purchased At End string
Only return expenses purchased on or before this date-time, in RFC 3339 format, e.g. 2024-01-31T23:59:59.999Z.
Optional
userIds Users string[]
Only return expenses belonging to these people, e.g. ["cuuser_example"]. Use List Users to find a user ID by email address.
Optional
expenseType Expense Type string[]
Only return expenses of these types.
Optional
status Status string[]
Only return expenses in these expense statuses.
Optional
paymentStatus Payment Status string[]
Only return expenses in these payment states.
Optional
merchantQuery Merchant string
Case-insensitive substring match on the merchant descriptor, e.g. amazon matches AMAZON WEB SERVICES. Brex has no server-side merchant filter, so this is applied after fetching.
Optional
minAmount Min Amount integer
Only return records of at least this amount, in the currency's smallest denomination — 700 is $7.00 in USD. Applied after fetching, like Merchant.
Optional
maxAmount Max Amount integer
Only return records of at most this amount, in the currency's smallest denomination — 700 is $7.00 in USD. Applied after fetching, like Merchant.
Optional
maxResults Max Results integer
The maximum number of records to return, from 1 to 2000. Defaults to 100.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
brex-search-expenses
Version
0.0.1
App
Brex
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes