Skip to content

ExpensesComponents

Defined in: src/expenses/types.gen.ts:135

headers: never

Defined in: src/expenses/types.gen.ts:855


parameters: never

Defined in: src/expenses/types.gen.ts:853


pathItems: never

Defined in: src/expenses/types.gen.ts:856


requestBodies: never

Defined in: src/expenses/types.gen.ts:854


responses: never

Defined in: src/expenses/types.gen.ts:852


schemas: object

Defined in: src/expenses/types.gen.ts:136

Address: object

Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed).

optional city?: string | null

City, district, suburb, town, or village.

optional country?: string | null

Two-letter country code (ISO 3166-1 alpha-2).

optional line1?: string | null

Address line 1, no PO Box.

optional line2?: string | null

Address line 2 (e.g., apartment, suite, unit, or building).

optional phone_number?: string | null

Phone number.

optional postal_code?: string | null

ZIP or postal code.

optional state?: string | null

For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.

ApprovalStepDetails: object

optional copilot_reviewer?: { department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; } | null

{ department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; }

optional department_id?: string | null

first_name: string

First name of the User.

id: string

Unique ID for the User.

last_name: string

Last name of the User.

optional location_id?: string | null


null

optional pending_reviewers?: object[] | null

optional resolved_at?: string | null

Format: date-time

optional reviewer?: { department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; } | null

{ department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; }

optional department_id?: string | null

first_name: string

First name of the User.

id: string

Unique ID for the User.

last_name: string

Last name of the User.

optional location_id?: string | null


null

optional status?: string | null

BooleanListValue: object & object & object & object & object

Boolean list value

optional data?: boolean[] | null

data_type: "BOOLEAN"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Boolean list value for a custom field

BooleanValue: object & object & object & object & object

Boolean value

optional data?: boolean | null

The data of the custom field.

data_type: "BOOLEAN"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Boolean value for a custom field

Budget: object

id: string

Unique ID for the Budget.

name: string

Name for the Budget.

CardPaymentInstrument: object & object & object

type: "CARD"

id: string

Unique ID for the card.

type: "CARD"

type: "CARD"

discriminator enum property added by openapi-typescript

Category: "GROCERY" | "TELEPHONY" | "OFFICE_SUPPLIES" | "PRIVATE_AIR_TRAVEL" | "CLOTHING" | "CAR_RENTAL" | "VEHICLE_EXPENSES" | "RESTAURANTS" | "GAMBLING" | "FLOWERS" | "ELECTRONICS" | "LEGAL_SERVICES" | "UTILITIES" | "FURNITURE" | "LAUNDRY" | "EVENT_EXPENSES" | "SHIPPING" | "OTHER_TRAVEL_EXPENSES" | "CHARITY" | "LODGING" | "FACILITIES_EXPENSES" | "SERVERS" | "CONFERENCES" | "FOOD_DELIVERY" | "RENT" | "AIRLINE_EXPENSES" | "OTHER_BUSINESS_EXPENSES" | "CORPORATE_INSURANCE" | "DIGITAL_GOODS" | "GENERAL_MERCHANDISE" | "MEDICAL" | "PARKING_EXPENSES" | "POLITICAL_DONATIONS" | "PUBLIC_TRANSPORTATION" | "ADVERTISING_AND_MARKETING" | "BARS_AND_NIGHTLIFE" | "SOFTWARE_NON_RECURRING" | "BANK_AND_FINANCIAL_FEES" | "BOOKS_AND_NEWSPAPERS" | "CONSULTANT_AND_CONTRACTOR" | "FEES_AND_LICENSES_AND_TAXES" | "GAS_AND_FUEL" | "MEMBERSHIPS_AND_CLUBS" | "RECURRING_SOFTWARE_AND_SAAS" | "RIDESHARE_AND_TAXI" | "TOLL_AND_BRIDGE_FEES" | "TRAINING_AND_EDUCATION" | "TRAVEL_WIFI"

The category of expenses.

CreateAsyncFileUploadResponse: object

The pre-signed file upload URI and unique identifier of the request.

id: string

The unique identifier for the request.

uri: string

The pre-signed S3 link that should be used to upload the file. The maximum size accepted for this document is 50 MB.

CustomerLocation: object

The location associated with the expense.

id: string

The unique identifier for the location.

name: string

The name of the location.

CustomField: object

key: string

The key of the custom field.

value: object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object | object & object & object & object & object

CustomField.ValueWrapper: object

Base class for custom field values

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

CustomField.ValueWrapper.MultipleValueWrapper
Section titled “CustomField.ValueWrapper.MultipleValueWrapper”

CustomField.ValueWrapper.MultipleValueWrapper: object & object & object

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

Multiple value wrapper for custom fields

CustomField.ValueWrapper.SingleValueWrapper
Section titled “CustomField.ValueWrapper.SingleValueWrapper”

CustomField.ValueWrapper.SingleValueWrapper: object & object & object

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

Single value wrapper for custom fields

CustomFieldDataType: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

The type of the custom field data.

CustomFieldValueType: "SINGLE_VALUE" | "LIST"

The type of the custom field value.

DateListValue: object & object & object & object & object

Date list value

optional data?: string[] | null

data_type: "DATE"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Date list value for a custom field

DateValue: object & object & object & object & object

Date value

optional data?: string | null

Format: date

The data of the custom field.

data_type: "DATE"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Date value for a custom field

DecimalListValue: object & object & object & object & object

Decimal list value

optional data?: number[] | null

data_type: "DECIMAL"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Decimal list value for a custom field

DecimalValue: object & object & object & object & object

Decimal value

optional data?: number | null

The data of the custom field.

data_type: "DECIMAL"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Decimal value for a custom field

Department: object

The department associated with the expense.

id: string

The unique identifier for the department.

name: string

The name of the department.

EnumListValue: object & object & object & object & object

Enum list value

optional data?: string[] | null

data_type: "ENUM"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Enum list value for a custom field

EnumValue: object & object & object & object & object

Enum value

optional data?: string | null

Format: enum

The data of the custom field.

data_type: "ENUM"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Enum value for a custom field

ExpandableExpense: object

The expense object that has expandable fields, e.g., location, department, merchant, receipts.download_uris, user, budget, payment, spending_entity, and policy.

optional address?: { city?: string | null; coordinates?: { latitude: number; longitude: number; } | null; country?: string | null; line1?: string | null; line2?: string | null; postal_code?: string | null; state?: string | null; timezone?: string | null; } | null

{ city?: string | null; coordinates?: { latitude: number; longitude: number; } | null; country?: string | null; line1?: string | null; line2?: string | null; postal_code?: string | null; state?: string | null; timezone?: string | null; }

optional city?: string | null

City, district, suburb, town, or village.

optional coordinates?: { latitude: number; longitude: number; } | null

{ latitude: number; longitude: number; }

latitude: number

Format: double

longitude: number

Format: double


null

optional country?: string | null

Two-letter country code (ISO 3166-1 alpha-2).

optional line1?: string | null

Address line 1, no PO Box.

optional line2?: string | null

Address line 2 (e.g., apartment, suite, unit, or building).

optional postal_code?: string | null

ZIP or postal code.

optional state?: string | null

For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.

optional timezone?: string | null

Timezone.


null

optional approved_at?: string | null

Format: date-time

The time the expense is approved.

optional billing_amount?: { amount: number; currency: string | null; } | null

{ amount: number; currency: string | null; }

amount: number

Format: int64

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

700

currency: string | null

The type of currency, in ISO 4217 format.

USD
USD

null

optional billing_entity_id?: string | null

ID of the legal entity responsible for billing the expense.

optional booking_id?: string | null

The booking ID associated with the expense if it is a trip expense.

optional budget?: { id: string; name: string; } | null

{ id: string; name: string; }

id: string

Unique ID for the Budget.

name: string

Name for the Budget.


null

optional budget_amount?: { amount: number; currency: string | null; } | null

{ amount: number; currency: string | null; }

amount: number

Format: int64

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

700

currency: string | null

The type of currency, in ISO 4217 format.

USD
USD

null

optional budget_id?: string | null

optional category?: "GROCERY" | "TELEPHONY" | "OFFICE_SUPPLIES" | "PRIVATE_AIR_TRAVEL" | "CLOTHING" | "CAR_RENTAL" | "VEHICLE_EXPENSES" | "RESTAURANTS" | "GAMBLING" | "FLOWERS" | "ELECTRONICS" | "LEGAL_SERVICES" | "UTILITIES" | "FURNITURE" | "LAUNDRY" | "EVENT_EXPENSES" | "SHIPPING" | "OTHER_TRAVEL_EXPENSES" | "CHARITY" | "LODGING" | "FACILITIES_EXPENSES" | "SERVERS" | "CONFERENCES" | "FOOD_DELIVERY" | "RENT" | "AIRLINE_EXPENSES" | "OTHER_BUSINESS_EXPENSES" | "CORPORATE_INSURANCE" | "DIGITAL_GOODS" | "GENERAL_MERCHANDISE" | "MEDICAL" | "PARKING_EXPENSES" | "POLITICAL_DONATIONS" | "PUBLIC_TRANSPORTATION" | "ADVERTISING_AND_MARKETING" | "BARS_AND_NIGHTLIFE" | "SOFTWARE_NON_RECURRING" | "BANK_AND_FINANCIAL_FEES" | "BOOKS_AND_NEWSPAPERS" | "CONSULTANT_AND_CONTRACTOR" | "FEES_AND_LICENSES_AND_TAXES" | "GAS_AND_FUEL" | "MEMBERSHIPS_AND_CLUBS" | "RECURRING_SOFTWARE_AND_SAAS" | "RIDESHARE_AND_TAXI" | "TOLL_AND_BRIDGE_FEES" | "TRAINING_AND_EDUCATION" | "TRAVEL_WIFI" | null

optional completion_date?: string | null

Format: date-time

The time payment will be completed/is completed.

optional custom_fields?: object[] | null

A list of custom field values associated with the expense.

dashboard_url: string

URL to view the expense in the Brex dashboard.

optional department?: { id: string; name: string; } | null

{ id: string; name: string; }

id: string

The unique identifier for the department.

name: string

The name of the department.


null

optional department_id?: string | null

optional expense_line_items?: { address?: { city?: string | null | undefined; coordinates?: { latitude: number; longitude: number; } | null | undefined; country?: string | null | undefined; line1?: string | null | undefined; line2?: string | … 1 more … | undefined; postal_code?: string | … 1 more … | undefined; state?: string | … 1 mor…[] | null

The expense line items. Limited to 100 items.

optional expense_type?: "CARD" | "REIMBURSEMENT" | "BILLPAY" | "CLAWBACK" | "UNSET" | null

optional exported_at?: string | null

Format: date-time

Timestamp when the expense was exported to the accounting system.

id: string

Unique ID associated with the expense.

ExpandableExpense.integration_billing_entity_id?
Section titled “ExpandableExpense.integration_billing_entity_id?”

optional integration_billing_entity_id?: string | null

ID of the billing entity in accounting.

ExpandableExpense.integration_spending_entity_id?
Section titled “ExpandableExpense.integration_spending_entity_id?”

optional integration_spending_entity_id?: string | null

ID of the spending entity in accounting.

optional location?: { id: string; name: string; } | null

{ id: string; name: string; }

id: string

The unique identifier for the location.

name: string

The name of the location.


null

optional location_id?: string | null

optional memo?: string | null

The memo of the expense.

optional merchant?: { country: string; mcc: string; raw_descriptor: string; } | null

{ country: string; mcc: string; raw_descriptor: string; }

country: string

Merchant’s country, in ISO 3166-1 alpha-3 format.

mcc: string

A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to https://en.wikipedia.org/wiki/Merchant_category_code for more details.

raw_descriptor: string

Merchant descriptor, it can be the merchant name.


null

optional merchant_id?: string | null

optional original_amount?: { amount: number; currency: string | null; } | null

{ amount: number; currency: string | null; }

amount: number

Format: int64

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

700

currency: string | null

The type of currency, in ISO 4217 format.

USD
USD

null

optional payment?: { id: string; paymentInstrument: Omit<object & object & object, "type">; statusReason: "APPROVED" | "OTHER" | "EXCEEDED_BUDGET_LIMIT" | "BUDGET_EXPIRED" | "NO_BUDGET" | "BUDGET_NOT_YET_STARTED" | "BUDGET_CATEGORY_RESTRICTION" | "BUDGET_MERCHANT_RESTRICTION" | "SUSPECTED_FRAUD" | "EXCEEDED_GLOBAL_LIMIT" | "EXCEEDED_USER_LIMIT" | "EXCEEDED_CARD_LIMIT" | "INVALID_EXPIRATION_DATE" | "CARD_NOT_ACTIVE" | "INVALID_CARD_CREDENTIALS" | "INVALID_BILLING_ADDRESS" | "CARD_SUSPENDED" | "CARD_TERMINATED" | "CARD_EXPIRED" | "MCC_BLOCKED" | "USER_SUSPENDED" | "INVALID_PIN" | "INVALID_CVV" | "EXCEEDED_PIN_ATTEMPTS" | "INSIDE_SANCTIONED_COUNTRY" | "SOFT_EXPIRATION" | "TRANSFERRED_CARD_NEW_MERCHANT" | "EXCEEDED_ANCESTOR_BUDGET_LIMIT" | "EXCEEDED_BUDGET_TRANSACTION_LIMIT" | "TOS_BLOCKED" | "COMPLIANCE_BLOCKED"; } | null

{ id: string; paymentInstrument: Omit<object & object & object, "type">; statusReason: "APPROVED" | "OTHER" | "EXCEEDED_BUDGET_LIMIT" | "BUDGET_EXPIRED" | "NO_BUDGET" | "BUDGET_NOT_YET_STARTED" | "BUDGET_CATEGORY_RESTRICTION" | "BUDGET_MERCHANT_RESTRICTION" | "SUSPECTED_FRAUD" | "EXCEEDED_GLOBAL_LIMIT" | "EXCEEDED_USER_LIMIT" | "EXCEEDED_CARD_LIMIT" | "INVALID_EXPIRATION_DATE" | "CARD_NOT_ACTIVE" | "INVALID_CARD_CREDENTIALS" | "INVALID_BILLING_ADDRESS" | "CARD_SUSPENDED" | "CARD_TERMINATED" | "CARD_EXPIRED" | "MCC_BLOCKED" | "USER_SUSPENDED" | "INVALID_PIN" | "INVALID_CVV" | "EXCEEDED_PIN_ATTEMPTS" | "INSIDE_SANCTIONED_COUNTRY" | "SOFT_EXPIRATION" | "TRANSFERRED_CARD_NEW_MERCHANT" | "EXCEEDED_ANCESTOR_BUDGET_LIMIT" | "EXCEEDED_BUDGET_TRANSACTION_LIMIT" | "TOS_BLOCKED" | "COMPLIANCE_BLOCKED"; }

id: string

Unique ID for the payment.

paymentInstrument: Omit<object & object & object, "type">

statusReason: "APPROVED" | "OTHER" | "EXCEEDED_BUDGET_LIMIT" | "BUDGET_EXPIRED" | "NO_BUDGET" | "BUDGET_NOT_YET_STARTED" | "BUDGET_CATEGORY_RESTRICTION" | "BUDGET_MERCHANT_RESTRICTION" | "SUSPECTED_FRAUD" | "EXCEEDED_GLOBAL_LIMIT" | "EXCEEDED_USER_LIMIT" | "EXCEEDED_CARD_LIMIT" | "INVALID_EXPIRATION_DATE" | "CARD_NOT_ACTIVE" | "INVALID_CARD_CREDENTIALS" | "INVALID_BILLING_ADDRESS" | "CARD_SUSPENDED" | "CARD_TERMINATED" | "CARD_EXPIRED" | "MCC_BLOCKED" | "USER_SUSPENDED" | "INVALID_PIN" | "INVALID_CVV" | "EXCEEDED_PIN_ATTEMPTS" | "INSIDE_SANCTIONED_COUNTRY" | "SOFT_EXPIRATION" | "TRANSFERRED_CARD_NEW_MERCHANT" | "EXCEEDED_ANCESTOR_BUDGET_LIMIT" | "EXCEEDED_BUDGET_TRANSACTION_LIMIT" | "TOS_BLOCKED" | "COMPLIANCE_BLOCKED"


null

optional payment_posted_at?: string | null

Format: date-time

optional payment_status?: "NOT_STARTED" | "PROCESSING" | "CANCELED" | "DECLINED" | "CLEARED" | "REFUNDING" | "REFUNDED" | "CASH_ADVANCE" | "CREDITED" | "AWAITING_PAYMENT" | "SCHEDULED" | null

optional policy?: { id: string; name: string; } | null

{ id: string; name: string; }

id: string

The unique identifier for the policy.

name: string

The display name of the policy.


null

optional purchased_amount?: { amount: number; currency: string | null; } | null

{ amount: number; currency: string | null; }

amount: number

Format: int64

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

700

currency: string | null

The type of currency, in ISO 4217 format.

USD
USD

null

optional purchased_at?: string | null

Format: date-time

The time the purchase was made.

optional receipts?: object[] | null

A list of receipts associated with the expense.

optional repayment?: { repayment_initiated_by?: { department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; } | null; repayment_initiation_date?: string | null; } | null

{ repayment_initiated_by?: { department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; } | null; repayment_initiation_date?: string | null; }

optional repayment_initiated_by?: { department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; } | null

{ department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; }

optional department_id?: string | null

first_name: string

First name of the User.

id: string

Unique ID for the User.

last_name: string

Last name of the User.

optional location_id?: string | null


null

optional repayment_initiation_date?: string | null

Format: date-time


null

optional review?: { approval_steps: object[] | null; compliance_status: string | null; } | null

{ approval_steps: object[] | null; compliance_status: string | null; }

approval_steps: object[] | null

Information for each approval step of the expense

compliance_status: string | null

Compliance status of the expense


null

optional spending_entity?: { billing_address: { city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }; created_at: string; display_name: string; id: string; is_default?: boolean; status: "UNSUBMITTED" | "UNVERIFIED" | "IN_PROGRESS" | "VERIFIED" | "REJECTED"; } | null

{ billing_address: { city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }; created_at: string; display_name: string; id: string; is_default?: boolean; status: "UNSUBMITTED" | "UNVERIFIED" | "IN_PROGRESS" | "VERIFIED" | "REJECTED"; }

billing_address: object

optional city?: string | null

City, district, suburb, town, or village.

optional country?: string | null

Two-letter country code (ISO 3166-1 alpha-2).

optional line1?: string | null

Address line 1, no PO Box.

optional line2?: string | null

Address line 2 (e.g., apartment, suite, unit, or building).

optional phone_number?: string | null

Phone number.

optional postal_code?: string | null

ZIP or postal code.

optional state?: string | null

For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.

created_at: string

Format: date-time

Timestamp, in UTC, when this legal entity was created.

display_name: string

The display name of this legal entity.

id: string

The ID of this legal entity.

optional is_default?: boolean

Whether this is the default entity of the account.

status: "UNSUBMITTED" | "UNVERIFIED" | "IN_PROGRESS" | "VERIFIED" | "REJECTED"


null

optional spending_entity_id?: string | null

The spending entity ID associated with the expense.

optional status?: "APPROVED" | "CANCELED" | "DRAFT" | "SUBMITTED" | "OUT_OF_POLICY" | "VOID" | "SPLIT" | "SETTLED" | null

optional submitted_at?: string | null

Format: date-time

The time the expense is submitted,

optional trip_id?: string | null

The trip ID associated with the expense if it is a trip expense.

updated_at: string

Format: date-time

The last time the expense was updated.

optional usd_equivalent_amount?: { amount: number; currency: string | null; } | null

{ amount: number; currency: string | null; }

amount: number

Format: int64

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

700

currency: string | null

The type of currency, in ISO 4217 format.

USD
USD

null

optional user?: { department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; } | null

{ department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; }

optional department_id?: string | null

first_name: string

First name of the User.

id: string

Unique ID for the User.

last_name: string

Last name of the User.

optional location_id?: string | null


null

optional user_id?: string | null

Expense: object

optional billing_amount?: { amount: number; currency: string | null; } | null

{ amount: number; currency: string | null; }

amount: number

Format: int64

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

700

currency: string | null

The type of currency, in ISO 4217 format.

USD
USD

null

optional budget_id?: string | null

optional category?: "GROCERY" | "TELEPHONY" | "OFFICE_SUPPLIES" | "PRIVATE_AIR_TRAVEL" | "CLOTHING" | "CAR_RENTAL" | "VEHICLE_EXPENSES" | "RESTAURANTS" | "GAMBLING" | "FLOWERS" | "ELECTRONICS" | "LEGAL_SERVICES" | "UTILITIES" | "FURNITURE" | "LAUNDRY" | "EVENT_EXPENSES" | "SHIPPING" | "OTHER_TRAVEL_EXPENSES" | "CHARITY" | "LODGING" | "FACILITIES_EXPENSES" | "SERVERS" | "CONFERENCES" | "FOOD_DELIVERY" | "RENT" | "AIRLINE_EXPENSES" | "OTHER_BUSINESS_EXPENSES" | "CORPORATE_INSURANCE" | "DIGITAL_GOODS" | "GENERAL_MERCHANDISE" | "MEDICAL" | "PARKING_EXPENSES" | "POLITICAL_DONATIONS" | "PUBLIC_TRANSPORTATION" | "ADVERTISING_AND_MARKETING" | "BARS_AND_NIGHTLIFE" | "SOFTWARE_NON_RECURRING" | "BANK_AND_FINANCIAL_FEES" | "BOOKS_AND_NEWSPAPERS" | "CONSULTANT_AND_CONTRACTOR" | "FEES_AND_LICENSES_AND_TAXES" | "GAS_AND_FUEL" | "MEMBERSHIPS_AND_CLUBS" | "RECURRING_SOFTWARE_AND_SAAS" | "RIDESHARE_AND_TAXI" | "TOLL_AND_BRIDGE_FEES" | "TRAINING_AND_EDUCATION" | "TRAVEL_WIFI" | null

optional department_id?: string | null

id: string

Unique ID associated with the expense.

optional location_id?: string | null

optional memo?: string | null

The memo of the expense.

optional merchant_id?: string | null

optional original_amount?: { amount: number; currency: string | null; } | null

{ amount: number; currency: string | null; }

amount: number

Format: int64

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

700

currency: string | null

The type of currency, in ISO 4217 format.

USD
USD

null

optional payment_status?: "NOT_STARTED" | "PROCESSING" | "CANCELED" | "DECLINED" | "CLEARED" | "REFUNDING" | "REFUNDED" | "CASH_ADVANCE" | "CREDITED" | "AWAITING_PAYMENT" | "SCHEDULED" | null

optional purchased_at?: string | null

Format: date-time

The time the purchase was made.

optional status?: "APPROVED" | "CANCELED" | "DRAFT" | "SUBMITTED" | "OUT_OF_POLICY" | "VOID" | "SPLIT" | "SETTLED" | null

updated_at: string

Format: date-time

The last time the expense was updated.

ExpensePaymentStatus: "NOT_STARTED" | "PROCESSING" | "CANCELED" | "DECLINED" | "CLEARED" | "REFUNDING" | "REFUNDED" | "CASH_ADVANCE" | "CREDITED" | "AWAITING_PAYMENT" | "SCHEDULED"

ExpenseStatus: "APPROVED" | "CANCELED" | "DRAFT" | "SUBMITTED" | "OUT_OF_POLICY" | "VOID" | "SPLIT" | "SETTLED"

ExpenseType: "CARD" | "REIMBURSEMENT" | "BILLPAY" | "CLAWBACK" | "UNSET"

LegalEntity: object

Legal Entity

A Brex legal entity.

billing_address: object

optional city?: string | null

City, district, suburb, town, or village.

optional country?: string | null

Two-letter country code (ISO 3166-1 alpha-2).

optional line1?: string | null

Address line 1, no PO Box.

optional line2?: string | null

Address line 2 (e.g., apartment, suite, unit, or building).

optional phone_number?: string | null

Phone number.

optional postal_code?: string | null

ZIP or postal code.

optional state?: string | null

For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.

created_at: string

Format: date-time

Timestamp, in UTC, when this legal entity was created.

display_name: string

The display name of this legal entity.

id: string

The ID of this legal entity.

optional is_default?: boolean

Whether this is the default entity of the account.

status: "UNSUBMITTED" | "UNVERIFIED" | "IN_PROGRESS" | "VERIFIED" | "REJECTED"

LegalEntityStatus: "UNSUBMITTED" | "UNVERIFIED" | "IN_PROGRESS" | "VERIFIED" | "REJECTED"

The possible statuses for an entity’s verification in Brex.

Location: object

Location

optional city?: string | null

City, district, suburb, town, or village.

optional coordinates?: { latitude: number; longitude: number; } | null

{ latitude: number; longitude: number; }

latitude: number

Format: double

longitude: number

Format: double


null

optional country?: string | null

Two-letter country code (ISO 3166-1 alpha-2).

optional line1?: string | null

Address line 1, no PO Box.

optional line2?: string | null

Address line 2 (e.g., apartment, suite, unit, or building).

optional postal_code?: string | null

ZIP or postal code.

optional state?: string | null

For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.

optional timezone?: string | null

Timezone.

Location.LatLong: object

Latitude and longitude

latitude: number

Format: double

longitude: number

Format: double

Merchant: object

country: string

Merchant’s country, in ISO 3166-1 alpha-3 format.

mcc: string

A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to https://en.wikipedia.org/wiki/Merchant_category_code for more details.

raw_descriptor: string

Merchant descriptor, it can be the merchant name.

Money: object

Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700.

amount: number

Format: int64

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

700

currency: string | null

The type of currency, in ISO 4217 format.

USD
USD

MoneyListValue: object & object & object & object & object

Money list value

optional data?: object[] | null

data_type: "MONEY"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Money list value for a custom field

MoneyValue: object & object & object & object & object

Money value

optional data?: { amount: number; currency: string | null; } | null

{ amount: number; currency: string | null; }

amount: number

Format: int64

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

700

currency: string | null

The type of currency, in ISO 4217 format.

USD
USD

null

data_type: "MONEY"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Money value for a custom field

OptionString: object

Option string fields have a label and a identifier.

optional option_id?: string | null

The identifier when custom field data is of type option string.

optional option_label?: string | null

The label when custom field data is of type option string.

OptionStringListValue: object & object & object & object & object

Option string list value

optional data?: object[] | null

data_type: "OPTION_STRING"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Option string list value for a custom field

OptionStringValue: object & object & object & object & object

Option string value

optional data?: { option_id?: string | null; option_label?: string | null; } | null

{ option_id?: string | null; option_label?: string | null; }

optional option_id?: string | null

The identifier when custom field data is of type option string.

optional option_label?: string | null

The label when custom field data is of type option string.


null

data_type: "OPTION_STRING"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Option string value for a custom field

Page_ExpandableExpense_: object

items: object[]

optional next_cursor?: string | null

Payment: object

The payment associated with the expense.

id: string

Unique ID for the payment.

paymentInstrument: Omit<object & object & object, "type">

statusReason: "APPROVED" | "OTHER" | "EXCEEDED_BUDGET_LIMIT" | "BUDGET_EXPIRED" | "NO_BUDGET" | "BUDGET_NOT_YET_STARTED" | "BUDGET_CATEGORY_RESTRICTION" | "BUDGET_MERCHANT_RESTRICTION" | "SUSPECTED_FRAUD" | "EXCEEDED_GLOBAL_LIMIT" | "EXCEEDED_USER_LIMIT" | "EXCEEDED_CARD_LIMIT" | "INVALID_EXPIRATION_DATE" | "CARD_NOT_ACTIVE" | "INVALID_CARD_CREDENTIALS" | "INVALID_BILLING_ADDRESS" | "CARD_SUSPENDED" | "CARD_TERMINATED" | "CARD_EXPIRED" | "MCC_BLOCKED" | "USER_SUSPENDED" | "INVALID_PIN" | "INVALID_CVV" | "EXCEEDED_PIN_ATTEMPTS" | "INSIDE_SANCTIONED_COUNTRY" | "SOFT_EXPIRATION" | "TRANSFERRED_CARD_NEW_MERCHANT" | "EXCEEDED_ANCESTOR_BUDGET_LIMIT" | "EXCEEDED_BUDGET_TRANSACTION_LIMIT" | "TOS_BLOCKED" | "COMPLIANCE_BLOCKED"

PaymentInstrument: object & object & object

type: "CARD"

id: string

Unique ID for the card.

type: "CARD"

type: "CARD"

discriminator enum property added by openapi-typescript

PaymentInstrumentType: "CARD"

PaymentStatusReason: "APPROVED" | "OTHER" | "EXCEEDED_BUDGET_LIMIT" | "BUDGET_EXPIRED" | "NO_BUDGET" | "BUDGET_NOT_YET_STARTED" | "BUDGET_CATEGORY_RESTRICTION" | "BUDGET_MERCHANT_RESTRICTION" | "SUSPECTED_FRAUD" | "EXCEEDED_GLOBAL_LIMIT" | "EXCEEDED_USER_LIMIT" | "EXCEEDED_CARD_LIMIT" | "INVALID_EXPIRATION_DATE" | "CARD_NOT_ACTIVE" | "INVALID_CARD_CREDENTIALS" | "INVALID_BILLING_ADDRESS" | "CARD_SUSPENDED" | "CARD_TERMINATED" | "CARD_EXPIRED" | "MCC_BLOCKED" | "USER_SUSPENDED" | "INVALID_PIN" | "INVALID_CVV" | "EXCEEDED_PIN_ATTEMPTS" | "INSIDE_SANCTIONED_COUNTRY" | "SOFT_EXPIRATION" | "TRANSFERRED_CARD_NEW_MERCHANT" | "EXCEEDED_ANCESTOR_BUDGET_LIMIT" | "EXCEEDED_BUDGET_TRANSACTION_LIMIT" | "TOS_BLOCKED" | "COMPLIANCE_BLOCKED"

The reason for the payment’s status.

Policy: object

The policy associated with the expense.

id: string

The unique identifier for the policy.

name: string

The display name of the policy.

Receipt: object

The receipt associated with the expense.

optional download_uris?: string[] | null

Presigned S3 link(s) to download file(s) of the receipt. Link(s) expire in 15 minutes.

id: string

The unique identifier for the receipt.

ReceiptMatchRequest: object

The parameter for creating a receipt match.

receipt_name: string

The name of the receipt (with the file extension). It will be used in the matching result email.

ReceiptUploadRequest: object

The parameter for creating a receipt upload.

receipt_name: string

The name of the receipt (with the file extension).

Repayment: object

optional repayment_initiated_by?: { department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; } | null

{ department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; }

optional department_id?: string | null

first_name: string

First name of the User.

id: string

Unique ID for the User.

last_name: string

Last name of the User.

optional location_id?: string | null


null

optional repayment_initiation_date?: string | null

Format: date-time

Review: object

approval_steps: object[] | null

Information for each approval step of the expense

compliance_status: string | null

Compliance status of the expense

StringListValue: object & object & object & object & object

String list value

optional data?: string[] | null

data_type: "STRING"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

String list value for a custom field

StringValue: object & object & object & object & object

String value

optional data?: string | null

The data of the custom field.

data_type: "STRING"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

String value for a custom field

TimestampListValue: object & object & object & object & object

Timestamp list value

optional data?: string[] | null

data_type: "TIMESTAMP"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Timestamp list value for a custom field

TimestampValue: object & object & object & object & object

Timestamp value

optional data?: string | null

Format: date-time

The data of the custom field.

data_type: "TIMESTAMP"

The type of the custom field data.

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

value_type: "SINGLE_VALUE" | "LIST"

value_type: "SINGLE_VALUE" | "LIST"

data_type: "BOOLEAN" | "STRING" | "DECIMAL" | "ENUM" | "TIMESTAMP" | "DATE" | "MONEY" | "OPTION_STRING"

Timestamp value for a custom field

UpdateExpenseRequest: object

The parameter for updating an expense.

optional memo?: string | null

Expense memo.

User: object

optional department_id?: string | null

first_name: string

First name of the User.

id: string

Unique ID for the User.

last_name: string

Last name of the User.

optional location_id?: string | null