Skip to content
brex
Search
Ctrl
K
Cancel
GitHub
npm
Select theme
Dark
Light
Auto
Getting started
Installation
Quickstart
Guides
Tree-shakeable imports
Pagination
Authentication
Client & request options
Error handling
How generation works
Migrating from v1
API reference
accounting
Classes
AccountingIntegrations
AccountingRecords
BrexAccounting
Interfaces
AccountingComponents
AccountingPaths
Type Aliases
AccountingErrorDetails
AccountingErrorResponse
AccountingFieldValue
AccountingRecordDetailed
AccountingRecordLineItem
AccountingRecordsResponse
Amount
CreateIntegrationRequest
ExportFailureDetails
ExportResultsResponse
ExportSuccessDetails
FailedExportResult
Integration
Receipt
ReportExportResultsRequest
SuccessfulExportResult
UpdatedAtFilter
User
Vendor
Functions
createAccountingClient
References
BrexCore
BrexError
BrexOptions
Idempotency
PageItem
PagePromise
PageShape
RequestArgs
RequestOptions
serializeQuery
budgets
Classes
BrexBudgets
BudgetPrograms
Budgets
BudgetsV1
SpendLimits
Interfaces
BudgetsComponents
BudgetsPaths
Type Aliases
AuthorizationSettings
AuthorizationType
AuthorizationVisibility
AutoCreateLimitCardsSetting
AutoTransferCardsSetting
Budget
BudgetBlueprint
BudgetLimitVisibilityType
BudgetPeriodBalance
BudgetProgram
BudgetProgramStatus
BudgetStatus
BudgetType
CreateAuthorizationSettings
CreateBudgetBlueprintRequest
CreateBudgetProgramRequest
CreateBudgetRequest
CreateSpendBudgetRequest
CreateSpendLimitRequest
EmployeeFilter
EmploymentStatus
EmploymentType
ExpenseVisibility
LimitIncreaseSetting
LimitType
LimitType_1
LimitType_3
LimitType_4
MerchantCategory
MerchantCategoryControls
Money
Page_Budget_
Page_BudgetProgram_
Page_SpendBudget_
Page_SpendLimit_
PeriodRecurrenceType
PeriodType
RolloverRefreshRate
SpendBudget
SpendBudgetStatus
SpendLimit
SpendLimitPeriodBalance
SpendLimitPeriodRecurrenceType
SpendLimitStatus
SpendType
UpdateAuthorizationSettings
UpdateBudgetBlueprintRequest
UpdateBudgetProgramRequest
UpdateBudgetRequest
UpdateSpendBudgetRequest
UpdateSpendLimitRequest
Functions
createBudgetsClient
References
BrexCore
BrexError
BrexOptions
Idempotency
PageItem
PagePromise
PageShape
RequestArgs
RequestOptions
serializeQuery
expenses
Classes
BrexExpenses
CardExpenses
Expenses
Receipts
Interfaces
ExpensesComponents
ExpensesPaths
Type Aliases
Address
ApprovalStepDetails
BooleanListValue
BooleanValue
Budget
CardPaymentInstrument
Category
CreateAsyncFileUploadResponse
CustomerLocation
CustomField
CustomField_ValueWrapper
CustomField_ValueWrapper_MultipleValueWrapper
CustomField_ValueWrapper_SingleValueWrapper
CustomFieldDataType
CustomFieldValueType
DateListValue
DateValue
DecimalListValue
DecimalValue
Department
EnumListValue
EnumValue
ExpandableExpense
Expense
ExpensePaymentStatus
ExpenseStatus
ExpenseType
LegalEntity
LegalEntityStatus
Location
Location_LatLong
Merchant
Money
MoneyListValue
MoneyValue
OptionString
OptionStringListValue
OptionStringValue
Page_ExpandableExpense_
Payment
PaymentInstrument
PaymentInstrumentType
PaymentStatusReason
Policy
Receipt
ReceiptMatchRequest
ReceiptUploadRequest
Repayment
Review
StringListValue
StringValue
TimestampListValue
TimestampValue
UpdateExpenseRequest
User
Functions
createExpensesClient
References
BrexCore
BrexError
BrexOptions
Idempotency
PageItem
PagePromise
PageShape
RequestArgs
RequestOptions
serializeQuery
fields
Classes
BrexFields
Fields
FieldValues
Interfaces
FieldsComponents
FieldsPaths
Type Aliases
CreateFieldValueBody
CreateFieldValueListBody
CreateFieldValueListResponse
DeletedFieldValueListResponse
DeleteFieldValue_ByBrexId
DeleteFieldValue_ByRemoteId
DeleteFieldValue_ByValueId
DeleteFieldValueBody
DeleteFieldValueListBody
Field
FieldCreateBody
FieldGroup
FieldUpdateBody
FieldValue
Page_Field_
Page_FieldValue_
UpdateFieldValue_ByBrexId
UpdateFieldValue_ByRemoteId
UpdateFieldValue_ByValueId
UpdateFieldValueBody
UpdateFieldValueDataBody
UpdateFieldValueListBody
UpdateFieldValueListResponse
Functions
createFieldsClient
References
BrexCore
BrexError
BrexOptions
Idempotency
PageItem
PagePromise
PageShape
RequestArgs
RequestOptions
serializeQuery
index
Classes
Brex
BrexCore
BrexError
PagePromise
Interfaces
BrexOptions
PageShape
RequestArgs
RequestOptions
Type Aliases
Idempotency
PageItem
Functions
serializeQuery
onboarding
Classes
BrexOnboarding
Referrals
Interfaces
OnboardingComponents
OnboardingPaths
Type Aliases
Account
Address
Applicant
Application
ApplicationStatus
BeneficialOwner
Business
Cash
CompanyRelationship
ContactPreference
CreateDocumentRequest
CreateReferralRequest
Document
DocumentType
DomesticInstruction
IdentityDocument
IdentityDocumentType
IncorporationType
Instruction
InternationalInstruction
ProcessDelayedEINDocumentRequest
Product
Prong
Referral
ReferralPage
ReferralStatus
Functions
createOnboardingClient
References
BrexCore
BrexError
BrexOptions
Idempotency
PageItem
PagePromise
PageShape
RequestArgs
RequestOptions
serializeQuery
payments
Classes
BrexPayments
LinkedAccounts
Transfers
Vendors
Interfaces
PaymentsComponents
PaymentsPaths
Type Aliases
AccountClass
AccountType
ACHDetailsRequest
ACHDetailsResponse
Address
ApprovalType
Balance
BankAccountDetailsResponse
BankConnection
BankDetails
BankType
BeneficiaryBank
BookTransferDetails
BookTransferDetailsResponse
BrexCashAccountDetails
BrexCashAccountDetailsResponse
BrexCashDetails
ChequeDetailsRequest
ChequeDetailsResponse
CounterParty
CounterPartyBankDetails
CounterPartyIncomingTransfer
CounterPartyIncomingTransferType
CounterPartyResponse
CounterPartyResponseType
CounterPartyType
CreateIncomingTransferRequest
CreateTransferRequest
CreateVendorRequest
DomesticWireDetailsRequest
DomesticWireDetailsResponse
InternationalWireDetailsResponse
Money
OriginatingAccount
OriginatingAccountResponse
OriginatingAccountResponseType
OriginatingAccountType
Page_BankConnection_
Page_Transfer_
Page_VendorResponse_
PaymentAccountDetails
PaymentAccountDetailsResponse
PaymentAccountRequest
PaymentAccountResponse
PaymentDetailsTypeRequest
PaymentDetailsTypeResponse
PaymentType
ReceivingAccount
ReceivingAccountType
Recipient
RecipientType
Transfer
TransferCancellationReason
TransferStatus
UpdateVendorRequest
VendorDetails
VendorDetailsResponse
VendorResponse
Functions
createPaymentsClient
References
BrexCore
BrexError
BrexOptions
Idempotency
PageItem
PagePromise
PageShape
RequestArgs
RequestOptions
serializeQuery
team
Classes
BrexTeam
Cards
Companies
Departments
LegalEntities
Locations
Titles
Users
Interfaces
TeamComponents
TeamPaths
Type Aliases
AccountType
Address
Card
CardAttributePreferences
CardExpiration
CardNumberResponse
CardOwner
CardStatus
CardType
ChangeCardReason
CompanyResponse
CreateCardRequest
CreateDepartmentRequest
CreateLocationRequest
CreateTitleRequest
CreateUserRequest
DepartmentResponse
LegalEntity
LegalEntityStatus
LimitType
LocationResponse
LockCardRequest
LockedMerchantDetails
Money
OwnerType
Page_Card_
Page_DepartmentResponse_
Page_LegalEntity_
Page_LocationResponse_
Page_TitleResponse_
Page_UserResponse_
SecureEmailForCardDetailsRequest
SetUserLimitRequest
SpendControl
SpendControlRequest
SpendControlUpdateRequest
SpendDuration
TerminateCardRequest
ThreeDomainSecureEnabledPreference
TitleResponse
UpdateCardRequest
UpdateUserRequest
UpdateUserStatus
UserLimitResponse
UserOwner
UserResponse
UserStatus
Functions
createTeamClient
References
BrexCore
BrexError
BrexOptions
Idempotency
PageItem
PagePromise
PageShape
RequestArgs
RequestOptions
serializeQuery
transactions
Classes
Accounts
BrexTransactions
Transactions
Interfaces
TransactionsComponents
TransactionsPaths
Type Aliases
CardAccount
CardTransaction
CardTransactionType
CashAccount
CashTransaction
CashTransactionType
Merchant
Money
Page_CardTransaction_
Page_CashAccount_
Page_CashTransaction_
Page_Statement_
Statement
StatementPeriod
Status
Functions
createTransactionsClient
References
BrexCore
BrexError
BrexOptions
Idempotency
PageItem
PagePromise
PageShape
RequestArgs
RequestOptions
serializeQuery
travel
Classes
BrexTravel
Trips
Interfaces
TravelComponents
TravelPaths
Type Aliases
Address
Address_GeoCoordinates
AirBookingData
AirBookingData_CabinClass
AirBookingData_DocumentNumber
AirBookingData_Flight
AirBookingData_FlightEndpoint
AirBookingData_FlightNumber
AirBookingData_FlightSeat
AirBookingData_FlightSeatStatus
AirBookingData_FlightTicket
AirBookingData_Journey
Booking
Booking_Data
Booking_Source
Booking_Time
Booking_Type
BookingStatus
CarRentalBookingData
CarRentalBookingData_CarClass
CarRentalBookingData_CarDetails
CarRentalBookingData_RentalEndpoint
CarRentalBookingData_ReservationDetails
LodgingBookingData
LodgingBookingData_ContactInfo
LodgingBookingData_LodgingDetails
LodgingBookingData_ReservationDetails
LodgingBookingData_Room
Page_Booking_
Page_Trip_
RailBookingData
RailBookingData_RailClass
RailBookingData_RailJourney
RailBookingData_RailLeg
RailBookingData_RailSeat
RailBookingData_RailStation
RailBookingData_RailStationType
RailBookingData_Vehicle
RailBookingData_VehicleType
Traveler
Traveler_Name
Traveler_Type
Trip
Trip_Status
Functions
createTravelClient
References
BrexCore
BrexError
BrexOptions
Idempotency
PageItem
PagePromise
PageShape
RequestArgs
RequestOptions
serializeQuery
webhooks
Classes
BrexWebhooks
WebhookGroups
Webhooks
Interfaces
WebhooksComponents
WebhooksPaths
Type Aliases
AccountingRecordReadyForExport
AddWebhookGroupMembersRequest
ApplicationStatus
CreateWebhookGroupRequest
CreateWebhookSubscriptionRequest
EventWrapper
ExpensePaymentStatus
ExpensePaymentType
ExpensePaymentUpdated
Merchant
Money
Page_WebhookGroup_
Page_WebhookGroupMember_
Page_WebhookSubscription_
PaymentStatusReason
PaymentType
ProductApplication
ReferralActivated
ReferralApplicationStatusChanged
ReferralCreated
RemoveWebhookGroupMembersRequest
TransferFailed
TransferProcessed
UpdateWebhookSubscriptionRequest
UserAttributes
UserUpdated
WebhookEventType
WebhookGroup
WebhookGroupMember
WebhookGroupMemberInput
WebhookGroupMemberType
WebhookSecret
WebhookSecretStatus
WebhookSubscription
WebhookSubscriptionStatus
Functions
createWebhooksClient
References
BrexCore
BrexError
BrexOptions
Idempotency
PageItem
PagePromise
PageShape
RequestArgs
RequestOptions
serializeQuery
GitHub
npm
Select theme
Dark
Light
Auto
brex
Copy Markdown
Open
Open in ChatGPT
Open in Claude
View in Markdown
Share
Share on LinkedIn
Share on X
Share on Threads
Share on Bluesky
Share on Facebook
Share on Reddit
Share on Hacker News
Share on Email
Share on WhatsApp
Share on Telegram
Modules
Section titled “Modules”
accounting
budgets
expenses
fields
index
onboarding
payments
team
transactions
travel
webhooks