Skip to content

Brex: Accounting schemas

52 Brex schemas with complete fields and constraints.

← Accounting operations · All schemas

Create accounting integration — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
amortizationbooleanOptionalWhen true, provisions the amortization fields (amortization template, template start/end dates, and amortize toggle) and enables the AMORTIZATION capability for the integration. Returns 403 when amortization is not available to the account. The ERP opts into amortization by having these fields provisioned, so this works for any accounting integration created through this endpoint. Omitting the field, or passing false, leaves the integration unchanged — the same provisioning also happens on the first POST /accounting/integration/{integration_id}/amortization, so this field only decides whether it happens up front.
vendorstringRequired within parentThe accounting vendor/system
One of: CAMPFIRE, DUALENTRY, HANOVER_PARK, INKLE, RILLET
vendor_account_idstringRequired within parentThe vendor account ID to tie this integration to

Create amortization template — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentHuman-readable name of the template
remote_idstringOptionalThe template's identifier in the ERP. Omit when the ERP has no id for it.

Create tax code — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentName of the tax code. Reserved names ("Not Eligible", "Custom") are rejected
ratenumberRequired within parentTax rate as a percentage (e.g. 20 for 20%). Use 0 for zero-rated. Required on create
remote_idstringOptionalThe tax code's identifier in the remote accounting system. Omit when the remote system has no identifier.
subsidiary_idsarrayRequired within parentSubsidiaries to enable this code for on creation
subsidiary_ids[]stringEach item

Create tax group — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentName of the tax group. Reserved names ("Not Eligible", "Custom") are rejected
subsidiary_idsarrayRequired within parentSubsidiaries to enable this group for on creation
subsidiary_ids[]stringEach item
tax_code_idsarrayRequired within parentThe Brex IDs of the existing tax codes to include in this group
tax_code_ids[]stringEach item

Get accounting integration — response body

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp when the integration was created
Format: date-time
integration_idstringRequired within parentUnique identifier for the integration
statusstringRequired within parentCurrent status of the integration
Known values: ACTIVE, DISABLED
vendorstringRequired within parentThe accounting vendor/system
Known values: CAMPFIRE, DUALENTRY, HANOVER_PARK, INKLE, RILLET
vendor_account_idstringRequired within parentThe vendor account ID this integration is tied to

Get accounting record by ID — response body

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parentAmount of the accounting record
amount (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — amount amount, currency
billing_amountJSONOptional
billing_amount (anyOf 1)objectAlternativeBilling/settlement amount in the account's home currency. For multi-currency transactions (e.g., EUR bill paid from USD account), this represents the actual amount debited. Use billing_amount / original_amount to derive the effective FX rate.
billing_amount (anyOf 1) (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — amount amount, currency
billing_amount (anyOf 2)nullAlternative
due_atJSONOptional
due_at (anyOf 1)stringAlternativeSource due at in UTC timezone. For bills only
Format: date-time
due_at (anyOf 2)nullAlternative
erp_posting_datestringRequired within parentERP impact date in UTC timezone
Format: date-time
idstringRequired within parentUnique identifier for the accounting record
invoice_numberJSONOptional
invoice_number (anyOf 1)stringAlternativeInvoice number. For bills only
invoice_number (anyOf 2)nullAlternative
line_itemsarrayRequired within parentLine items for double-entry bookkeeping
line_items[]ModelEach itemExpand Get accounting record by ID — response body — line items item
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo/description
memo (anyOf 2)nullAlternative
original_amountJSONOptional
original_amount (anyOf 1)objectAlternativeOriginal amount if different from current
original_amount (anyOf 1) (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — amount amount, currency
original_amount (anyOf 2)nullAlternative
posted_atstringRequired within parentSource posted date in UTC timezone
Format: date-time
receiptsJSONOptional
receipts (anyOf 1)arrayAlternativeAssociated receipts
receipts (anyOf 1)[]ModelEach itemExpand Get accounting record by ID — response body — receipts Associated receipts item
receipts (anyOf 2)nullAlternative
review_statusstringRequired within parentReview status
Known values: READY_FOR_EXPORT, PREPARE, REVIEW, EXPORTED
source_idJSONOptional
source_id (anyOf 1)stringAlternativeSource transaction ID
source_id (anyOf 2)nullAlternative
source_typestringRequired within parentSource type
Known values: CARD, REIMBURSEMENT, BILL
statusJSONOptional
status (anyOf 1)stringAlternativeThe source expense's approval/lifecycle status. For bills this reflects the bill's approval state (e.g. SUBMITTED = pending approval, APPROVED = approved), which is not derivable from review_status (always READY_FOR_EXPORT when polling).
Known values: APPROVED, CANCELED, DRAFT, OUT_OF_POLICY, SETTLED, SPLIT, SUBMITTED, VOID
status (anyOf 2)nullAlternative
typestringRequired within parentTypes of accounting records representing different financial transactions:

**Card-related transactions:**

- `CARD_EXPENSE_POST`: Records when a card expense is posted and settled

- `CARD_EXPENSE_REFUND`: Records when a merchant issues a refund for a card transaction

- `CARD_EXPENSE_REPAYMENT`: Records when an employee repays money to the company for a card expense

- `CARD_PAYMENT`: Records payments from customer to Brex for card balances

- `CARD_PAYMENT_REFUND`: Records refunds from Brex to customer for overpayments

- `REWARD_REDEMPTION`: Records when a reward is redeemed

**Bill-related transactions:**

- `BILL_EXPENSE`: Records when a bill expense is created

- `BILL_EXPENSE_PAYMENT`: Records when a bill is paid through ACH/wire transfer

- `BILL_EXPENSE_CARD_PAYMENT`: Records when a bill is paid using a Brex card

**Reimbursement-related transactions:**

- `REIMBURSEMENT_EXPENSE_APPROVAL`: Records approval of reimbursement (accrual basis)

- `REIMBURSEMENT_EXPENSE_POST`: Records when reimbursement is fulfilled (cash basis)

- `REIMBURSEMENT_EXPENSE_REPAYMENT`: Records repayment of a reimbursement expense

- `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT`: Records payout to employee/third party

- `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT_REVERSAL`: Records reversal of payout

- `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYIN`: Records payment from customer to Brex

- `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_REFUND`: Records refund to customer's bank
Known values: CARD_EXPENSE_POST, CARD_EXPENSE_REPAYMENT, REIMBURSEMENT_EXPENSE_REPAYMENT, REIMBURSEMENT_EXPENSE_APPROVAL, REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT, REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYIN, REIMBURSEMENT_EXPENSE_POST, CARD_PAYMENT, REWARD_REDEMPTION, REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_REFUND, CARD_EXPENSE_REFUND, CARD_PAYMENT_REFUND, REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT_REVERSAL, INVOICE, INVOICE_PAYMENT, BILL_EXPENSE, BILL_EXPENSE_PAYMENT, BILL_EXPENSE_CARD_PAYMENT, BILL_MONEY_MOVEMENT_PAYIN
updated_atstringRequired within parentLast update timestamp in UTC timezone
Format: date-time
userJSONOptional
user (anyOf 1)objectAlternativeUser associated with the record
user (anyOf 1) (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name
user (anyOf 2)nullAlternative
vendorJSONOptional
vendor (anyOf 1)objectAlternativeVendor information
vendor (anyOf 1) (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website
vendor (anyOf 2)nullAlternative
versionJSONRequired within parent
version (anyOf 1)numberAlternativeVersion number
version (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get accounting record by ID — response body — receipts Associated receipts item, Get accounting record by ID — response body — line items item, Get accounting record by ID — response body — amount amount, currency, Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name, Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website

Get accounting record by ID — response body — amount amount, currency

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeThe amount
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThe currency

Get accounting record by ID — response body — line items item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_valuesarrayRequired within parentAccounting field mappings
accounting_field_values[]ModelEach itemExpand Get accounting record by ID — response body — line items item accounting field values item
amortizationJSONOptional
amortization (anyOf 1)objectAlternativeFirst-class amortization view for this line, present only when the expense is amortized (Amortize Expense toggle on); null otherwise. The underlying amortization extended fields are surfaced here and excluded from accounting_field_values.
amortization (anyOf 1) (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — line items item amortization amortization end date, amortization start date, amortization template amortization end date, amortization start date, amortization template
amortization (anyOf 2)nullAlternative
amountJSONRequired within parentAmount for this line item. Amount is always positive for `AccountingRecordLineItem`.
amount (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — amount amount, currency
billing_amountJSONOptional
billing_amount (anyOf 1)objectAlternativeBilling/settlement amount for this line item in the account's home currency.
billing_amount (anyOf 1) (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — amount amount, currency
billing_amount (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the line item
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo/description
memo (anyOf 2)nullAlternative
original_amountJSONOptional
original_amount (anyOf 1)objectAlternativeOriginal amount for this line item. Amount is always positive for `AccountingRecordLineItem`.
original_amount (anyOf 1) (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — amount amount, currency
original_amount (anyOf 2)nullAlternative
typestringRequired within parentType of line item
Known values: CREDIT, DEBIT

Referenced models: Get accounting record by ID — response body — line items item accounting field values item, Get accounting record by ID — response body — line items item amortization amortization end date, amortization start date, amortization template amortization end date, amortization start date, amortization template, Get accounting record by ID — response body — amount amount, currency

Get accounting record by ID — response body — line items item accounting field values item

FieldTypePresenceDescription and constraints
$objectRoot
brex_field_idstringRequired within parentBrex internal field identifier
brex_field_value_idJSONRequired within parent
brex_field_value_id (anyOf 1)stringAlternativeBrex internal field value identifier. Set for IDENTIFIER (option/list) fields; null for typed (STRING/BOOL/DATE) fields.
brex_field_value_id (anyOf 2)nullAlternative
field_nameJSONRequired within parent
field_name (anyOf 1)stringAlternativeBrex field display name. Null only when the field has no display name.
field_name (anyOf 2)nullAlternative
field_value_nameJSONRequired within parent
field_value_name (anyOf 1)stringAlternativeBrex field value display name. Set for IDENTIFIER (option/list) fields; null for typed (STRING/BOOL/DATE) fields.
field_value_name (anyOf 2)nullAlternative
remote_field_idJSONRequired within parent
remote_field_id (anyOf 1)stringAlternativeRemote system field identifier
remote_field_id (anyOf 2)nullAlternative
remote_field_value_idJSONRequired within parent
remote_field_value_id (anyOf 1)stringAlternativeRemote system field value identifier
remote_field_value_id (anyOf 2)nullAlternative
set_byJSONOptional
set_by (anyOf 1)stringAlternativeWho set the accounting field value: MANUAL (a user or API client), AUTOMATED (a rule, integration setting, or system default), AGENT (the Brex AI agent), or OCR (receipt or invoice extraction). Null when the source is unknown. Only returned when Automation API access is enabled.
Known values: MANUAL, AUTOMATED, AGENT, OCR
set_by (anyOf 2)nullAlternative
set_by_detailsJSONOptionalDetails about the automation that set this accounting field value. Null unless set_by is AUTOMATED. Only returned when Automation API access is enabled.
set_by_details (anyOf 1)ModelAlternativeExpand Get accounting record by ID — response body — line_items / item / accounting_field_values / item / set_by_details / type: CUSTOM RULE
set_by_details (anyOf 2)ModelAlternativeExpand Get accounting record by ID — response body — line_items / item / accounting_field_values / item / set_by_details / type: MAPPING RULE
set_by_details (anyOf 3)ModelAlternativeExpand Get accounting record by ID — response body — line_items / item / accounting_field_values / item / set_by_details / type: INTEGRATION SETTINGS
set_by_details (anyOf 4)JSONAlternative
set_by_details (anyOf 4) (anyOf 1)objectAlternativeNull when the value was not set by automation.
Maximum fields: 0
Additional keys: not allowed
set_by_details (anyOf 4) (anyOf 2)nullAlternative
typeJSONOptional
type (anyOf 1)stringAlternativeThe field's value type. IDENTIFIER for option/list fields (read brex_field_value_id / field_value_name); STRING, BOOL, or DATE for typed fields (read `value`, interpreting it per this type).
Known values: IDENTIFIER, STRING, BOOL, DATE
type (anyOf 2)nullAlternative
valueJSONOptionalThe typed value for a STRING/BOOL/DATE field, interpreted according to `type`: a string for STRING, a boolean for BOOL (false is returned as false, never omitted), or an ISO 8601 date (YYYY-MM-DD) for DATE. Null for IDENTIFIER fields (read brex_field_value_id / field_value_name instead) and when unset.
value (anyOf 1)JSONAlternative
value (anyOf 1) (anyOf 1)stringAlternative
value (anyOf 1) (anyOf 2)nullAlternative
value (anyOf 2)JSONAlternative
value (anyOf 2) (anyOf 1)booleanAlternative
value (anyOf 2) (anyOf 2)nullAlternative

Referenced models: Get accounting record by ID — response body — line_items / item / accounting_field_values / item / set_by_details / type: CUSTOM RULE, Get accounting record by ID — response body — line_items / item / accounting_field_values / item / set_by_details / type: INTEGRATION SETTINGS, Get accounting record by ID — response body — line_items / item / accounting_field_values / item / set_by_details / type: MAPPING RULE

Get accounting record by ID — response body — line items item amortization amortization end date, amortization start date, amortization template amortization end date, amortization start date, amortization template

FieldTypePresenceDescription and constraints
$objectRoot
amortization_end_dateJSONOptional
amortization_end_date (anyOf 1)stringAlternativeAmortization period end date, as an ISO 8601 date (YYYY-MM-DD). Null when unset.
amortization_end_date (anyOf 2)nullAlternative
amortization_start_dateJSONOptional
amortization_start_date (anyOf 1)stringAlternativeAmortization period start date, as an ISO 8601 date (YYYY-MM-DD). Null when unset.
amortization_start_date (anyOf 2)nullAlternative
amortization_templateJSONOptional
amortization_template (anyOf 1)objectAlternativeThe selected amortization template (identifier + display name), when set. Null for GL-based ERPs with no template concept, or when unset.
amortization_template (anyOf 1) (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — line items item amortization amortization end date, amortization start date, amortization template amortization end date, amortization start date, amortization template amortization template display name, id, remote id display name, id, remote id
amortization_template (anyOf 2)nullAlternative

Referenced models: Get accounting record by ID — response body — line items item amortization amortization end date, amortization start date, amortization template amortization end date, amortization start date, amortization template amortization template display name, id, remote id display name, id, remote id

Get accounting record by ID — response body — line items item amortization amortization end date, amortization start date, amortization template amortization end date, amortization start date, amortization template amortization template display name, id, remote id display name, id, remote id

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parentDisplay name of the selected amortization template.
idstringRequired within parentBrex identifier of the selected amortization template option (matches brex_field_value_id of the template field).
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeIdentifier of the template in the external accounting system (ERP). Null when the option has no remote id yet.
remote_id (anyOf 2)nullAlternative

Get accounting record by ID — response body — line_items / item / accounting_field_values / item / set_by_details / type: CUSTOM RULE

FieldTypePresenceDescription and constraints
$objectRoot
rule_idstringRequired within parentAutomation API custom rule ID.
typestringRequired within parentThe type of automation that set this accounting field value.
Known values: CUSTOM_RULE

Get accounting record by ID — response body — line_items / item / accounting_field_values / item / set_by_details / type: INTEGRATION SETTINGS

FieldTypePresenceDescription and constraints
$objectRoot
typestringRequired within parentThe type of automation that set this accounting field value.
Known values: INTEGRATION_SETTINGS

Get accounting record by ID — response body — line_items / item / accounting_field_values / item / set_by_details / type: MAPPING RULE

FieldTypePresenceDescription and constraints
$objectRoot
mapping_idJSONRequired within parent
mapping_id (anyOf 1)stringAlternativeAutomation API value mapping ID.
mapping_id (anyOf 2)nullAlternative
mapping_rule_idstringRequired within parentAutomation API mapping rule ID.
typestringRequired within parentThe type of automation that set this accounting field value.
Known values: MAPPING_RULE

Get accounting record by ID — response body — receipts Associated receipts item

FieldTypePresenceDescription and constraints
$objectRoot
download_urisJSONOptional
download_uris (anyOf 1)arrayAlternativeSigned URLs to download receipt files (expire in 15 minutes)
download_uris (anyOf 1)[]stringEach item
download_uris (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the receipt

Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name

FieldTypePresenceDescription and constraints
$objectRoot
account_idstringOptionalThe ID of the account the user belongs to
brex_assistantJSONRequired within parent
brex_assistant (anyOf 1)objectAlternativeResolved Brex Assistant state. Null unless include contains 'brex_assistant'.
brex_assistant (anyOf 1) (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name brex assistant disabled reason, experience, is enabled disabled reason, experience, is enabled
brex_assistant (anyOf 2)nullAlternative
department_idstringOptionalThe ID of the user's department
department_namestringOptionalThe user's department name
emailstringOptionalThe user's email address. Omitted for callers without the `user.read` operation permission when they look up users other than themselves.
first_namestringRequired within parentThe user's first name
idstringRequired within parentThe ID of the user
last_namestringRequired within parentThe user's last name
location_idstringOptionalThe ID of the user's location
location_namestringOptionalThe user's location name
manager_first_namestringOptionalThe user's manager first name
manager_idstringOptionalThe ID of the user's manager
manager_last_namestringOptionalThe user's manager last name
manager_title_idstringOptionalThe user's manager title ID
manager_title_namestringOptionalThe user's manager title display name
metadataobjectOptionalCustomer-defined metadata associated with the user
Maximum fields: 100
Additional keys: see wildcard field
metadata.*stringAdditional keys
notification_preferencesJSONRequired within parent
notification_preferences (anyOf 1)objectAlternativeThe user's notification preferences across Brex. Null unless include contains 'notification_preferences', or when the caller cannot read this user.
notification_preferences (anyOf 1) (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name notification preferences card transactions completed, preferred channels, text card transactions completed, preferred channels, text
notification_preferences (anyOf 2)nullAlternative
phone_numberJSONOptional
phone_number (anyOf 1)stringAlternativeThe user's phone number (from their active SMS channel). Null unless include contains 'phone_number'.
phone_number (anyOf 2)nullAlternative
rolestringRequired within parentThe user's role in the system
Known values: ACCOUNT_ADMIN, AP_CLERK, BOOKKEEPER, CARD_ADMIN, EMPLOYEE, EMPLOYEE_WITHOUT_CORP_CARDS, EXPENSE_ADMIN, SUPER_ADMIN, USER_MANAGEMENT_ADMIN
statusstringRequired within parentThe user's status in the system
Known values: ACTIVE, ARCHIVED, DELETED, DISABLED, INACTIVE, INVITED, PENDING_ACTIVATION
title_idstringOptionalThe user's title ID
title_namestringOptionalThe user's title display name

Referenced models: Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name brex assistant disabled reason, experience, is enabled disabled reason, experience, is enabled, Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name notification preferences card transactions completed, preferred channels, text card transactions completed, preferred channels, text

Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name brex assistant disabled reason, experience, is enabled disabled reason, experience, is enabled

FieldTypePresenceDescription and constraints
$objectRoot
disabled_reasonJSONRequired within parent
disabled_reason (anyOf 1)stringAlternativeWhy Brex Assistant is disabled for this user, or null when enabled or on the legacy experience
Known values: ACCOUNT_DISABLED, INHERITED_FROM_ACCOUNT_DEFAULT, USER_DISABLED
disabled_reason (anyOf 2)nullAlternative
experienceJSONRequired within parent
experience (anyOf 1)stringAlternativeThe Brex Assistant experience resolved for this user
Known values: IAF, LEGACY
experience (anyOf 2)nullAlternative
is_enabledJSONRequired within parent
is_enabled (anyOf 1)booleanAlternativeWhether the resolved Brex Assistant experience is enabled for this user
is_enabled (anyOf 2)nullAlternative

Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name notification preferences card transactions completed, preferred channels, text card transactions completed, preferred channels, text

FieldTypePresenceDescription and constraints
$objectRoot
card_transactions_completedJSONRequired within parent
card_transactions_completed (anyOf 1)objectAlternativeThe Card transactions (completed) preference for Brex Assistant. Filled with the rest of notification_preferences; null when the caller is not this user.
card_transactions_completed (anyOf 1) (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name notification preferences card transactions completed, preferred channels, text card transactions completed, preferred channels, text card transactions completed brex assistant brex assistant
card_transactions_completed (anyOf 2)nullAlternative
preferred_channelsJSONRequired within parent
preferred_channels (anyOf 1)arrayAlternativeThe channels that can reach the user proactively, most preferred first. Empty when no channel can reach the user. Null when the order cannot be resolved.
preferred_channels (anyOf 1)[]ModelEach itemExpand Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name notification preferences card transactions completed, preferred channels, text card transactions completed, preferred channels, text preferred channels array item
preferred_channels (anyOf 2)nullAlternative
textJSONRequired within parent
text (anyOf 1)stringAlternativeThe user's text notification preference. Null when it cannot be resolved.
Known values: OFF, SMS, WHATSAPP
text (anyOf 2)nullAlternative

Referenced models: Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name notification preferences card transactions completed, preferred channels, text card transactions completed, preferred channels, text card transactions completed brex assistant brex assistant, Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name notification preferences card transactions completed, preferred channels, text card transactions completed, preferred channels, text preferred channels array item

Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name notification preferences card transactions completed, preferred channels, text card transactions completed, preferred channels, text card transactions completed brex assistant brex assistant

FieldTypePresenceDescription and constraints
$objectRoot
brex_assistantbooleanRequired within parentWhether Brex Assistant messages the user about a completed card transaction that needs no documentation. False when the user never saved a choice.

Get accounting record by ID — response body — user User associated with the record account id, brex assistant, department id, department name, email, first name, id, last name, location id, location name, manager first name, manager id, manager last name, manager title id, manager title name, metadata, notification preferences, phone number, role, status, title id, title name notification preferences card transactions completed, preferred channels, text card transactions completed, preferred channels, text preferred channels array item

FieldTypePresenceDescription and constraints
$objectRoot
channelJSONRequired within parent
channel (anyOf 1)stringAlternativeA channel that can reach the user
Known values: SLACK, SMS, WHATSAPP
channel (anyOf 2)nullAlternative
reply_modeJSONRequired within parent
reply_mode (anyOf 1)stringAlternativeWhether a free-text reply on this channel reaches Brex (TWO_WAY) or not (ONE_WAY, e.g. SMS from a short code outside the US and Canada)
Known values: ONE_WAY, TWO_WAY
reply_mode (anyOf 2)nullAlternative

Get accounting record by ID — response body — vendor / Vendor information / contact_name, customer_account_id, customer_dba_name, email, id, name, payment_config, phone, rail_account_details, website / payment_config / irs_form1099_eligibility_status: ELIGIBLE, INELIGIBLE, self serve request payment instrument: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, self serve request tax info: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, tax form tin validation status: INVALID, NOT REQUESTED, REQUESTED, VALID

FieldTypePresenceDescription and constraints
$objectRoot
default_payment_method_stringstringOptionalDefault payment method (ACH, Wire, Check)
idstringRequired within parentPayment config ID
irs_form1099_eligibility_statusstringOptionalIRS Form 1099 eligibility status
Known values: ELIGIBLE, INELIGIBLE
linked_erp_vendor_urlstringOptionalLinked ERP vendor URL
linked_vendor_erp_namestringOptionalLinked ERP vendor name
payment_termsstringOptionalPayment terms
self_serve_request_payment_instrumentstringOptionalSelf-serve payment instrument request status
Known values: COMPLETE, EXPIRED, NOT_ALLOWED, REQUESTED
self_serve_request_tax_infostringOptionalSelf-serve tax info request status
Known values: COMPLETE, EXPIRED, NOT_ALLOWED, REQUESTED
tax_form_tin_validation_statusstringOptionalTax form TIN validation status
Known values: INVALID, NOT_REQUESTED, REQUESTED, VALID
tax_form_w8JSONOptionalW8 tax form data
tax_form_w8 (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — vendor / Vendor information / contact_name, customer_account_id, customer_dba_name, email, id, name, payment_config, phone, rail_account_details, website / payment_config / irs_form1099_eligibility_status: ELIGIBLE, INELIGIBLE, self serve request payment instrument: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, self serve request tax info: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, tax form tin validation status: INVALID, NOT REQUESTED, REQUESTED, VALID tax form w8 country of citizenship, date of birth, domestic tax identification number, foreign tax identification number, legal name
tax_form_w9JSONOptionalW9 tax form data
tax_form_w9 (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — vendor / Vendor information / contact_name, customer_account_id, customer_dba_name, email, id, name, payment_config, phone, rail_account_details, website / payment_config / irs_form1099_eligibility_status: ELIGIBLE, INELIGIBLE, self serve request payment instrument: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, self serve request tax info: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, tax form tin validation status: INVALID, NOT REQUESTED, REQUESTED, VALID tax form w9 tax classification: C CORP, INDIVIDUAL, LLC, OTHER, PARTNERSHIP, S CORP
vendor_ownersJSONOptionalVendor owners group
vendor_owners (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — vendor / Vendor information / contact_name, customer_account_id, customer_dba_name, email, id, name, payment_config, phone, rail_account_details, website / payment_config / irs_form1099_eligibility_status: ELIGIBLE, INELIGIBLE, self serve request payment instrument: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, self serve request tax info: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, tax form tin validation status: INVALID, NOT REQUESTED, REQUESTED, VALID vendor owners id

Referenced models: Get accounting record by ID — response body — vendor / Vendor information / contact_name, customer_account_id, customer_dba_name, email, id, name, payment_config, phone, rail_account_details, website / payment_config / irs_form1099_eligibility_status: ELIGIBLE, INELIGIBLE, self serve request payment instrument: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, self serve request tax info: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, tax form tin validation status: INVALID, NOT REQUESTED, REQUESTED, VALID vendor owners id, Get accounting record by ID — response body — vendor / Vendor information / contact_name, customer_account_id, customer_dba_name, email, id, name, payment_config, phone, rail_account_details, website / payment_config / irs_form1099_eligibility_status: ELIGIBLE, INELIGIBLE, self serve request payment instrument: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, self serve request tax info: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, tax form tin validation status: INVALID, NOT REQUESTED, REQUESTED, VALID tax form w8 country of citizenship, date of birth, domestic tax identification number, foreign tax identification number, legal name, Get accounting record by ID — response body — vendor / Vendor information / contact_name, customer_account_id, customer_dba_name, email, id, name, payment_config, phone, rail_account_details, website / payment_config / irs_form1099_eligibility_status: ELIGIBLE, INELIGIBLE, self serve request payment instrument: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, self serve request tax info: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, tax form tin validation status: INVALID, NOT REQUESTED, REQUESTED, VALID tax form w9 tax classification: C CORP, INDIVIDUAL, LLC, OTHER, PARTNERSHIP, S CORP

Get accounting record by ID — response body — vendor / Vendor information / contact_name, customer_account_id, customer_dba_name, email, id, name, payment_config, phone, rail_account_details, website / payment_config / irs_form1099_eligibility_status: ELIGIBLE, INELIGIBLE, self serve request payment instrument: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, self serve request tax info: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, tax form tin validation status: INVALID, NOT REQUESTED, REQUESTED, VALID tax form w8 country of citizenship, date of birth, domestic tax identification number, foreign tax identification number, legal name

FieldTypePresenceDescription and constraints
$objectRoot
country_of_citizenshipstringOptionalCountry of citizenship
date_of_birthstringOptionalDate of birth
domestic_tax_identification_numberstringOptionalDomestic tax identification number
foreign_tax_identification_numberstringOptionalForeign tax identification number
legal_namestringOptionalLegal name

Get accounting record by ID — response body — vendor / Vendor information / contact_name, customer_account_id, customer_dba_name, email, id, name, payment_config, phone, rail_account_details, website / payment_config / irs_form1099_eligibility_status: ELIGIBLE, INELIGIBLE, self serve request payment instrument: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, self serve request tax info: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, tax form tin validation status: INVALID, NOT REQUESTED, REQUESTED, VALID tax form w9 tax classification: C CORP, INDIVIDUAL, LLC, OTHER, PARTNERSHIP, S CORP

FieldTypePresenceDescription and constraints
$objectRoot
business_namestringOptionalBusiness name
is_signedbooleanOptionalWhether the form is signed
legal_namestringOptionalLegal name
signed_datestringOptionalDate the form was signed
tax_classificationstringOptionalTax classification
Known values: C_CORP, INDIVIDUAL, LLC, OTHER, PARTNERSHIP, S_CORP
tax_identification_numberstringOptionalTax identification number

Get accounting record by ID — response body — vendor / Vendor information / contact_name, customer_account_id, customer_dba_name, email, id, name, payment_config, phone, rail_account_details, website / payment_config / irs_form1099_eligibility_status: ELIGIBLE, INELIGIBLE, self serve request payment instrument: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, self serve request tax info: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, tax form tin validation status: INVALID, NOT REQUESTED, REQUESTED, VALID vendor owners id

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentVendor owners group ID

Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website

FieldTypePresenceDescription and constraints
$objectRoot
contact_namestringOptionalThe name of the contact for the vendor
customer_account_idstringRequired within parentCustomer account ID
customer_dba_namestringOptionalThe DBA name of the vendor
emailstringOptionalThe email for the vendor
idstringRequired within parentThe unique identifier for the vendor
namestringRequired within parentThe name of the vendor
payment_configJSONOptionalPayment configuration for this vendor
payment_config (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — vendor / Vendor information / contact_name, customer_account_id, customer_dba_name, email, id, name, payment_config, phone, rail_account_details, website / payment_config / irs_form1099_eligibility_status: ELIGIBLE, INELIGIBLE, self serve request payment instrument: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, self serve request tax info: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, tax form tin validation status: INVALID, NOT REQUESTED, REQUESTED, VALID
phonestringOptionalThe phone number for the vendor
rail_account_detailsarrayOptionalRail account details (payment accounts) for this vendor
rail_account_details[]ModelEach itemExpand Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item
websitestringOptionalThe website of the vendor

Referenced models: Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item, Get accounting record by ID — response body — vendor / Vendor information / contact_name, customer_account_id, customer_dba_name, email, id, name, payment_config, phone, rail_account_details, website / payment_config / irs_form1099_eligibility_status: ELIGIBLE, INELIGIBLE, self serve request payment instrument: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, self serve request tax info: COMPLETE, EXPIRED, NOT ALLOWED, REQUESTED, tax form tin validation status: INVALID, NOT REQUESTED, REQUESTED, VALID

Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item

FieldTypePresenceDescription and constraints
$objectRoot
account_holder_addressJSONOptionalAccount holder address
account_holder_address (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item account holder address address1, address2, city, country, state, zip
bank_account_classstringOptionalBank account class
Known values: BUSINESS, PERSONAL
bank_namestringOptionalBank name
beneficiary_bank_addressJSONOptionalBeneficiary bank address
beneficiary_bank_address (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item account holder address address1, address2, city, country, state, zip
beneficiary_name_infoobjectOptionalBeneficiary name information
Additional keys: see wildcard field
beneficiary_name_info.*stringAdditional keys
beneficiary_typestringOptionalBeneficiary type
Known values: BUSINESS, INDIVIDUAL
display_namestringRequired within parentDisplay name for this payment account
idstringRequired within parentUnique identifier for this rail account details
inserted_atstringRequired within parentWhen this account was created (ISO timestamp)
propertiesobjectRequired within parentAccount properties (routing number, account number, IBAN, etc.)
Additional keys: see wildcard field
properties.*stringAdditional keys
railJSONRequired within parentRail information (payment method type)
rail (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item rail type
statusstringRequired within parentStatus of this payment account
Known values: ACCOUNT_CLOSED, ACTIVE, AUTOMATICALLY_INVALIDATED, DELETED, DISABLED, FAILED_VERIFICATIONS, PENDING_APPROVAL, REJECTED
target_countrystringOptionalTarget country
target_currencyJSONOptionalTarget currency
target_currency (allOf 1)ModelAll variants applyExpand Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item target currency code
updated_atstringRequired within parentWhen this account was last updated (ISO timestamp)

Referenced models: Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item account holder address address1, address2, city, country, state, zip, Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item target currency code, Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item rail type

Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item account holder address address1, address2, city, country, state, zip

FieldTypePresenceDescription and constraints
$objectRoot
address1stringOptionalAddress line 1
address2stringOptionalAddress line 2
citystringOptionalCity
countrystringOptionalCountry code
statestringOptionalState or province
zipstringOptionalZIP or postal code

Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item rail type

FieldTypePresenceDescription and constraints
$objectRoot
typestringRequired within parentRail type (payment method)
Known values: AU_BECS, CARD, CA_EFT, CRYPTO_BASE, CRYPTO_ETH, EU_SEPA, GLOBAL_BANK_TRANSFER, HK_FPS, INTL_SWIFT_WIRE, SG_EGIRO, UK_BACS, US_ACH, US_CHEQUE, US_WIRE

Get accounting record by ID — response body — vendor Vendor information contact name, customer account id, customer dba name, email, id, name, payment config, phone, rail account details, website rail account details item target currency code

FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentCurrency code (e.g., USD, EUR)

Get amortization template — response body

FieldTypePresenceDescription and constraints
$objectRoot
brex_idstringRequired within parentThe internal Brex ID of the amortization template
is_disabledbooleanRequired within parentWhether the template is hidden from selection on new expenses. Existing expenses keep a disabled template.
namestringRequired within parentHuman-readable name of the template
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeThe template's identifier in the ERP, if the ERP supplied one
remote_id (anyOf 2)nullAlternative
updated_atstringRequired within parentThe last updated timestamp of the template
Format: date-time

Get tax code — response body

FieldTypePresenceDescription and constraints
$objectRoot
brex_idstringRequired within parentThe internal Brex ID of the tax code
namestringRequired within parentHuman-readable name of the tax code
rateJSONOptional
rate (anyOf 1)JSONAlternative
rate (anyOf 1) (anyOf 1)numberAlternativeTax rate as a percentage (e.g. 20 for 20%). 0 is zero-rated; null is exempt
rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate (anyOf 2)nullAlternative
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeThe tax code's identifier in the remote accounting system. Null when the caller did not provide one.
remote_id (anyOf 2)nullAlternative
subsidiariesarrayRequired within parentPer-subsidiary enablement, one entry per subsidiary with a setting for this code
subsidiaries[]ModelEach itemExpand Get tax code — response body — subsidiaries item
updated_atstringRequired within parentThe last updated timestamp of the tax code
Format: date-time

Referenced models: Get tax code — response body — subsidiaries item

Get tax code — response body — subsidiaries item

FieldTypePresenceDescription and constraints
$objectRoot
statusstringRequired within parentWhether the code/group is enabled for this subsidiary
Known values: ENABLED, DISABLED
subsidiary_idstringRequired within parentThe internal Brex ID of the subsidiary
subsidiary_namestringRequired within parentHuman-readable name of the subsidiary

Get tax group — response body

FieldTypePresenceDescription and constraints
$objectRoot
brex_idstringRequired within parentThe internal Brex ID of the tax group
namestringRequired within parentHuman-readable name of the tax group
subsidiariesarrayRequired within parentPer-subsidiary enablement, one entry per subsidiary with a setting for this group
subsidiaries[]ModelEach itemExpand Get tax code — response body — subsidiaries item
tax_codesarrayRequired within parentThe member tax codes contained in this group
tax_codes[]ModelEach itemExpand Get tax group — response body — tax codes item
updated_atstringRequired within parentThe last updated timestamp of the tax group
Format: date-time

Referenced models: Get tax group — response body — tax codes item, Get tax code — response body — subsidiaries item

Get tax group — response body — tax codes item

FieldTypePresenceDescription and constraints
$objectRoot
brex_idstringRequired within parentThe internal Brex ID of the member tax code
namestringRequired within parentHuman-readable name of the member tax code
rateJSONOptional
rate (anyOf 1)JSONAlternative
rate (anyOf 1) (anyOf 1)numberAlternativeTax rate as a percentage (e.g. 20 for 20%). 0 is zero-rated; null is exempt
rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate (anyOf 2)nullAlternative
updated_atstringRequired within parentThe last updated timestamp of the member tax code
Format: date-time

List accounting integrations — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parentThe items in the response
items[]ModelEach itemExpand Get accounting integration — response body
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeThe next cursor
next_cursor (anyOf 2)nullAlternative

Referenced models: Get accounting integration — response body

List amortization templates — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parentThe items in the response
items[]ModelEach itemExpand Get amortization template — response body
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeThe next cursor
next_cursor (anyOf 2)nullAlternative

Referenced models: Get amortization template — response body

List tax codes — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parentThe items in the response
items[]ModelEach itemExpand Get tax code — response body
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeThe next cursor
next_cursor (anyOf 2)nullAlternative

Referenced models: Get tax code — response body

List tax groups — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parentThe items in the response
items[]ModelEach itemExpand Get tax group — response body
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeThe next cursor
next_cursor (anyOf 2)nullAlternative

Referenced models: Get tax group — response body

Query accounting records — request body — query erp posting date

FieldTypePresenceDescription and constraints
$objectRoot
fromstringOptionalInclusive start of the ERP posting date range - ISO 8601 UTC datetime format
Format: date-time
tostringOptionalInclusive end of the ERP posting date range - ISO 8601 UTC datetime format
Format: date-time

Query accounting records — request body — query updated at

FieldTypePresenceDescription and constraints
$objectRoot
gtstringOptionalMinimum value to filter by (exclusive) - ISO 8601 format
Format: date-time
gtestringOptionalMinimum value to filter by (inclusive) - ISO 8601 format
Format: date-time
ltstringOptionalMaximum value to filter by (exclusive) - ISO 8601 format
Format: date-time
ltestringOptionalMaximum value to filter by (inclusive) - ISO 8601 format
Format: date-time

Query accounting records — response body

FieldTypePresenceDescription and constraints
$objectRoot
has_next_pagebooleanRequired within parentWhether there are more results available
itemsarrayRequired within parentThe items in the response
items[]ModelEach itemExpand Get accounting record by ID — response body
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeThe next cursor
next_cursor (anyOf 2)nullAlternative
total_countJSONOptional
total_count (anyOf 1)JSONAlternative
total_count (anyOf 1) (anyOf 1)numberAlternativeTotal count of records matching the query
Format: int32
total_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_count (anyOf 2)nullAlternative

Referenced models: Get accounting record by ID — response body

Report accounting export results — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
resultsarrayRequired within parentArray of export results (must contain at least one result)
Minimum items: 1
results[]JSONEach item
results[] (oneOf 1)ModelAlternativeExpand Report accounting export results — request body — body results item accounting record id, success
results[] (oneOf 2)ModelAlternativeExpand Report accounting export results — request body — body results item accounting record id, failure

Referenced models: Report accounting export results — request body — body results item accounting record id, failure, Report accounting export results — request body — body results item accounting record id, success

Report accounting export results — request body — body results item accounting record id, failure

FieldTypePresenceDescription and constraints
$objectRoot
accounting_record_idstringRequired within parentID of the accounting record the export outcome applies to
failureJSONRequired within parentDetails for a failed export
failure (allOf 1)ModelAll variants applyExpand Report accounting export results — request body — body results item accounting record id, failure failure error message

Referenced models: Report accounting export results — request body — body results item accounting record id, failure failure error message

Report accounting export results — request body — body results item accounting record id, failure failure error message

FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringRequired within parentHuman-readable explanation of the failure

Report accounting export results — request body — body results item accounting record id, success

FieldTypePresenceDescription and constraints
$objectRoot
accounting_record_idstringRequired within parentID of the accounting record the export outcome applies to
successJSONRequired within parentDetails for a successful export
success (allOf 1)ModelAll variants applyExpand Report accounting export results — request body — body results item accounting record id, success success deep link url, reference id

Referenced models: Report accounting export results — request body — body results item accounting record id, success success deep link url, reference id

Report accounting export results — request body — body results item accounting record id, success success deep link url, reference id

FieldTypePresenceDescription and constraints
$objectRoot
deep_link_urlstringOptionalURL pointing to the record in the external system
reference_idJSONOptional
reference_id (anyOf 1)stringAlternativeExternal system identifier assigned to the exported record
reference_id (anyOf 2)nullAlternative

Report accounting export results — response body

FieldTypePresenceDescription and constraints
$objectRoot
updated_accounting_record_idsarrayRequired within parentAccounting record ids that were updated by the request
updated_accounting_record_ids[]stringEach item

Update accounting records — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
accounting_fieldsarrayRequired within parentMaximum items: 50
Minimum items: 1
accounting_fields[]objectEach itemAdditional keys: not allowed
accounting_fields[].bool_valueJSONOptional
accounting_fields[].bool_value (anyOf 1)booleanAlternative
accounting_fields[].bool_value (anyOf 2)nullAlternative
accounting_fields[].date_valueJSONOptional
accounting_fields[].date_value (anyOf 1)stringAlternativeFormat: date
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
accounting_fields[].date_value (anyOf 2)nullAlternative
accounting_fields[].enum_valueJSONOptional
accounting_fields[].enum_value (anyOf 1)stringAlternativeMinimum length: 1
accounting_fields[].enum_value (anyOf 2)nullAlternative
accounting_fields[].field_idstringRequired within parentField brex_id from accounting field discovery.
Minimum length: 1
accounting_fields[].is_deletedJSONOptional
accounting_fields[].is_deleted (anyOf 1)booleanAlternative
accounting_fields[].is_deleted (anyOf 2)nullAlternative
accounting_fields[].number_valueJSONOptional
accounting_fields[].number_value (anyOf 1)numberAlternative
accounting_fields[].number_value (anyOf 2)nullAlternative
accounting_fields[].string_valueJSONOptional
accounting_fields[].string_value (anyOf 1)stringAlternative
accounting_fields[].string_value (anyOf 2)nullAlternative
accounting_fields[].value_idJSONOptional
accounting_fields[].value_id (anyOf 1)stringAlternativeOption brex_id for an option field.
Minimum length: 1
accounting_fields[].value_id (anyOf 2)nullAlternative
accounting_record_idsarrayRequired within parentMaximum items: 50
Minimum items: 1
accounting_record_ids[]stringEach itemMinimum length: 1

Update accounting records — response body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
resultsarrayRequired within parent
results[]JSONEach item
results[] (anyOf 1)objectAlternativeAdditional keys: not allowed
results[] (anyOf 1).accounting_recordobjectRequired within parentAdditional keys: not allowed
results[] (anyOf 1).accounting_record.amountobjectRequired within parentAdditional keys: not allowed
results[] (anyOf 1).accounting_record.amount.amountJSONRequired within parent
results[] (anyOf 1).accounting_record.amount.amount (anyOf 1)numberAlternative
results[] (anyOf 1).accounting_record.amount.amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
results[] (anyOf 1).accounting_record.amount.currencystringRequired within parent
results[] (anyOf 1).accounting_record.billing_amountJSONOptional
results[] (anyOf 1).accounting_record.billing_amount (anyOf 1)objectAlternativeAdditional keys: not allowed
results[] (anyOf 1).accounting_record.billing_amount (anyOf 1).amountJSONRequired within parent
results[] (anyOf 1).accounting_record.billing_amount (anyOf 1).amount (anyOf 1)numberAlternative
results[] (anyOf 1).accounting_record.billing_amount (anyOf 1).amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
results[] (anyOf 1).accounting_record.billing_amount (anyOf 1).currencystringRequired within parent
results[] (anyOf 1).accounting_record.billing_amount (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.due_atJSONOptional
results[] (anyOf 1).accounting_record.due_at (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.due_at (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.erp_posting_datestringRequired within parent
results[] (anyOf 1).accounting_record.idstringRequired within parent
results[] (anyOf 1).accounting_record.invoice_numberJSONOptional
results[] (anyOf 1).accounting_record.invoice_number (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.invoice_number (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_itemsarrayRequired within parent
results[] (anyOf 1).accounting_record.line_items[]objectEach itemAdditional keys: not allowed
results[] (anyOf 1).accounting_record.line_items[].accounting_field_valuesarrayRequired within parent
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[]objectEach itemAdditional keys: not allowed
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].brex_field_idstringRequired within parent
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].brex_field_value_idJSONRequired within parent
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].brex_field_value_id (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].brex_field_value_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].field_nameJSONRequired within parent
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].field_name (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].field_name (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].field_value_nameJSONRequired within parent
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].field_value_name (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].field_value_name (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].remote_field_idJSONRequired within parent
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].remote_field_id (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].remote_field_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].remote_field_value_idJSONRequired within parent
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].remote_field_value_id (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].remote_field_value_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_byJSONOptional
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by (anyOf 1)stringAlternativeKnown values: MANUAL, AUTOMATED, AGENT, OCR
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_detailsJSONOptional
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_details (anyOf 1)objectAlternativeAdditional keys: not allowed
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_details (anyOf 1).mapping_idJSONOptional
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_details (anyOf 1).mapping_id (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_details (anyOf 1).mapping_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_details (anyOf 1).mapping_rule_idJSONOptional
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_details (anyOf 1).mapping_rule_id (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_details (anyOf 1).mapping_rule_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_details (anyOf 1).rule_idJSONOptional
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_details (anyOf 1).rule_id (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_details (anyOf 1).rule_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_details (anyOf 1).typestringRequired within parentKnown values: CUSTOM_RULE, MAPPING_RULE, INTEGRATION_SETTINGS
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].set_by_details (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].typeJSONOptional
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].type (anyOf 1)stringAlternativeKnown values: IDENTIFIER, STRING, BOOL, DATE
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].type (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].valueJSONOptional
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].value (anyOf 1)JSONAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].value (anyOf 1) (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].value (anyOf 1) (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].value (anyOf 2)JSONAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].value (anyOf 2) (anyOf 1)booleanAlternative
results[] (anyOf 1).accounting_record.line_items[].accounting_field_values[].value (anyOf 2) (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].amortizationJSONOptional
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1)objectAlternativeAdditional keys: not allowed
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_end_dateJSONOptional
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_end_date (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_end_date (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_start_dateJSONOptional
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_start_date (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_start_date (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_templateJSONOptional
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_template (anyOf 1)objectAlternativeAdditional keys: not allowed
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_template (anyOf 1).display_namestringRequired within parent
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_template (anyOf 1).idstringRequired within parent
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_template (anyOf 1).remote_idJSONOptional
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_template (anyOf 1).remote_id (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_template (anyOf 1).remote_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 1).amortization_template (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].amortization (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].amountobjectRequired within parentAdditional keys: not allowed
results[] (anyOf 1).accounting_record.line_items[].amount.amountJSONRequired within parent
results[] (anyOf 1).accounting_record.line_items[].amount.amount (anyOf 1)numberAlternative
results[] (anyOf 1).accounting_record.line_items[].amount.amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
results[] (anyOf 1).accounting_record.line_items[].amount.currencystringRequired within parent
results[] (anyOf 1).accounting_record.line_items[].billing_amountJSONOptional
results[] (anyOf 1).accounting_record.line_items[].billing_amount (anyOf 1)objectAlternativeAdditional keys: not allowed
results[] (anyOf 1).accounting_record.line_items[].billing_amount (anyOf 1).amountJSONRequired within parent
results[] (anyOf 1).accounting_record.line_items[].billing_amount (anyOf 1).amount (anyOf 1)numberAlternative
results[] (anyOf 1).accounting_record.line_items[].billing_amount (anyOf 1).amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
results[] (anyOf 1).accounting_record.line_items[].billing_amount (anyOf 1).currencystringRequired within parent
results[] (anyOf 1).accounting_record.line_items[].billing_amount (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].idstringRequired within parent
results[] (anyOf 1).accounting_record.line_items[].memoJSONOptional
results[] (anyOf 1).accounting_record.line_items[].memo (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.line_items[].memo (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].original_amountJSONOptional
results[] (anyOf 1).accounting_record.line_items[].original_amount (anyOf 1)objectAlternativeAdditional keys: not allowed
results[] (anyOf 1).accounting_record.line_items[].original_amount (anyOf 1).amountJSONRequired within parent
results[] (anyOf 1).accounting_record.line_items[].original_amount (anyOf 1).amount (anyOf 1)numberAlternative
results[] (anyOf 1).accounting_record.line_items[].original_amount (anyOf 1).amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
results[] (anyOf 1).accounting_record.line_items[].original_amount (anyOf 1).currencystringRequired within parent
results[] (anyOf 1).accounting_record.line_items[].original_amount (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.line_items[].typestringRequired within parentKnown values: CREDIT, DEBIT
results[] (anyOf 1).accounting_record.memoJSONOptional
results[] (anyOf 1).accounting_record.memo (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.memo (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.original_amountJSONOptional
results[] (anyOf 1).accounting_record.original_amount (anyOf 1)objectAlternativeAdditional keys: not allowed
results[] (anyOf 1).accounting_record.original_amount (anyOf 1).amountJSONRequired within parent
results[] (anyOf 1).accounting_record.original_amount (anyOf 1).amount (anyOf 1)numberAlternative
results[] (anyOf 1).accounting_record.original_amount (anyOf 1).amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
results[] (anyOf 1).accounting_record.original_amount (anyOf 1).currencystringRequired within parent
results[] (anyOf 1).accounting_record.original_amount (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.posted_atstringRequired within parent
results[] (anyOf 1).accounting_record.receiptsJSONOptional
results[] (anyOf 1).accounting_record.receipts (anyOf 1)arrayAlternative
results[] (anyOf 1).accounting_record.receipts (anyOf 1)[]objectEach itemAdditional keys: not allowed
results[] (anyOf 1).accounting_record.receipts (anyOf 1)[].download_urisarrayOptional
results[] (anyOf 1).accounting_record.receipts (anyOf 1)[].download_uris[]stringEach item
results[] (anyOf 1).accounting_record.receipts (anyOf 1)[].idstringRequired within parent
results[] (anyOf 1).accounting_record.receipts (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.review_statusstringRequired within parentKnown values: PREPARE, REVIEW, EXPORTED, READY_FOR_EXPORT
results[] (anyOf 1).accounting_record.source_idstringOptional
results[] (anyOf 1).accounting_record.source_typestringRequired within parentKnown values: CARD, REIMBURSEMENT, BILL
results[] (anyOf 1).accounting_record.statusJSONOptional
results[] (anyOf 1).accounting_record.status (anyOf 1)stringAlternativeThe source expense's approval/lifecycle status.
Known values: APPROVED, CANCELED, DRAFT, OUT_OF_POLICY, SETTLED, SPLIT, SUBMITTED, VOID
results[] (anyOf 1).accounting_record.status (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.typestringRequired within parentKnown values: CARD_EXPENSE_POST, CARD_EXPENSE_REPAYMENT, REIMBURSEMENT_EXPENSE_REPAYMENT, REIMBURSEMENT_EXPENSE_APPROVAL, REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT, REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYIN, REIMBURSEMENT_EXPENSE_POST, CARD_PAYMENT, REWARD_REDEMPTION, REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_REFUND, CARD_EXPENSE_REFUND, CARD_PAYMENT_REFUND, REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT_REVERSAL, INVOICE, INVOICE_PAYMENT, BILL_EXPENSE, BILL_EXPENSE_PAYMENT, BILL_EXPENSE_CARD_PAYMENT, BILL_MONEY_MOVEMENT_PAYIN
results[] (anyOf 1).accounting_record.updated_atstringRequired within parent
results[] (anyOf 1).accounting_record.userJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1)objectAlternativeAdditional keys: not allowed
results[] (anyOf 1).accounting_record.user (anyOf 1).account_idJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).account_id (anyOf 1)stringAlternativeThe ID of the account the user belongs to (e.g., cuacc_1234)
results[] (anyOf 1).accounting_record.user (anyOf 1).account_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).brex_assistantJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).brex_assistant (anyOf 1)objectAlternativeThe resolved Brex Assistant state. Null unless include contains 'brex_assistant'.
Additional keys: not allowed
results[] (anyOf 1).accounting_record.user (anyOf 1).brex_assistant (anyOf 1).disabled_reasonJSONRequired within parent
results[] (anyOf 1).accounting_record.user (anyOf 1).brex_assistant (anyOf 1).disabled_reason (anyOf 1)stringAlternativeKnown values: ACCOUNT_DISABLED, INHERITED_FROM_ACCOUNT_DEFAULT, USER_DISABLED
results[] (anyOf 1).accounting_record.user (anyOf 1).brex_assistant (anyOf 1).disabled_reason (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).brex_assistant (anyOf 1).experienceJSONRequired within parent
results[] (anyOf 1).accounting_record.user (anyOf 1).brex_assistant (anyOf 1).experience (anyOf 1)stringAlternativeKnown values: IAF, LEGACY
results[] (anyOf 1).accounting_record.user (anyOf 1).brex_assistant (anyOf 1).experience (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).brex_assistant (anyOf 1).is_enabledJSONRequired within parent
results[] (anyOf 1).accounting_record.user (anyOf 1).brex_assistant (anyOf 1).is_enabled (anyOf 1)booleanAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).brex_assistant (anyOf 1).is_enabled (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).brex_assistant (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).department_idJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).department_id (anyOf 1)stringAlternativeThe ID of the user's department
results[] (anyOf 1).accounting_record.user (anyOf 1).department_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).department_nameJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).department_name (anyOf 1)stringAlternativeThe user's department name (e.g., Engineering)
results[] (anyOf 1).accounting_record.user (anyOf 1).department_name (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).emailJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).email (anyOf 1)stringAlternativeThe user's email address (e.g., john.doe@example.com)
results[] (anyOf 1).accounting_record.user (anyOf 1).email (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).first_namestringRequired within parentThe user's first name (e.g., John)
results[] (anyOf 1).accounting_record.user (anyOf 1).idstringRequired within parentThe ID of the user (e.g., cuuser_abc123def456ghi789jkl012)
results[] (anyOf 1).accounting_record.user (anyOf 1).last_namestringRequired within parentThe user's last name (e.g., Doe)
results[] (anyOf 1).accounting_record.user (anyOf 1).location_idJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).location_id (anyOf 1)stringAlternativeThe ID of the user's location
results[] (anyOf 1).accounting_record.user (anyOf 1).location_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).location_nameJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).location_name (anyOf 1)stringAlternativeThe user's location name (e.g., San Francisco)
results[] (anyOf 1).accounting_record.user (anyOf 1).location_name (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_first_nameJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_first_name (anyOf 1)stringAlternativeThe user's manager first name
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_first_name (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_idJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_id (anyOf 1)stringAlternativeThe ID of the user's manager
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_last_nameJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_last_name (anyOf 1)stringAlternativeThe user's manager last name
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_last_name (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_title_idJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_title_id (anyOf 1)stringAlternativeThe user's manager title ID
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_title_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_title_nameJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_title_name (anyOf 1)stringAlternativeThe user's manager title display name
results[] (anyOf 1).accounting_record.user (anyOf 1).manager_title_name (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).metadataJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).metadata (anyOf 1)objectAlternativeCustomer-defined user metadata
property Names: {"type": "string"}
Additional keys: see wildcard field
results[] (anyOf 1).accounting_record.user (anyOf 1).metadata (anyOf 1).*stringAdditional keys
results[] (anyOf 1).accounting_record.user (anyOf 1).metadata (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferencesJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1)objectAlternativeThe user's notification preferences across Brex. Null unless include contains 'notification_preferences', or when the caller cannot read this user.
Additional keys: not allowed
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).card_transactions_completedJSONRequired within parent
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).card_transactions_completed (anyOf 1)objectAlternativeAdditional keys: not allowed
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).card_transactions_completed (anyOf 1).brex_assistantbooleanRequired within parent
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).card_transactions_completed (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).preferred_channelsJSONRequired within parent
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).preferred_channels (anyOf 1)arrayAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).preferred_channels (anyOf 1)[]objectEach itemAdditional keys: not allowed
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).preferred_channels (anyOf 1)[].channelJSONRequired within parent
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).preferred_channels (anyOf 1)[].channel (anyOf 1)stringAlternativeKnown values: SLACK, SMS, WHATSAPP
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).preferred_channels (anyOf 1)[].channel (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).preferred_channels (anyOf 1)[].reply_modeJSONRequired within parent
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).preferred_channels (anyOf 1)[].reply_mode (anyOf 1)stringAlternativeKnown values: ONE_WAY, TWO_WAY
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).preferred_channels (anyOf 1)[].reply_mode (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).preferred_channels (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).textJSONRequired within parent
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).text (anyOf 1)stringAlternativeKnown values: OFF, SMS, WHATSAPP
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 1).text (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).notification_preferences (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).phone_numberJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).phone_number (anyOf 1)stringAlternativeThe user's phone number. Null unless include contains 'phone_number'.
results[] (anyOf 1).accounting_record.user (anyOf 1).phone_number (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).roleJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).role (anyOf 1)stringAlternativeThe user's role in the system (e.g., CARD_ADMIN). See UserRole enum for values.
Known values: ACCOUNT_ADMIN, AP_CLERK, BOOKKEEPER, CARD_ADMIN, EMPLOYEE, EMPLOYEE_WITHOUT_CORP_CARDS, EXPENSE_ADMIN, SUPER_ADMIN, USER_MANAGEMENT_ADMIN
results[] (anyOf 1).accounting_record.user (anyOf 1).role (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).statusstringRequired within parentThe user's status in the system (e.g., ACTIVE)
Known values: ACTIVE, ARCHIVED, DELETED, DISABLED, INACTIVE, INVITED, PENDING_ACTIVATION
results[] (anyOf 1).accounting_record.user (anyOf 1).title_idJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).title_id (anyOf 1)stringAlternativeThe user's title ID
results[] (anyOf 1).accounting_record.user (anyOf 1).title_id (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 1).title_nameJSONOptional
results[] (anyOf 1).accounting_record.user (anyOf 1).title_name (anyOf 1)stringAlternativeThe user's title display name (e.g., Software Engineer)
results[] (anyOf 1).accounting_record.user (anyOf 1).title_name (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.user (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.vendorJSONOptional
results[] (anyOf 1).accounting_record.vendor (anyOf 1)objectAlternativeAdditional keys: not allowed
results[] (anyOf 1).accounting_record.vendor (anyOf 1).contact_nameJSONOptional
results[] (anyOf 1).accounting_record.vendor (anyOf 1).contact_name (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.vendor (anyOf 1).contact_name (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.vendor (anyOf 1).emailJSONOptional
results[] (anyOf 1).accounting_record.vendor (anyOf 1).email (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.vendor (anyOf 1).email (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.vendor (anyOf 1).idstringRequired within parent
results[] (anyOf 1).accounting_record.vendor (anyOf 1).namestringRequired within parent
results[] (anyOf 1).accounting_record.vendor (anyOf 1).phoneJSONOptional
results[] (anyOf 1).accounting_record.vendor (anyOf 1).phone (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.vendor (anyOf 1).phone (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.vendor (anyOf 1).websiteJSONOptional
results[] (anyOf 1).accounting_record.vendor (anyOf 1).website (anyOf 1)stringAlternative
results[] (anyOf 1).accounting_record.vendor (anyOf 1).website (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.vendor (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record.versionJSONOptional
results[] (anyOf 1).accounting_record.version (anyOf 1)JSONAlternative
results[] (anyOf 1).accounting_record.version (anyOf 1) (anyOf 1)numberAlternative
results[] (anyOf 1).accounting_record.version (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
results[] (anyOf 1).accounting_record.version (anyOf 2)nullAlternative
results[] (anyOf 1).accounting_record_idstringRequired within parent
results[] (anyOf 1).statusstringRequired within parentKnown values: updated
results[] (anyOf 2)objectAlternativeAdditional keys: not allowed
results[] (anyOf 2).accounting_record_idstringRequired within parent
results[] (anyOf 2).errorobjectRequired within parentAdditional keys: not allowed
results[] (anyOf 2).error.codestringRequired within parentKnown values: NOT_FOUND, UNSUPPORTED_SOURCE_TYPE, ITEMIZED_EXPENSE_NOT_SUPPORTED, RECORD_NOT_EDITABLE, FIELD_NOT_EDITABLE, INVALID_FIELD_VALUE, PERMISSION_DENIED, UPDATE_FAILED, UPDATE_OUTCOME_UNKNOWN
results[] (anyOf 2).error.messagestringRequired within parent
results[] (anyOf 2).statusstringRequired within parentKnown values: failed

Update amortization template — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
is_disabledbooleanOptionalSet true to hide the template from selection on new expenses, false to restore it
namestringOptionalNew name for the template

Update tax code — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
subsidiariesarrayRequired within parentPer-subsidiary status changes to apply
subsidiaries[]ModelEach itemExpand Update tax code — request body — body subsidiaries item

Referenced models: Update tax code — request body — body subsidiaries item

Update tax code — request body — body subsidiaries item

FieldTypePresenceDescription and constraints
$objectRoot
statusstringRequired within parentWhether the tax code is enabled for this subsidiary
One of: ENABLED, DISABLED
subsidiary_idstringRequired within parentThe subsidiary this status applies to

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.