Skip to content

Brex: Expenses schemas

38 Brex schemas with complete fields and constraints.

← Expenses operations · All schemas

Create a new receipt match — request body — body

FieldTypePresenceDescription and constraints
$objectRootThe parameter for creating a receipt match.
receipt_namestringRequired within parentThe name of the receipt (with the file extension). It will be used in the matching result email.

Create a new receipt match — response body

FieldTypePresenceDescription and constraints
$objectRootThe pre-signed file upload URI and unique identifier of the request.
idstringRequired within parentThe unique identifier for the request.
uristringRequired within parentThe pre-signed S3 link that should be used to upload the file.
The maximum size accepted for this document is 50 MB.

Create a new receipt upload — request body — body

FieldTypePresenceDescription and constraints
$objectRootThe parameter for creating a receipt upload.
receipt_namestringRequired within parentThe name of the receipt (with the file extension).

Get an expense — response body

FieldTypePresenceDescription and constraints
$objectRootThe expense object that has expandable fields, e.g., `location`, `department`, `cost_center`, `merchant`, `receipts.download_uris`, `user`, `budget`, `payment`, `spending_entity`, and `policy`.
addendaJSONOptional
addenda (anyOf 1)arrayAlternativeStructured purchase data attached to the expense, returned only when `load_expense_addenda=true`. Omitted when the expense has no addenda.
addenda (anyOf 1)[]ModelEach itemExpand Get an expense — response body — addenda array item
addenda (anyOf 2)nullAlternative
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — address Location Location
address (anyOf 2)nullAlternative
approved_atJSONOptional
approved_at (anyOf 1)stringAlternativeThe time the expense is approved.
Format: date-time
approved_at (anyOf 2)nullAlternative
billing_amountJSONOptional
billing_amount (anyOf 1)JSONAlternative
billing_amount (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
billing_amount (anyOf 1) (allOf 2)JSONAll variants applyThe billing amount of the expense is the amount that the entity is charged, on the entity's currency, for reimbursements or card spends.
billing_amount (anyOf 2)nullAlternative
billing_entity_idJSONOptional
billing_entity_id (anyOf 1)stringAlternativeID of the legal entity responsible for billing the expense.
billing_entity_id (anyOf 2)nullAlternative
booking_idJSONOptional
booking_id (anyOf 1)stringAlternativeThe booking ID associated with the expense if it is a trip expense.
booking_id (anyOf 2)nullAlternative
budgetJSONOptional
budget (anyOf 1)JSONAlternative
budget (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — budget id, name id, name
budget (anyOf 2)nullAlternative
budget_amountJSONOptional
budget_amount (anyOf 1)JSONAlternative
budget_amount (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
budget_amount (anyOf 1) (allOf 2)JSONAll variants applyThe budget amount of the expense is the amount that was incurred in the budget's currency
budget_amount (anyOf 2)nullAlternative
budget_idJSONOptional
budget_id (anyOf 1)stringAlternative
budget_id (anyOf 2)nullAlternative
card_transaction_reference_idJSONOptional
card_transaction_reference_id (anyOf 1)stringAlternativeReference identifier for the underlying card transaction, if applicable. Null for non-card expenses (e.g. reimbursements).
card_transaction_reference_id (anyOf 2)nullAlternative
categoryJSONOptional
category (anyOf 1)JSONAlternative
category (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — category The category of expenses The category of expenses
category (anyOf 2)nullAlternative
completion_dateJSONOptional
completion_date (anyOf 1)stringAlternativeThe time payment will be completed/is completed.
Format: date-time
completion_date (anyOf 2)nullAlternative
cost_centerJSONOptional
cost_center (anyOf 1)JSONAlternative
cost_center (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — cost center The cost center associated with the expense The cost center associated with the expense
cost_center (anyOf 1) (allOf 2)JSONAll variants applyThe cost center associated with the expense.
cost_center (anyOf 2)nullAlternative
cost_center_idJSONOptional
cost_center_id (anyOf 1)stringAlternative
cost_center_id (anyOf 2)nullAlternative
custom_fieldsJSONOptional
custom_fields (anyOf 1)arrayAlternativeA list of custom field values associated with the expense.
custom_fields (anyOf 1)[]ModelEach itemExpand Get user — response body — custom fields array item
custom_fields (anyOf 2)nullAlternative
dashboard_urlstringRequired within parentURL to view the expense in the Brex dashboard.
departmentJSONOptional
department (anyOf 1)JSONAlternative
department (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — department The department associated with the expense The department associated with the expense
department (anyOf 2)nullAlternative
department_idJSONOptional
department_id (anyOf 1)stringAlternative
department_id (anyOf 2)nullAlternative
expense_line_itemsJSONOptional
expense_line_items (anyOf 1)arrayAlternativeThe expense line items. Limited to 100 items.
expense_line_items (anyOf 1)[]ModelEach itemExpand Get an expense — response body
expense_line_items (anyOf 2)nullAlternative
expense_typeJSONOptional
expense_type (anyOf 1)JSONAlternative
expense_type (anyOf 1) (allOf 1)stringAll variants applyKnown values: CARD, BILLPAY, REIMBURSEMENT, CLAWBACK, UNSET
expense_type (anyOf 2)nullAlternative
exported_atJSONOptional
exported_at (anyOf 1)stringAlternativeTimestamp when the expense was exported to the accounting system.
Format: date-time
exported_at (anyOf 2)nullAlternative
idstringRequired within parentUnique ID associated with the expense.
integration_billing_entity_idJSONOptional
integration_billing_entity_id (anyOf 1)stringAlternativeID of the billing entity in accounting.
integration_billing_entity_id (anyOf 2)nullAlternative
integration_spending_entity_idJSONOptional
integration_spending_entity_id (anyOf 1)stringAlternativeID of the spending entity in accounting.
integration_spending_entity_id (anyOf 2)nullAlternative
locationJSONOptional
location (anyOf 1)JSONAlternative
location (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — location The location associated with the expense The location associated with the expense
location (anyOf 1) (allOf 2)JSONAll variants applyThe location associated with the expense.
location (anyOf 2)nullAlternative
location_idJSONOptional
location_id (anyOf 1)stringAlternative
location_id (anyOf 2)nullAlternative
memoJSONOptional
memo (anyOf 1)stringAlternativeThe memo of the expense.
memo (anyOf 2)nullAlternative
merchantJSONOptional
merchant (anyOf 1)JSONAlternative
merchant (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — merchant country, mcc, raw descriptor country, mcc, raw descriptor
merchant (anyOf 2)nullAlternative
merchant_idJSONOptional
merchant_id (anyOf 1)stringAlternative
merchant_id (anyOf 2)nullAlternative
original_amountJSONOptional
original_amount (anyOf 1)JSONAlternative
original_amount (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
original_amount (anyOf 1) (allOf 2)JSONAll variants applyThe original amount of the expense is the amount that the employee submitted or incurred for reimbursements or card spends.
original_amount (anyOf 2)nullAlternative
paymentJSONOptional
payment (anyOf 1)JSONAlternative
payment (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — payment The payment associated with the expense The payment associated with the expense
payment (anyOf 2)nullAlternative
payment_posted_atJSONOptional
payment_posted_at (anyOf 1)stringAlternativeFormat: date-time
payment_posted_at (anyOf 2)nullAlternative
payment_statusJSONOptional
payment_status (anyOf 1)JSONAlternative
payment_status (anyOf 1) (allOf 1)stringAll variants applyThe payment status of the expense. HELD means a bill payment is on hold until the vendor's new payment method is approved. New values may be added to this enum, so handle unknown values.
Known values: NOT_STARTED, PROCESSING, CANCELED, DECLINED, CLEARED, REFUNDING, REFUNDED, CASH_ADVANCE, CREDITED, AWAITING_PAYMENT, SCHEDULED, HELD
payment_status (anyOf 2)nullAlternative
policyJSONOptional
policy (anyOf 1)JSONAlternative
policy (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — policy The policy associated with the expense The policy associated with the expense
policy (anyOf 1) (allOf 2)JSONAll variants applyThe policy associated with the expense.
policy (anyOf 2)nullAlternative
purchased_amountJSONOptional
purchased_amount (anyOf 1)JSONAlternative
purchased_amount (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
purchased_amount (anyOf 1) (allOf 2)JSONAll variants applyThe purchased amount of the expense is the amount that's on the receipt.
purchased_amount (anyOf 2)nullAlternative
purchased_atJSONOptional
purchased_at (anyOf 1)stringAlternativeThe time the purchase was made.
Format: date-time
purchased_at (anyOf 2)nullAlternative
receiptsJSONOptional
receipts (anyOf 1)arrayAlternativeA list of receipts associated with the expense.
receipts (anyOf 1)[]ModelEach itemExpand Get an expense — response body — receipts A list of receipts associated with the expense item
receipts (anyOf 2)nullAlternative
repaymentJSONOptional
repayment (anyOf 1)JSONAlternative
repayment (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — repayment repayment initiated by, repayment initiation date repayment initiated by, repayment initiation date
repayment (anyOf 1) (allOf 2)JSONAll variants applyThe repayment information for the expense, include the time the repayment is created and the user that created the repayment.
repayment (anyOf 2)nullAlternative
reviewJSONOptional
review (anyOf 1)JSONAlternative
review (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — review approval steps, compliance status approval steps, compliance status
review (anyOf 1) (allOf 2)JSONAll variants applyReview information for the expense, including compliance status and reviewer details.
review (anyOf 2)nullAlternative
spending_entityJSONOptional
spending_entity (anyOf 1)JSONAlternative
spending_entity (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — spending entity The spending entity associated with the expense Legal Entity
spending_entity (anyOf 1) (allOf 2)JSONAll variants applyThe spending entity associated with the expense.
spending_entity (anyOf 2)nullAlternative
spending_entity_idJSONOptional
spending_entity_id (anyOf 1)stringAlternativeThe spending entity ID associated with the expense.
spending_entity_id (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)JSONAlternative
status (anyOf 1) (allOf 1)stringAll variants applyKnown values: DRAFT, SUBMITTED, APPROVED, OUT_OF_POLICY, VOID, CANCELED, SPLIT, SETTLED
status (anyOf 2)nullAlternative
submitted_atJSONOptional
submitted_at (anyOf 1)stringAlternativeThe time the expense is submitted,
Format: date-time
submitted_at (anyOf 2)nullAlternative
trip_idJSONOptional
trip_id (anyOf 1)stringAlternativeThe trip ID associated with the expense if it is a trip expense.
trip_id (anyOf 2)nullAlternative
updated_atstringRequired within parentThe last time the expense was updated.
Format: date-time
usd_equivalent_amountJSONOptional
usd_equivalent_amount (anyOf 1)JSONAlternative
usd_equivalent_amount (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
usd_equivalent_amount (anyOf 1) (allOf 2)JSONAll variants applyThe amount of the expense converted in USD (if not already in USD).
usd_equivalent_amount (anyOf 2)nullAlternative
userJSONOptional
user (anyOf 1)JSONAlternative
user (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — user department id, first name, id, last name, location id department id, first name, id, last name, location id
user (anyOf 2)nullAlternative
user_idJSONOptional
user_id (anyOf 1)stringAlternative
user_id (anyOf 2)nullAlternative

Referenced models: Get transfer — response body — amount, Get an expense — response body — budget id, name id, name, Get an expense — response body — category The category of expenses The category of expenses, Get an expense — response body — cost center The cost center associated with the expense The cost center associated with the expense, Get user — response body — custom fields array item, Get an expense — response body — location The location associated with the expense The location associated with the expense, Get an expense — response body — department The department associated with the expense The department associated with the expense, Get an expense — response body, Get an expense — response body — addenda array item, Get an expense — response body — spending entity The spending entity associated with the expense Legal Entity, Get an expense — response body — address Location Location, Get an expense — response body — merchant country, mcc, raw descriptor country, mcc, raw descriptor, Get an expense — response body — payment The payment associated with the expense The payment associated with the expense, Get an expense — response body — policy The policy associated with the expense The policy associated with the expense, Get an expense — response body — receipts A list of receipts associated with the expense item, Get an expense — response body — repayment repayment initiated by, repayment initiation date repayment initiated by, repayment initiation date, Get an expense — response body — review approval steps, compliance status approval steps, compliance status, Get an expense — response body — user department id, first name, id, last name, location id department id, first name, id, last name, location id

Get an expense — response body — addenda / array / item / data / object / type: ATTENDEES

FieldTypePresenceDescription and constraints
$objectRootThe people the expense was for, such as at a business meal.
external_attendeesarrayRequired within parentAttendees who are not Brex users.
external_attendees[]ModelEach itemExpand Get an expense — response body — addenda / array / item / data / object / type: ATTENDEES external attendees item
internal_attendeesarrayRequired within parentAttendees who are users on the same Brex account as the expense.
internal_attendees[]ModelEach itemExpand Get an expense — response body — addenda / array / item / data / object / type: ATTENDEES internal attendees item
typestringRequired within parentKnown values: ATTENDEES

Referenced models: Get an expense — response body — addenda / array / item / data / object / type: ATTENDEES external attendees item, Get an expense — response body — addenda / array / item / data / object / type: ATTENDEES internal attendees item

Get an expense — response body — addenda / array / item / data / object / type: ATTENDEES external attendees item

FieldTypePresenceDescription and constraints
$objectRootAn attendee who is not a Brex user.
company_nameJSONOptional
company_name (anyOf 1)stringAlternativeThe attendee's company name.
company_name (anyOf 2)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternativeThe ID of the external attendee.
id (anyOf 2)nullAlternative
is_governmentJSONOptional
is_government (anyOf 1)booleanAlternativeWhether the attendee works for a government.
is_government (anyOf 2)nullAlternative
namestringRequired within parentThe attendee's name.
titleJSONOptional
title (anyOf 1)stringAlternativeThe attendee's job title.
title (anyOf 2)nullAlternative

Get an expense — response body — addenda / array / item / data / object / type: ATTENDEES internal attendees item

FieldTypePresenceDescription and constraints
$objectRootAn attendee who is a Brex user on the same account.
customer_user_idstringRequired within parentThe user ID of the attendee.
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeThe attendee's first name.
first_name (anyOf 2)nullAlternative
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeThe attendee's last name.
last_name (anyOf 2)nullAlternative

Get an expense — response body — addenda / array / item / data / object / type: COMMON DATA REQUIREMENTS

FieldTypePresenceDescription and constraints
$objectRootPurchase data that card networks send with a clearing (Level 2 data).
card_acceptor_reference_numberJSONOptional
card_acceptor_reference_number (anyOf 1)stringAlternativeThe merchant's reference number for the transaction. Omitted when the network didn't send one.
card_acceptor_reference_number (anyOf 2)nullAlternative
customer_codeJSONOptional
customer_code (anyOf 1)stringAlternativeThe code the cardholder gave the merchant at purchase, such as a purchase order or order number. Omitted when the network didn't send one.
customer_code (anyOf 2)nullAlternative
typestringRequired within parentKnown values: COMMON_DATA_REQUIREMENTS

Get an expense — response body — addenda / array / item / data / object / type: GENERAL TICKET INFORMATION

FieldTypePresenceDescription and constraints
$objectRootGeneral information about a travel ticket.
issuing_carrierJSONOptional
issuing_carrier (anyOf 1)stringAlternativeThe carrier that issued the ticket.
issuing_carrier (anyOf 2)nullAlternative
passenger_nameJSONOptional
passenger_name (anyOf 1)stringAlternativeThe passenger name on the ticket.
passenger_name (anyOf 2)nullAlternative
ticket_numberJSONOptional
ticket_number (anyOf 1)stringAlternativeThe ticket number.
ticket_number (anyOf 2)nullAlternative
typestringRequired within parentKnown values: GENERAL_TICKET_INFORMATION

Get an expense — response body — addenda / array / item / data / object / type: LODGING

FieldTypePresenceDescription and constraints
$objectRootLodging details from the hotel's folio.
booked_atJSONOptional
booked_at (anyOf 1)stringAlternativeWhen the accommodation was booked, in UTC, without an offset.
booked_at (anyOf 2)nullAlternative
cancellation_feeJSONOptional
cancellation_fee (anyOf 1)objectAlternative
cancellation_fee (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies
cancellation_fee (anyOf 1) (allOf 2)objectAll variants applyThe fee for cancelling the booking.
cancellation_fee (anyOf 2)nullAlternative
check_in_timeJSONOptional
check_in_time (anyOf 1)stringAlternativeWhen check-in becomes available, in local time at the property, without an offset. Pair it with `check_in_time_zone_offset`.
check_in_time (anyOf 2)nullAlternative
check_in_time_zone_offsetJSONOptional
check_in_time_zone_offset (anyOf 1)stringAlternativeThe time zone offset of the check-in time, in ISO-8601 format.
check_in_time_zone_offset (anyOf 2)nullAlternative
checkout_timeJSONOptional
checkout_time (anyOf 1)stringAlternativeWhen checkout must be done, in local time at the property, without an offset. Pair it with `checkout_time_zone_offset`.
checkout_time (anyOf 2)nullAlternative
checkout_time_zone_offsetJSONOptional
checkout_time_zone_offset (anyOf 1)stringAlternativeThe time zone offset of the checkout time, in ISO-8601 format.
checkout_time_zone_offset (anyOf 2)nullAlternative
folio_idJSONOptional
folio_id (anyOf 1)stringAlternativeThe folio ID of the stay.
folio_id (anyOf 2)nullAlternative
guest_countJSONOptional
guest_count (anyOf 1)JSONAlternative
guest_count (anyOf 1) (anyOf 1)integerAlternativeThe number of people in the reservation.
Format: int64
guest_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
guest_count (anyOf 2)nullAlternative
incidental_costJSONOptional
incidental_cost (anyOf 1)objectAlternative
incidental_cost (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies
incidental_cost (anyOf 1) (allOf 2)objectAll variants applyIncidental costs associated with the booking.
incidental_cost (anyOf 2)nullAlternative
laundry_feeJSONOptional
laundry_fee (anyOf 1)objectAlternative
laundry_fee (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies
laundry_fee (anyOf 1) (allOf 2)objectAll variants applyThe laundry fee associated with the booking.
laundry_fee (anyOf 2)nullAlternative
locationJSONOptional
location (anyOf 1)objectAlternative
location (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — address Location Location
location (anyOf 1) (allOf 2)objectAll variants applyWhere the accommodation is located.
location (anyOf 2)nullAlternative
no_show_feeJSONOptional
no_show_fee (anyOf 1)objectAlternative
no_show_fee (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies
no_show_fee (anyOf 1) (allOf 2)objectAll variants applyThe no-show fee associated with the booking.
no_show_fee (anyOf 2)nullAlternative
parking_feeJSONOptional
parking_fee (anyOf 1)objectAlternative
parking_fee (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies
parking_fee (anyOf 1) (allOf 2)objectAll variants applyThe parking fee associated with the booking.
parking_fee (anyOf 2)nullAlternative
property_phone_numberJSONOptional
property_phone_number (anyOf 1)stringAlternativeThe phone number of the property.
property_phone_number (anyOf 2)nullAlternative
resort_feeJSONOptional
resort_fee (anyOf 1)objectAlternative
resort_fee (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies
resort_fee (anyOf 1) (allOf 2)objectAll variants applyThe resort fee associated with the booking.
resort_fee (anyOf 2)nullAlternative
room_rateJSONOptional
room_rate (anyOf 1)objectAlternative
room_rate (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies
room_rate (anyOf 1) (allOf 2)objectAll variants applyThe average nightly rate for the accommodation.
room_rate (anyOf 2)nullAlternative
room_servicearrayRequired within parentRoom service charges. There can be several.
room_service[]ModelEach itemExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING room service item
star_ratingJSONOptional
star_rating (anyOf 1)JSONAlternative
star_rating (anyOf 1) (anyOf 1)integerAlternativeThe star rating of the accommodation, if available.
Format: int32
star_rating (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
star_rating (anyOf 2)nullAlternative
total_rateJSONOptional
total_rate (anyOf 1)objectAlternative
total_rate (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies
total_rate (anyOf 1) (allOf 2)objectAll variants applyThe total amount paid for the accommodation. May differ from the expense amount because of incidentals.
total_rate (anyOf 2)nullAlternative
tourism_taxJSONOptional
tourism_tax (anyOf 1)objectAlternative
tourism_tax (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies
tourism_tax (anyOf 1) (allOf 2)objectAll variants applyThe tourism tax associated with the booking.
tourism_tax (anyOf 2)nullAlternative
typestringRequired within parentKnown values: LODGING
upgrade_feeJSONOptional
upgrade_fee (anyOf 1)objectAlternative
upgrade_fee (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies
upgrade_fee (anyOf 1) (allOf 2)objectAll variants applyThe fee for upgrading the booking.
upgrade_fee (anyOf 2)nullAlternative

Referenced models: Get an expense — response body — address Location Location, Get an expense — response body — addenda / array / item / data / object / type: LODGING room service item, Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies

Get an expense — response body — addenda / array / item / data / object / type: LODGING room service item

FieldTypePresenceDescription and constraints
$objectRootA room service charge.
descriptionstringRequired within parentA description of the room service.
total_feeJSONOptional
total_fee (allOf 1)ModelAll variants applyExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies
total_fee (allOf 2)JSONAll variants applyThe total fee for the room service.

Referenced models: Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies

Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies

FieldTypePresenceDescription and constraints
$objectRootAn amount in one or more currencies, keyed by lowercase ISO 4217 currency code, e.g. `usd`. Each amount's `currency` is uppercase, e.g. `USD`.
currenciesobjectRequired within parentThe amount in each available currency, keyed by lowercase ISO 4217 currency code. Lowercase an amount's `currency` before using it as a key.
Additional keys: see wildcard field
currencies.*ModelAdditional keysExpand Get transfer — response body — amount

Referenced models: Get transfer — response body — amount

Get an expense — response body — addenda / array / item / data / object / type: TRAIN DATA

FieldTypePresenceDescription and constraints
$objectRootOne segment of a train trip.
carrier_codeJSONOptional
carrier_code (anyOf 1)stringAlternativeThe standard abbreviation for the railway carrier.
carrier_code (anyOf 2)nullAlternative
city_of_destinationJSONOptional
city_of_destination (anyOf 1)stringAlternativeThe city of destination.
city_of_destination (anyOf 2)nullAlternative
city_of_originJSONOptional
city_of_origin (anyOf 1)stringAlternativeThe city of origin.
city_of_origin (anyOf 2)nullAlternative
destination_stationJSONOptional
destination_station (anyOf 1)stringAlternativeThe station where this segment ended.
destination_station (anyOf 2)nullAlternative
procedure_idJSONOptional
procedure_id (anyOf 1)stringAlternativeThe order in which the service was booked.
procedure_id (anyOf 2)nullAlternative
sequence_numberJSONOptional
sequence_number (anyOf 1)stringAlternativeWhere this segment falls in the trip's sequence.
sequence_number (anyOf 2)nullAlternative
service_class_codeJSONOptional
service_class_code (anyOf 1)stringAlternativeThe service class, such as coach or first.
service_class_code (anyOf 2)nullAlternative
start_stationJSONOptional
start_station (anyOf 1)stringAlternativeThe station where this segment started.
start_station (anyOf 2)nullAlternative
travel_dateJSONOptional
travel_date (anyOf 1)stringAlternativeThe date of the train segment.
Format: date
travel_date (anyOf 2)nullAlternative
typestringRequired within parentKnown values: TRAIN_DATA

Get an expense — response body — addenda / array / item / data / object / type: TRIP LEG DATA

FieldTypePresenceDescription and constraints
$objectRootOne leg of a trip, such as a flight.
carrier_codeJSONOptional
carrier_code (anyOf 1)stringAlternativeThe standard abbreviation for the airline or railway carrier.
carrier_code (anyOf 2)nullAlternative
departure_timeJSONOptional
departure_time (anyOf 1)stringAlternativeThe departure time as the card network sent it, with no date or time zone. Usually four digits on a 24-hour clock, such as `0715`. Some values end in `A` or `P`, such as `0640P`: add 12 hours to a `P` value whose hour is below 12, and read a `12` hour followed by `A` as hour 0.
departure_time (anyOf 2)nullAlternative
destination_airport_codeJSONOptional
destination_airport_code (anyOf 1)stringAlternativeThe destination airport code.
destination_airport_code (anyOf 2)nullAlternative
flight_numberJSONOptional
flight_number (anyOf 1)stringAlternativeThe flight number.
flight_number (anyOf 2)nullAlternative
origin_airport_codeJSONOptional
origin_airport_code (anyOf 1)stringAlternativeThe origin airport code.
origin_airport_code (anyOf 2)nullAlternative
service_class_codeJSONOptional
service_class_code (anyOf 1)stringAlternativeThe service class, such as coach or first.
service_class_code (anyOf 2)nullAlternative
travel_dateJSONOptional
travel_date (anyOf 1)stringAlternativeThe date of the trip leg.
Format: date
travel_date (anyOf 2)nullAlternative
typestringRequired within parentKnown values: TRIP_LEG_DATA

Get an expense — response body — addenda array item

FieldTypePresenceDescription and constraints
$objectRootOne addendum on an expense.
dataJSONRequired within parent
data (allOf 1)ModelAll variants applyExpand Get an expense — response body — addenda array item data object
data (allOf 2)JSONAll variants applyThe addendum's data. `type` names the variant, such as `LODGING` or `COMMON_DATA_REQUIREMENTS`. More types may be added, and this schema lists only today's, so a client that validates against it rejects a new type. Skip addenda with a `type` you don't recognize instead of failing the whole response.
idstringRequired within parentUnique ID of the addendum.

Referenced models: Get an expense — response body — addenda array item data object

Get an expense — response body — addenda array item data object

FieldTypePresenceDescription and constraints
$objectRootdiscriminator: {"mapping": {"ATTENDEES": "#/components/schemas/expenses__AttendeesAddendum", "COMMON_DATA_REQUIREMENTS": "#/components/schemas/expenses__CommonDataRequirementsAddendum", "GENERAL_TICKET_INFORMATION": "#/components/schemas/expenses__GeneralTicketInformationAddendum", "LODGING": "#/components/schemas/expenses__LodgingAddendum", "TRAIN_DATA": "#/components/schemas/expenses__TrainDataAddendum", "TRIP_LEG_DATA": "#/components/schemas/expenses__TripLegDataAddendum"}, "propertyName": "type"}
$ (anyOf 1)ModelAlternativeExpand Get an expense — response body — addenda / array / item / data / object / type: COMMON DATA REQUIREMENTS
$ (anyOf 2)ModelAlternativeExpand Get an expense — response body — addenda / array / item / data / object / type: LODGING
$ (anyOf 3)ModelAlternativeExpand Get an expense — response body — addenda / array / item / data / object / type: GENERAL TICKET INFORMATION
$ (anyOf 4)ModelAlternativeExpand Get an expense — response body — addenda / array / item / data / object / type: TRIP LEG DATA
$ (anyOf 5)ModelAlternativeExpand Get an expense — response body — addenda / array / item / data / object / type: TRAIN DATA
$ (anyOf 6)ModelAlternativeExpand Get an expense — response body — addenda / array / item / data / object / type: ATTENDEES

Referenced models: Get an expense — response body — addenda / array / item / data / object / type: ATTENDEES, Get an expense — response body — addenda / array / item / data / object / type: COMMON DATA REQUIREMENTS, Get an expense — response body — addenda / array / item / data / object / type: GENERAL TICKET INFORMATION, Get an expense — response body — addenda / array / item / data / object / type: LODGING, Get an expense — response body — addenda / array / item / data / object / type: TRAIN DATA, Get an expense — response body — addenda / array / item / data / object / type: TRIP LEG DATA

Get an expense — response body — address Location Location

FieldTypePresenceDescription and constraints
$objectRootLocation
cityJSONOptional
city (anyOf 1)stringAlternativeCity, district, suburb, town, or village.
city (anyOf 2)nullAlternative
coordinatesJSONOptional
coordinates (anyOf 1)JSONAlternative
coordinates (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — address Location Location coordinates Latitude and longitude Latitude and longitude
coordinates (anyOf 2)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternativeTwo-letter country code (ISO 3166-1 alpha-2).
country (anyOf 2)nullAlternative
line1JSONOptional
line1 (anyOf 1)stringAlternativeAddress line 1, no PO Box.
line1 (anyOf 2)nullAlternative
line2JSONOptional
line2 (anyOf 1)stringAlternativeAddress line 2 (e.g., apartment, suite, unit, or building).
line2 (anyOf 2)nullAlternative
postal_codeJSONOptional
postal_code (anyOf 1)stringAlternativeZIP or postal code.
postal_code (anyOf 2)nullAlternative
stateJSONOptional
state (anyOf 1)stringAlternativeFor US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
state (anyOf 2)nullAlternative
timezoneJSONOptional
timezone (anyOf 1)stringAlternativeTimezone.
timezone (anyOf 2)nullAlternative

Referenced models: Get an expense — response body — address Location Location coordinates Latitude and longitude Latitude and longitude

Get an expense — response body — address Location Location coordinates Latitude and longitude Latitude and longitude

FieldTypePresenceDescription and constraints
$objectRootLatitude and longitude
latitudeJSONRequired within parent
latitude (anyOf 1)numberAlternativeFormat: double
latitude (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
longitudeJSONRequired within parent
longitude (anyOf 1)numberAlternativeFormat: double
longitude (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get an expense — response body — budget id, name id, name

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
Unique ID for the Budget.
namestringRequired within parent
Name for the Budget.

Get an expense — response body — category The category of expenses The category of expenses

FieldTypePresenceDescription and constraints
$stringRootThe category of expenses.
Known values: ADVERTISING_AND_MARKETING, GROCERY, TELEPHONY, OFFICE_SUPPLIES, PRIVATE_AIR_TRAVEL, CLOTHING, CAR_RENTAL, VEHICLE_EXPENSES, RESTAURANTS, GAMBLING, FLOWERS, ELECTRONICS, LEGAL_SERVICES, UTILITIES, FURNITURE, BARS_AND_NIGHTLIFE, LAUNDRY, EVENT_EXPENSES, SHIPPING, OTHER_TRAVEL_EXPENSES, CHARITY, SOFTWARE_NON_RECURRING, LODGING, FACILITIES_EXPENSES, SERVERS, CONFERENCES, FOOD_DELIVERY, RENT, AIRLINE_EXPENSES, OTHER_BUSINESS_EXPENSES, BANK_AND_FINANCIAL_FEES, BOOKS_AND_NEWSPAPERS, CONSULTANT_AND_CONTRACTOR, CORPORATE_INSURANCE, DIGITAL_GOODS, FEES_AND_LICENSES_AND_TAXES, GAS_AND_FUEL, GENERAL_MERCHANDISE, MEDICAL, MEMBERSHIPS_AND_CLUBS, PARKING_EXPENSES, POLITICAL_DONATIONS, PUBLIC_TRANSPORTATION, RECURRING_SOFTWARE_AND_SAAS, RIDESHARE_AND_TAXI, TOLL_AND_BRIDGE_FEES, TRAINING_AND_EDUCATION, TRAVEL_WIFI

Get an expense — response body — cost center The cost center associated with the expense The cost center associated with the expense

FieldTypePresenceDescription and constraints
$objectRootThe cost center associated with the expense.
idstringRequired within parentThe unique identifier for the cost center.
namestringRequired within parentThe name of the cost center.

Get an expense — response body — department The department associated with the expense The department associated with the expense

FieldTypePresenceDescription and constraints
$objectRootThe department associated with the expense.
idstringRequired within parentThe unique identifier for the department.
namestringRequired within parentThe name of the department.

Get an expense — response body — location The location associated with the expense The location associated with the expense

FieldTypePresenceDescription and constraints
$objectRootThe location associated with the expense.
idstringRequired within parentThe unique identifier for the location.
namestringRequired within parentThe name of the location.

Get an expense — response body — merchant country, mcc, raw descriptor country, mcc, raw descriptor

FieldTypePresenceDescription and constraints
$objectRoot
countrystringRequired within parentMerchant's country, in ISO 3166-1 alpha-3 format.
mccstringRequired within parentA 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_descriptorstringRequired within parentMerchant descriptor, it can be the merchant name.

Get an expense — response body — payment / The payment associated with the expense / The payment associated with the expense / paymentInstrument / type: CARD

FieldTypePresenceDescription and constraints
$objectRootdiscriminator: {"mapping": {"CARD": "#/components/schemas/expenses__CardPaymentInstrument"}, "propertyName": "type"}
typestringRequired within parentKnown values: CARD
$ (anyOf 1)ModelAlternativeExpand Get an expense — response body — payment / The payment associated with the expense / The payment associated with the expense / paymentInstrument / type: CARD type: CARD

Referenced models: Get an expense — response body — payment / The payment associated with the expense / The payment associated with the expense / paymentInstrument / type: CARD type: CARD

Get an expense — response body — payment / The payment associated with the expense / The payment associated with the expense / paymentInstrument / type: CARD type: CARD

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).typestringRequired within parentKnown values: CARD
$ (allOf 2)JSONAll variants apply
$ (allOf 2).idstringRequired within parentUnique ID for the card.
$ (allOf 2).typestringRequired within parentKnown values: CARD

Get an expense — response body — payment The payment associated with the expense The payment associated with the expense

FieldTypePresenceDescription and constraints
$objectRootThe payment associated with the expense.
idstringRequired within parentUnique ID for the payment.
paymentInstrumentJSONRequired within parent
paymentInstrument (allOf 1)ModelAll variants applyExpand Get an expense — response body — payment / The payment associated with the expense / The payment associated with the expense / paymentInstrument / type: CARD
paymentInstrument (allOf 2)JSONAll variants applyThe type of instrument by which the payment was made.
statusReasonModelRequired within parentExpand Get an expense — response body — payment The payment associated with the expense The payment associated with the expense status Reason

Referenced models: Get an expense — response body — payment / The payment associated with the expense / The payment associated with the expense / paymentInstrument / type: CARD, Get an expense — response body — payment The payment associated with the expense The payment associated with the expense status Reason

Get an expense — response body — payment The payment associated with the expense The payment associated with the expense status Reason

FieldTypePresenceDescription and constraints
$stringRootThe reason for the payment's status.
Known values: OTHER, APPROVED, 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

Get an expense — response body — policy The policy associated with the expense The policy associated with the expense

FieldTypePresenceDescription and constraints
$objectRootThe policy associated with the expense.
idstringRequired within parentThe unique identifier for the policy.
namestringRequired within parentThe display name of the policy.

Get an expense — response body — receipts A list of receipts associated with the expense item

FieldTypePresenceDescription and constraints
$objectRootThe receipt associated with the expense.
download_urisJSONOptional
download_uris (anyOf 1)arrayAlternative[Presigned S3 link](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-presigned-url.html)(s) to download file(s) of the receipt. Link(s) expire in 15 minutes.
download_uris (anyOf 1)[]stringEach item
download_uris (anyOf 2)nullAlternative
idstringRequired within parentThe unique identifier for the receipt.

Get an expense — response body — repayment repayment initiated by, repayment initiation date repayment initiated by, repayment initiation date

FieldTypePresenceDescription and constraints
$objectRoot
repayment_initiated_byJSONOptional
repayment_initiated_by (anyOf 1)JSONAlternative
repayment_initiated_by (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — user department id, first name, id, last name, location id department id, first name, id, last name, location id
repayment_initiated_by (anyOf 2)nullAlternative
repayment_initiation_dateJSONOptional
repayment_initiation_date (anyOf 1)stringAlternativeFormat: date-time
repayment_initiation_date (anyOf 2)nullAlternative

Referenced models: Get an expense — response body — user department id, first name, id, last name, location id department id, first name, id, last name, location id

Get an expense — response body — review approval steps, compliance status approval steps, compliance status

FieldTypePresenceDescription and constraints
$objectRoot
approval_stepsJSONRequired within parent
approval_steps (anyOf 1)arrayAlternativeInformation for each approval step of the expense
approval_steps (anyOf 1)[]ModelEach itemExpand Get an expense — response body — review approval steps, compliance status approval steps, compliance status approval steps Information for each approval step of the expense item
approval_steps (anyOf 2)nullAlternative
compliance_statusJSONRequired within parent
compliance_status (anyOf 1)stringAlternativeCompliance status of the expense
compliance_status (anyOf 2)nullAlternative

Referenced models: Get an expense — response body — review approval steps, compliance status approval steps, compliance status approval steps Information for each approval step of the expense item

Get an expense — response body — review approval steps, compliance status approval steps, compliance status approval steps Information for each approval step of the expense item

FieldTypePresenceDescription and constraints
$objectRoot
copilot_reviewerJSONOptional
copilot_reviewer (anyOf 1)JSONAlternative
copilot_reviewer (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — user department id, first name, id, last name, location id department id, first name, id, last name, location id
copilot_reviewer (anyOf 2)nullAlternative
pending_reviewersJSONOptional
pending_reviewers (anyOf 1)arrayAlternative
pending_reviewers (anyOf 1)[]ModelEach itemExpand Get an expense — response body — user department id, first name, id, last name, location id department id, first name, id, last name, location id
pending_reviewers (anyOf 2)nullAlternative
resolved_atJSONOptional
resolved_at (anyOf 1)stringAlternativeFormat: date-time
resolved_at (anyOf 2)nullAlternative
reviewerJSONOptional
reviewer (anyOf 1)JSONAlternative
reviewer (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — user department id, first name, id, last name, location id department id, first name, id, last name, location id
reviewer (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)stringAlternative
status (anyOf 2)nullAlternative

Referenced models: Get an expense — response body — user department id, first name, id, last name, location id department id, first name, id, last name, location id

Get an expense — response body — spending entity The spending entity associated with the expense Legal Entity

FieldTypePresenceDescription and constraints
$objectRootA Brex legal entity.
billing_addressJSONRequired within parent
billing_address (allOf 1)ModelAll variants applyExpand Get card — response body — billing address
billing_address (allOf 2)JSONAll variants applyThe billing address of this legal entity. Also used as billing address for cards issued to users who belong to this entity.
created_atstringRequired within parentTimestamp, in UTC, when this legal entity was created.
Format: date-time
display_namestringRequired within parentThe display name of this legal entity.
idstringRequired within parentThe ID of this legal entity.
is_defaultbooleanOptionalWhether this is the default entity of the account.
statusJSONRequired within parent
status (allOf 1)stringAll variants applyThe possible statuses for an entity's verification in Brex.
Known values: UNSUBMITTED, UNVERIFIED, IN_PROGRESS, VERIFIED, REJECTED
status (allOf 2)JSONAll variants applyThe current status of this legal entity.

Referenced models: Get card — response body — billing address

Get an expense — response body — user department id, first name, id, last name, location id department id, first name, id, last name, location id

FieldTypePresenceDescription and constraints
$objectRoot
department_idJSONOptional
department_id (anyOf 1)stringAlternative
department_id (anyOf 2)nullAlternative
first_namestringRequired within parentFirst name of the User.
idstringRequired within parentUnique ID for the User.
last_namestringRequired within parentLast name of the User.
location_idJSONOptional
location_id (anyOf 1)stringAlternative
location_id (anyOf 2)nullAlternative

List expenses — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get an expense — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get an expense — response body

Update an expense — request body — body

FieldTypePresenceDescription and constraints
$objectRootThe parameter for updating an expense.
memoJSONOptional
memo (anyOf 1)stringAlternativeExpense memo.
memo (anyOf 2)nullAlternative

Update an expense — response body

FieldTypePresenceDescription and constraints
$objectRoot
billing_amountJSONOptional
billing_amount (anyOf 1)JSONAlternative
billing_amount (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
billing_amount (anyOf 1) (allOf 2)JSONAll variants applyThe billing amount of the expense is the amount that the entity is charged, on the entity's currency, for reimbursements or card spends.
billing_amount (anyOf 2)nullAlternative
budget_idJSONOptional
budget_id (anyOf 1)stringAlternative
budget_id (anyOf 2)nullAlternative
categoryJSONOptional
category (anyOf 1)JSONAlternative
category (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — category The category of expenses The category of expenses
category (anyOf 2)nullAlternative
department_idJSONOptional
department_id (anyOf 1)stringAlternative
department_id (anyOf 2)nullAlternative
idstringRequired within parentUnique ID associated with the expense.
location_idJSONOptional
location_id (anyOf 1)stringAlternative
location_id (anyOf 2)nullAlternative
memoJSONOptional
memo (anyOf 1)stringAlternativeThe memo of the expense.
memo (anyOf 2)nullAlternative
merchant_idJSONOptional
merchant_id (anyOf 1)stringAlternative
merchant_id (anyOf 2)nullAlternative
original_amountJSONOptional
original_amount (anyOf 1)JSONAlternative
original_amount (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
original_amount (anyOf 1) (allOf 2)JSONAll variants applyThe original amount of the expense is the amount that the employee submitted or incurred for reimbursements or card spends.
original_amount (anyOf 2)nullAlternative
payment_statusJSONOptional
payment_status (anyOf 1)JSONAlternative
payment_status (anyOf 1) (allOf 1)stringAll variants applyThe payment status of the expense. HELD means a bill payment is on hold until the vendor's new payment method is approved. New values may be added to this enum, so handle unknown values.
Known values: NOT_STARTED, PROCESSING, CANCELED, DECLINED, CLEARED, REFUNDING, REFUNDED, CASH_ADVANCE, CREDITED, AWAITING_PAYMENT, SCHEDULED, HELD
payment_status (anyOf 2)nullAlternative
purchased_atJSONOptional
purchased_at (anyOf 1)stringAlternativeThe time the purchase was made.
Format: date-time
purchased_at (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)JSONAlternative
status (anyOf 1) (allOf 1)stringAll variants applyKnown values: DRAFT, SUBMITTED, APPROVED, OUT_OF_POLICY, VOID, CANCELED, SPLIT, SETTLED
status (anyOf 2)nullAlternative
updated_atstringRequired within parentThe last time the expense was updated.
Format: date-time

Referenced models: Get transfer — response body — amount, Get an expense — response body — category The category of expenses The category of expenses

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.