Brex: Expenses schemas
38 Brex schemas with complete fields and constraints.
← Expenses operations · All schemas
Create a new receipt match — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The parameter for creating a receipt match. |
receipt_name | string | Required within parent | The name of the receipt (with the file extension). It will be used in the matching result email. |
Create a new receipt match — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The pre-signed file upload URI and unique identifier of the request. |
id | string | Required within parent | The unique identifier for the request. |
uri | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The parameter for creating a receipt upload. |
receipt_name | string | Required within parent | The name of the receipt (with the file extension). |
Get an expense — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The expense object that has expandable fields, e.g., `location`, `department`, `cost_center`, `merchant`, `receipts.download_uris`, `user`, `budget`, `payment`, `spending_entity`, and `policy`. |
addenda | JSON | Optional | |
addenda (anyOf 1) | array | Alternative | Structured purchase data attached to the expense, returned only when `load_expense_addenda=true`. Omitted when the expense has no addenda. |
addenda (anyOf 1)[] | Model | Each item | Expand Get an expense — response body — addenda array item |
addenda (anyOf 2) | null | Alternative | |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | |
address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — address Location Location |
address (anyOf 2) | null | Alternative | |
approved_at | JSON | Optional | |
approved_at (anyOf 1) | string | Alternative | The time the expense is approved. Format: date-time |
approved_at (anyOf 2) | null | Alternative | |
billing_amount | JSON | Optional | |
billing_amount (anyOf 1) | JSON | Alternative | |
billing_amount (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
billing_amount (anyOf 1) (allOf 2) | JSON | All variants apply | The 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) | null | Alternative | |
billing_entity_id | JSON | Optional | |
billing_entity_id (anyOf 1) | string | Alternative | ID of the legal entity responsible for billing the expense. |
billing_entity_id (anyOf 2) | null | Alternative | |
booking_id | JSON | Optional | |
booking_id (anyOf 1) | string | Alternative | The booking ID associated with the expense if it is a trip expense. |
booking_id (anyOf 2) | null | Alternative | |
budget | JSON | Optional | |
budget (anyOf 1) | JSON | Alternative | |
budget (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — budget id, name id, name |
budget (anyOf 2) | null | Alternative | |
budget_amount | JSON | Optional | |
budget_amount (anyOf 1) | JSON | Alternative | |
budget_amount (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
budget_amount (anyOf 1) (allOf 2) | JSON | All variants apply | The budget amount of the expense is the amount that was incurred in the budget's currency |
budget_amount (anyOf 2) | null | Alternative | |
budget_id | JSON | Optional | |
budget_id (anyOf 1) | string | Alternative | |
budget_id (anyOf 2) | null | Alternative | |
card_transaction_reference_id | JSON | Optional | |
card_transaction_reference_id (anyOf 1) | string | Alternative | Reference identifier for the underlying card transaction, if applicable. Null for non-card expenses (e.g. reimbursements). |
card_transaction_reference_id (anyOf 2) | null | Alternative | |
category | JSON | Optional | |
category (anyOf 1) | JSON | Alternative | |
category (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — category The category of expenses The category of expenses |
category (anyOf 2) | null | Alternative | |
completion_date | JSON | Optional | |
completion_date (anyOf 1) | string | Alternative | The time payment will be completed/is completed. Format: date-time |
completion_date (anyOf 2) | null | Alternative | |
cost_center | JSON | Optional | |
cost_center (anyOf 1) | JSON | Alternative | |
cost_center (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | JSON | All variants apply | The cost center associated with the expense. |
cost_center (anyOf 2) | null | Alternative | |
cost_center_id | JSON | Optional | |
cost_center_id (anyOf 1) | string | Alternative | |
cost_center_id (anyOf 2) | null | Alternative | |
custom_fields | JSON | Optional | |
custom_fields (anyOf 1) | array | Alternative | A list of custom field values associated with the expense. |
custom_fields (anyOf 1)[] | Model | Each item | Expand Get user — response body — custom fields array item |
custom_fields (anyOf 2) | null | Alternative | |
dashboard_url | string | Required within parent | URL to view the expense in the Brex dashboard. |
department | JSON | Optional | |
department (anyOf 1) | JSON | Alternative | |
department (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — department The department associated with the expense The department associated with the expense |
department (anyOf 2) | null | Alternative | |
department_id | JSON | Optional | |
department_id (anyOf 1) | string | Alternative | |
department_id (anyOf 2) | null | Alternative | |
expense_line_items | JSON | Optional | |
expense_line_items (anyOf 1) | array | Alternative | The expense line items. Limited to 100 items. |
expense_line_items (anyOf 1)[] | Model | Each item | Expand Get an expense — response body |
expense_line_items (anyOf 2) | null | Alternative | |
expense_type | JSON | Optional | |
expense_type (anyOf 1) | JSON | Alternative | |
expense_type (anyOf 1) (allOf 1) | string | All variants apply | Known values: CARD, BILLPAY, REIMBURSEMENT, CLAWBACK, UNSET |
expense_type (anyOf 2) | null | Alternative | |
exported_at | JSON | Optional | |
exported_at (anyOf 1) | string | Alternative | Timestamp when the expense was exported to the accounting system. Format: date-time |
exported_at (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique ID associated with the expense. |
integration_billing_entity_id | JSON | Optional | |
integration_billing_entity_id (anyOf 1) | string | Alternative | ID of the billing entity in accounting. |
integration_billing_entity_id (anyOf 2) | null | Alternative | |
integration_spending_entity_id | JSON | Optional | |
integration_spending_entity_id (anyOf 1) | string | Alternative | ID of the spending entity in accounting. |
integration_spending_entity_id (anyOf 2) | null | Alternative | |
location | JSON | Optional | |
location (anyOf 1) | JSON | Alternative | |
location (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — location The location associated with the expense The location associated with the expense |
location (anyOf 1) (allOf 2) | JSON | All variants apply | The location associated with the expense. |
location (anyOf 2) | null | Alternative | |
location_id | JSON | Optional | |
location_id (anyOf 1) | string | Alternative | |
location_id (anyOf 2) | null | Alternative | |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | The memo of the expense. |
memo (anyOf 2) | null | Alternative | |
merchant | JSON | Optional | |
merchant (anyOf 1) | JSON | Alternative | |
merchant (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — merchant country, mcc, raw descriptor country, mcc, raw descriptor |
merchant (anyOf 2) | null | Alternative | |
merchant_id | JSON | Optional | |
merchant_id (anyOf 1) | string | Alternative | |
merchant_id (anyOf 2) | null | Alternative | |
original_amount | JSON | Optional | |
original_amount (anyOf 1) | JSON | Alternative | |
original_amount (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
original_amount (anyOf 1) (allOf 2) | JSON | All variants apply | The original amount of the expense is the amount that the employee submitted or incurred for reimbursements or card spends. |
original_amount (anyOf 2) | null | Alternative | |
payment | JSON | Optional | |
payment (anyOf 1) | JSON | Alternative | |
payment (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — payment The payment associated with the expense The payment associated with the expense |
payment (anyOf 2) | null | Alternative | |
payment_posted_at | JSON | Optional | |
payment_posted_at (anyOf 1) | string | Alternative | Format: date-time |
payment_posted_at (anyOf 2) | null | Alternative | |
payment_status | JSON | Optional | |
payment_status (anyOf 1) | JSON | Alternative | |
payment_status (anyOf 1) (allOf 1) | string | All variants apply | The 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) | null | Alternative | |
policy | JSON | Optional | |
policy (anyOf 1) | JSON | Alternative | |
policy (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — policy The policy associated with the expense The policy associated with the expense |
policy (anyOf 1) (allOf 2) | JSON | All variants apply | The policy associated with the expense. |
policy (anyOf 2) | null | Alternative | |
purchased_amount | JSON | Optional | |
purchased_amount (anyOf 1) | JSON | Alternative | |
purchased_amount (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
purchased_amount (anyOf 1) (allOf 2) | JSON | All variants apply | The purchased amount of the expense is the amount that's on the receipt. |
purchased_amount (anyOf 2) | null | Alternative | |
purchased_at | JSON | Optional | |
purchased_at (anyOf 1) | string | Alternative | The time the purchase was made. Format: date-time |
purchased_at (anyOf 2) | null | Alternative | |
receipts | JSON | Optional | |
receipts (anyOf 1) | array | Alternative | A list of receipts associated with the expense. |
receipts (anyOf 1)[] | Model | Each item | Expand Get an expense — response body — receipts A list of receipts associated with the expense item |
receipts (anyOf 2) | null | Alternative | |
repayment | JSON | Optional | |
repayment (anyOf 1) | JSON | Alternative | |
repayment (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — repayment repayment initiated by, repayment initiation date repayment initiated by, repayment initiation date |
repayment (anyOf 1) (allOf 2) | JSON | All variants apply | The repayment information for the expense, include the time the repayment is created and the user that created the repayment. |
repayment (anyOf 2) | null | Alternative | |
review | JSON | Optional | |
review (anyOf 1) | JSON | Alternative | |
review (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — review approval steps, compliance status approval steps, compliance status |
review (anyOf 1) (allOf 2) | JSON | All variants apply | Review information for the expense, including compliance status and reviewer details. |
review (anyOf 2) | null | Alternative | |
spending_entity | JSON | Optional | |
spending_entity (anyOf 1) | JSON | Alternative | |
spending_entity (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — spending entity The spending entity associated with the expense Legal Entity |
spending_entity (anyOf 1) (allOf 2) | JSON | All variants apply | The spending entity associated with the expense. |
spending_entity (anyOf 2) | null | Alternative | |
spending_entity_id | JSON | Optional | |
spending_entity_id (anyOf 1) | string | Alternative | The spending entity ID associated with the expense. |
spending_entity_id (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | JSON | Alternative | |
status (anyOf 1) (allOf 1) | string | All variants apply | Known values: DRAFT, SUBMITTED, APPROVED, OUT_OF_POLICY, VOID, CANCELED, SPLIT, SETTLED |
status (anyOf 2) | null | Alternative | |
submitted_at | JSON | Optional | |
submitted_at (anyOf 1) | string | Alternative | The time the expense is submitted, Format: date-time |
submitted_at (anyOf 2) | null | Alternative | |
trip_id | JSON | Optional | |
trip_id (anyOf 1) | string | Alternative | The trip ID associated with the expense if it is a trip expense. |
trip_id (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | The last time the expense was updated. Format: date-time |
usd_equivalent_amount | JSON | Optional | |
usd_equivalent_amount (anyOf 1) | JSON | Alternative | |
usd_equivalent_amount (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
usd_equivalent_amount (anyOf 1) (allOf 2) | JSON | All variants apply | The amount of the expense converted in USD (if not already in USD). |
usd_equivalent_amount (anyOf 2) | null | Alternative | |
user | JSON | Optional | |
user (anyOf 1) | JSON | Alternative | |
user (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | null | Alternative | |
user_id | JSON | Optional | |
user_id (anyOf 1) | string | Alternative | |
user_id (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The people the expense was for, such as at a business meal. |
external_attendees | array | Required within parent | Attendees who are not Brex users. |
external_attendees[] | Model | Each item | Expand Get an expense — response body — addenda / array / item / data / object / type: ATTENDEES external attendees item |
internal_attendees | array | Required within parent | Attendees who are users on the same Brex account as the expense. |
internal_attendees[] | Model | Each item | Expand Get an expense — response body — addenda / array / item / data / object / type: ATTENDEES internal attendees item |
type | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An attendee who is not a Brex user. |
company_name | JSON | Optional | |
company_name (anyOf 1) | string | Alternative | The attendee's company name. |
company_name (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the external attendee. |
id (anyOf 2) | null | Alternative | |
is_government | JSON | Optional | |
is_government (anyOf 1) | boolean | Alternative | Whether the attendee works for a government. |
is_government (anyOf 2) | null | Alternative | |
name | string | Required within parent | The attendee's name. |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | The attendee's job title. |
title (anyOf 2) | null | Alternative |
Get an expense — response body — addenda / array / item / data / object / type: ATTENDEES internal attendees item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An attendee who is a Brex user on the same account. |
customer_user_id | string | Required within parent | The user ID of the attendee. |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | The attendee's first name. |
first_name (anyOf 2) | null | Alternative | |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | The attendee's last name. |
last_name (anyOf 2) | null | Alternative |
Get an expense — response body — addenda / array / item / data / object / type: COMMON DATA REQUIREMENTS
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Purchase data that card networks send with a clearing (Level 2 data). |
card_acceptor_reference_number | JSON | Optional | |
card_acceptor_reference_number (anyOf 1) | string | Alternative | The merchant's reference number for the transaction. Omitted when the network didn't send one. |
card_acceptor_reference_number (anyOf 2) | null | Alternative | |
customer_code | JSON | Optional | |
customer_code (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
type | string | Required within parent | Known values: COMMON_DATA_REQUIREMENTS |
Get an expense — response body — addenda / array / item / data / object / type: GENERAL TICKET INFORMATION
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | General information about a travel ticket. |
issuing_carrier | JSON | Optional | |
issuing_carrier (anyOf 1) | string | Alternative | The carrier that issued the ticket. |
issuing_carrier (anyOf 2) | null | Alternative | |
passenger_name | JSON | Optional | |
passenger_name (anyOf 1) | string | Alternative | The passenger name on the ticket. |
passenger_name (anyOf 2) | null | Alternative | |
ticket_number | JSON | Optional | |
ticket_number (anyOf 1) | string | Alternative | The ticket number. |
ticket_number (anyOf 2) | null | Alternative | |
type | string | Required within parent | Known values: GENERAL_TICKET_INFORMATION |
Get an expense — response body — addenda / array / item / data / object / type: LODGING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Lodging details from the hotel's folio. |
booked_at | JSON | Optional | |
booked_at (anyOf 1) | string | Alternative | When the accommodation was booked, in UTC, without an offset. |
booked_at (anyOf 2) | null | Alternative | |
cancellation_fee | JSON | Optional | |
cancellation_fee (anyOf 1) | object | Alternative | |
cancellation_fee (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies |
cancellation_fee (anyOf 1) (allOf 2) | object | All variants apply | The fee for cancelling the booking. |
cancellation_fee (anyOf 2) | null | Alternative | |
check_in_time | JSON | Optional | |
check_in_time (anyOf 1) | string | Alternative | When 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) | null | Alternative | |
check_in_time_zone_offset | JSON | Optional | |
check_in_time_zone_offset (anyOf 1) | string | Alternative | The time zone offset of the check-in time, in ISO-8601 format. |
check_in_time_zone_offset (anyOf 2) | null | Alternative | |
checkout_time | JSON | Optional | |
checkout_time (anyOf 1) | string | Alternative | When checkout must be done, in local time at the property, without an offset. Pair it with `checkout_time_zone_offset`. |
checkout_time (anyOf 2) | null | Alternative | |
checkout_time_zone_offset | JSON | Optional | |
checkout_time_zone_offset (anyOf 1) | string | Alternative | The time zone offset of the checkout time, in ISO-8601 format. |
checkout_time_zone_offset (anyOf 2) | null | Alternative | |
folio_id | JSON | Optional | |
folio_id (anyOf 1) | string | Alternative | The folio ID of the stay. |
folio_id (anyOf 2) | null | Alternative | |
guest_count | JSON | Optional | |
guest_count (anyOf 1) | JSON | Alternative | |
guest_count (anyOf 1) (anyOf 1) | integer | Alternative | The number of people in the reservation. Format: int64 |
guest_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
guest_count (anyOf 2) | null | Alternative | |
incidental_cost | JSON | Optional | |
incidental_cost (anyOf 1) | object | Alternative | |
incidental_cost (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies |
incidental_cost (anyOf 1) (allOf 2) | object | All variants apply | Incidental costs associated with the booking. |
incidental_cost (anyOf 2) | null | Alternative | |
laundry_fee | JSON | Optional | |
laundry_fee (anyOf 1) | object | Alternative | |
laundry_fee (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies |
laundry_fee (anyOf 1) (allOf 2) | object | All variants apply | The laundry fee associated with the booking. |
laundry_fee (anyOf 2) | null | Alternative | |
location | JSON | Optional | |
location (anyOf 1) | object | Alternative | |
location (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — address Location Location |
location (anyOf 1) (allOf 2) | object | All variants apply | Where the accommodation is located. |
location (anyOf 2) | null | Alternative | |
no_show_fee | JSON | Optional | |
no_show_fee (anyOf 1) | object | Alternative | |
no_show_fee (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies |
no_show_fee (anyOf 1) (allOf 2) | object | All variants apply | The no-show fee associated with the booking. |
no_show_fee (anyOf 2) | null | Alternative | |
parking_fee | JSON | Optional | |
parking_fee (anyOf 1) | object | Alternative | |
parking_fee (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies |
parking_fee (anyOf 1) (allOf 2) | object | All variants apply | The parking fee associated with the booking. |
parking_fee (anyOf 2) | null | Alternative | |
property_phone_number | JSON | Optional | |
property_phone_number (anyOf 1) | string | Alternative | The phone number of the property. |
property_phone_number (anyOf 2) | null | Alternative | |
resort_fee | JSON | Optional | |
resort_fee (anyOf 1) | object | Alternative | |
resort_fee (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies |
resort_fee (anyOf 1) (allOf 2) | object | All variants apply | The resort fee associated with the booking. |
resort_fee (anyOf 2) | null | Alternative | |
room_rate | JSON | Optional | |
room_rate (anyOf 1) | object | Alternative | |
room_rate (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies |
room_rate (anyOf 1) (allOf 2) | object | All variants apply | The average nightly rate for the accommodation. |
room_rate (anyOf 2) | null | Alternative | |
room_service | array | Required within parent | Room service charges. There can be several. |
room_service[] | Model | Each item | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING room service item |
star_rating | JSON | Optional | |
star_rating (anyOf 1) | JSON | Alternative | |
star_rating (anyOf 1) (anyOf 1) | integer | Alternative | The star rating of the accommodation, if available. Format: int32 |
star_rating (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
star_rating (anyOf 2) | null | Alternative | |
total_rate | JSON | Optional | |
total_rate (anyOf 1) | object | Alternative | |
total_rate (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies |
total_rate (anyOf 1) (allOf 2) | object | All variants apply | The total amount paid for the accommodation. May differ from the expense amount because of incidentals. |
total_rate (anyOf 2) | null | Alternative | |
tourism_tax | JSON | Optional | |
tourism_tax (anyOf 1) | object | Alternative | |
tourism_tax (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies |
tourism_tax (anyOf 1) (allOf 2) | object | All variants apply | The tourism tax associated with the booking. |
tourism_tax (anyOf 2) | null | Alternative | |
type | string | Required within parent | Known values: LODGING |
upgrade_fee | JSON | Optional | |
upgrade_fee (anyOf 1) | object | Alternative | |
upgrade_fee (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies |
upgrade_fee (anyOf 1) (allOf 2) | object | All variants apply | The fee for upgrading the booking. |
upgrade_fee (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A room service charge. |
description | string | Required within parent | A description of the room service. |
total_fee | JSON | Optional | |
total_fee (allOf 1) | Model | All variants apply | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING total rate currencies currencies |
total_fee (allOf 2) | JSON | All variants apply | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An 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`. |
currencies | object | Required within parent | The 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.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One segment of a train trip. |
carrier_code | JSON | Optional | |
carrier_code (anyOf 1) | string | Alternative | The standard abbreviation for the railway carrier. |
carrier_code (anyOf 2) | null | Alternative | |
city_of_destination | JSON | Optional | |
city_of_destination (anyOf 1) | string | Alternative | The city of destination. |
city_of_destination (anyOf 2) | null | Alternative | |
city_of_origin | JSON | Optional | |
city_of_origin (anyOf 1) | string | Alternative | The city of origin. |
city_of_origin (anyOf 2) | null | Alternative | |
destination_station | JSON | Optional | |
destination_station (anyOf 1) | string | Alternative | The station where this segment ended. |
destination_station (anyOf 2) | null | Alternative | |
procedure_id | JSON | Optional | |
procedure_id (anyOf 1) | string | Alternative | The order in which the service was booked. |
procedure_id (anyOf 2) | null | Alternative | |
sequence_number | JSON | Optional | |
sequence_number (anyOf 1) | string | Alternative | Where this segment falls in the trip's sequence. |
sequence_number (anyOf 2) | null | Alternative | |
service_class_code | JSON | Optional | |
service_class_code (anyOf 1) | string | Alternative | The service class, such as coach or first. |
service_class_code (anyOf 2) | null | Alternative | |
start_station | JSON | Optional | |
start_station (anyOf 1) | string | Alternative | The station where this segment started. |
start_station (anyOf 2) | null | Alternative | |
travel_date | JSON | Optional | |
travel_date (anyOf 1) | string | Alternative | The date of the train segment. Format: date |
travel_date (anyOf 2) | null | Alternative | |
type | string | Required within parent | Known values: TRAIN_DATA |
Get an expense — response body — addenda / array / item / data / object / type: TRIP LEG DATA
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One leg of a trip, such as a flight. |
carrier_code | JSON | Optional | |
carrier_code (anyOf 1) | string | Alternative | The standard abbreviation for the airline or railway carrier. |
carrier_code (anyOf 2) | null | Alternative | |
departure_time | JSON | Optional | |
departure_time (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
destination_airport_code | JSON | Optional | |
destination_airport_code (anyOf 1) | string | Alternative | The destination airport code. |
destination_airport_code (anyOf 2) | null | Alternative | |
flight_number | JSON | Optional | |
flight_number (anyOf 1) | string | Alternative | The flight number. |
flight_number (anyOf 2) | null | Alternative | |
origin_airport_code | JSON | Optional | |
origin_airport_code (anyOf 1) | string | Alternative | The origin airport code. |
origin_airport_code (anyOf 2) | null | Alternative | |
service_class_code | JSON | Optional | |
service_class_code (anyOf 1) | string | Alternative | The service class, such as coach or first. |
service_class_code (anyOf 2) | null | Alternative | |
travel_date | JSON | Optional | |
travel_date (anyOf 1) | string | Alternative | The date of the trip leg. Format: date |
travel_date (anyOf 2) | null | Alternative | |
type | string | Required within parent | Known values: TRIP_LEG_DATA |
Get an expense — response body — addenda array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One addendum on an expense. |
data | JSON | Required within parent | |
data (allOf 1) | Model | All variants apply | Expand Get an expense — response body — addenda array item data object |
data (allOf 2) | JSON | All variants apply | The 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. |
id | string | Required within parent | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | discriminator: {"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) | Model | Alternative | Expand Get an expense — response body — addenda / array / item / data / object / type: COMMON DATA REQUIREMENTS |
$ (anyOf 2) | Model | Alternative | Expand Get an expense — response body — addenda / array / item / data / object / type: LODGING |
$ (anyOf 3) | Model | Alternative | Expand Get an expense — response body — addenda / array / item / data / object / type: GENERAL TICKET INFORMATION |
$ (anyOf 4) | Model | Alternative | Expand Get an expense — response body — addenda / array / item / data / object / type: TRIP LEG DATA |
$ (anyOf 5) | Model | Alternative | Expand Get an expense — response body — addenda / array / item / data / object / type: TRAIN DATA |
$ (anyOf 6) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Location |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City, district, suburb, town, or village. |
city (anyOf 2) | null | Alternative | |
coordinates | JSON | Optional | |
coordinates (anyOf 1) | JSON | Alternative | |
coordinates (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — address Location Location coordinates Latitude and longitude Latitude and longitude |
coordinates (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Two-letter country code (ISO 3166-1 alpha-2). |
country (anyOf 2) | null | Alternative | |
line1 | JSON | Optional | |
line1 (anyOf 1) | string | Alternative | Address line 1, no PO Box. |
line1 (anyOf 2) | null | Alternative | |
line2 | JSON | Optional | |
line2 (anyOf 1) | string | Alternative | Address line 2 (e.g., apartment, suite, unit, or building). |
line2 (anyOf 2) | null | Alternative | |
postal_code | JSON | Optional | |
postal_code (anyOf 1) | string | Alternative | ZIP or postal code. |
postal_code (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. |
state (anyOf 2) | null | Alternative | |
timezone | JSON | Optional | |
timezone (anyOf 1) | string | Alternative | Timezone. |
timezone (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Latitude and longitude |
latitude | JSON | Required within parent | |
latitude (anyOf 1) | number | Alternative | Format: double |
latitude (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
longitude | JSON | Required within parent | |
longitude (anyOf 1) | number | Alternative | Format: double |
longitude (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get an expense — response body — budget id, name id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique ID for the Budget. |
name | string | Required within parent | Name for the Budget. |
Get an expense — response body — category The category of expenses The category of expenses
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The cost center associated with the expense. |
id | string | Required within parent | The unique identifier for the cost center. |
name | string | Required within parent | The name of the cost center. |
Get an expense — response body — department The department associated with the expense The department associated with the expense
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The department associated with the expense. |
id | string | Required within parent | The unique identifier for the department. |
name | string | Required within parent | The name of the department. |
Get an expense — response body — location The location associated with the expense The location associated with the expense
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The location associated with the expense. |
id | string | Required within parent | The unique identifier for the location. |
name | string | Required within parent | The name of the location. |
Get an expense — response body — merchant country, mcc, raw descriptor country, mcc, raw descriptor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Required within parent | Merchant's country, in ISO 3166-1 alpha-3 format. |
mcc | string | Required within parent | A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to https://en.wikipedia.org/wiki/Merchant_category_code for more details. |
raw_descriptor | string | Required within parent | Merchant 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | discriminator: {"mapping": {"CARD": "#/components/schemas/expenses__CardPaymentInstrument"}, "propertyName": "type"} |
type | string | Required within parent | Known values: CARD |
$ (anyOf 1) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).type | string | Required within parent | Known values: CARD |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).id | string | Required within parent | Unique ID for the card. |
$ (allOf 2).type | string | Required within parent | Known values: CARD |
Get an expense — response body — payment The payment associated with the expense The payment associated with the expense
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The payment associated with the expense. |
id | string | Required within parent | Unique ID for the payment. |
paymentInstrument | JSON | Required within parent | |
paymentInstrument (allOf 1) | Model | All variants apply | Expand Get an expense — response body — payment / The payment associated with the expense / The payment associated with the expense / paymentInstrument / type: CARD |
paymentInstrument (allOf 2) | JSON | All variants apply | The type of instrument by which the payment was made. |
statusReason | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The policy associated with the expense. |
id | string | Required within parent | The unique identifier for the policy. |
name | string | Required within parent | The display name of the policy. |
Get an expense — response body — receipts A list of receipts associated with the expense item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The receipt associated with the expense. |
download_uris | JSON | Optional | |
download_uris (anyOf 1) | array | Alternative | [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)[] | string | Each item | |
download_uris (anyOf 2) | null | Alternative | |
id | string | Required within parent | The unique identifier for the receipt. |
Get an expense — response body — repayment repayment initiated by, repayment initiation date repayment initiated by, repayment initiation date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
repayment_initiated_by | JSON | Optional | |
repayment_initiated_by (anyOf 1) | JSON | Alternative | |
repayment_initiated_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | null | Alternative | |
repayment_initiation_date | JSON | Optional | |
repayment_initiation_date (anyOf 1) | string | Alternative | Format: date-time |
repayment_initiation_date (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_steps | JSON | Required within parent | |
approval_steps (anyOf 1) | array | Alternative | Information for each approval step of the expense |
approval_steps (anyOf 1)[] | Model | Each item | Expand 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) | null | Alternative | |
compliance_status | JSON | Required within parent | |
compliance_status (anyOf 1) | string | Alternative | Compliance status of the expense |
compliance_status (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
copilot_reviewer | JSON | Optional | |
copilot_reviewer (anyOf 1) | JSON | Alternative | |
copilot_reviewer (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | null | Alternative | |
pending_reviewers | JSON | Optional | |
pending_reviewers (anyOf 1) | array | Alternative | |
pending_reviewers (anyOf 1)[] | Model | Each item | Expand 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) | null | Alternative | |
resolved_at | JSON | Optional | |
resolved_at (anyOf 1) | string | Alternative | Format: date-time |
resolved_at (anyOf 2) | null | Alternative | |
reviewer | JSON | Optional | |
reviewer (anyOf 1) | JSON | Alternative | |
reviewer (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | |
status (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Brex legal entity. |
billing_address | JSON | Required within parent | |
billing_address (allOf 1) | Model | All variants apply | Expand Get card — response body — billing address |
billing_address (allOf 2) | JSON | All variants apply | The billing address of this legal entity. Also used as billing address for cards issued to users who belong to this entity. |
created_at | string | Required within parent | Timestamp, in UTC, when this legal entity was created. Format: date-time |
display_name | string | Required within parent | The display name of this legal entity. |
id | string | Required within parent | The ID of this legal entity. |
is_default | boolean | Optional | Whether this is the default entity of the account. |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | The possible statuses for an entity's verification in Brex. Known values: UNSUBMITTED, UNVERIFIED, IN_PROGRESS, VERIFIED, REJECTED |
status (allOf 2) | JSON | All variants apply | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department_id | JSON | Optional | |
department_id (anyOf 1) | string | Alternative | |
department_id (anyOf 2) | null | Alternative | |
first_name | string | Required within parent | First name of the User. |
id | string | Required within parent | Unique ID for the User. |
last_name | string | Required within parent | Last name of the User. |
location_id | JSON | Optional | |
location_id (anyOf 1) | string | Alternative | |
location_id (anyOf 2) | null | Alternative |
List expenses — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get an expense — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get an expense — response body
Update an expense — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The parameter for updating an expense. |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Expense memo. |
memo (anyOf 2) | null | Alternative |
Update an expense — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
billing_amount | JSON | Optional | |
billing_amount (anyOf 1) | JSON | Alternative | |
billing_amount (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
billing_amount (anyOf 1) (allOf 2) | JSON | All variants apply | The 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) | null | Alternative | |
budget_id | JSON | Optional | |
budget_id (anyOf 1) | string | Alternative | |
budget_id (anyOf 2) | null | Alternative | |
category | JSON | Optional | |
category (anyOf 1) | JSON | Alternative | |
category (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — category The category of expenses The category of expenses |
category (anyOf 2) | null | Alternative | |
department_id | JSON | Optional | |
department_id (anyOf 1) | string | Alternative | |
department_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique ID associated with the expense. |
location_id | JSON | Optional | |
location_id (anyOf 1) | string | Alternative | |
location_id (anyOf 2) | null | Alternative | |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | The memo of the expense. |
memo (anyOf 2) | null | Alternative | |
merchant_id | JSON | Optional | |
merchant_id (anyOf 1) | string | Alternative | |
merchant_id (anyOf 2) | null | Alternative | |
original_amount | JSON | Optional | |
original_amount (anyOf 1) | JSON | Alternative | |
original_amount (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
original_amount (anyOf 1) (allOf 2) | JSON | All variants apply | The original amount of the expense is the amount that the employee submitted or incurred for reimbursements or card spends. |
original_amount (anyOf 2) | null | Alternative | |
payment_status | JSON | Optional | |
payment_status (anyOf 1) | JSON | Alternative | |
payment_status (anyOf 1) (allOf 1) | string | All variants apply | The 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) | null | Alternative | |
purchased_at | JSON | Optional | |
purchased_at (anyOf 1) | string | Alternative | The time the purchase was made. Format: date-time |
purchased_at (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | JSON | Alternative | |
status (anyOf 1) (allOf 1) | string | All variants apply | Known values: DRAFT, SUBMITTED, APPROVED, OUT_OF_POLICY, VOID, CANCELED, SPLIT, SETTLED |
status (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | The 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