---
title: ExpensesPaths
editUrl: false
head: []
template: doc
prev: false
next: false
sidebar:
  hidden: false
  attrs: {}
pagefind: true
draft: false
---

Defined in: [src/expenses/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L2)

## Properties

### /v1/expenses

> **/v1/expenses**: `object`

Defined in: [src/expenses/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L3)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

List expenses

##### Description

List expenses under the same account. Admin and bookkeeper have access to any expense, and regular users can only access their own.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path?

> `optional` **path?**: `undefined`

##### get.parameters.query?

> `optional` **query?**: `object`

##### get.parameters.query.budget\_id\[\]?

> `optional` **budget\_id\[\]?**: `string`[] \| `null`

##### get.parameters.query.cursor?

> `optional` **cursor?**: `string` \| `null`

###### Description

The cursor to use for pagination. This is the `next_cursor` value returned from the previous response.

##### get.parameters.query.expand\[\]?

> `optional` **expand\[\]?**: `string`[] \| `null`

###### Description

Get additional details for the expense, e.g. merchant mcc code, by passing in `expand[]=merchant`. Query parameters include `location`, `department`, `merchant`, `receipts.download_uris`, `user`, `budget`, `payment`, `spending_entity` and `policy`.

###### Example

```ts
?expand[]=merchant&expand[]=location
```

##### get.parameters.query.expense\_type\[\]?

> `optional` **expense\_type\[\]?**: (`"CARD"` \| `"REIMBURSEMENT"` \| `"BILLPAY"` \| `"CLAWBACK"` \| `"UNSET"`)[] \| `null`

##### get.parameters.query.limit?

> `optional` **limit?**: `number` \| `null`

###### Description

Controls the maximum number of expenses returned in the response, can't be greater than 100

##### get.parameters.query.load\_custom\_fields?

> `optional` **load\_custom\_fields?**: `boolean` \| `null`

###### Description

Load custom fields for the expenses.

##### get.parameters.query.parent\_expense\_id\[\]?

> `optional` **parent\_expense\_id\[\]?**: `string`[] \| `null`

###### Description

Get itemized expenses belong to provided parent expenses ID(s).

##### get.parameters.query.payment\_posted\_at\_end?

> `optional` **payment\_posted\_at\_end?**: `string` \| `null`

###### Description

Shows only expenses with a `payment_posted_at` on or before this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999

###### Example

```ts
2023-01-10T23:59:59.999
```

##### get.parameters.query.payment\_posted\_at\_start?

> `optional` **payment\_posted\_at\_start?**: `string` \| `null`

###### Description

Shows only expenses with a `payment_posted_at` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999

###### Example

```ts
2023-01-01T23:59:59.999
```

##### get.parameters.query.payment\_status\[\]?

> `optional` **payment\_status\[\]?**: (`"NOT_STARTED"` \| `"PROCESSING"` \| `"CANCELED"` \| `"DECLINED"` \| `"CLEARED"` \| `"REFUNDING"` \| `"REFUNDED"` \| `"CASH_ADVANCE"` \| `"CREDITED"` \| `"AWAITING_PAYMENT"` \| `"SCHEDULED"`)[] \| `null`

##### get.parameters.query.purchased\_at\_end?

> `optional` **purchased\_at\_end?**: `string` \| `null`

###### Description

Shows only expenses with a `purchased_at` on or before this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999

###### Example

```ts
2023-01-10T23:59:59.999
```

##### get.parameters.query.purchased\_at\_start?

> `optional` **purchased\_at\_start?**: `string` \| `null`

###### Description

Shows only expenses with a `purchased_at` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999

###### Example

```ts
2023-01-01T23:59:59.999
```

##### get.parameters.query.spending\_entity\_id\[\]?

> `optional` **spending\_entity\_id\[\]?**: `string`[] \| `null`

##### get.parameters.query.status\[\]?

> `optional` **status\[\]?**: (`"APPROVED"` \| `"CANCELED"` \| `"DRAFT"` \| `"SUBMITTED"` \| `"OUT_OF_POLICY"` \| `"VOID"` \| `"SPLIT"` \| `"SETTLED"`)[] \| `null`

##### get.parameters.query.updated\_at\_end?

> `optional` **updated\_at\_end?**: `string` \| `null`

###### Description

Shows only expenses with a `updated_at` on or before this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999

###### Example

```ts
2023-01-10T23:59:59.999
```

##### get.parameters.query.updated\_at\_start?

> `optional` **updated\_at\_start?**: `string` \| `null`

###### Description

Shows only expenses with a `updated_at` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999

###### Example

```ts
2023-01-01T23:59:59.999
```

##### get.parameters.query.user\_id\[\]?

> `optional` **user\_id\[\]?**: `string`[] \| `null`

###### Description

Get expenses belong to provided user(s).

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

List expenses response.

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.items

> **items**: `object`[]

##### get.responses.200.content.application/json.next\_cursor?

> `optional` **next\_cursor?**: `string` \| `null`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/expenses/\{id\}

> **/v1/expenses/\{id\}**: `object`

Defined in: [src/expenses/types.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L23)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

Get an expense

##### Description

Get an expense by its ID.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path

> **path**: `object`

##### get.parameters.path.id

> **id**: `string`

##### get.parameters.query?

> `optional` **query?**: `object`

##### get.parameters.query.expand\[\]?

> `optional` **expand\[\]?**: `string`[] \| `null`

###### Description

Get additional details for the expense, e.g. merchant mcc code, by passing in `expand[]=merchant`. Query parameters include `location`, `department`, `merchant`, `receipts.download_uris`, `user`, `budget`, `payment`, `spending_entity` and `policy`.

###### Example

```ts
?expand[]=merchant&expand[]=location
```

##### get.parameters.query.load\_custom\_fields?

> `optional` **load\_custom\_fields?**: `boolean` \| `null`

###### Description

Load custom fields for the expense.

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

Get an expense response.

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.address?

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

###### Union Members

###### Type Literal

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

###### city?

> `optional` **city?**: `string` \| `null`

###### Description

City, district, suburb, town, or village.

###### coordinates?

> `optional` **coordinates?**: \{ `latitude`: `number`; `longitude`: `number`; \} \| `null`

###### Union Members

###### Type Literal

\{ `latitude`: `number`; `longitude`: `number`; \}

###### latitude

> **latitude**: `number`

Format: double

###### longitude

> **longitude**: `number`

Format: double

***

`null`

###### country?

> `optional` **country?**: `string` \| `null`

###### Description

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

###### line1?

> `optional` **line1?**: `string` \| `null`

###### Description

Address line 1, no PO Box.

###### line2?

> `optional` **line2?**: `string` \| `null`

###### Description

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

###### postal\_code?

> `optional` **postal\_code?**: `string` \| `null`

###### Description

ZIP or postal code.

###### state?

> `optional` **state?**: `string` \| `null`

###### Description

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

###### timezone?

> `optional` **timezone?**: `string` \| `null`

###### Description

Timezone.

***

`null`

##### get.responses.200.content.application/json.approved\_at?

> `optional` **approved\_at?**: `string` \| `null`

Format: date-time

###### Description

The time the expense is approved.

##### get.responses.200.content.application/json.billing\_amount?

> `optional` **billing\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### amount

> **amount**: `number`

Format: int64

###### Description

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

###### Example

```ts
700
```

###### currency

> **currency**: `string` \| `null`

###### Description

The type of currency, in ISO 4217 format.

###### Default

```ts
USD
```

###### Example

```ts
USD
```

***

`null`

##### get.responses.200.content.application/json.billing\_entity\_id?

> `optional` **billing\_entity\_id?**: `string` \| `null`

###### Description

ID of the legal entity responsible for billing the expense.

##### get.responses.200.content.application/json.booking\_id?

> `optional` **booking\_id?**: `string` \| `null`

###### Description

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

##### get.responses.200.content.application/json.budget?

> `optional` **budget?**: \{ `id`: `string`; `name`: `string`; \} \| `null`

###### Union Members

###### Type Literal

\{ `id`: `string`; `name`: `string`; \}

###### id

> **id**: `string`

###### Description

Unique ID for the Budget.

###### name

> **name**: `string`

###### Description

Name for the Budget.

***

`null`

##### get.responses.200.content.application/json.budget\_amount?

> `optional` **budget\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### amount

> **amount**: `number`

Format: int64

###### Description

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

###### Example

```ts
700
```

###### currency

> **currency**: `string` \| `null`

###### Description

The type of currency, in ISO 4217 format.

###### Default

```ts
USD
```

###### Example

```ts
USD
```

***

`null`

##### get.responses.200.content.application/json.budget\_id?

> `optional` **budget\_id?**: `string` \| `null`

##### get.responses.200.content.application/json.category?

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

##### get.responses.200.content.application/json.completion\_date?

> `optional` **completion\_date?**: `string` \| `null`

Format: date-time

###### Description

The time payment will be completed/is completed.

##### get.responses.200.content.application/json.custom\_fields?

> `optional` **custom\_fields?**: `object`[] \| `null`

###### Description

A list of custom field values associated with the expense.

##### get.responses.200.content.application/json.dashboard\_url

> **dashboard\_url**: `string`

###### Description

URL to view the expense in the Brex dashboard.

##### get.responses.200.content.application/json.department?

> `optional` **department?**: \{ `id`: `string`; `name`: `string`; \} \| `null`

###### Union Members

###### Type Literal

\{ `id`: `string`; `name`: `string`; \}

###### id

> **id**: `string`

###### Description

The unique identifier for the department.

###### name

> **name**: `string`

###### Description

The name of the department.

***

`null`

##### get.responses.200.content.application/json.department\_id?

> `optional` **department\_id?**: `string` \| `null`

##### get.responses.200.content.application/json.expense\_line\_items?

> `optional` **expense\_line\_items?**: \{ address?: \{ city?: string \| null \| undefined; coordinates?: \{ latitude: number; longitude: number; \} \| null \| undefined; country?: string \| null \| undefined; line1?: string \| null \| undefined; line2?: string \| ... 1 more ... \| undefined; postal\_code?: string \| ... 1 more ... \| undefined; state?: string \| ... 1 mor...[] \| `null`

###### Description

The expense line items. Limited to 100 items.

##### get.responses.200.content.application/json.expense\_type?

> `optional` **expense\_type?**: `"CARD"` \| `"REIMBURSEMENT"` \| `"BILLPAY"` \| `"CLAWBACK"` \| `"UNSET"` \| `null`

##### get.responses.200.content.application/json.exported\_at?

> `optional` **exported\_at?**: `string` \| `null`

Format: date-time

###### Description

Timestamp when the expense was exported to the accounting system.

##### get.responses.200.content.application/json.id

> **id**: `string`

###### Description

Unique ID associated with the expense.

##### get.responses.200.content.application/json.integration\_billing\_entity\_id?

> `optional` **integration\_billing\_entity\_id?**: `string` \| `null`

###### Description

ID of the billing entity in accounting.

##### get.responses.200.content.application/json.integration\_spending\_entity\_id?

> `optional` **integration\_spending\_entity\_id?**: `string` \| `null`

###### Description

ID of the spending entity in accounting.

##### get.responses.200.content.application/json.location?

> `optional` **location?**: \{ `id`: `string`; `name`: `string`; \} \| `null`

###### Union Members

###### Type Literal

\{ `id`: `string`; `name`: `string`; \}

###### id

> **id**: `string`

###### Description

The unique identifier for the location.

###### name

> **name**: `string`

###### Description

The name of the location.

***

`null`

##### get.responses.200.content.application/json.location\_id?

> `optional` **location\_id?**: `string` \| `null`

##### get.responses.200.content.application/json.memo?

> `optional` **memo?**: `string` \| `null`

###### Description

The memo of the expense.

##### get.responses.200.content.application/json.merchant?

> `optional` **merchant?**: \{ `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; \} \| `null`

###### Union Members

###### Type Literal

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

###### country

> **country**: `string`

###### Description

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

###### mcc

> **mcc**: `string`

###### Description

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

> **raw\_descriptor**: `string`

###### Description

Merchant descriptor, it can be the merchant name.

***

`null`

##### get.responses.200.content.application/json.merchant\_id?

> `optional` **merchant\_id?**: `string` \| `null`

##### get.responses.200.content.application/json.original\_amount?

> `optional` **original\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### amount

> **amount**: `number`

Format: int64

###### Description

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

###### Example

```ts
700
```

###### currency

> **currency**: `string` \| `null`

###### Description

The type of currency, in ISO 4217 format.

###### Default

```ts
USD
```

###### Example

```ts
USD
```

***

`null`

##### get.responses.200.content.application/json.payment?

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

###### Union Members

###### Type Literal

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

###### id

> **id**: `string`

###### Description

Unique ID for the payment.

###### paymentInstrument

> **paymentInstrument**: `Omit`\<`object` & `object` & `object`, `"type"`\>

###### statusReason

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

***

`null`

##### get.responses.200.content.application/json.payment\_posted\_at?

> `optional` **payment\_posted\_at?**: `string` \| `null`

Format: date-time

##### get.responses.200.content.application/json.payment\_status?

> `optional` **payment\_status?**: `"NOT_STARTED"` \| `"PROCESSING"` \| `"CANCELED"` \| `"DECLINED"` \| `"CLEARED"` \| `"REFUNDING"` \| `"REFUNDED"` \| `"CASH_ADVANCE"` \| `"CREDITED"` \| `"AWAITING_PAYMENT"` \| `"SCHEDULED"` \| `null`

##### get.responses.200.content.application/json.policy?

> `optional` **policy?**: \{ `id`: `string`; `name`: `string`; \} \| `null`

###### Union Members

###### Type Literal

\{ `id`: `string`; `name`: `string`; \}

###### id

> **id**: `string`

###### Description

The unique identifier for the policy.

###### name

> **name**: `string`

###### Description

The display name of the policy.

***

`null`

##### get.responses.200.content.application/json.purchased\_amount?

> `optional` **purchased\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### amount

> **amount**: `number`

Format: int64

###### Description

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

###### Example

```ts
700
```

###### currency

> **currency**: `string` \| `null`

###### Description

The type of currency, in ISO 4217 format.

###### Default

```ts
USD
```

###### Example

```ts
USD
```

***

`null`

##### get.responses.200.content.application/json.purchased\_at?

> `optional` **purchased\_at?**: `string` \| `null`

Format: date-time

###### Description

The time the purchase was made.

##### get.responses.200.content.application/json.receipts?

> `optional` **receipts?**: `object`[] \| `null`

###### Description

A list of receipts associated with the expense.

##### get.responses.200.content.application/json.repayment?

> `optional` **repayment?**: \{ `repayment_initiated_by?`: \{ `department_id?`: ... \| ... \| ...; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: ... \| ... \| ...; \} \| `null`; `repayment_initiation_date?`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### repayment\_initiated\_by?

> `optional` **repayment\_initiated\_by?**: \{ `department_id?`: ... \| ... \| ...; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: ... \| ... \| ...; \} \| `null`

###### Union Members

###### Type Literal

\{ `department_id?`: ... \| ... \| ...; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: ... \| ... \| ...; \}

###### department\_id?

> `optional` **department\_id?**: ... \| ... \| ...

###### first\_name

> **first\_name**: `string`

###### Description

First name of the User.

###### id

> **id**: `string`

###### Description

Unique ID for the User.

###### last\_name

> **last\_name**: `string`

###### Description

Last name of the User.

###### location\_id?

> `optional` **location\_id?**: ... \| ... \| ...

***

`null`

###### repayment\_initiation\_date?

> `optional` **repayment\_initiation\_date?**: `string` \| `null`

Format: date-time

***

`null`

##### get.responses.200.content.application/json.review?

> `optional` **review?**: \{ `approval_steps`: `object`[] \| `null`; `compliance_status`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### approval\_steps

> **approval\_steps**: `object`[] \| `null`

###### Description

Information for each approval step of the expense

###### compliance\_status

> **compliance\_status**: `string` \| `null`

###### Description

Compliance status of the expense

***

`null`

##### get.responses.200.content.application/json.spending\_entity?

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

###### Union Members

###### Type Literal

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

###### billing\_address

> **billing\_address**: `object`

###### billing\_address.city?

> `optional` **city?**: `string` \| `null`

###### Description

City, district, suburb, town, or village.

###### billing\_address.country?

> `optional` **country?**: `string` \| `null`

###### Description

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

###### billing\_address.line1?

> `optional` **line1?**: `string` \| `null`

###### Description

Address line 1, no PO Box.

###### billing\_address.line2?

> `optional` **line2?**: `string` \| `null`

###### Description

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

###### billing\_address.phone\_number?

> `optional` **phone\_number?**: `string` \| `null`

###### Description

Phone number.

###### billing\_address.postal\_code?

> `optional` **postal\_code?**: `string` \| `null`

###### Description

ZIP or postal code.

###### billing\_address.state?

> `optional` **state?**: `string` \| `null`

###### Description

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

###### created\_at

> **created\_at**: `string`

Format: date-time

###### Description

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

###### display\_name

> **display\_name**: `string`

###### Description

The display name of this legal entity.

###### id

> **id**: `string`

###### Description

The ID of this legal entity.

###### is\_default?

> `optional` **is\_default?**: `boolean`

###### Description

Whether this is the default entity of the account.

###### status

> **status**: `"UNSUBMITTED"` \| `"UNVERIFIED"` \| `"IN_PROGRESS"` \| `"VERIFIED"` \| `"REJECTED"`

***

`null`

##### get.responses.200.content.application/json.spending\_entity\_id?

> `optional` **spending\_entity\_id?**: `string` \| `null`

###### Description

The spending entity ID associated with the expense.

##### get.responses.200.content.application/json.status?

> `optional` **status?**: `"APPROVED"` \| `"CANCELED"` \| `"DRAFT"` \| `"SUBMITTED"` \| `"OUT_OF_POLICY"` \| `"VOID"` \| `"SPLIT"` \| `"SETTLED"` \| `null`

##### get.responses.200.content.application/json.submitted\_at?

> `optional` **submitted\_at?**: `string` \| `null`

Format: date-time

###### Description

The time the expense is submitted,

##### get.responses.200.content.application/json.trip\_id?

> `optional` **trip\_id?**: `string` \| `null`

###### Description

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

##### get.responses.200.content.application/json.updated\_at

> **updated\_at**: `string`

Format: date-time

###### Description

The last time the expense was updated.

##### get.responses.200.content.application/json.usd\_equivalent\_amount?

> `optional` **usd\_equivalent\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### amount

> **amount**: `number`

Format: int64

###### Description

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

###### Example

```ts
700
```

###### currency

> **currency**: `string` \| `null`

###### Description

The type of currency, in ISO 4217 format.

###### Default

```ts
USD
```

###### Example

```ts
USD
```

***

`null`

##### get.responses.200.content.application/json.user?

> `optional` **user?**: \{ `department_id?`: `string` \| `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### department\_id?

> `optional` **department\_id?**: `string` \| `null`

###### first\_name

> **first\_name**: `string`

###### Description

First name of the User.

###### id

> **id**: `string`

###### Description

Unique ID for the User.

###### last\_name

> **last\_name**: `string`

###### Description

Last name of the User.

###### location\_id?

> `optional` **location\_id?**: `string` \| `null`

***

`null`

##### get.responses.200.content.application/json.user\_id?

> `optional` **user\_id?**: `string` \| `null`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.404

> **404**: `object`

###### Description

Not found

##### get.responses.404.content?

> `optional` **content?**: `undefined`

##### get.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/expenses/card

> **/v1/expenses/card**: `object`

Defined in: [src/expenses/types.gen.ts:43](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L43)

#### delete?

> `optional` **delete?**: `undefined`

#### ~~get~~

> **get**: `object`

List card expenses

:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::

##### Description

This endpoint is deprecated. Use the "List expenses" (`GET /v1/expenses`) endpoint instead.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path?

> `optional` **path?**: `undefined`

##### get.parameters.query?

> `optional` **query?**: `object`

##### get.parameters.query.budget\_id\[\]?

> `optional` **budget\_id\[\]?**: `string`[] \| `null`

##### get.parameters.query.cursor?

> `optional` **cursor?**: `string` \| `null`

###### Description

The cursor to use for pagination. This is the `next_cursor` value returned from the previous response.

##### get.parameters.query.expand\[\]?

> `optional` **expand\[\]?**: `string`[] \| `null`

###### Description

Get additional details for the expense, e.g. merchant mcc code, by passing in `expand[]=merchant`. Query parameters include `location`, `department`, `merchant`, `receipts.download_uris`, `user`, `budget`, `payment`, `spending_entity` and `policy`.

###### Example

```ts
?expand[]=merchant&expand[]=location
```

##### get.parameters.query.limit?

> `optional` **limit?**: `number` \| `null`

###### Description

Controls the maximum number of expenses returned in the response, can't be greater than 100

##### get.parameters.query.load\_custom\_fields?

> `optional` **load\_custom\_fields?**: `boolean` \| `null`

###### Description

Load custom fields for the expenses.

##### get.parameters.query.parent\_expense\_id\[\]?

> `optional` **parent\_expense\_id\[\]?**: `string`[] \| `null`

###### Description

Get itemized expenses belong to provided parent expenses ID(s).

##### get.parameters.query.payment\_posted\_at\_end?

> `optional` **payment\_posted\_at\_end?**: `string` \| `null`

###### Description

Shows only expenses with a `payment_posted_at` on or before this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999

###### Example

```ts
2023-01-10T23:59:59.999
```

##### get.parameters.query.payment\_posted\_at\_start?

> `optional` **payment\_posted\_at\_start?**: `string` \| `null`

###### Description

Shows only expenses with a `payment_posted_at` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999

###### Example

```ts
2023-01-01T23:59:59.999
```

##### get.parameters.query.payment\_status\[\]?

> `optional` **payment\_status\[\]?**: (`"NOT_STARTED"` \| `"PROCESSING"` \| `"CANCELED"` \| `"DECLINED"` \| `"CLEARED"` \| `"REFUNDING"` \| `"REFUNDED"` \| `"CASH_ADVANCE"` \| `"CREDITED"` \| `"AWAITING_PAYMENT"` \| `"SCHEDULED"`)[] \| `null`

##### get.parameters.query.purchased\_at\_end?

> `optional` **purchased\_at\_end?**: `string` \| `null`

###### Description

Shows only expenses with a `purchased_at` on or before this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999

###### Example

```ts
2023-01-10T23:59:59.999
```

##### get.parameters.query.purchased\_at\_start?

> `optional` **purchased\_at\_start?**: `string` \| `null`

###### Description

Shows only expenses with a `purchased_at` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999

###### Example

```ts
2023-01-01T23:59:59.999
```

##### get.parameters.query.spending\_entity\_id\[\]?

> `optional` **spending\_entity\_id\[\]?**: `string`[] \| `null`

##### get.parameters.query.status\[\]?

> `optional` **status\[\]?**: (`"APPROVED"` \| `"CANCELED"` \| `"DRAFT"` \| `"SUBMITTED"` \| `"OUT_OF_POLICY"` \| `"VOID"` \| `"SPLIT"` \| `"SETTLED"`)[] \| `null`

##### get.parameters.query.updated\_at\_end?

> `optional` **updated\_at\_end?**: `string` \| `null`

###### Description

Shows only expenses with a `updated_at` on or before this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999

###### Example

```ts
2023-01-10T23:59:59.999
```

##### get.parameters.query.updated\_at\_start?

> `optional` **updated\_at\_start?**: `string` \| `null`

###### Description

Shows only expenses with a `updated_at` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999

###### Example

```ts
2023-01-01T23:59:59.999
```

##### get.parameters.query.user\_id\[\]?

> `optional` **user\_id\[\]?**: `string`[] \| `null`

###### Description

Get expenses belong to provided user(s).

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

List expenses response.

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.items

> **items**: `object`[]

##### get.responses.200.content.application/json.next\_cursor?

> `optional` **next\_cursor?**: `string` \| `null`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/expenses/card/\{expense\_id\}

> **/v1/expenses/card/\{expense\_id\}**: `object`

Defined in: [src/expenses/types.gen.ts:64](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L64)

#### delete?

> `optional` **delete?**: `undefined`

#### ~~get~~

> **get**: `object`

Get a card expense

:::caution[Deprecated]
This API is no longer supported and may be removed in a future release.
:::

##### Description

This endpoint is deprecated. Use the "Get an expense" (`GET /v1/expenses/{id}`) endpoint instead.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path

> **path**: `object`

##### get.parameters.path.expense\_id

> **expense\_id**: `string`

##### get.parameters.query?

> `optional` **query?**: `object`

##### get.parameters.query.expand\[\]?

> `optional` **expand\[\]?**: `string`[] \| `null`

###### Description

Get additional details for the expense, e.g. merchant mcc code, by passing in `expand[]=merchant`. Query parameters include `location`, `department`, `merchant`, `receipts.download_uris`, `user`, `budget`, `payment`, `spending_entity` and `policy`.

###### Example

```ts
?expand[]=merchant&expand[]=location
```

##### get.parameters.query.load\_custom\_fields?

> `optional` **load\_custom\_fields?**: `boolean` \| `null`

###### Description

Load custom fields for the expense.

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

Get an expense response.

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.address?

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

###### Union Members

###### Type Literal

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

###### ~~city?~~

> `optional` **city?**: `string` \| `null`

###### Description

City, district, suburb, town, or village.

###### ~~coordinates?~~

> `optional` **coordinates?**: \{ `latitude`: `number`; `longitude`: `number`; \} \| `null`

###### Union Members

###### Type Literal

\{ `latitude`: `number`; `longitude`: `number`; \}

###### ~~latitude~~

> **latitude**: `number`

Format: double

###### ~~longitude~~

> **longitude**: `number`

Format: double

***

`null`

###### ~~country?~~

> `optional` **country?**: `string` \| `null`

###### Description

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

###### ~~line1?~~

> `optional` **line1?**: `string` \| `null`

###### Description

Address line 1, no PO Box.

###### ~~line2?~~

> `optional` **line2?**: `string` \| `null`

###### Description

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

###### ~~postal\_code?~~

> `optional` **postal\_code?**: `string` \| `null`

###### Description

ZIP or postal code.

###### ~~state?~~

> `optional` **state?**: `string` \| `null`

###### Description

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

###### ~~timezone?~~

> `optional` **timezone?**: `string` \| `null`

###### Description

Timezone.

***

`null`

##### get.responses.200.content.application/json.approved\_at?

> `optional` **approved\_at?**: `string` \| `null`

Format: date-time

###### Description

The time the expense is approved.

##### get.responses.200.content.application/json.billing\_amount?

> `optional` **billing\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### ~~amount~~

> **amount**: `number`

Format: int64

###### Description

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

###### Example

```ts
700
```

###### ~~currency~~

> **currency**: `string` \| `null`

###### Description

The type of currency, in ISO 4217 format.

###### Default

```ts
USD
```

###### Example

```ts
USD
```

***

`null`

##### get.responses.200.content.application/json.billing\_entity\_id?

> `optional` **billing\_entity\_id?**: `string` \| `null`

###### Description

ID of the legal entity responsible for billing the expense.

##### get.responses.200.content.application/json.booking\_id?

> `optional` **booking\_id?**: `string` \| `null`

###### Description

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

##### get.responses.200.content.application/json.budget?

> `optional` **budget?**: \{ `id`: `string`; `name`: `string`; \} \| `null`

###### Union Members

###### Type Literal

\{ `id`: `string`; `name`: `string`; \}

###### ~~id~~

> **id**: `string`

###### Description

Unique ID for the Budget.

###### ~~name~~

> **name**: `string`

###### Description

Name for the Budget.

***

`null`

##### get.responses.200.content.application/json.budget\_amount?

> `optional` **budget\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### ~~amount~~

> **amount**: `number`

Format: int64

###### Description

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

###### Example

```ts
700
```

###### ~~currency~~

> **currency**: `string` \| `null`

###### Description

The type of currency, in ISO 4217 format.

###### Default

```ts
USD
```

###### Example

```ts
USD
```

***

`null`

##### get.responses.200.content.application/json.budget\_id?

> `optional` **budget\_id?**: `string` \| `null`

##### get.responses.200.content.application/json.category?

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

##### get.responses.200.content.application/json.completion\_date?

> `optional` **completion\_date?**: `string` \| `null`

Format: date-time

###### Description

The time payment will be completed/is completed.

##### get.responses.200.content.application/json.custom\_fields?

> `optional` **custom\_fields?**: `object`[] \| `null`

###### Description

A list of custom field values associated with the expense.

##### get.responses.200.content.application/json.dashboard\_url

> **dashboard\_url**: `string`

###### Description

URL to view the expense in the Brex dashboard.

##### get.responses.200.content.application/json.department?

> `optional` **department?**: \{ `id`: `string`; `name`: `string`; \} \| `null`

###### Union Members

###### Type Literal

\{ `id`: `string`; `name`: `string`; \}

###### ~~id~~

> **id**: `string`

###### Description

The unique identifier for the department.

###### ~~name~~

> **name**: `string`

###### Description

The name of the department.

***

`null`

##### get.responses.200.content.application/json.department\_id?

> `optional` **department\_id?**: `string` \| `null`

##### get.responses.200.content.application/json.expense\_line\_items?

> `optional` **expense\_line\_items?**: \{ address?: \{ city?: string \| null \| undefined; coordinates?: \{ latitude: number; longitude: number; \} \| null \| undefined; country?: string \| null \| undefined; line1?: string \| null \| undefined; line2?: string \| ... 1 more ... \| undefined; postal\_code?: string \| ... 1 more ... \| undefined; state?: string \| ... 1 mor...[] \| `null`

###### Description

The expense line items. Limited to 100 items.

##### get.responses.200.content.application/json.expense\_type?

> `optional` **expense\_type?**: `"CARD"` \| `"REIMBURSEMENT"` \| `"BILLPAY"` \| `"CLAWBACK"` \| `"UNSET"` \| `null`

##### get.responses.200.content.application/json.exported\_at?

> `optional` **exported\_at?**: `string` \| `null`

Format: date-time

###### Description

Timestamp when the expense was exported to the accounting system.

##### get.responses.200.content.application/json.id

> **id**: `string`

###### Description

Unique ID associated with the expense.

##### get.responses.200.content.application/json.integration\_billing\_entity\_id?

> `optional` **integration\_billing\_entity\_id?**: `string` \| `null`

###### Description

ID of the billing entity in accounting.

##### get.responses.200.content.application/json.integration\_spending\_entity\_id?

> `optional` **integration\_spending\_entity\_id?**: `string` \| `null`

###### Description

ID of the spending entity in accounting.

##### get.responses.200.content.application/json.location?

> `optional` **location?**: \{ `id`: `string`; `name`: `string`; \} \| `null`

###### Union Members

###### Type Literal

\{ `id`: `string`; `name`: `string`; \}

###### ~~id~~

> **id**: `string`

###### Description

The unique identifier for the location.

###### ~~name~~

> **name**: `string`

###### Description

The name of the location.

***

`null`

##### get.responses.200.content.application/json.location\_id?

> `optional` **location\_id?**: `string` \| `null`

##### get.responses.200.content.application/json.memo?

> `optional` **memo?**: `string` \| `null`

###### Description

The memo of the expense.

##### get.responses.200.content.application/json.merchant?

> `optional` **merchant?**: \{ `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; \} \| `null`

###### Union Members

###### Type Literal

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

###### ~~country~~

> **country**: `string`

###### Description

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

###### ~~mcc~~

> **mcc**: `string`

###### Description

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~~

> **raw\_descriptor**: `string`

###### Description

Merchant descriptor, it can be the merchant name.

***

`null`

##### get.responses.200.content.application/json.merchant\_id?

> `optional` **merchant\_id?**: `string` \| `null`

##### get.responses.200.content.application/json.original\_amount?

> `optional` **original\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### ~~amount~~

> **amount**: `number`

Format: int64

###### Description

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

###### Example

```ts
700
```

###### ~~currency~~

> **currency**: `string` \| `null`

###### Description

The type of currency, in ISO 4217 format.

###### Default

```ts
USD
```

###### Example

```ts
USD
```

***

`null`

##### get.responses.200.content.application/json.payment?

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

###### Union Members

###### Type Literal

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

###### ~~id~~

> **id**: `string`

###### Description

Unique ID for the payment.

###### ~~paymentInstrument~~

> **paymentInstrument**: `Omit`\<`object` & `object` & `object`, `"type"`\>

###### ~~statusReason~~

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

***

`null`

##### get.responses.200.content.application/json.payment\_posted\_at?

> `optional` **payment\_posted\_at?**: `string` \| `null`

Format: date-time

##### get.responses.200.content.application/json.payment\_status?

> `optional` **payment\_status?**: `"NOT_STARTED"` \| `"PROCESSING"` \| `"CANCELED"` \| `"DECLINED"` \| `"CLEARED"` \| `"REFUNDING"` \| `"REFUNDED"` \| `"CASH_ADVANCE"` \| `"CREDITED"` \| `"AWAITING_PAYMENT"` \| `"SCHEDULED"` \| `null`

##### get.responses.200.content.application/json.policy?

> `optional` **policy?**: \{ `id`: `string`; `name`: `string`; \} \| `null`

###### Union Members

###### Type Literal

\{ `id`: `string`; `name`: `string`; \}

###### ~~id~~

> **id**: `string`

###### Description

The unique identifier for the policy.

###### ~~name~~

> **name**: `string`

###### Description

The display name of the policy.

***

`null`

##### get.responses.200.content.application/json.purchased\_amount?

> `optional` **purchased\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### ~~amount~~

> **amount**: `number`

Format: int64

###### Description

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

###### Example

```ts
700
```

###### ~~currency~~

> **currency**: `string` \| `null`

###### Description

The type of currency, in ISO 4217 format.

###### Default

```ts
USD
```

###### Example

```ts
USD
```

***

`null`

##### get.responses.200.content.application/json.purchased\_at?

> `optional` **purchased\_at?**: `string` \| `null`

Format: date-time

###### Description

The time the purchase was made.

##### get.responses.200.content.application/json.receipts?

> `optional` **receipts?**: `object`[] \| `null`

###### Description

A list of receipts associated with the expense.

##### get.responses.200.content.application/json.repayment?

> `optional` **repayment?**: \{ `repayment_initiated_by?`: \{ `department_id?`: ... \| ... \| ...; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: ... \| ... \| ...; \} \| `null`; `repayment_initiation_date?`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### ~~repayment\_initiated\_by?~~

> `optional` **repayment\_initiated\_by?**: \{ `department_id?`: ... \| ... \| ...; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: ... \| ... \| ...; \} \| `null`

###### Union Members

###### Type Literal

\{ `department_id?`: ... \| ... \| ...; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: ... \| ... \| ...; \}

###### ~~department\_id?~~

> `optional` **department\_id?**: ... \| ... \| ...

###### ~~first\_name~~

> **first\_name**: `string`

###### Description

First name of the User.

###### ~~id~~

> **id**: `string`

###### Description

Unique ID for the User.

###### ~~last\_name~~

> **last\_name**: `string`

###### Description

Last name of the User.

###### ~~location\_id?~~

> `optional` **location\_id?**: ... \| ... \| ...

***

`null`

###### ~~repayment\_initiation\_date?~~

> `optional` **repayment\_initiation\_date?**: `string` \| `null`

Format: date-time

***

`null`

##### get.responses.200.content.application/json.review?

> `optional` **review?**: \{ `approval_steps`: `object`[] \| `null`; `compliance_status`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### ~~approval\_steps~~

> **approval\_steps**: `object`[] \| `null`

###### Description

Information for each approval step of the expense

###### ~~compliance\_status~~

> **compliance\_status**: `string` \| `null`

###### Description

Compliance status of the expense

***

`null`

##### get.responses.200.content.application/json.spending\_entity?

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

###### Union Members

###### Type Literal

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

###### ~~billing\_address~~

> **billing\_address**: `object`

###### billing\_address.city?

> `optional` **city?**: `string` \| `null`

###### Description

City, district, suburb, town, or village.

###### billing\_address.country?

> `optional` **country?**: `string` \| `null`

###### Description

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

###### billing\_address.line1?

> `optional` **line1?**: `string` \| `null`

###### Description

Address line 1, no PO Box.

###### billing\_address.line2?

> `optional` **line2?**: `string` \| `null`

###### Description

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

###### billing\_address.phone\_number?

> `optional` **phone\_number?**: `string` \| `null`

###### Description

Phone number.

###### billing\_address.postal\_code?

> `optional` **postal\_code?**: `string` \| `null`

###### Description

ZIP or postal code.

###### billing\_address.state?

> `optional` **state?**: `string` \| `null`

###### Description

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

###### ~~created\_at~~

> **created\_at**: `string`

Format: date-time

###### Description

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

###### ~~display\_name~~

> **display\_name**: `string`

###### Description

The display name of this legal entity.

###### ~~id~~

> **id**: `string`

###### Description

The ID of this legal entity.

###### ~~is\_default?~~

> `optional` **is\_default?**: `boolean`

###### Description

Whether this is the default entity of the account.

###### ~~status~~

> **status**: `"UNSUBMITTED"` \| `"UNVERIFIED"` \| `"IN_PROGRESS"` \| `"VERIFIED"` \| `"REJECTED"`

***

`null`

##### get.responses.200.content.application/json.spending\_entity\_id?

> `optional` **spending\_entity\_id?**: `string` \| `null`

###### Description

The spending entity ID associated with the expense.

##### get.responses.200.content.application/json.status?

> `optional` **status?**: `"APPROVED"` \| `"CANCELED"` \| `"DRAFT"` \| `"SUBMITTED"` \| `"OUT_OF_POLICY"` \| `"VOID"` \| `"SPLIT"` \| `"SETTLED"` \| `null`

##### get.responses.200.content.application/json.submitted\_at?

> `optional` **submitted\_at?**: `string` \| `null`

Format: date-time

###### Description

The time the expense is submitted,

##### get.responses.200.content.application/json.trip\_id?

> `optional` **trip\_id?**: `string` \| `null`

###### Description

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

##### get.responses.200.content.application/json.updated\_at

> **updated\_at**: `string`

Format: date-time

###### Description

The last time the expense was updated.

##### get.responses.200.content.application/json.usd\_equivalent\_amount?

> `optional` **usd\_equivalent\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### ~~amount~~

> **amount**: `number`

Format: int64

###### Description

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

###### Example

```ts
700
```

###### ~~currency~~

> **currency**: `string` \| `null`

###### Description

The type of currency, in ISO 4217 format.

###### Default

```ts
USD
```

###### Example

```ts
USD
```

***

`null`

##### get.responses.200.content.application/json.user?

> `optional` **user?**: \{ `department_id?`: `string` \| `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### ~~department\_id?~~

> `optional` **department\_id?**: `string` \| `null`

###### ~~first\_name~~

> **first\_name**: `string`

###### Description

First name of the User.

###### ~~id~~

> **id**: `string`

###### Description

Unique ID for the User.

###### ~~last\_name~~

> **last\_name**: `string`

###### Description

Last name of the User.

###### ~~location\_id?~~

> `optional` **location\_id?**: `string` \| `null`

***

`null`

##### get.responses.200.content.application/json.user\_id?

> `optional` **user\_id?**: `string` \| `null`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.404

> **404**: `object`

###### Description

Not found

##### get.responses.404.content?

> `optional` **content?**: `undefined`

##### get.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put

> **put**: `object`

Update an expense

##### Description

Update an expense. Admin and bookkeeper have access to any expense, and regular users can only access their own.

##### put.parameters

> **parameters**: `object`

##### put.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### put.parameters.header?

> `optional` **header?**: `undefined`

##### put.parameters.path

> **path**: `object`

##### put.parameters.path.expense\_id

> **expense\_id**: `string`

##### put.parameters.query?

> `optional` **query?**: `undefined`

##### put.requestBody

> **requestBody**: `object`

##### put.requestBody.content

> **content**: `object`

##### put.requestBody.content.application/json

> **application/json**: `object`

##### put.requestBody.content.application/json.memo?

> `optional` **memo?**: `string` \| `null`

###### Description

Expense memo.

##### put.responses

> **responses**: `object`

##### put.responses.200

> **200**: `object`

###### Description

Update an expense response.

##### put.responses.200.content

> **content**: `object`

##### put.responses.200.content.application/json

> **application/json**: `object`

##### put.responses.200.content.application/json.billing\_amount?

> `optional` **billing\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### amount

> **amount**: `number`

Format: int64

###### Description

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

###### Example

```ts
700
```

###### currency

> **currency**: `string` \| `null`

###### Description

The type of currency, in ISO 4217 format.

###### Default

```ts
USD
```

###### Example

```ts
USD
```

***

`null`

##### put.responses.200.content.application/json.budget\_id?

> `optional` **budget\_id?**: `string` \| `null`

##### put.responses.200.content.application/json.category?

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

##### put.responses.200.content.application/json.department\_id?

> `optional` **department\_id?**: `string` \| `null`

##### put.responses.200.content.application/json.id

> **id**: `string`

###### Description

Unique ID associated with the expense.

##### put.responses.200.content.application/json.location\_id?

> `optional` **location\_id?**: `string` \| `null`

##### put.responses.200.content.application/json.memo?

> `optional` **memo?**: `string` \| `null`

###### Description

The memo of the expense.

##### put.responses.200.content.application/json.merchant\_id?

> `optional` **merchant\_id?**: `string` \| `null`

##### put.responses.200.content.application/json.original\_amount?

> `optional` **original\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null`

###### Union Members

###### Type Literal

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

###### amount

> **amount**: `number`

Format: int64

###### Description

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

###### Example

```ts
700
```

###### currency

> **currency**: `string` \| `null`

###### Description

The type of currency, in ISO 4217 format.

###### Default

```ts
USD
```

###### Example

```ts
USD
```

***

`null`

##### put.responses.200.content.application/json.payment\_status?

> `optional` **payment\_status?**: `"NOT_STARTED"` \| `"PROCESSING"` \| `"CANCELED"` \| `"DECLINED"` \| `"CLEARED"` \| `"REFUNDING"` \| `"REFUNDED"` \| `"CASH_ADVANCE"` \| `"CREDITED"` \| `"AWAITING_PAYMENT"` \| `"SCHEDULED"` \| `null`

##### put.responses.200.content.application/json.purchased\_at?

> `optional` **purchased\_at?**: `string` \| `null`

Format: date-time

###### Description

The time the purchase was made.

##### put.responses.200.content.application/json.status?

> `optional` **status?**: `"APPROVED"` \| `"CANCELED"` \| `"DRAFT"` \| `"SUBMITTED"` \| `"OUT_OF_POLICY"` \| `"VOID"` \| `"SPLIT"` \| `"SETTLED"` \| `null`

##### put.responses.200.content.application/json.updated\_at

> **updated\_at**: `string`

Format: date-time

###### Description

The last time the expense was updated.

##### put.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.400

> **400**: `object`

###### Description

Bad request

##### put.responses.400.content?

> `optional` **content?**: `undefined`

##### put.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.401

> **401**: `object`

###### Description

Unauthorized

##### put.responses.401.content?

> `optional` **content?**: `undefined`

##### put.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.403

> **403**: `object`

###### Description

Forbidden

##### put.responses.403.content?

> `optional` **content?**: `undefined`

##### put.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.404

> **404**: `object`

###### Description

Not found

##### put.responses.404.content?

> `optional` **content?**: `undefined`

##### put.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/expenses/card/\{expense\_id\}/receipt\_upload

> **/v1/expenses/card/\{expense\_id\}/receipt\_upload**: `object`

Defined in: [src/expenses/types.gen.ts:89](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L89)

#### delete?

> `optional` **delete?**: `undefined`

#### get?

> `optional` **get?**: `undefined`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post

> **post**: `object`

Create a new receipt upload

##### Description

The `uri` will be a pre-signed S3 URL allowing you to upload the receipt securely. This URL can only be used for a `PUT` operation and expires 30 minutes after its creation. Once your upload is complete, we will try to match the receipt with existing expenses.

    Refer to these [docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/PresignedUrlUploadObject.html) on how to upload to this pre-signed S3 URL. We highly recommend using one of AWS SDKs if they're available for your language to upload these files.

##### post.parameters

> **parameters**: `object`

##### post.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### post.parameters.header?

> `optional` **header?**: `undefined`

##### post.parameters.path

> **path**: `object`

##### post.parameters.path.expense\_id

> **expense\_id**: `string`

##### post.parameters.query?

> `optional` **query?**: `undefined`

##### post.requestBody

> **requestBody**: `object`

##### post.requestBody.content

> **content**: `object`

##### post.requestBody.content.application/json

> **application/json**: `object`

##### post.requestBody.content.application/json.receipt\_name

> **receipt\_name**: `string`

###### Description

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

##### post.responses

> **responses**: `object`

##### post.responses.201

> **201**: `object`

###### Description

Upload a new receipt response.

##### post.responses.201.content

> **content**: `object`

##### post.responses.201.content.application/json

> **application/json**: `object`

##### post.responses.201.content.application/json.id

> **id**: `string`

###### Description

The unique identifier for the request.

##### post.responses.201.content.application/json.uri

> **uri**: `string`

###### Description

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

##### post.responses.201.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.400

> **400**: `object`

###### Description

Bad request

##### post.responses.400.content?

> `optional` **content?**: `undefined`

##### post.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.401

> **401**: `object`

###### Description

Unauthorized

##### post.responses.401.content?

> `optional` **content?**: `undefined`

##### post.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.403

> **403**: `object`

###### Description

Forbidden

##### post.responses.403.content?

> `optional` **content?**: `undefined`

##### post.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.404

> **404**: `object`

###### Description

Not found

##### post.responses.404.content?

> `optional` **content?**: `undefined`

##### post.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/expenses/card/receipt\_match

> **/v1/expenses/card/receipt\_match**: `object`

Defined in: [src/expenses/types.gen.ts:111](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L111)

#### delete?

> `optional` **delete?**: `undefined`

#### get?

> `optional` **get?**: `undefined`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post

> **post**: `object`

Create a new receipt match

##### Description

The `uri` will be a pre-signed S3 URL allowing you to upload the receipt securely. This URL can only be used for a `PUT` operation and expires 30 minutes after its creation. Once your upload is complete, we will try to match the receipt with existing expenses.

    Refer to these [docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/PresignedUrlUploadObject.html) on how to upload to this pre-signed S3 URL. We highly recommend using one of AWS SDKs if they're available for your language to upload these files.

##### post.parameters

> **parameters**: `object`

##### post.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### post.parameters.header?

> `optional` **header?**: `undefined`

##### post.parameters.path?

> `optional` **path?**: `undefined`

##### post.parameters.query?

> `optional` **query?**: `undefined`

##### post.requestBody

> **requestBody**: `object`

##### post.requestBody.content

> **content**: `object`

##### post.requestBody.content.application/json

> **application/json**: `object`

##### post.requestBody.content.application/json.receipt\_name

> **receipt\_name**: `string`

###### Description

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

##### post.responses

> **responses**: `object`

##### post.responses.201

> **201**: `object`

###### Description

Create a new receipt match response.

##### post.responses.201.content

> **content**: `object`

##### post.responses.201.content.application/json

> **application/json**: `object`

##### post.responses.201.content.application/json.id

> **id**: `string`

###### Description

The unique identifier for the request.

##### post.responses.201.content.application/json.uri

> **uri**: `string`

###### Description

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

##### post.responses.201.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.400

> **400**: `object`

###### Description

Bad request

##### post.responses.400.content?

> `optional` **content?**: `undefined`

##### post.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.401

> **401**: `object`

###### Description

Unauthorized

##### post.responses.401.content?

> `optional` **content?**: `undefined`

##### post.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`