This is the full developer documentation for brex # brex > The unofficial TypeScript SDK for the Brex API. Fully typed, tree-shakeable, zero-dependency — and generated deterministically from Brex's published OpenAPI specs. ```ts import { Brex } from 'brex'; const brex = new Brex({ token: process.env.BREX_TOKEN! }); // Typed responses, auto-pagination, idempotency — all built in. for await (const expense of brex.expenses.list({ 'expand[]': ['merchant'] })) { console.log(expense.id, expense.merchant?.raw_descriptor); } ``` Fully typed Request bodies, query params, and responses are typed straight from the specs. Every method also carries the operation’s full description inline. Tree-shakeable Import one API via a subpath (`brex/payments`) and the other nine never enter your bundle — about 3.5 kB min for a single API. Runs everywhere Native `fetch`, zero runtime dependencies, ESM-only. Node ≥ 20.19 (including `require()`), Bun, Deno, browsers, and edge runtimes. Auto-pagination Every list method is both a promise and an async iterator — await a page, or `for await` across all of them. Idempotency built in `Idempotency-Key` headers are sent automatically wherever Brex requires them, with an auto-generated UUID by default. LLM-friendly Every page is available as raw Markdown (add `.md` to any URL), plus [`/llms.txt`](/brex/llms.txt) and [`/llms-full.txt`](/brex/llms-full.txt). Unofficial library `brex` is **not** created, maintained, or endorsed by Brex Inc. or any associated entity. “Brex” is a registered trademark of Brex, Inc. Use of the Brex API is subject to the [Brex Access Agreement](https://www.brex.com/legal/developer-portal/). Most usage involves highly sensitive financial data — you are entirely responsible for securing it. # AccountingIntegrations Defined in: [src/accounting/client.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L8) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new AccountingIntegrations**(`_core`): `AccountingIntegrations` Defined in: [src/accounting/client.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L9) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `AccountingIntegrations` ## Methods [Section titled “Methods”](#methods) ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `created_at`: `string`; `integration_id`: `string`; `status`: `"ACTIVE"` | `"DISABLED"`; `vendor`: `string`; `vendor_account_id`: `string`; }> Defined in: [src/accounting/client.gen.ts:25](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L25) Create accounting integration Create a new accounting integration. The behavior depends on the existing active integration: * If no active integration exists: Creates and returns new integration * If active integration exists with same vendor and vendor\_account\_id: Returns the existing active integration * If active integration exists with same vendor but different vendor\_account\_id: Returns 409 error * If active integration exists with different vendor: Returns 409 error This ensures only one active integration exists per account. `POST /v3/accounting/integration` — requires OAuth scope: `accounting.integration.write` #### Parameters [Section titled “Parameters”](#parameters-1) ##### body [Section titled “body”](#body) ###### vendor [Section titled “vendor”](#vendor) `string` **Description** The accounting vendor/system. ERP partners must request Brex to create a vendor ID for them to use this field. **Example** ```ts ERP_A ``` ###### vendor\_account\_id [Section titled “vendor\_account\_id”](#vendor_account_id) `string` **Description** The vendor account ID to tie this integration to **Example** ```ts vendor_account_id ``` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `created_at`: `string`; `integration_id`: `string`; `status`: `"ACTIVE"` | `"DISABLED"`; `vendor`: `string`; `vendor_account_id`: `string`; }> *** ### disconnect() [Section titled “disconnect()”](#disconnect) > **disconnect**(`integrationId`, `options?`): `Promise`<{ `created_at`: `string`; `integration_id`: `string`; `status`: `"ACTIVE"` | `"DISABLED"`; `vendor`: `string`; `vendor_account_id`: `string`; }> Defined in: [src/accounting/client.gen.ts:49](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L49) Disconnect accounting integration Disconnect an active accounting integration. * If integration is ACTIVE: Disconnects and returns success * If integration ID doesn’t exist: Returns 404 error * If integration is not currently active: Returns 409 error `POST /v3/accounting/integration/{integration_id}/disconnect` — requires OAuth scope: `accounting.integration.write` #### Parameters [Section titled “Parameters”](#parameters-2) ##### integrationId [Section titled “integrationId”](#integrationid) `string` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `created_at`: `string`; `integration_id`: `string`; `status`: `"ACTIVE"` | `"DISABLED"`; `vendor`: `string`; `vendor_account_id`: `string`; }> *** ### reactivate() [Section titled “reactivate()”](#reactivate) > **reactivate**(`integrationId`, `options?`): `Promise`<{ `created_at`: `string`; `integration_id`: `string`; `status`: `"ACTIVE"` | `"DISABLED"`; `vendor`: `string`; `vendor_account_id`: `string`; }> Defined in: [src/accounting/client.gen.ts:73](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L73) Reactivate accounting integration Reactivate a disconnected accounting integration. * If integration is DISABLED: Reactivates and returns success * If integration ID doesn’t exist: Returns 404 error * If an active integration already exists: Returns 409 error `POST /v3/accounting/integration/{integration_id}/reactivate` — requires OAuth scope: `accounting.integration.write` #### Parameters [Section titled “Parameters”](#parameters-3) ##### integrationId [Section titled “integrationId”](#integrationid-1) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `created_at`: `string`; `integration_id`: `string`; `status`: `"ACTIVE"` | `"DISABLED"`; `vendor`: `string`; `vendor_account_id`: `string`; }> # AccountingRecords Defined in: [src/accounting/client.gen.ts:87](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L87) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new AccountingRecords**(`_core`): `AccountingRecords` Defined in: [src/accounting/client.gen.ts:88](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L88) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `AccountingRecords` ## Methods [Section titled “Methods”](#methods) ### get() [Section titled “get()”](#get) > **get**(`recordId`, `query?`, `options?`): `Promise`<{ `amount`: { `amount`: `number`; `currency`: `string`; }; `due_at?`: `string` | `null`; `erp_posting_date`: `string`; `id`: `string`; `invoice_number?`: `string` | `null`; `line_items`: `object`\[]; `memo?`: `string` | `null`; `original_amount?`: { `amount`: `number`; `currency`: `string`; } | `null`; `posted_at`: `string`; `receipts?`: `object`\[] | `null`; `review_status`: `"PREPARE"` | `"REVIEW"` | `"READY_FOR_EXPORT"` | `"EXPORTED"`; `source_id?`: `string` | `null`; `source_type`: `"CARD"` | `"REIMBURSEMENT"` | `"BILL"`; `type`: `"CARD_EXPENSE_POST"` | `"CARD_EXPENSE_REPAYMENT"` | `"REIMBURSEMENT_EXPENSE_REPAYMENT"` | `"REIMBURSEMENT_EXPENSE_APPROVAL"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYIN"` | `"REIMBURSEMENT_EXPENSE_POST"` | `"CARD_PAYMENT"` | `"REWARD_REDEMPTION"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_REFUND"` | `"CARD_EXPENSE_REFUND"` | `"CARD_PAYMENT_REFUND"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT_REVERSAL"` | `"INVOICE"` | `"INVOICE_PAYMENT"` | `"BILL_EXPENSE"` | `"BILL_EXPENSE_PAYMENT"` | `"BILL_EXPENSE_CARD_PAYMENT"` | `"BILL_MONEY_MOVEMENT_PAYIN"`; `updated_at`: `string`; `user?`: { `department_id?`: `string`; `department_name?`: `string`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string`; `location_name?`: `string`; `manager_first_name?`: `string`; `manager_id?`: `string`; `manager_last_name?`: `string`; `manager_title_id?`: `string`; `manager_title_name?`: `string`; `role`: `"ACCOUNT_ADMIN"` | `"AP_CLERK"` | `"BOOKKEEPER"` | `"CARD_ADMIN"` | `"EMPLOYEE"` | `"EMPLOYEE_WITHOUT_CORP_CARDS"` | `"EXPENSE_ADMIN"` | `"SUPER_ADMIN"` | `"USER_MANAGEMENT_ADMIN"`; `status`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"`; `title_id?`: `string`; `title_name?`: `string`; } | `null`; `vendor?`: { `contact_name?`: `string` | `null`; `email?`: `string` | `null`; `id`: `string`; `name`: `string`; `phone?`: `string` | `null`; `website?`: `string` | `null`; } | `null`; `version`: `number`; }> Defined in: [src/accounting/client.gen.ts:97](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L97) Get accounting record by ID Retrieve a single accounting record by its unique identifier `GET /v3/accounting/records/{record_id}` — requires OAuth scope: `accounting.record.read`, `accounting.record.write` #### Parameters [Section titled “Parameters”](#parameters-1) ##### recordId [Section titled “recordId”](#recordid) `string` ##### query? [Section titled “query?”](#query) ###### single\_entry? [Section titled “single\_entry?”](#single_entry) `boolean` **Description** Toggles the response format between single-entry and double-entry bookkeeping. Set to true to filter out offsetting ledger entries and return only the core cash-flow or economic-impact line items. Defaults to false. ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `amount`: { `amount`: `number`; `currency`: `string`; }; `due_at?`: `string` | `null`; `erp_posting_date`: `string`; `id`: `string`; `invoice_number?`: `string` | `null`; `line_items`: `object`\[]; `memo?`: `string` | `null`; `original_amount?`: { `amount`: `number`; `currency`: `string`; } | `null`; `posted_at`: `string`; `receipts?`: `object`\[] | `null`; `review_status`: `"PREPARE"` | `"REVIEW"` | `"READY_FOR_EXPORT"` | `"EXPORTED"`; `source_id?`: `string` | `null`; `source_type`: `"CARD"` | `"REIMBURSEMENT"` | `"BILL"`; `type`: `"CARD_EXPENSE_POST"` | `"CARD_EXPENSE_REPAYMENT"` | `"REIMBURSEMENT_EXPENSE_REPAYMENT"` | `"REIMBURSEMENT_EXPENSE_APPROVAL"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYIN"` | `"REIMBURSEMENT_EXPENSE_POST"` | `"CARD_PAYMENT"` | `"REWARD_REDEMPTION"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_REFUND"` | `"CARD_EXPENSE_REFUND"` | `"CARD_PAYMENT_REFUND"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT_REVERSAL"` | `"INVOICE"` | `"INVOICE_PAYMENT"` | `"BILL_EXPENSE"` | `"BILL_EXPENSE_PAYMENT"` | `"BILL_EXPENSE_CARD_PAYMENT"` | `"BILL_MONEY_MOVEMENT_PAYIN"`; `updated_at`: `string`; `user?`: { `department_id?`: `string`; `department_name?`: `string`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string`; `location_name?`: `string`; `manager_first_name?`: `string`; `manager_id?`: `string`; `manager_last_name?`: `string`; `manager_title_id?`: `string`; `manager_title_name?`: `string`; `role`: `"ACCOUNT_ADMIN"` | `"AP_CLERK"` | `"BOOKKEEPER"` | `"CARD_ADMIN"` | `"EMPLOYEE"` | `"EMPLOYEE_WITHOUT_CORP_CARDS"` | `"EXPENSE_ADMIN"` | `"SUPER_ADMIN"` | `"USER_MANAGEMENT_ADMIN"`; `status`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"`; `title_id?`: `string`; `title_name?`: `string`; } | `null`; `vendor?`: { `contact_name?`: `string` | `null`; `email?`: `string` | `null`; `id`: `string`; `name`: `string`; `phone?`: `string` | `null`; `website?`: `string` | `null`; } | `null`; `version`: `number`; }> *** ### query() [Section titled “query()”](#query-1) > **query**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `has_next_page`: `boolean`; `items`: `object`\[]; `next_cursor?`: `string` | `null`; `total_count?`: `number` | `null`; }> Defined in: [src/accounting/client.gen.ts:126](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L126) Query accounting records Query accounting records by IDs or with filters for polling. When building integrations with Brex accounting workflow, use filter-based polling as a fallback mechanism. Suggested cadence is 1 hour. **For card and reimbursement records:** Use `review_status` to filter by accounting workflow stage (e.g., READY\_FOR\_EXPORT, EXPORTED). **For bill records:** Use `source_type=BILL` with `updated_at[gt]` to poll for updated bill records. **Filter Constraints:** * `review_status` is only supported with CARD and REIMBURSEMENT source types `GET /v3/accounting/records` — requires OAuth scope: `accounting.record.read`, `accounting.record.write` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-2) ##### query? [Section titled “query?”](#query-2) ###### cursor? [Section titled “cursor?”](#cursor) `string` **Description** Cursor for pagination ###### ids? [Section titled “ids?”](#ids) `string`\[] **Description** Filter by accounting record IDs. ID size is limited to 500. Example: `ids=accr_xxx&ids=accr_yyy` ###### limit? [Section titled “limit?”](#limit) `number` **Description** Maximum number of records to return. Defaults to 100. The maximum is 500; requests with a higher value are rejected with a 400 error. ###### review\_status? [Section titled “review\_status?”](#review_status) `"PREPARE"` | `"REVIEW"` | `"READY_FOR_EXPORT"` | `"EXPORTED"` **Description** Filter by review status. Tracks a record’s stage in the accounting review lifecycle, which progresses in this order: `PREPARE` (the record is being prepared and is not yet ready for review) → `REVIEW` (the record is ready to be reviewed) → `READY_FOR_EXPORT` (the record has been reviewed and is queued for export to your ERP) → `EXPORTED` (the record has been exported). ###### single\_entry? [Section titled “single\_entry?”](#single_entry-1) `boolean` **Description** Toggles the response format between single-entry and double-entry bookkeeping. Set to true to filter out offsetting ledger entries and return only the core cash-flow or economic-impact line items. Defaults to false. ###### source\_type? [Section titled “source\_type?”](#source_type) `"CARD"` | `"REIMBURSEMENT"` | `"BILL"` **Description** Filter by accounting record source type. This is a high-level filter that maps to specific accounting record types. Example: `source_type=BILL` ###### updated\_at? [Section titled “updated\_at?”](#updated_at) { `gt?`: `string`; `gte?`: `string`; `lt?`: `string`; `lte?`: `string`; } **Description** Filter by updated\_at timestamp range in UTC. Accepts gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal). Example: `updated_at[gte]=2025-01-01` ###### updated\_at.gt? [Section titled “updated\_at.gt?”](#updated_atgt) `string` Format: date-time **Description** Minimum value to filter by (exclusive) - ISO 8601 format **Example** ```ts 2025-01-01T00:00:00Z ``` ###### updated\_at.gte? [Section titled “updated\_at.gte?”](#updated_atgte) `string` Format: date-time **Description** Minimum value to filter by (inclusive) - ISO 8601 format **Example** ```ts 2025-01-01T00:00:00Z ``` ###### updated\_at.lt? [Section titled “updated\_at.lt?”](#updated_atlt) `string` Format: date-time **Description** Maximum value to filter by (exclusive) - ISO 8601 format **Example** ```ts 2025-01-01T00:00:00Z ``` ###### updated\_at.lte? [Section titled “updated\_at.lte?”](#updated_atlte) `string` Format: date-time **Description** Maximum value to filter by (inclusive) - ISO 8601 format **Example** ```ts 2025-01-01T23:59:59.999Z ``` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `has_next_page`: `boolean`; `items`: `object`\[]; `next_cursor?`: `string` | `null`; `total_count?`: `number` | `null`; }> *** ### reportAccountingExportResults() [Section titled “reportAccountingExportResults()”](#reportaccountingexportresults) > **reportAccountingExportResults**(`body`, `options?`): `Promise`<{ `updated_accounting_record_ids`: `string`\[]; }> Defined in: [src/accounting/client.gen.ts:144](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L144) Report accounting export results Report export success or failure for accounting records. `POST /v3/accounting/records/export-results` — requires OAuth scope: `accounting.record.write` #### Parameters [Section titled “Parameters”](#parameters-3) ##### body [Section titled “body”](#body) ###### results [Section titled “results”](#results) ({ `accounting_record_id`: `string`; `failure`: { `error_message`: `string`; }; } | { `accounting_record_id`: `string`; `success`: { `deep_link_url?`: `string`; `reference_id?`: `string` | `null`; }; })\[] **Description** Array of export results (must contain at least one result) ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `updated_accounting_record_ids`: `string`\[]; }> # BrexAccounting Defined in: [src/accounting/client.gen.ts:158](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L158) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BrexAccounting**(`core`): `BrexAccounting` Defined in: [src/accounting/client.gen.ts:161](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L161) #### Parameters [Section titled “Parameters”](#parameters) ##### core [Section titled “core”](#core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `BrexAccounting` ## Properties [Section titled “Properties”](#properties) ### accountingIntegrations [Section titled “accountingIntegrations”](#accountingintegrations) > `readonly` **accountingIntegrations**: [`AccountingIntegrations`](/brex/api/accounting/classes/accountingintegrations/) Defined in: [src/accounting/client.gen.ts:159](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L159) *** ### accountingRecords [Section titled “accountingRecords”](#accountingrecords) > `readonly` **accountingRecords**: [`AccountingRecords`](/brex/api/accounting/classes/accountingrecords/) Defined in: [src/accounting/client.gen.ts:160](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/client.gen.ts#L160) # createAccountingClient > **createAccountingClient**(`options`): [`BrexAccounting`](/brex/api/accounting/classes/brexaccounting/) Defined in: [src/accounting/index.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/index.ts#L13) Standalone client for the Brex Accounting API. ## Parameters [Section titled “Parameters”](#parameters) ### options [Section titled “options”](#options) [`BrexOptions`](/brex/api/index/interfaces/brexoptions/) ## Returns [Section titled “Returns”](#returns) [`BrexAccounting`](/brex/api/accounting/classes/brexaccounting/) # AccountingComponents Defined in: [src/accounting/types.gen.ts:149](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L149) ## Properties [Section titled “Properties”](#properties) ### headers [Section titled “headers”](#headers) > **headers**: `never` Defined in: [src/accounting/types.gen.ts:680](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L680) *** ### parameters [Section titled “parameters”](#parameters) > **parameters**: `never` Defined in: [src/accounting/types.gen.ts:678](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L678) *** ### pathItems [Section titled “pathItems”](#pathitems) > **pathItems**: `never` Defined in: [src/accounting/types.gen.ts:681](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L681) *** ### requestBodies [Section titled “requestBodies”](#requestbodies) > **requestBodies**: `never` Defined in: [src/accounting/types.gen.ts:679](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L679) *** ### responses [Section titled “responses”](#responses) > **responses**: `never` Defined in: [src/accounting/types.gen.ts:677](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L677) *** ### schemas [Section titled “schemas”](#schemas) > **schemas**: `object` Defined in: [src/accounting/types.gen.ts:150](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L150) #### AccountingErrorDetails [Section titled “AccountingErrorDetails”](#accountingerrordetails) > **AccountingErrorDetails**: `object` ##### AccountingErrorDetails.current\_status? [Section titled “AccountingErrorDetails.current\_status?”](#accountingerrordetailscurrent_status) > `optional` **current\_status?**: `string` ###### Description [Section titled “Description”](#description) Current status of the integration when the error occurred ###### Example [Section titled “Example”](#example) ```ts DISABLED ``` ##### AccountingErrorDetails.duplicate\_accounting\_record\_ids? [Section titled “AccountingErrorDetails.duplicate\_accounting\_record\_ids?”](#accountingerrordetailsduplicate_accounting_record_ids) > `optional` **duplicate\_accounting\_record\_ids?**: `string`\[] ###### Description [Section titled “Description”](#description-1) Accounting record IDs that triggered the error ###### Example [Section titled “Example”](#example-1) ```ts [ "accr_abc123", "accr_def456" ] ``` ##### AccountingErrorDetails.existing\_integration\_id? [Section titled “AccountingErrorDetails.existing\_integration\_id?”](#accountingerrordetailsexisting_integration_id) > `optional` **existing\_integration\_id?**: `string` ###### Description [Section titled “Description”](#description-2) ID of the existing active integration ###### Example [Section titled “Example”](#example-2) ```ts int_abc123 ``` ##### AccountingErrorDetails.existing\_vendor? [Section titled “AccountingErrorDetails.existing\_vendor?”](#accountingerrordetailsexisting_vendor) > `optional` **existing\_vendor?**: `string` ###### Description [Section titled “Description”](#description-3) Vendor of the existing integration ###### Example [Section titled “Example”](#example-3) ```ts ERP_A ``` ##### AccountingErrorDetails.integration\_id? [Section titled “AccountingErrorDetails.integration\_id?”](#accountingerrordetailsintegration_id) > `optional` **integration\_id?**: `string` ###### Description [Section titled “Description”](#description-4) Integration ID associated with the error ###### Example [Section titled “Example”](#example-4) ```ts int_abc123 ``` ##### AccountingErrorDetails.not\_found\_export\_entry\_source\_ids? [Section titled “AccountingErrorDetails.not\_found\_export\_entry\_source\_ids?”](#accountingerrordetailsnot_found_export_entry_source_ids) > `optional` **not\_found\_export\_entry\_source\_ids?**: `string`\[] ###### Description [Section titled “Description”](#description-5) Accounting record IDs that could not be found ###### Example [Section titled “Example”](#example-5) ```ts [ "accr_ghi789" ] ``` ##### AccountingErrorDetails.not\_ready\_for\_export\_accounting\_record\_ids? [Section titled “AccountingErrorDetails.not\_ready\_for\_export\_accounting\_record\_ids?”](#accountingerrordetailsnot_ready_for_export_accounting_record_ids) > `optional` **not\_ready\_for\_export\_accounting\_record\_ids?**: `string`\[] ###### Description [Section titled “Description”](#description-6) Accounting record IDs that are not ready for export ###### Example [Section titled “Example”](#example-6) ```ts [ "accr_ghi789" ] ``` ##### AccountingErrorDetails.requested\_vendor? [Section titled “AccountingErrorDetails.requested\_vendor?”](#accountingerrordetailsrequested_vendor) > `optional` **requested\_vendor?**: `string` ###### Description [Section titled “Description”](#description-7) Vendor that was requested to be created ###### Example [Section titled “Example”](#example-7) ```ts ERP_B ``` #### AccountingErrorResponse [Section titled “AccountingErrorResponse”](#accountingerrorresponse) > **AccountingErrorResponse**: `object` ##### AccountingErrorResponse.details? [Section titled “AccountingErrorResponse.details?”](#accountingerrorresponsedetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-8) Additional error context ##### AccountingErrorResponse.error\_code [Section titled “AccountingErrorResponse.error\_code”](#accountingerrorresponseerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-9) Machine-readable error code ###### Example [Section titled “Example”](#example-8) ```ts INVALID_REQUEST @enum {string} ``` ##### AccountingErrorResponse.message [Section titled “AccountingErrorResponse.message”](#accountingerrorresponsemessage) > **message**: `string` ###### Description [Section titled “Description”](#description-10) Human-readable error message ###### Example [Section titled “Example”](#example-9) ```ts The request is malformed or contains invalid data. ``` #### AccountingFieldValue [Section titled “AccountingFieldValue”](#accountingfieldvalue) > **AccountingFieldValue**: `object` ##### AccountingFieldValue.brex\_field\_id [Section titled “AccountingFieldValue.brex\_field\_id”](#accountingfieldvaluebrex_field_id) > **brex\_field\_id**: `string` ###### Description [Section titled “Description”](#description-11) Brex internal field identifier ###### Example [Section titled “Example”](#example-10) ```ts ef_123 ``` ##### AccountingFieldValue.brex\_field\_value\_id [Section titled “AccountingFieldValue.brex\_field\_value\_id”](#accountingfieldvaluebrex_field_value_id) > **brex\_field\_value\_id**: `string` ###### Description [Section titled “Description”](#description-12) Brex internal field value identifier ###### Example [Section titled “Example”](#example-11) ```ts efo_123 ``` ##### AccountingFieldValue.remote\_field\_id [Section titled “AccountingFieldValue.remote\_field\_id”](#accountingfieldvalueremote_field_id) > **remote\_field\_id**: `string` | `null` ###### Description [Section titled “Description”](#description-13) Remote system field identifier ###### Example [Section titled “Example”](#example-12) ```ts 1 ``` ##### AccountingFieldValue.remote\_field\_value\_id [Section titled “AccountingFieldValue.remote\_field\_value\_id”](#accountingfieldvalueremote_field_value_id) > **remote\_field\_value\_id**: `string` | `null` ###### Description [Section titled “Description”](#description-14) Remote system field value identifier ###### Example [Section titled “Example”](#example-13) ```ts 123 ``` #### AccountingRecordDetailed [Section titled “AccountingRecordDetailed”](#accountingrecorddetailed) > **AccountingRecordDetailed**: `object` ##### AccountingRecordDetailed.amount [Section titled “AccountingRecordDetailed.amount”](#accountingrecorddetailedamount) > **amount**: `object` ###### Description [Section titled “Description”](#description-15) Amount of the accounting record ##### AccountingRecordDetailed.amount.amount [Section titled “AccountingRecordDetailed.amount.amount”](#accountingrecorddetailedamountamount) > **amount**: `number` ###### Description [Section titled “Description”](#description-16) The amount ###### Example [Section titled “Example”](#example-14) ```ts 100 ``` ##### AccountingRecordDetailed.amount.currency [Section titled “AccountingRecordDetailed.amount.currency”](#accountingrecorddetailedamountcurrency) > **currency**: `string` ###### Description [Section titled “Description”](#description-17) The currency ###### Example [Section titled “Example”](#example-15) ```ts USD ``` ##### AccountingRecordDetailed.due\_at? [Section titled “AccountingRecordDetailed.due\_at?”](#accountingrecorddetaileddue_at) > `optional` **due\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-18) Source due at in UTC timezone. For bills only ##### AccountingRecordDetailed.erp\_posting\_date [Section titled “AccountingRecordDetailed.erp\_posting\_date”](#accountingrecorddetailederp_posting_date) > **erp\_posting\_date**: `string` Format: date-time ###### Description [Section titled “Description”](#description-19) ERP impact date in UTC timezone ##### AccountingRecordDetailed.id [Section titled “AccountingRecordDetailed.id”](#accountingrecorddetailedid) > **id**: `string` ###### Description [Section titled “Description”](#description-20) Unique identifier for the accounting record ###### Example [Section titled “Example”](#example-16) ```ts accr_abc123 ``` ##### AccountingRecordDetailed.invoice\_number? [Section titled “AccountingRecordDetailed.invoice\_number?”](#accountingrecorddetailedinvoice_number) > `optional` **invoice\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-21) Invoice number. For bills only ##### AccountingRecordDetailed.line\_items [Section titled “AccountingRecordDetailed.line\_items”](#accountingrecorddetailedline_items) > **line\_items**: `object`\[] ###### Description [Section titled “Description”](#description-22) Line items for double-entry bookkeeping ##### AccountingRecordDetailed.memo? [Section titled “AccountingRecordDetailed.memo?”](#accountingrecorddetailedmemo) > `optional` **memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-23) Memo/description ##### AccountingRecordDetailed.original\_amount? [Section titled “AccountingRecordDetailed.original\_amount?”](#accountingrecorddetailedoriginal_amount) > `optional` **original\_amount?**: { `amount`: `number`; `currency`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `amount`: `number`; `currency`: `string`; } ###### amount [Section titled “amount”](#amount) > **amount**: `number` ###### Description [Section titled “Description”](#description-24) The amount ###### Example [Section titled “Example”](#example-17) ```ts 100 ``` ###### currency [Section titled “currency”](#currency) > **currency**: `string` ###### Description [Section titled “Description”](#description-25) The currency ###### Example [Section titled “Example”](#example-18) ```ts USD ``` *** `null` ###### Description [Section titled “Description”](#description-26) Original amount if different from current ##### AccountingRecordDetailed.posted\_at [Section titled “AccountingRecordDetailed.posted\_at”](#accountingrecorddetailedposted_at) > **posted\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-27) Source posted date in UTC timezone ##### AccountingRecordDetailed.receipts? [Section titled “AccountingRecordDetailed.receipts?”](#accountingrecorddetailedreceipts) > `optional` **receipts?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-28) Associated receipts ##### AccountingRecordDetailed.review\_status [Section titled “AccountingRecordDetailed.review\_status”](#accountingrecorddetailedreview_status) > **review\_status**: `"PREPARE"` | `"REVIEW"` | `"READY_FOR_EXPORT"` | `"EXPORTED"` ###### Description [Section titled “Description”](#description-29) Current review status of the record in the accounting review lifecycle: `PREPARE` → `REVIEW` → `READY_FOR_EXPORT` → `EXPORTED`. ##### AccountingRecordDetailed.source\_id? [Section titled “AccountingRecordDetailed.source\_id?”](#accountingrecorddetailedsource_id) > `optional` **source\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-30) Source transaction ID ##### AccountingRecordDetailed.source\_type [Section titled “AccountingRecordDetailed.source\_type”](#accountingrecorddetailedsource_type) > **source\_type**: `"CARD"` | `"REIMBURSEMENT"` | `"BILL"` ###### Description [Section titled “Description”](#description-31) Source type ##### AccountingRecordDetailed.type [Section titled “AccountingRecordDetailed.type”](#accountingrecorddetailedtype) > **type**: `"CARD_EXPENSE_POST"` | `"CARD_EXPENSE_REPAYMENT"` | `"REIMBURSEMENT_EXPENSE_REPAYMENT"` | `"REIMBURSEMENT_EXPENSE_APPROVAL"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYIN"` | `"REIMBURSEMENT_EXPENSE_POST"` | `"CARD_PAYMENT"` | `"REWARD_REDEMPTION"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_REFUND"` | `"CARD_EXPENSE_REFUND"` | `"CARD_PAYMENT_REFUND"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT_REVERSAL"` | `"INVOICE"` | `"INVOICE_PAYMENT"` | `"BILL_EXPENSE"` | `"BILL_EXPENSE_PAYMENT"` | `"BILL_EXPENSE_CARD_PAYMENT"` | `"BILL_MONEY_MOVEMENT_PAYIN"` ###### Description [Section titled “Description”](#description-32) Types of accounting records representing different financial transactions: ```plaintext **Card-related transactions:** - `CARD_EXPENSE_POST`: Records when a card expense is posted and settled - `CARD_EXPENSE_REFUND`: Records when a merchant issues a refund for a card transaction - `CARD_EXPENSE_REPAYMENT`: Records when an employee repays money to the company for a card expense - `CARD_PAYMENT`: Records payments from customer to Brex for card balances - `CARD_PAYMENT_REFUND`: Records refunds from Brex to customer for overpayments - `REWARD_REDEMPTION`: Records when a reward is redeemed **Bill-related transactions:** - `BILL_EXPENSE`: Records when a bill expense is created - `BILL_EXPENSE_PAYMENT`: Records when a bill is paid through ACH/wire transfer - `BILL_EXPENSE_CARD_PAYMENT`: Records when a bill is paid using a Brex card **Reimbursement-related transactions:** - `REIMBURSEMENT_EXPENSE_APPROVAL`: Records approval of reimbursement (accrual basis) - `REIMBURSEMENT_EXPENSE_POST`: Records when reimbursement is fulfilled (cash basis) - `REIMBURSEMENT_EXPENSE_REPAYMENT`: Records repayment of a reimbursement expense - `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT`: Records payout to employee/third party - `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT_REVERSAL`: Records reversal of payout - `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYIN`: Records payment from customer to Brex - `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_REFUND`: Records refund to customer's bank ``` ##### AccountingRecordDetailed.updated\_at [Section titled “AccountingRecordDetailed.updated\_at”](#accountingrecorddetailedupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-33) Last update timestamp in UTC timezone ##### AccountingRecordDetailed.user? [Section titled “AccountingRecordDetailed.user?”](#accountingrecorddetaileduser) > `optional` **user?**: { `department_id?`: `string`; `department_name?`: `string`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string`; `location_name?`: `string`; `manager_first_name?`: `string`; `manager_id?`: `string`; `manager_last_name?`: `string`; `manager_title_id?`: `string`; `manager_title_name?`: `string`; `role`: `"ACCOUNT_ADMIN"` | `"AP_CLERK"` | `"BOOKKEEPER"` | `"CARD_ADMIN"` | `"EMPLOYEE"` | `"EMPLOYEE_WITHOUT_CORP_CARDS"` | `"EXPENSE_ADMIN"` | `"SUPER_ADMIN"` | `"USER_MANAGEMENT_ADMIN"`; `status`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"`; `title_id?`: `string`; `title_name?`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `department_id?`: `string`; `department_name?`: `string`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string`; `location_name?`: `string`; `manager_first_name?`: `string`; `manager_id?`: `string`; `manager_last_name?`: `string`; `manager_title_id?`: `string`; `manager_title_name?`: `string`; `role`: `"ACCOUNT_ADMIN"` | `"AP_CLERK"` | `"BOOKKEEPER"` | `"CARD_ADMIN"` | `"EMPLOYEE"` | `"EMPLOYEE_WITHOUT_CORP_CARDS"` | `"EXPENSE_ADMIN"` | `"SUPER_ADMIN"` | `"USER_MANAGEMENT_ADMIN"`; `status`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"`; `title_id?`: `string`; `title_name?`: `string`; } ###### department\_id? [Section titled “department\_id?”](#department_id) > `optional` **department\_id?**: `string` ###### Description [Section titled “Description”](#description-34) The ID of the user’s department ###### Example [Section titled “Example”](#example-19) ```ts VXNlcjpjdXVzZXJfMTIzNA== ``` ###### department\_name? [Section titled “department\_name?”](#department_name) > `optional` **department\_name?**: `string` ###### Description [Section titled “Description”](#description-35) The user’s department name ###### Example [Section titled “Example”](#example-20) ```ts Engineering ``` ###### email [Section titled “email”](#email) > **email**: `string` ###### Description [Section titled “Description”](#description-36) The user’s email address ###### Example [Section titled “Example”](#example-21) ```ts john.doe@example.com ``` ###### first\_name [Section titled “first\_name”](#first_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-37) The user’s first name ###### Example [Section titled “Example”](#example-22) ```ts John ``` ###### id [Section titled “id”](#id) > **id**: `string` ###### Description [Section titled “Description”](#description-38) The ID of the user ###### Example [Section titled “Example”](#example-23) ```ts VXNlcjpjdXVzZXJfMTIzNA== ``` ###### last\_name [Section titled “last\_name”](#last_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-39) The user’s last name ###### Example [Section titled “Example”](#example-24) ```ts Doe ``` ###### location\_id? [Section titled “location\_id?”](#location_id) > `optional` **location\_id?**: `string` ###### Description [Section titled “Description”](#description-40) The ID of the user’s location ###### Example [Section titled “Example”](#example-25) ```ts VXNlcjpjdXVzZXJfMTIzNA== ``` ###### location\_name? [Section titled “location\_name?”](#location_name) > `optional` **location\_name?**: `string` ###### Description [Section titled “Description”](#description-41) The user’s location name ###### Example [Section titled “Example”](#example-26) ```ts San Francisco ``` ###### manager\_first\_name? [Section titled “manager\_first\_name?”](#manager_first_name) > `optional` **manager\_first\_name?**: `string` ###### Description [Section titled “Description”](#description-42) The user’s manager first name ###### Example [Section titled “Example”](#example-27) ```ts Jane ``` ###### manager\_id? [Section titled “manager\_id?”](#manager_id) > `optional` **manager\_id?**: `string` ###### Description [Section titled “Description”](#description-43) The ID of the user’s manager ###### Example [Section titled “Example”](#example-28) ```ts VXNlcjpjdXVzZXJfMTIzNA== ``` ###### manager\_last\_name? [Section titled “manager\_last\_name?”](#manager_last_name) > `optional` **manager\_last\_name?**: `string` ###### Description [Section titled “Description”](#description-44) The user’s manager last name ###### Example [Section titled “Example”](#example-29) ```ts Smith ``` ###### manager\_title\_id? [Section titled “manager\_title\_id?”](#manager_title_id) > `optional` **manager\_title\_id?**: `string` ###### Description [Section titled “Description”](#description-45) The user’s manager title ID ###### Example [Section titled “Example”](#example-30) ```ts VGl0bGU6dGl0bGVfMTIzNA== ``` ###### manager\_title\_name? [Section titled “manager\_title\_name?”](#manager_title_name) > `optional` **manager\_title\_name?**: `string` ###### Description [Section titled “Description”](#description-46) The user’s manager title display name ###### Example [Section titled “Example”](#example-31) ```ts Engineering Manager ``` ###### role [Section titled “role”](#role) > **role**: `"ACCOUNT_ADMIN"` | `"AP_CLERK"` | `"BOOKKEEPER"` | `"CARD_ADMIN"` | `"EMPLOYEE"` | `"EMPLOYEE_WITHOUT_CORP_CARDS"` | `"EXPENSE_ADMIN"` | `"SUPER_ADMIN"` | `"USER_MANAGEMENT_ADMIN"` ###### Description [Section titled “Description”](#description-47) The user’s role in the system ###### Example [Section titled “Example”](#example-32) ```ts CARD_ADMIN @enum {string} ``` ###### status [Section titled “status”](#status) > **status**: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` ###### Description [Section titled “Description”](#description-48) The user’s status in the system ###### Example [Section titled “Example”](#example-33) ```ts ACTIVE @enum {string} ``` ###### title\_id? [Section titled “title\_id?”](#title_id) > `optional` **title\_id?**: `string` ###### Description [Section titled “Description”](#description-49) The user’s title ID ###### Example [Section titled “Example”](#example-34) ```ts VGl0bGU6dGl0bGVfMTIzNA== ``` ###### title\_name? [Section titled “title\_name?”](#title_name) > `optional` **title\_name?**: `string` ###### Description [Section titled “Description”](#description-50) The user’s title display name ###### Example [Section titled “Example”](#example-35) ```ts Software Engineer ``` *** `null` ###### Description [Section titled “Description”](#description-51) User associated with the record ##### AccountingRecordDetailed.vendor? [Section titled “AccountingRecordDetailed.vendor?”](#accountingrecorddetailedvendor) > `optional` **vendor?**: { `contact_name?`: `string` | `null`; `email?`: `string` | `null`; `id`: `string`; `name`: `string`; `phone?`: `string` | `null`; `website?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `contact_name?`: `string` | `null`; `email?`: `string` | `null`; `id`: `string`; `name`: `string`; `phone?`: `string` | `null`; `website?`: `string` | `null`; } ###### contact\_name? [Section titled “contact\_name?”](#contact_name) > `optional` **contact\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-52) The name of the contact for the vendor ###### Example [Section titled “Example”](#example-36) ```ts Jane Smith ``` ###### email? [Section titled “email?”](#email-1) > `optional` **email?**: `string` | `null` ###### Description [Section titled “Description”](#description-53) The email for the vendor ###### Example [Section titled “Example”](#example-37) ```ts contact@acme.com ``` ###### id [Section titled “id”](#id-1) > **id**: `string` ###### Description [Section titled “Description”](#description-54) The unique identifier for the vendor ###### Example [Section titled “Example”](#example-38) ```ts vendor_123 ``` ###### name [Section titled “name”](#name) > **name**: `string` ###### Description [Section titled “Description”](#description-55) The name of the vendor ###### Example [Section titled “Example”](#example-39) ```ts Acme Corp ``` ###### phone? [Section titled “phone?”](#phone) > `optional` **phone?**: `string` | `null` ###### Description [Section titled “Description”](#description-56) The phone number for the vendor ###### Example [Section titled “Example”](#example-40) ```ts +1-555-123-4567 ``` ###### website? [Section titled “website?”](#website) > `optional` **website?**: `string` | `null` ###### Description [Section titled “Description”](#description-57) The website of the vendor ###### Example [Section titled “Example”](#example-41) ```ts https://acme.com ``` *** `null` ###### Description [Section titled “Description”](#description-58) Vendor information ##### AccountingRecordDetailed.version [Section titled “AccountingRecordDetailed.version”](#accountingrecorddetailedversion) > **version**: `number` ###### Description [Section titled “Description”](#description-59) Version number #### AccountingRecordLineItem [Section titled “AccountingRecordLineItem”](#accountingrecordlineitem) > **AccountingRecordLineItem**: `object` ##### AccountingRecordLineItem.accounting\_field\_values [Section titled “AccountingRecordLineItem.accounting\_field\_values”](#accountingrecordlineitemaccounting_field_values) > **accounting\_field\_values**: `object`\[] ###### Description [Section titled “Description”](#description-60) Accounting field mappings ##### AccountingRecordLineItem.amount [Section titled “AccountingRecordLineItem.amount”](#accountingrecordlineitemamount) > **amount**: `object` ###### Description [Section titled “Description”](#description-61) Amount for this line item. Amount is always positive for `AccountingRecordLineItem`. ##### AccountingRecordLineItem.amount.amount [Section titled “AccountingRecordLineItem.amount.amount”](#accountingrecordlineitemamountamount) > **amount**: `number` ###### Description [Section titled “Description”](#description-62) The amount ###### Example [Section titled “Example”](#example-42) ```ts 100 ``` ##### AccountingRecordLineItem.amount.currency [Section titled “AccountingRecordLineItem.amount.currency”](#accountingrecordlineitemamountcurrency) > **currency**: `string` ###### Description [Section titled “Description”](#description-63) The currency ###### Example [Section titled “Example”](#example-43) ```ts USD ``` ##### AccountingRecordLineItem.id [Section titled “AccountingRecordLineItem.id”](#accountingrecordlineitemid) > **id**: `string` ###### Description [Section titled “Description”](#description-64) Unique identifier for the line item ###### Example [Section titled “Example”](#example-44) ```ts arli_abc123 ``` ##### AccountingRecordLineItem.memo? [Section titled “AccountingRecordLineItem.memo?”](#accountingrecordlineitemmemo) > `optional` **memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-65) Memo/description ##### AccountingRecordLineItem.original\_amount? [Section titled “AccountingRecordLineItem.original\_amount?”](#accountingrecordlineitemoriginal_amount) > `optional` **original\_amount?**: { `amount`: `number`; `currency`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-3) ###### Type Literal [Section titled “Type Literal”](#type-literal-3) { `amount`: `number`; `currency`: `string`; } ###### amount [Section titled “amount”](#amount-1) > **amount**: `number` ###### Description [Section titled “Description”](#description-66) The amount ###### Example [Section titled “Example”](#example-45) ```ts 100 ``` ###### currency [Section titled “currency”](#currency-1) > **currency**: `string` ###### Description [Section titled “Description”](#description-67) The currency ###### Example [Section titled “Example”](#example-46) ```ts USD ``` *** `null` ###### Description [Section titled “Description”](#description-68) Original amount for this line item. Amount is always positive for `AccountingRecordLineItem`. ##### AccountingRecordLineItem.type [Section titled “AccountingRecordLineItem.type”](#accountingrecordlineitemtype) > **type**: `"CREDIT"` | `"DEBIT"` ###### Description [Section titled “Description”](#description-69) Type of line item #### AccountingRecordsResponse [Section titled “AccountingRecordsResponse”](#accountingrecordsresponse) > **AccountingRecordsResponse**: `object` ##### AccountingRecordsResponse.has\_next\_page [Section titled “AccountingRecordsResponse.has\_next\_page”](#accountingrecordsresponsehas_next_page) > **has\_next\_page**: `boolean` ###### Description [Section titled “Description”](#description-70) Whether there are more results available ##### AccountingRecordsResponse.items [Section titled “AccountingRecordsResponse.items”](#accountingrecordsresponseitems) > **items**: `object`\[] ###### Description [Section titled “Description”](#description-71) List of accounting records ##### AccountingRecordsResponse.next\_cursor? [Section titled “AccountingRecordsResponse.next\_cursor?”](#accountingrecordsresponsenext_cursor) > `optional` **next\_cursor?**: `string` | `null` ###### Description [Section titled “Description”](#description-72) Cursor for the next page of results ##### AccountingRecordsResponse.total\_count? [Section titled “AccountingRecordsResponse.total\_count?”](#accountingrecordsresponsetotal_count) > `optional` **total\_count?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-73) Total count of records matching the query #### Amount [Section titled “Amount”](#amount-2) > **Amount**: `object` ##### Amount.amount [Section titled “Amount.amount”](#amountamount) > **amount**: `number` ###### Description [Section titled “Description”](#description-74) The amount ###### Example [Section titled “Example”](#example-47) ```ts 100 ``` ##### Amount.currency [Section titled “Amount.currency”](#amountcurrency) > **currency**: `string` ###### Description [Section titled “Description”](#description-75) The currency ###### Example [Section titled “Example”](#example-48) ```ts USD ``` #### CreateIntegrationRequest [Section titled “CreateIntegrationRequest”](#createintegrationrequest) > **CreateIntegrationRequest**: `object` ##### CreateIntegrationRequest.vendor [Section titled “CreateIntegrationRequest.vendor”](#createintegrationrequestvendor) > **vendor**: `string` ###### Description [Section titled “Description”](#description-76) The accounting vendor/system. ERP partners must request Brex to create a vendor ID for them to use this field. ###### Example [Section titled “Example”](#example-49) ```ts ERP_A ``` ##### CreateIntegrationRequest.vendor\_account\_id [Section titled “CreateIntegrationRequest.vendor\_account\_id”](#createintegrationrequestvendor_account_id) > **vendor\_account\_id**: `string` ###### Description [Section titled “Description”](#description-77) The vendor account ID to tie this integration to ###### Example [Section titled “Example”](#example-50) ```ts vendor_account_id ``` #### ExportFailureDetails [Section titled “ExportFailureDetails”](#exportfailuredetails) > **ExportFailureDetails**: `object` ##### ExportFailureDetails.error\_message [Section titled “ExportFailureDetails.error\_message”](#exportfailuredetailserror_message) > **error\_message**: `string` ###### Description [Section titled “Description”](#description-78) Human-readable explanation of the failure ###### Example [Section titled “Example”](#example-51) ```ts Invalid GL account ``` #### ExportResultsResponse [Section titled “ExportResultsResponse”](#exportresultsresponse) > **ExportResultsResponse**: `object` ##### ExportResultsResponse.updated\_accounting\_record\_ids [Section titled “ExportResultsResponse.updated\_accounting\_record\_ids”](#exportresultsresponseupdated_accounting_record_ids) > **updated\_accounting\_record\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-79) Accounting record ids that were updated by the request ###### Example [Section titled “Example”](#example-52) ```ts [ "accr_abc123", "accr_def456" ] ``` #### ExportSuccessDetails [Section titled “ExportSuccessDetails”](#exportsuccessdetails) > **ExportSuccessDetails**: `object` ##### ExportSuccessDetails.deep\_link\_url? [Section titled “ExportSuccessDetails.deep\_link\_url?”](#exportsuccessdetailsdeep_link_url) > `optional` **deep\_link\_url?**: `string` ###### Description [Section titled “Description”](#description-80) URL pointing to the record in the external system ###### Example [Section titled “Example”](#example-53) ```ts https://erp.com/transactions/456789 ``` ##### ExportSuccessDetails.reference\_id? [Section titled “ExportSuccessDetails.reference\_id?”](#exportsuccessdetailsreference_id) > `optional` **reference\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-81) External system identifier assigned to the exported record ###### Example [Section titled “Example”](#example-54) ```ts erp_txn_456789 ``` #### FailedExportResult [Section titled “FailedExportResult”](#failedexportresult) > **FailedExportResult**: `object` ##### FailedExportResult.accounting\_record\_id [Section titled “FailedExportResult.accounting\_record\_id”](#failedexportresultaccounting_record_id) > **accounting\_record\_id**: `string` ###### Description [Section titled “Description”](#description-82) ID of the accounting record the export outcome applies to ###### Example [Section titled “Example”](#example-55) ```ts accr_abc123 ``` ##### FailedExportResult.failure [Section titled “FailedExportResult.failure”](#failedexportresultfailure) > **failure**: `object` ###### Description [Section titled “Description”](#description-83) Details for a failed export ##### FailedExportResult.failure.error\_message [Section titled “FailedExportResult.failure.error\_message”](#failedexportresultfailureerror_message) > **error\_message**: `string` ###### Description [Section titled “Description”](#description-84) Human-readable explanation of the failure ###### Example [Section titled “Example”](#example-56) ```ts Invalid GL account ``` #### Integration [Section titled “Integration”](#integration) > **Integration**: `object` ##### Integration.created\_at [Section titled “Integration.created\_at”](#integrationcreated_at) > **created\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-85) Timestamp when the integration was created ###### Example [Section titled “Example”](#example-57) ```ts 2025-08-15T10:00:00Z ``` ##### Integration.integration\_id [Section titled “Integration.integration\_id”](#integrationintegration_id) > **integration\_id**: `string` ###### Description [Section titled “Description”](#description-86) Unique identifier for the integration ###### Example [Section titled “Example”](#example-58) ```ts int_abc123 ``` ##### Integration.status [Section titled “Integration.status”](#integrationstatus) > **status**: `"ACTIVE"` | `"DISABLED"` ###### Description [Section titled “Description”](#description-87) Current status of the integration ###### Example [Section titled “Example”](#example-59) ```ts ACTIVE @enum {string} ``` ##### Integration.vendor [Section titled “Integration.vendor”](#integrationvendor) > **vendor**: `string` ###### Description [Section titled “Description”](#description-88) The accounting vendor/system. ERP partners must request Brex to create a vendor ID for them to use this field. ##### Integration.vendor\_account\_id [Section titled “Integration.vendor\_account\_id”](#integrationvendor_account_id) > **vendor\_account\_id**: `string` ###### Description [Section titled “Description”](#description-89) The vendor account ID this integration is tied to ###### Example [Section titled “Example”](#example-60) ```ts customer_account_id ``` #### Receipt [Section titled “Receipt”](#receipt) > **Receipt**: `object` ##### Receipt.download\_uris? [Section titled “Receipt.download\_uris?”](#receiptdownload_uris) > `optional` **download\_uris?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-90) Presigned S3 URLs to download receipt files (expire in 15 minutes) ##### Receipt.id [Section titled “Receipt.id”](#receiptid) > **id**: `string` ###### Description [Section titled “Description”](#description-91) Unique identifier for the receipt #### ReportExportResultsRequest [Section titled “ReportExportResultsRequest”](#reportexportresultsrequest) > **ReportExportResultsRequest**: `object` ##### ReportExportResultsRequest.results [Section titled “ReportExportResultsRequest.results”](#reportexportresultsrequestresults) > **results**: ({ `accounting_record_id`: `string`; `failure`: { `error_message`: `string`; }; } | { `accounting_record_id`: `string`; `success`: { `deep_link_url?`: `string`; `reference_id?`: `string` | `null`; }; })\[] ###### Description [Section titled “Description”](#description-92) Array of export results (must contain at least one result) #### SuccessfulExportResult [Section titled “SuccessfulExportResult”](#successfulexportresult) > **SuccessfulExportResult**: `object` ##### SuccessfulExportResult.accounting\_record\_id [Section titled “SuccessfulExportResult.accounting\_record\_id”](#successfulexportresultaccounting_record_id) > **accounting\_record\_id**: `string` ###### Description [Section titled “Description”](#description-93) ID of the accounting record the export outcome applies to ###### Example [Section titled “Example”](#example-61) ```ts accr_abc123 ``` ##### SuccessfulExportResult.success [Section titled “SuccessfulExportResult.success”](#successfulexportresultsuccess) > **success**: `object` ###### Description [Section titled “Description”](#description-94) Details for a successful export ##### SuccessfulExportResult.success.deep\_link\_url? [Section titled “SuccessfulExportResult.success.deep\_link\_url?”](#successfulexportresultsuccessdeep_link_url) > `optional` **deep\_link\_url?**: `string` ###### Description [Section titled “Description”](#description-95) URL pointing to the record in the external system ###### Example [Section titled “Example”](#example-62) ```ts https://erp.com/transactions/456789 ``` ##### SuccessfulExportResult.success.reference\_id? [Section titled “SuccessfulExportResult.success.reference\_id?”](#successfulexportresultsuccessreference_id) > `optional` **reference\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-96) External system identifier assigned to the exported record ###### Example [Section titled “Example”](#example-63) ```ts erp_txn_456789 ``` #### UpdatedAtFilter [Section titled “UpdatedAtFilter”](#updatedatfilter) > **UpdatedAtFilter**: `object` ##### UpdatedAtFilter.gt? [Section titled “UpdatedAtFilter.gt?”](#updatedatfiltergt) > `optional` **gt?**: `string` Format: date-time ###### Description [Section titled “Description”](#description-97) Minimum value to filter by (exclusive) - ISO 8601 format ###### Example [Section titled “Example”](#example-64) ```ts 2025-01-01T00:00:00Z ``` ##### UpdatedAtFilter.gte? [Section titled “UpdatedAtFilter.gte?”](#updatedatfiltergte) > `optional` **gte?**: `string` Format: date-time ###### Description [Section titled “Description”](#description-98) Minimum value to filter by (inclusive) - ISO 8601 format ###### Example [Section titled “Example”](#example-65) ```ts 2025-01-01T00:00:00Z ``` ##### UpdatedAtFilter.lt? [Section titled “UpdatedAtFilter.lt?”](#updatedatfilterlt) > `optional` **lt?**: `string` Format: date-time ###### Description [Section titled “Description”](#description-99) Maximum value to filter by (exclusive) - ISO 8601 format ###### Example [Section titled “Example”](#example-66) ```ts 2025-01-01T00:00:00Z ``` ##### UpdatedAtFilter.lte? [Section titled “UpdatedAtFilter.lte?”](#updatedatfilterlte) > `optional` **lte?**: `string` Format: date-time ###### Description [Section titled “Description”](#description-100) Maximum value to filter by (inclusive) - ISO 8601 format ###### Example [Section titled “Example”](#example-67) ```ts 2025-01-01T23:59:59.999Z ``` #### User [Section titled “User”](#user) > **User**: `object` ##### User.department\_id? [Section titled “User.department\_id?”](#userdepartment_id) > `optional` **department\_id?**: `string` ###### Description [Section titled “Description”](#description-101) The ID of the user’s department ###### Example [Section titled “Example”](#example-68) ```ts VXNlcjpjdXVzZXJfMTIzNA== ``` ##### User.department\_name? [Section titled “User.department\_name?”](#userdepartment_name) > `optional` **department\_name?**: `string` ###### Description [Section titled “Description”](#description-102) The user’s department name ###### Example [Section titled “Example”](#example-69) ```ts Engineering ``` ##### User.email [Section titled “User.email”](#useremail) > **email**: `string` ###### Description [Section titled “Description”](#description-103) The user’s email address ###### Example [Section titled “Example”](#example-70) ```ts john.doe@example.com ``` ##### User.first\_name [Section titled “User.first\_name”](#userfirst_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-104) The user’s first name ###### Example [Section titled “Example”](#example-71) ```ts John ``` ##### User.id [Section titled “User.id”](#userid) > **id**: `string` ###### Description [Section titled “Description”](#description-105) The ID of the user ###### Example [Section titled “Example”](#example-72) ```ts VXNlcjpjdXVzZXJfMTIzNA== ``` ##### User.last\_name [Section titled “User.last\_name”](#userlast_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-106) The user’s last name ###### Example [Section titled “Example”](#example-73) ```ts Doe ``` ##### User.location\_id? [Section titled “User.location\_id?”](#userlocation_id) > `optional` **location\_id?**: `string` ###### Description [Section titled “Description”](#description-107) The ID of the user’s location ###### Example [Section titled “Example”](#example-74) ```ts VXNlcjpjdXVzZXJfMTIzNA== ``` ##### User.location\_name? [Section titled “User.location\_name?”](#userlocation_name) > `optional` **location\_name?**: `string` ###### Description [Section titled “Description”](#description-108) The user’s location name ###### Example [Section titled “Example”](#example-75) ```ts San Francisco ``` ##### User.manager\_first\_name? [Section titled “User.manager\_first\_name?”](#usermanager_first_name) > `optional` **manager\_first\_name?**: `string` ###### Description [Section titled “Description”](#description-109) The user’s manager first name ###### Example [Section titled “Example”](#example-76) ```ts Jane ``` ##### User.manager\_id? [Section titled “User.manager\_id?”](#usermanager_id) > `optional` **manager\_id?**: `string` ###### Description [Section titled “Description”](#description-110) The ID of the user’s manager ###### Example [Section titled “Example”](#example-77) ```ts VXNlcjpjdXVzZXJfMTIzNA== ``` ##### User.manager\_last\_name? [Section titled “User.manager\_last\_name?”](#usermanager_last_name) > `optional` **manager\_last\_name?**: `string` ###### Description [Section titled “Description”](#description-111) The user’s manager last name ###### Example [Section titled “Example”](#example-78) ```ts Smith ``` ##### User.manager\_title\_id? [Section titled “User.manager\_title\_id?”](#usermanager_title_id) > `optional` **manager\_title\_id?**: `string` ###### Description [Section titled “Description”](#description-112) The user’s manager title ID ###### Example [Section titled “Example”](#example-79) ```ts VGl0bGU6dGl0bGVfMTIzNA== ``` ##### User.manager\_title\_name? [Section titled “User.manager\_title\_name?”](#usermanager_title_name) > `optional` **manager\_title\_name?**: `string` ###### Description [Section titled “Description”](#description-113) The user’s manager title display name ###### Example [Section titled “Example”](#example-80) ```ts Engineering Manager ``` ##### User.role [Section titled “User.role”](#userrole) > **role**: `"ACCOUNT_ADMIN"` | `"AP_CLERK"` | `"BOOKKEEPER"` | `"CARD_ADMIN"` | `"EMPLOYEE"` | `"EMPLOYEE_WITHOUT_CORP_CARDS"` | `"EXPENSE_ADMIN"` | `"SUPER_ADMIN"` | `"USER_MANAGEMENT_ADMIN"` ###### Description [Section titled “Description”](#description-114) The user’s role in the system ###### Example [Section titled “Example”](#example-81) ```ts CARD_ADMIN @enum {string} ``` ##### User.status [Section titled “User.status”](#userstatus) > **status**: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` ###### Description [Section titled “Description”](#description-115) The user’s status in the system ###### Example [Section titled “Example”](#example-82) ```ts ACTIVE @enum {string} ``` ##### User.title\_id? [Section titled “User.title\_id?”](#usertitle_id) > `optional` **title\_id?**: `string` ###### Description [Section titled “Description”](#description-116) The user’s title ID ###### Example [Section titled “Example”](#example-83) ```ts VGl0bGU6dGl0bGVfMTIzNA== ``` ##### User.title\_name? [Section titled “User.title\_name?”](#usertitle_name) > `optional` **title\_name?**: `string` ###### Description [Section titled “Description”](#description-117) The user’s title display name ###### Example [Section titled “Example”](#example-84) ```ts Software Engineer ``` #### Vendor [Section titled “Vendor”](#vendor) > **Vendor**: `object` ##### Vendor.contact\_name? [Section titled “Vendor.contact\_name?”](#vendorcontact_name) > `optional` **contact\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-118) The name of the contact for the vendor ###### Example [Section titled “Example”](#example-85) ```ts Jane Smith ``` ##### Vendor.email? [Section titled “Vendor.email?”](#vendoremail) > `optional` **email?**: `string` | `null` ###### Description [Section titled “Description”](#description-119) The email for the vendor ###### Example [Section titled “Example”](#example-86) ```ts contact@acme.com ``` ##### Vendor.id [Section titled “Vendor.id”](#vendorid) > **id**: `string` ###### Description [Section titled “Description”](#description-120) The unique identifier for the vendor ###### Example [Section titled “Example”](#example-87) ```ts vendor_123 ``` ##### Vendor.name [Section titled “Vendor.name”](#vendorname) > **name**: `string` ###### Description [Section titled “Description”](#description-121) The name of the vendor ###### Example [Section titled “Example”](#example-88) ```ts Acme Corp ``` ##### Vendor.phone? [Section titled “Vendor.phone?”](#vendorphone) > `optional` **phone?**: `string` | `null` ###### Description [Section titled “Description”](#description-122) The phone number for the vendor ###### Example [Section titled “Example”](#example-89) ```ts +1-555-123-4567 ``` ##### Vendor.website? [Section titled “Vendor.website?”](#vendorwebsite) > `optional` **website?**: `string` | `null` ###### Description [Section titled “Description”](#description-123) The website of the vendor ###### Example [Section titled “Example”](#example-90) ```ts https://acme.com ``` # AccountingPaths Defined in: [src/accounting/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L2) ## Properties [Section titled “Properties”](#properties) ### /v3/accounting/integration [Section titled “/v3/accounting/integration”](#v3accountingintegration) > **/v3/accounting/integration**: `object` Defined in: [src/accounting/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L3) #### delete? [Section titled “delete?”](#delete) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post) > **post**: `object` Create accounting integration ##### Description [Section titled “Description”](#description) Create a new accounting integration. The behavior depends on the existing active integration: ```plaintext - If no active integration exists: Creates and returns new integration - If active integration exists with same vendor and vendor_account_id: Returns the existing active integration - If active integration exists with same vendor but different vendor_account_id: Returns 409 error - If active integration exists with different vendor: Returns 409 error This ensures only one active integration exists per account. ``` ##### post.parameters [Section titled “post.parameters”](#postparameters) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader) > `optional` **header?**: `undefined` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson) > **application/json**: `object` ##### post.requestBody.content.application/json.vendor [Section titled “post.requestBody.content.application/json.vendor”](#postrequestbodycontentapplicationjsonvendor) > **vendor**: `string` ###### Description [Section titled “Description”](#description-1) The accounting vendor/system. ERP partners must request Brex to create a vendor ID for them to use this field. ###### Example [Section titled “Example”](#example) ```ts ERP_A ``` ##### post.requestBody.content.application/json.vendor\_account\_id [Section titled “post.requestBody.content.application/json.vendor\_account\_id”](#postrequestbodycontentapplicationjsonvendor_account_id) > **vendor\_account\_id**: `string` ###### Description [Section titled “Description”](#description-2) The vendor account ID to tie this integration to ###### Example [Section titled “Example”](#example-1) ```ts vendor_account_id ``` ##### post.responses [Section titled “post.responses”](#postresponses) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-3) Integration created successfully ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson) > **application/json**: `object` ##### post.responses.200.content.application/json.created\_at [Section titled “post.responses.200.content.application/json.created\_at”](#postresponses200contentapplicationjsoncreated_at) > **created\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-4) Timestamp when the integration was created ###### Example [Section titled “Example”](#example-2) ```ts 2025-08-15T10:00:00Z ``` ##### post.responses.200.content.application/json.integration\_id [Section titled “post.responses.200.content.application/json.integration\_id”](#postresponses200contentapplicationjsonintegration_id) > **integration\_id**: `string` ###### Description [Section titled “Description”](#description-5) Unique identifier for the integration ###### Example [Section titled “Example”](#example-3) ```ts int_abc123 ``` ##### post.responses.200.content.application/json.status [Section titled “post.responses.200.content.application/json.status”](#postresponses200contentapplicationjsonstatus) > **status**: `"ACTIVE"` | `"DISABLED"` ###### Description [Section titled “Description”](#description-6) Current status of the integration ###### Example [Section titled “Example”](#example-4) ```ts ACTIVE @enum {string} ``` ##### post.responses.200.content.application/json.vendor [Section titled “post.responses.200.content.application/json.vendor”](#postresponses200contentapplicationjsonvendor) > **vendor**: `string` ###### Description [Section titled “Description”](#description-7) The accounting vendor/system. ERP partners must request Brex to create a vendor ID for them to use this field. ##### post.responses.200.content.application/json.vendor\_account\_id [Section titled “post.responses.200.content.application/json.vendor\_account\_id”](#postresponses200contentapplicationjsonvendor_account_id) > **vendor\_account\_id**: `string` ###### Description [Section titled “Description”](#description-8) The vendor account ID this integration is tied to ###### Example [Section titled “Example”](#example-5) ```ts customer_account_id ``` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-9) Bad request ##### post.responses.400.content [Section titled “post.responses.400.content”](#postresponses400content) > **content**: `object` ##### post.responses.400.content.application/json [Section titled “post.responses.400.content.application/json”](#postresponses400contentapplicationjson) > **application/json**: `object` ##### post.responses.400.content.application/json.details? [Section titled “post.responses.400.content.application/json.details?”](#postresponses400contentapplicationjsondetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-10) Additional error context ##### post.responses.400.content.application/json.error\_code [Section titled “post.responses.400.content.application/json.error\_code”](#postresponses400contentapplicationjsonerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-11) Machine-readable error code ###### Example [Section titled “Example”](#example-6) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.400.content.application/json.message [Section titled “post.responses.400.content.application/json.message”](#postresponses400contentapplicationjsonmessage) > **message**: `string` ###### Description [Section titled “Description”](#description-12) Human-readable error message ###### Example [Section titled “Example”](#example-7) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-1) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-13) Unauthorized ##### post.responses.401.content [Section titled “post.responses.401.content”](#postresponses401content) > **content**: `object` ##### post.responses.401.content.application/json [Section titled “post.responses.401.content.application/json”](#postresponses401contentapplicationjson) > **application/json**: `object` ##### post.responses.401.content.application/json.details? [Section titled “post.responses.401.content.application/json.details?”](#postresponses401contentapplicationjsondetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-14) Additional error context ##### post.responses.401.content.application/json.error\_code [Section titled “post.responses.401.content.application/json.error\_code”](#postresponses401contentapplicationjsonerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-15) Machine-readable error code ###### Example [Section titled “Example”](#example-8) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.401.content.application/json.message [Section titled “post.responses.401.content.application/json.message”](#postresponses401contentapplicationjsonmessage) > **message**: `string` ###### Description [Section titled “Description”](#description-16) Human-readable error message ###### Example [Section titled “Example”](#example-9) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-2) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-17) Forbidden ##### post.responses.403.content [Section titled “post.responses.403.content”](#postresponses403content) > **content**: `object` ##### post.responses.403.content.application/json [Section titled “post.responses.403.content.application/json”](#postresponses403contentapplicationjson) > **application/json**: `object` ##### post.responses.403.content.application/json.details? [Section titled “post.responses.403.content.application/json.details?”](#postresponses403contentapplicationjsondetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-18) Additional error context ##### post.responses.403.content.application/json.error\_code [Section titled “post.responses.403.content.application/json.error\_code”](#postresponses403contentapplicationjsonerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-19) Machine-readable error code ###### Example [Section titled “Example”](#example-10) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.403.content.application/json.message [Section titled “post.responses.403.content.application/json.message”](#postresponses403contentapplicationjsonmessage) > **message**: `string` ###### Description [Section titled “Description”](#description-20) Human-readable error message ###### Example [Section titled “Example”](#example-11) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-3) \[`name`: `string`]: `unknown` ##### post.responses.409 [Section titled “post.responses.409”](#postresponses409) > **409**: `object` ###### Description [Section titled “Description”](#description-21) Active integration exists with different vendor or different vendor account ID ##### post.responses.409.content [Section titled “post.responses.409.content”](#postresponses409content) > **content**: `object` ##### post.responses.409.content.application/json [Section titled “post.responses.409.content.application/json”](#postresponses409contentapplicationjson) > **application/json**: `object` ##### post.responses.409.content.application/json.details? [Section titled “post.responses.409.content.application/json.details?”](#postresponses409contentapplicationjsondetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-22) Additional error context ##### post.responses.409.content.application/json.error\_code [Section titled “post.responses.409.content.application/json.error\_code”](#postresponses409contentapplicationjsonerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-23) Machine-readable error code ###### Example [Section titled “Example”](#example-12) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.409.content.application/json.message [Section titled “post.responses.409.content.application/json.message”](#postresponses409contentapplicationjsonmessage) > **message**: `string` ###### Description [Section titled “Description”](#description-24) Human-readable error message ###### Example [Section titled “Example”](#example-13) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.409.headers [Section titled “post.responses.409.headers”](#postresponses409headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-4) \[`name`: `string`]: `unknown` ##### post.responses.500 [Section titled “post.responses.500”](#postresponses500) > **500**: `object` ###### Description [Section titled “Description”](#description-25) Internal server error ##### post.responses.500.content [Section titled “post.responses.500.content”](#postresponses500content) > **content**: `object` ##### post.responses.500.content.application/json [Section titled “post.responses.500.content.application/json”](#postresponses500contentapplicationjson) > **application/json**: `object` ##### post.responses.500.content.application/json.details? [Section titled “post.responses.500.content.application/json.details?”](#postresponses500contentapplicationjsondetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-26) Additional error context ##### post.responses.500.content.application/json.error\_code [Section titled “post.responses.500.content.application/json.error\_code”](#postresponses500contentapplicationjsonerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-27) Machine-readable error code ###### Example [Section titled “Example”](#example-14) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.500.content.application/json.message [Section titled “post.responses.500.content.application/json.message”](#postresponses500contentapplicationjsonmessage) > **message**: `string` ###### Description [Section titled “Description”](#description-28) Human-readable error message ###### Example [Section titled “Example”](#example-15) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.500.headers [Section titled “post.responses.500.headers”](#postresponses500headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-5) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace) > `optional` **trace?**: `undefined` *** ### /v3/accounting/integration/{integration\_id}/disconnect [Section titled “/v3/accounting/integration/{integration\_id}/disconnect”](#v3accountingintegrationintegration_iddisconnect) > **/v3/accounting/integration/{integration\_id}/disconnect**: `object` Defined in: [src/accounting/types.gen.ts:30](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L30) #### delete? [Section titled “delete?”](#delete-1) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-1) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-1) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-1) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-1) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-1) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-1) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-1) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-1) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-1) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-1) > **post**: `object` Disconnect accounting integration ##### Description [Section titled “Description”](#description-29) Disconnect an active accounting integration. ```plaintext - If integration is ACTIVE: Disconnects and returns success - If integration ID doesn't exist: Returns 404 error - If integration is not currently active: Returns 409 error ``` ##### post.parameters [Section titled “post.parameters”](#postparameters-1) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-1) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-1) > `optional` **header?**: `undefined` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-1) > **path**: `object` ##### post.parameters.path.integration\_id [Section titled “post.parameters.path.integration\_id”](#postparameterspathintegration_id) > **integration\_id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-1) > `optional` **query?**: `undefined` ##### post.requestBody? [Section titled “post.requestBody?”](#postrequestbody-1) > `optional` **requestBody?**: `undefined` ##### post.responses [Section titled “post.responses”](#postresponses-1) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-30) Integration disconnected successfully ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-1) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-1) > **application/json**: `object` ##### post.responses.200.content.application/json.created\_at [Section titled “post.responses.200.content.application/json.created\_at”](#postresponses200contentapplicationjsoncreated_at-1) > **created\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-31) Timestamp when the integration was created ###### Example [Section titled “Example”](#example-16) ```ts 2025-08-15T10:00:00Z ``` ##### post.responses.200.content.application/json.integration\_id [Section titled “post.responses.200.content.application/json.integration\_id”](#postresponses200contentapplicationjsonintegration_id-1) > **integration\_id**: `string` ###### Description [Section titled “Description”](#description-32) Unique identifier for the integration ###### Example [Section titled “Example”](#example-17) ```ts int_abc123 ``` ##### post.responses.200.content.application/json.status [Section titled “post.responses.200.content.application/json.status”](#postresponses200contentapplicationjsonstatus-1) > **status**: `"ACTIVE"` | `"DISABLED"` ###### Description [Section titled “Description”](#description-33) Current status of the integration ###### Example [Section titled “Example”](#example-18) ```ts ACTIVE @enum {string} ``` ##### post.responses.200.content.application/json.vendor [Section titled “post.responses.200.content.application/json.vendor”](#postresponses200contentapplicationjsonvendor-1) > **vendor**: `string` ###### Description [Section titled “Description”](#description-34) The accounting vendor/system. ERP partners must request Brex to create a vendor ID for them to use this field. ##### post.responses.200.content.application/json.vendor\_account\_id [Section titled “post.responses.200.content.application/json.vendor\_account\_id”](#postresponses200contentapplicationjsonvendor_account_id-1) > **vendor\_account\_id**: `string` ###### Description [Section titled “Description”](#description-35) The vendor account ID this integration is tied to ###### Example [Section titled “Example”](#example-19) ```ts customer_account_id ``` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-6) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-36) Unauthorized ##### post.responses.401.content [Section titled “post.responses.401.content”](#postresponses401content-1) > **content**: `object` ##### post.responses.401.content.application/json [Section titled “post.responses.401.content.application/json”](#postresponses401contentapplicationjson-1) > **application/json**: `object` ##### post.responses.401.content.application/json.details? [Section titled “post.responses.401.content.application/json.details?”](#postresponses401contentapplicationjsondetails-1) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-37) Additional error context ##### post.responses.401.content.application/json.error\_code [Section titled “post.responses.401.content.application/json.error\_code”](#postresponses401contentapplicationjsonerror_code-1) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-38) Machine-readable error code ###### Example [Section titled “Example”](#example-20) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.401.content.application/json.message [Section titled “post.responses.401.content.application/json.message”](#postresponses401contentapplicationjsonmessage-1) > **message**: `string` ###### Description [Section titled “Description”](#description-39) Human-readable error message ###### Example [Section titled “Example”](#example-21) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-7) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-40) Forbidden ##### post.responses.403.content [Section titled “post.responses.403.content”](#postresponses403content-1) > **content**: `object` ##### post.responses.403.content.application/json [Section titled “post.responses.403.content.application/json”](#postresponses403contentapplicationjson-1) > **application/json**: `object` ##### post.responses.403.content.application/json.details? [Section titled “post.responses.403.content.application/json.details?”](#postresponses403contentapplicationjsondetails-1) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-41) Additional error context ##### post.responses.403.content.application/json.error\_code [Section titled “post.responses.403.content.application/json.error\_code”](#postresponses403contentapplicationjsonerror_code-1) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-42) Machine-readable error code ###### Example [Section titled “Example”](#example-22) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.403.content.application/json.message [Section titled “post.responses.403.content.application/json.message”](#postresponses403contentapplicationjsonmessage-1) > **message**: `string` ###### Description [Section titled “Description”](#description-43) Human-readable error message ###### Example [Section titled “Example”](#example-23) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-8) \[`name`: `string`]: `unknown` ##### post.responses.404 [Section titled “post.responses.404”](#postresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-44) Integration not found ##### post.responses.404.content [Section titled “post.responses.404.content”](#postresponses404content) > **content**: `object` ##### post.responses.404.content.application/json [Section titled “post.responses.404.content.application/json”](#postresponses404contentapplicationjson) > **application/json**: `object` ##### post.responses.404.content.application/json.details? [Section titled “post.responses.404.content.application/json.details?”](#postresponses404contentapplicationjsondetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-45) Additional error context ##### post.responses.404.content.application/json.error\_code [Section titled “post.responses.404.content.application/json.error\_code”](#postresponses404contentapplicationjsonerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-46) Machine-readable error code ###### Example [Section titled “Example”](#example-24) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.404.content.application/json.message [Section titled “post.responses.404.content.application/json.message”](#postresponses404contentapplicationjsonmessage) > **message**: `string` ###### Description [Section titled “Description”](#description-47) Human-readable error message ###### Example [Section titled “Example”](#example-25) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.404.headers [Section titled “post.responses.404.headers”](#postresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-9) \[`name`: `string`]: `unknown` ##### post.responses.409 [Section titled “post.responses.409”](#postresponses409-1) > **409**: `object` ###### Description [Section titled “Description”](#description-48) Integration is not active ##### post.responses.409.content [Section titled “post.responses.409.content”](#postresponses409content-1) > **content**: `object` ##### post.responses.409.content.application/json [Section titled “post.responses.409.content.application/json”](#postresponses409contentapplicationjson-1) > **application/json**: `object` ##### post.responses.409.content.application/json.details? [Section titled “post.responses.409.content.application/json.details?”](#postresponses409contentapplicationjsondetails-1) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-49) Additional error context ##### post.responses.409.content.application/json.error\_code [Section titled “post.responses.409.content.application/json.error\_code”](#postresponses409contentapplicationjsonerror_code-1) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-50) Machine-readable error code ###### Example [Section titled “Example”](#example-26) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.409.content.application/json.message [Section titled “post.responses.409.content.application/json.message”](#postresponses409contentapplicationjsonmessage-1) > **message**: `string` ###### Description [Section titled “Description”](#description-51) Human-readable error message ###### Example [Section titled “Example”](#example-27) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.409.headers [Section titled “post.responses.409.headers”](#postresponses409headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-10) \[`name`: `string`]: `unknown` ##### post.responses.500 [Section titled “post.responses.500”](#postresponses500-1) > **500**: `object` ###### Description [Section titled “Description”](#description-52) Internal server error ##### post.responses.500.content [Section titled “post.responses.500.content”](#postresponses500content-1) > **content**: `object` ##### post.responses.500.content.application/json [Section titled “post.responses.500.content.application/json”](#postresponses500contentapplicationjson-1) > **application/json**: `object` ##### post.responses.500.content.application/json.details? [Section titled “post.responses.500.content.application/json.details?”](#postresponses500contentapplicationjsondetails-1) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-53) Additional error context ##### post.responses.500.content.application/json.error\_code [Section titled “post.responses.500.content.application/json.error\_code”](#postresponses500contentapplicationjsonerror_code-1) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-54) Machine-readable error code ###### Example [Section titled “Example”](#example-28) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.500.content.application/json.message [Section titled “post.responses.500.content.application/json.message”](#postresponses500contentapplicationjsonmessage-1) > **message**: `string` ###### Description [Section titled “Description”](#description-55) Human-readable error message ###### Example [Section titled “Example”](#example-29) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.500.headers [Section titled “post.responses.500.headers”](#postresponses500headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-11) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-1) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-1) > `optional` **trace?**: `undefined` *** ### /v3/accounting/integration/{integration\_id}/reactivate [Section titled “/v3/accounting/integration/{integration\_id}/reactivate”](#v3accountingintegrationintegration_idreactivate) > **/v3/accounting/integration/{integration\_id}/reactivate**: `object` Defined in: [src/accounting/types.gen.ts:54](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L54) #### delete? [Section titled “delete?”](#delete-2) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-2) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-2) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-2) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-2) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-2) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-2) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-2) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-2) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-2) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-2) > **post**: `object` Reactivate accounting integration ##### Description [Section titled “Description”](#description-56) Reactivate a disconnected accounting integration. ```plaintext - If integration is DISABLED: Reactivates and returns success - If integration ID doesn't exist: Returns 404 error - If an active integration already exists: Returns 409 error ``` ##### post.parameters [Section titled “post.parameters”](#postparameters-2) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-2) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-2) > `optional` **header?**: `undefined` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-2) > **path**: `object` ##### post.parameters.path.integration\_id [Section titled “post.parameters.path.integration\_id”](#postparameterspathintegration_id-1) > **integration\_id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-2) > `optional` **query?**: `undefined` ##### post.requestBody? [Section titled “post.requestBody?”](#postrequestbody-2) > `optional` **requestBody?**: `undefined` ##### post.responses [Section titled “post.responses”](#postresponses-2) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-57) Integration reactivated successfully ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-2) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-2) > **application/json**: `object` ##### post.responses.200.content.application/json.created\_at [Section titled “post.responses.200.content.application/json.created\_at”](#postresponses200contentapplicationjsoncreated_at-2) > **created\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-58) Timestamp when the integration was created ###### Example [Section titled “Example”](#example-30) ```ts 2025-08-15T10:00:00Z ``` ##### post.responses.200.content.application/json.integration\_id [Section titled “post.responses.200.content.application/json.integration\_id”](#postresponses200contentapplicationjsonintegration_id-2) > **integration\_id**: `string` ###### Description [Section titled “Description”](#description-59) Unique identifier for the integration ###### Example [Section titled “Example”](#example-31) ```ts int_abc123 ``` ##### post.responses.200.content.application/json.status [Section titled “post.responses.200.content.application/json.status”](#postresponses200contentapplicationjsonstatus-2) > **status**: `"ACTIVE"` | `"DISABLED"` ###### Description [Section titled “Description”](#description-60) Current status of the integration ###### Example [Section titled “Example”](#example-32) ```ts ACTIVE @enum {string} ``` ##### post.responses.200.content.application/json.vendor [Section titled “post.responses.200.content.application/json.vendor”](#postresponses200contentapplicationjsonvendor-2) > **vendor**: `string` ###### Description [Section titled “Description”](#description-61) The accounting vendor/system. ERP partners must request Brex to create a vendor ID for them to use this field. ##### post.responses.200.content.application/json.vendor\_account\_id [Section titled “post.responses.200.content.application/json.vendor\_account\_id”](#postresponses200contentapplicationjsonvendor_account_id-2) > **vendor\_account\_id**: `string` ###### Description [Section titled “Description”](#description-62) The vendor account ID this integration is tied to ###### Example [Section titled “Example”](#example-33) ```ts customer_account_id ``` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-12) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-2) > **401**: `object` ###### Description [Section titled “Description”](#description-63) Unauthorized ##### post.responses.401.content [Section titled “post.responses.401.content”](#postresponses401content-2) > **content**: `object` ##### post.responses.401.content.application/json [Section titled “post.responses.401.content.application/json”](#postresponses401contentapplicationjson-2) > **application/json**: `object` ##### post.responses.401.content.application/json.details? [Section titled “post.responses.401.content.application/json.details?”](#postresponses401contentapplicationjsondetails-2) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-64) Additional error context ##### post.responses.401.content.application/json.error\_code [Section titled “post.responses.401.content.application/json.error\_code”](#postresponses401contentapplicationjsonerror_code-2) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-65) Machine-readable error code ###### Example [Section titled “Example”](#example-34) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.401.content.application/json.message [Section titled “post.responses.401.content.application/json.message”](#postresponses401contentapplicationjsonmessage-2) > **message**: `string` ###### Description [Section titled “Description”](#description-66) Human-readable error message ###### Example [Section titled “Example”](#example-35) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-13) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403-2) > **403**: `object` ###### Description [Section titled “Description”](#description-67) Forbidden ##### post.responses.403.content [Section titled “post.responses.403.content”](#postresponses403content-2) > **content**: `object` ##### post.responses.403.content.application/json [Section titled “post.responses.403.content.application/json”](#postresponses403contentapplicationjson-2) > **application/json**: `object` ##### post.responses.403.content.application/json.details? [Section titled “post.responses.403.content.application/json.details?”](#postresponses403contentapplicationjsondetails-2) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-68) Additional error context ##### post.responses.403.content.application/json.error\_code [Section titled “post.responses.403.content.application/json.error\_code”](#postresponses403contentapplicationjsonerror_code-2) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-69) Machine-readable error code ###### Example [Section titled “Example”](#example-36) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.403.content.application/json.message [Section titled “post.responses.403.content.application/json.message”](#postresponses403contentapplicationjsonmessage-2) > **message**: `string` ###### Description [Section titled “Description”](#description-70) Human-readable error message ###### Example [Section titled “Example”](#example-37) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-14) \[`name`: `string`]: `unknown` ##### post.responses.404 [Section titled “post.responses.404”](#postresponses404-1) > **404**: `object` ###### Description [Section titled “Description”](#description-71) Integration not found ##### post.responses.404.content [Section titled “post.responses.404.content”](#postresponses404content-1) > **content**: `object` ##### post.responses.404.content.application/json [Section titled “post.responses.404.content.application/json”](#postresponses404contentapplicationjson-1) > **application/json**: `object` ##### post.responses.404.content.application/json.details? [Section titled “post.responses.404.content.application/json.details?”](#postresponses404contentapplicationjsondetails-1) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-72) Additional error context ##### post.responses.404.content.application/json.error\_code [Section titled “post.responses.404.content.application/json.error\_code”](#postresponses404contentapplicationjsonerror_code-1) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-73) Machine-readable error code ###### Example [Section titled “Example”](#example-38) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.404.content.application/json.message [Section titled “post.responses.404.content.application/json.message”](#postresponses404contentapplicationjsonmessage-1) > **message**: `string` ###### Description [Section titled “Description”](#description-74) Human-readable error message ###### Example [Section titled “Example”](#example-39) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.404.headers [Section titled “post.responses.404.headers”](#postresponses404headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-15) \[`name`: `string`]: `unknown` ##### post.responses.409 [Section titled “post.responses.409”](#postresponses409-2) > **409**: `object` ###### Description [Section titled “Description”](#description-75) Active integration already exists ##### post.responses.409.content [Section titled “post.responses.409.content”](#postresponses409content-2) > **content**: `object` ##### post.responses.409.content.application/json [Section titled “post.responses.409.content.application/json”](#postresponses409contentapplicationjson-2) > **application/json**: `object` ##### post.responses.409.content.application/json.details? [Section titled “post.responses.409.content.application/json.details?”](#postresponses409contentapplicationjsondetails-2) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-76) Additional error context ##### post.responses.409.content.application/json.error\_code [Section titled “post.responses.409.content.application/json.error\_code”](#postresponses409contentapplicationjsonerror_code-2) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-77) Machine-readable error code ###### Example [Section titled “Example”](#example-40) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.409.content.application/json.message [Section titled “post.responses.409.content.application/json.message”](#postresponses409contentapplicationjsonmessage-2) > **message**: `string` ###### Description [Section titled “Description”](#description-78) Human-readable error message ###### Example [Section titled “Example”](#example-41) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.409.headers [Section titled “post.responses.409.headers”](#postresponses409headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-16) \[`name`: `string`]: `unknown` ##### post.responses.500 [Section titled “post.responses.500”](#postresponses500-2) > **500**: `object` ###### Description [Section titled “Description”](#description-79) Internal server error ##### post.responses.500.content [Section titled “post.responses.500.content”](#postresponses500content-2) > **content**: `object` ##### post.responses.500.content.application/json [Section titled “post.responses.500.content.application/json”](#postresponses500contentapplicationjson-2) > **application/json**: `object` ##### post.responses.500.content.application/json.details? [Section titled “post.responses.500.content.application/json.details?”](#postresponses500contentapplicationjsondetails-2) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-80) Additional error context ##### post.responses.500.content.application/json.error\_code [Section titled “post.responses.500.content.application/json.error\_code”](#postresponses500contentapplicationjsonerror_code-2) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-81) Machine-readable error code ###### Example [Section titled “Example”](#example-42) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.500.content.application/json.message [Section titled “post.responses.500.content.application/json.message”](#postresponses500contentapplicationjsonmessage-2) > **message**: `string` ###### Description [Section titled “Description”](#description-82) Human-readable error message ###### Example [Section titled “Example”](#example-43) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.500.headers [Section titled “post.responses.500.headers”](#postresponses500headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-17) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-2) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-2) > `optional` **trace?**: `undefined` *** ### /v3/accounting/records [Section titled “/v3/accounting/records”](#v3accountingrecords) > **/v3/accounting/records**: `object` Defined in: [src/accounting/types.gen.ts:78](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L78) #### delete? [Section titled “delete?”](#delete-3) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-3) > **get**: `object` Query accounting records ##### Description [Section titled “Description”](#description-83) Query accounting records by IDs or with filters for polling. When building integrations with Brex accounting workflow, use filter-based polling as a fallback mechanism. Suggested cadence is 1 hour. ```plaintext **For card and reimbursement records:** Use `review_status` to filter by accounting workflow stage (e.g., READY_FOR_EXPORT, EXPORTED). **For bill records:** Use `source_type=BILL` with `updated_at[gt]` to poll for updated bill records. **Filter Constraints:** - `review_status` is only supported with CARD and REIMBURSEMENT source types ``` ##### get.parameters [Section titled “get.parameters”](#getparameters) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor) > `optional` **cursor?**: `string` ###### Description [Section titled “Description”](#description-84) Cursor for pagination ##### get.parameters.query.ids? [Section titled “get.parameters.query.ids?”](#getparametersqueryids) > `optional` **ids?**: `string`\[] ###### Description [Section titled “Description”](#description-85) Filter by accounting record IDs. ID size is limited to 500. Example: `ids=accr_xxx&ids=accr_yyy` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit) > `optional` **limit?**: `number` ###### Description [Section titled “Description”](#description-86) Maximum number of records to return. Defaults to 100. The maximum is 500; requests with a higher value are rejected with a 400 error. ##### get.parameters.query.review\_status? [Section titled “get.parameters.query.review\_status?”](#getparametersqueryreview_status) > `optional` **review\_status?**: `"PREPARE"` | `"REVIEW"` | `"READY_FOR_EXPORT"` | `"EXPORTED"` ###### Description [Section titled “Description”](#description-87) Filter by review status. Tracks a record’s stage in the accounting review lifecycle, which progresses in this order: `PREPARE` (the record is being prepared and is not yet ready for review) → `REVIEW` (the record is ready to be reviewed) → `READY_FOR_EXPORT` (the record has been reviewed and is queued for export to your ERP) → `EXPORTED` (the record has been exported). ##### get.parameters.query.single\_entry? [Section titled “get.parameters.query.single\_entry?”](#getparametersquerysingle_entry) > `optional` **single\_entry?**: `boolean` ###### Description [Section titled “Description”](#description-88) Toggles the response format between single-entry and double-entry bookkeeping. Set to true to filter out offsetting ledger entries and return only the core cash-flow or economic-impact line items. Defaults to false. ##### get.parameters.query.source\_type? [Section titled “get.parameters.query.source\_type?”](#getparametersquerysource_type) > `optional` **source\_type?**: `"CARD"` | `"REIMBURSEMENT"` | `"BILL"` ###### Description [Section titled “Description”](#description-89) Filter by accounting record source type. This is a high-level filter that maps to specific accounting record types. Example: `source_type=BILL` ##### get.parameters.query.updated\_at? [Section titled “get.parameters.query.updated\_at?”](#getparametersqueryupdated_at) > `optional` **updated\_at?**: `object` ###### Description [Section titled “Description”](#description-90) Filter by updated\_at timestamp range in UTC. Accepts gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal). Example: `updated_at[gte]=2025-01-01` ##### get.parameters.query.updated\_at.gt? [Section titled “get.parameters.query.updated\_at.gt?”](#getparametersqueryupdated_atgt) > `optional` **gt?**: `string` Format: date-time ###### Description [Section titled “Description”](#description-91) Minimum value to filter by (exclusive) - ISO 8601 format ###### Example [Section titled “Example”](#example-44) ```ts 2025-01-01T00:00:00Z ``` ##### get.parameters.query.updated\_at.gte? [Section titled “get.parameters.query.updated\_at.gte?”](#getparametersqueryupdated_atgte) > `optional` **gte?**: `string` Format: date-time ###### Description [Section titled “Description”](#description-92) Minimum value to filter by (inclusive) - ISO 8601 format ###### Example [Section titled “Example”](#example-45) ```ts 2025-01-01T00:00:00Z ``` ##### get.parameters.query.updated\_at.lt? [Section titled “get.parameters.query.updated\_at.lt?”](#getparametersqueryupdated_atlt) > `optional` **lt?**: `string` Format: date-time ###### Description [Section titled “Description”](#description-93) Maximum value to filter by (exclusive) - ISO 8601 format ###### Example [Section titled “Example”](#example-46) ```ts 2025-01-01T00:00:00Z ``` ##### get.parameters.query.updated\_at.lte? [Section titled “get.parameters.query.updated\_at.lte?”](#getparametersqueryupdated_atlte) > `optional` **lte?**: `string` Format: date-time ###### Description [Section titled “Description”](#description-94) Maximum value to filter by (inclusive) - ISO 8601 format ###### Example [Section titled “Example”](#example-47) ```ts 2025-01-01T23:59:59.999Z ``` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-95) Query accounting records response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson) > **application/json**: `object` ##### get.responses.200.content.application/json.has\_next\_page [Section titled “get.responses.200.content.application/json.has\_next\_page”](#getresponses200contentapplicationjsonhas_next_page) > **has\_next\_page**: `boolean` ###### Description [Section titled “Description”](#description-96) Whether there are more results available ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems) > **items**: `object`\[] ###### Description [Section titled “Description”](#description-97) List of accounting records ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor) > `optional` **next\_cursor?**: `string` | `null` ###### Description [Section titled “Description”](#description-98) Cursor for the next page of results ##### get.responses.200.content.application/json.total\_count? [Section titled “get.responses.200.content.application/json.total\_count?”](#getresponses200contentapplicationjsontotal_count) > `optional` **total\_count?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-99) Total count of records matching the query ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-18) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-100) Bad request ##### get.responses.400.content [Section titled “get.responses.400.content”](#getresponses400content) > **content**: `object` ##### get.responses.400.content.application/json [Section titled “get.responses.400.content.application/json”](#getresponses400contentapplicationjson) > **application/json**: `object` ##### get.responses.400.content.application/json.details? [Section titled “get.responses.400.content.application/json.details?”](#getresponses400contentapplicationjsondetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-101) Additional error context ##### get.responses.400.content.application/json.error\_code [Section titled “get.responses.400.content.application/json.error\_code”](#getresponses400contentapplicationjsonerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-102) Machine-readable error code ###### Example [Section titled “Example”](#example-48) ```ts INVALID_REQUEST @enum {string} ``` ##### get.responses.400.content.application/json.message [Section titled “get.responses.400.content.application/json.message”](#getresponses400contentapplicationjsonmessage) > **message**: `string` ###### Description [Section titled “Description”](#description-103) Human-readable error message ###### Example [Section titled “Example”](#example-49) ```ts The request is malformed or contains invalid data. ``` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-19) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-104) Unauthorized ##### get.responses.401.content [Section titled “get.responses.401.content”](#getresponses401content) > **content**: `object` ##### get.responses.401.content.application/json [Section titled “get.responses.401.content.application/json”](#getresponses401contentapplicationjson) > **application/json**: `object` ##### get.responses.401.content.application/json.details? [Section titled “get.responses.401.content.application/json.details?”](#getresponses401contentapplicationjsondetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-105) Additional error context ##### get.responses.401.content.application/json.error\_code [Section titled “get.responses.401.content.application/json.error\_code”](#getresponses401contentapplicationjsonerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-106) Machine-readable error code ###### Example [Section titled “Example”](#example-50) ```ts INVALID_REQUEST @enum {string} ``` ##### get.responses.401.content.application/json.message [Section titled “get.responses.401.content.application/json.message”](#getresponses401contentapplicationjsonmessage) > **message**: `string` ###### Description [Section titled “Description”](#description-107) Human-readable error message ###### Example [Section titled “Example”](#example-51) ```ts The request is malformed or contains invalid data. ``` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-20) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-108) Forbidden ##### get.responses.403.content [Section titled “get.responses.403.content”](#getresponses403content) > **content**: `object` ##### get.responses.403.content.application/json [Section titled “get.responses.403.content.application/json”](#getresponses403contentapplicationjson) > **application/json**: `object` ##### get.responses.403.content.application/json.details? [Section titled “get.responses.403.content.application/json.details?”](#getresponses403contentapplicationjsondetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-109) Additional error context ##### get.responses.403.content.application/json.error\_code [Section titled “get.responses.403.content.application/json.error\_code”](#getresponses403contentapplicationjsonerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-110) Machine-readable error code ###### Example [Section titled “Example”](#example-52) ```ts INVALID_REQUEST @enum {string} ``` ##### get.responses.403.content.application/json.message [Section titled “get.responses.403.content.application/json.message”](#getresponses403contentapplicationjsonmessage) > **message**: `string` ###### Description [Section titled “Description”](#description-111) Human-readable error message ###### Example [Section titled “Example”](#example-53) ```ts The request is malformed or contains invalid data. ``` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-21) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500) > **500**: `object` ###### Description [Section titled “Description”](#description-112) Internal server error ##### get.responses.500.content [Section titled “get.responses.500.content”](#getresponses500content) > **content**: `object` ##### get.responses.500.content.application/json [Section titled “get.responses.500.content.application/json”](#getresponses500contentapplicationjson) > **application/json**: `object` ##### get.responses.500.content.application/json.details? [Section titled “get.responses.500.content.application/json.details?”](#getresponses500contentapplicationjsondetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-113) Additional error context ##### get.responses.500.content.application/json.error\_code [Section titled “get.responses.500.content.application/json.error\_code”](#getresponses500contentapplicationjsonerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-114) Machine-readable error code ###### Example [Section titled “Example”](#example-54) ```ts INVALID_REQUEST @enum {string} ``` ##### get.responses.500.content.application/json.message [Section titled “get.responses.500.content.application/json.message”](#getresponses500contentapplicationjsonmessage) > **message**: `string` ###### Description [Section titled “Description”](#description-115) Human-readable error message ###### Example [Section titled “Example”](#example-55) ```ts The request is malformed or contains invalid data. ``` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-22) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-3) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-3) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-3) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-3) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-3) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-3) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-3) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-3) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-3) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-3) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-3) > `optional` **trace?**: `undefined` *** ### /v3/accounting/records/{record\_id} [Section titled “/v3/accounting/records/{record\_id}”](#v3accountingrecordsrecord_id) > **/v3/accounting/records/{record\_id}**: `object` Defined in: [src/accounting/types.gen.ts:107](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L107) #### delete? [Section titled “delete?”](#delete-4) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-4) > **get**: `object` Get accounting record by ID ##### Description [Section titled “Description”](#description-116) Retrieve a single accounting record by its unique identifier ##### get.parameters [Section titled “get.parameters”](#getparameters-1) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-1) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-1) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-1) > **path**: `object` ##### get.parameters.path.record\_id [Section titled “get.parameters.path.record\_id”](#getparameterspathrecord_id) > **record\_id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-1) > `optional` **query?**: `object` ##### get.parameters.query.single\_entry? [Section titled “get.parameters.query.single\_entry?”](#getparametersquerysingle_entry-1) > `optional` **single\_entry?**: `boolean` ###### Description [Section titled “Description”](#description-117) Toggles the response format between single-entry and double-entry bookkeeping. Set to true to filter out offsetting ledger entries and return only the core cash-flow or economic-impact line items. Defaults to false. ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-1) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-1) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-118) Accounting record retrieved successfully ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-1) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-1) > **application/json**: `object` ##### get.responses.200.content.application/json.amount [Section titled “get.responses.200.content.application/json.amount”](#getresponses200contentapplicationjsonamount) > **amount**: `object` ###### Description [Section titled “Description”](#description-119) Amount of the accounting record ##### get.responses.200.content.application/json.amount.amount [Section titled “get.responses.200.content.application/json.amount.amount”](#getresponses200contentapplicationjsonamountamount) > **amount**: `number` ###### Description [Section titled “Description”](#description-120) The amount ###### Example [Section titled “Example”](#example-56) ```ts 100 ``` ##### get.responses.200.content.application/json.amount.currency [Section titled “get.responses.200.content.application/json.amount.currency”](#getresponses200contentapplicationjsonamountcurrency) > **currency**: `string` ###### Description [Section titled “Description”](#description-121) The currency ###### Example [Section titled “Example”](#example-57) ```ts USD ``` ##### get.responses.200.content.application/json.due\_at? [Section titled “get.responses.200.content.application/json.due\_at?”](#getresponses200contentapplicationjsondue_at) > `optional` **due\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-122) Source due at in UTC timezone. For bills only ##### get.responses.200.content.application/json.erp\_posting\_date [Section titled “get.responses.200.content.application/json.erp\_posting\_date”](#getresponses200contentapplicationjsonerp_posting_date) > **erp\_posting\_date**: `string` Format: date-time ###### Description [Section titled “Description”](#description-123) ERP impact date in UTC timezone ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-124) Unique identifier for the accounting record ###### Example [Section titled “Example”](#example-58) ```ts accr_abc123 ``` ##### get.responses.200.content.application/json.invoice\_number? [Section titled “get.responses.200.content.application/json.invoice\_number?”](#getresponses200contentapplicationjsoninvoice_number) > `optional` **invoice\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-125) Invoice number. For bills only ##### get.responses.200.content.application/json.line\_items [Section titled “get.responses.200.content.application/json.line\_items”](#getresponses200contentapplicationjsonline_items) > **line\_items**: `object`\[] ###### Description [Section titled “Description”](#description-126) Line items for double-entry bookkeeping ##### get.responses.200.content.application/json.memo? [Section titled “get.responses.200.content.application/json.memo?”](#getresponses200contentapplicationjsonmemo) > `optional` **memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-127) Memo/description ##### get.responses.200.content.application/json.original\_amount? [Section titled “get.responses.200.content.application/json.original\_amount?”](#getresponses200contentapplicationjsonoriginal_amount) > `optional` **original\_amount?**: { `amount`: `number`; `currency`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `amount`: `number`; `currency`: `string`; } ###### amount [Section titled “amount”](#amount) > **amount**: `number` ###### Description [Section titled “Description”](#description-128) The amount ###### Example [Section titled “Example”](#example-59) ```ts 100 ``` ###### currency [Section titled “currency”](#currency) > **currency**: `string` ###### Description [Section titled “Description”](#description-129) The currency ###### Example [Section titled “Example”](#example-60) ```ts USD ``` *** `null` ###### Description [Section titled “Description”](#description-130) Original amount if different from current ##### get.responses.200.content.application/json.posted\_at [Section titled “get.responses.200.content.application/json.posted\_at”](#getresponses200contentapplicationjsonposted_at) > **posted\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-131) Source posted date in UTC timezone ##### get.responses.200.content.application/json.receipts? [Section titled “get.responses.200.content.application/json.receipts?”](#getresponses200contentapplicationjsonreceipts) > `optional` **receipts?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-132) Associated receipts ##### get.responses.200.content.application/json.review\_status [Section titled “get.responses.200.content.application/json.review\_status”](#getresponses200contentapplicationjsonreview_status) > **review\_status**: `"PREPARE"` | `"REVIEW"` | `"READY_FOR_EXPORT"` | `"EXPORTED"` ###### Description [Section titled “Description”](#description-133) Current review status of the record in the accounting review lifecycle: `PREPARE` → `REVIEW` → `READY_FOR_EXPORT` → `EXPORTED`. ##### get.responses.200.content.application/json.source\_id? [Section titled “get.responses.200.content.application/json.source\_id?”](#getresponses200contentapplicationjsonsource_id) > `optional` **source\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-134) Source transaction ID ##### get.responses.200.content.application/json.source\_type [Section titled “get.responses.200.content.application/json.source\_type”](#getresponses200contentapplicationjsonsource_type) > **source\_type**: `"CARD"` | `"REIMBURSEMENT"` | `"BILL"` ###### Description [Section titled “Description”](#description-135) Source type ##### get.responses.200.content.application/json.type [Section titled “get.responses.200.content.application/json.type”](#getresponses200contentapplicationjsontype) > **type**: `"CARD_EXPENSE_POST"` | `"CARD_EXPENSE_REPAYMENT"` | `"REIMBURSEMENT_EXPENSE_REPAYMENT"` | `"REIMBURSEMENT_EXPENSE_APPROVAL"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYIN"` | `"REIMBURSEMENT_EXPENSE_POST"` | `"CARD_PAYMENT"` | `"REWARD_REDEMPTION"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_REFUND"` | `"CARD_EXPENSE_REFUND"` | `"CARD_PAYMENT_REFUND"` | `"REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT_REVERSAL"` | `"INVOICE"` | `"INVOICE_PAYMENT"` | `"BILL_EXPENSE"` | `"BILL_EXPENSE_PAYMENT"` | `"BILL_EXPENSE_CARD_PAYMENT"` | `"BILL_MONEY_MOVEMENT_PAYIN"` ###### Description [Section titled “Description”](#description-136) Types of accounting records representing different financial transactions: ```plaintext **Card-related transactions:** - `CARD_EXPENSE_POST`: Records when a card expense is posted and settled - `CARD_EXPENSE_REFUND`: Records when a merchant issues a refund for a card transaction - `CARD_EXPENSE_REPAYMENT`: Records when an employee repays money to the company for a card expense - `CARD_PAYMENT`: Records payments from customer to Brex for card balances - `CARD_PAYMENT_REFUND`: Records refunds from Brex to customer for overpayments - `REWARD_REDEMPTION`: Records when a reward is redeemed **Bill-related transactions:** - `BILL_EXPENSE`: Records when a bill expense is created - `BILL_EXPENSE_PAYMENT`: Records when a bill is paid through ACH/wire transfer - `BILL_EXPENSE_CARD_PAYMENT`: Records when a bill is paid using a Brex card **Reimbursement-related transactions:** - `REIMBURSEMENT_EXPENSE_APPROVAL`: Records approval of reimbursement (accrual basis) - `REIMBURSEMENT_EXPENSE_POST`: Records when reimbursement is fulfilled (cash basis) - `REIMBURSEMENT_EXPENSE_REPAYMENT`: Records repayment of a reimbursement expense - `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT`: Records payout to employee/third party - `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT_REVERSAL`: Records reversal of payout - `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYIN`: Records payment from customer to Brex - `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_REFUND`: Records refund to customer's bank ``` ##### get.responses.200.content.application/json.updated\_at [Section titled “get.responses.200.content.application/json.updated\_at”](#getresponses200contentapplicationjsonupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-137) Last update timestamp in UTC timezone ##### get.responses.200.content.application/json.user? [Section titled “get.responses.200.content.application/json.user?”](#getresponses200contentapplicationjsonuser) > `optional` **user?**: { `department_id?`: `string`; `department_name?`: `string`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string`; `location_name?`: `string`; `manager_first_name?`: `string`; `manager_id?`: `string`; `manager_last_name?`: `string`; `manager_title_id?`: `string`; `manager_title_name?`: `string`; `role`: `"ACCOUNT_ADMIN"` | `"AP_CLERK"` | `"BOOKKEEPER"` | `"CARD_ADMIN"` | `"EMPLOYEE"` | `"EMPLOYEE_WITHOUT_CORP_CARDS"` | `"EXPENSE_ADMIN"` | `"SUPER_ADMIN"` | `"USER_MANAGEMENT_ADMIN"`; `status`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"`; `title_id?`: `string`; `title_name?`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `department_id?`: `string`; `department_name?`: `string`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string`; `location_name?`: `string`; `manager_first_name?`: `string`; `manager_id?`: `string`; `manager_last_name?`: `string`; `manager_title_id?`: `string`; `manager_title_name?`: `string`; `role`: `"ACCOUNT_ADMIN"` | `"AP_CLERK"` | `"BOOKKEEPER"` | `"CARD_ADMIN"` | `"EMPLOYEE"` | `"EMPLOYEE_WITHOUT_CORP_CARDS"` | `"EXPENSE_ADMIN"` | `"SUPER_ADMIN"` | `"USER_MANAGEMENT_ADMIN"`; `status`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"`; `title_id?`: `string`; `title_name?`: `string`; } ###### department\_id? [Section titled “department\_id?”](#department_id) > `optional` **department\_id?**: `string` ###### Description [Section titled “Description”](#description-138) The ID of the user’s department ###### Example [Section titled “Example”](#example-61) ```ts VXNlcjpjdXVzZXJfMTIzNA== ``` ###### department\_name? [Section titled “department\_name?”](#department_name) > `optional` **department\_name?**: `string` ###### Description [Section titled “Description”](#description-139) The user’s department name ###### Example [Section titled “Example”](#example-62) ```ts Engineering ``` ###### email [Section titled “email”](#email) > **email**: `string` ###### Description [Section titled “Description”](#description-140) The user’s email address ###### Example [Section titled “Example”](#example-63) ```ts john.doe@example.com ``` ###### first\_name [Section titled “first\_name”](#first_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-141) The user’s first name ###### Example [Section titled “Example”](#example-64) ```ts John ``` ###### id [Section titled “id”](#id) > **id**: `string` ###### Description [Section titled “Description”](#description-142) The ID of the user ###### Example [Section titled “Example”](#example-65) ```ts VXNlcjpjdXVzZXJfMTIzNA== ``` ###### last\_name [Section titled “last\_name”](#last_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-143) The user’s last name ###### Example [Section titled “Example”](#example-66) ```ts Doe ``` ###### location\_id? [Section titled “location\_id?”](#location_id) > `optional` **location\_id?**: `string` ###### Description [Section titled “Description”](#description-144) The ID of the user’s location ###### Example [Section titled “Example”](#example-67) ```ts VXNlcjpjdXVzZXJfMTIzNA== ``` ###### location\_name? [Section titled “location\_name?”](#location_name) > `optional` **location\_name?**: `string` ###### Description [Section titled “Description”](#description-145) The user’s location name ###### Example [Section titled “Example”](#example-68) ```ts San Francisco ``` ###### manager\_first\_name? [Section titled “manager\_first\_name?”](#manager_first_name) > `optional` **manager\_first\_name?**: `string` ###### Description [Section titled “Description”](#description-146) The user’s manager first name ###### Example [Section titled “Example”](#example-69) ```ts Jane ``` ###### manager\_id? [Section titled “manager\_id?”](#manager_id) > `optional` **manager\_id?**: `string` ###### Description [Section titled “Description”](#description-147) The ID of the user’s manager ###### Example [Section titled “Example”](#example-70) ```ts VXNlcjpjdXVzZXJfMTIzNA== ``` ###### manager\_last\_name? [Section titled “manager\_last\_name?”](#manager_last_name) > `optional` **manager\_last\_name?**: `string` ###### Description [Section titled “Description”](#description-148) The user’s manager last name ###### Example [Section titled “Example”](#example-71) ```ts Smith ``` ###### manager\_title\_id? [Section titled “manager\_title\_id?”](#manager_title_id) > `optional` **manager\_title\_id?**: `string` ###### Description [Section titled “Description”](#description-149) The user’s manager title ID ###### Example [Section titled “Example”](#example-72) ```ts VGl0bGU6dGl0bGVfMTIzNA== ``` ###### manager\_title\_name? [Section titled “manager\_title\_name?”](#manager_title_name) > `optional` **manager\_title\_name?**: `string` ###### Description [Section titled “Description”](#description-150) The user’s manager title display name ###### Example [Section titled “Example”](#example-73) ```ts Engineering Manager ``` ###### role [Section titled “role”](#role) > **role**: `"ACCOUNT_ADMIN"` | `"AP_CLERK"` | `"BOOKKEEPER"` | `"CARD_ADMIN"` | `"EMPLOYEE"` | `"EMPLOYEE_WITHOUT_CORP_CARDS"` | `"EXPENSE_ADMIN"` | `"SUPER_ADMIN"` | `"USER_MANAGEMENT_ADMIN"` ###### Description [Section titled “Description”](#description-151) The user’s role in the system ###### Example [Section titled “Example”](#example-74) ```ts CARD_ADMIN @enum {string} ``` ###### status [Section titled “status”](#status) > **status**: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` ###### Description [Section titled “Description”](#description-152) The user’s status in the system ###### Example [Section titled “Example”](#example-75) ```ts ACTIVE @enum {string} ``` ###### title\_id? [Section titled “title\_id?”](#title_id) > `optional` **title\_id?**: `string` ###### Description [Section titled “Description”](#description-153) The user’s title ID ###### Example [Section titled “Example”](#example-76) ```ts VGl0bGU6dGl0bGVfMTIzNA== ``` ###### title\_name? [Section titled “title\_name?”](#title_name) > `optional` **title\_name?**: `string` ###### Description [Section titled “Description”](#description-154) The user’s title display name ###### Example [Section titled “Example”](#example-77) ```ts Software Engineer ``` *** `null` ###### Description [Section titled “Description”](#description-155) User associated with the record ##### get.responses.200.content.application/json.vendor? [Section titled “get.responses.200.content.application/json.vendor?”](#getresponses200contentapplicationjsonvendor) > `optional` **vendor?**: { `contact_name?`: `string` | `null`; `email?`: `string` | `null`; `id`: `string`; `name`: `string`; `phone?`: `string` | `null`; `website?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `contact_name?`: `string` | `null`; `email?`: `string` | `null`; `id`: `string`; `name`: `string`; `phone?`: `string` | `null`; `website?`: `string` | `null`; } ###### contact\_name? [Section titled “contact\_name?”](#contact_name) > `optional` **contact\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-156) The name of the contact for the vendor ###### Example [Section titled “Example”](#example-78) ```ts Jane Smith ``` ###### email? [Section titled “email?”](#email-1) > `optional` **email?**: `string` | `null` ###### Description [Section titled “Description”](#description-157) The email for the vendor ###### Example [Section titled “Example”](#example-79) ```ts contact@acme.com ``` ###### id [Section titled “id”](#id-1) > **id**: `string` ###### Description [Section titled “Description”](#description-158) The unique identifier for the vendor ###### Example [Section titled “Example”](#example-80) ```ts vendor_123 ``` ###### name [Section titled “name”](#name) > **name**: `string` ###### Description [Section titled “Description”](#description-159) The name of the vendor ###### Example [Section titled “Example”](#example-81) ```ts Acme Corp ``` ###### phone? [Section titled “phone?”](#phone) > `optional` **phone?**: `string` | `null` ###### Description [Section titled “Description”](#description-160) The phone number for the vendor ###### Example [Section titled “Example”](#example-82) ```ts +1-555-123-4567 ``` ###### website? [Section titled “website?”](#website) > `optional` **website?**: `string` | `null` ###### Description [Section titled “Description”](#description-161) The website of the vendor ###### Example [Section titled “Example”](#example-83) ```ts https://acme.com ``` *** `null` ###### Description [Section titled “Description”](#description-162) Vendor information ##### get.responses.200.content.application/json.version [Section titled “get.responses.200.content.application/json.version”](#getresponses200contentapplicationjsonversion) > **version**: `number` ###### Description [Section titled “Description”](#description-163) Version number ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-23) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-164) Bad request ##### get.responses.400.content [Section titled “get.responses.400.content”](#getresponses400content-1) > **content**: `object` ##### get.responses.400.content.application/json [Section titled “get.responses.400.content.application/json”](#getresponses400contentapplicationjson-1) > **application/json**: `object` ##### get.responses.400.content.application/json.details? [Section titled “get.responses.400.content.application/json.details?”](#getresponses400contentapplicationjsondetails-1) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-165) Additional error context ##### get.responses.400.content.application/json.error\_code [Section titled “get.responses.400.content.application/json.error\_code”](#getresponses400contentapplicationjsonerror_code-1) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-166) Machine-readable error code ###### Example [Section titled “Example”](#example-84) ```ts INVALID_REQUEST @enum {string} ``` ##### get.responses.400.content.application/json.message [Section titled “get.responses.400.content.application/json.message”](#getresponses400contentapplicationjsonmessage-1) > **message**: `string` ###### Description [Section titled “Description”](#description-167) Human-readable error message ###### Example [Section titled “Example”](#example-85) ```ts The request is malformed or contains invalid data. ``` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-24) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-168) Unauthorized ##### get.responses.401.content [Section titled “get.responses.401.content”](#getresponses401content-1) > **content**: `object` ##### get.responses.401.content.application/json [Section titled “get.responses.401.content.application/json”](#getresponses401contentapplicationjson-1) > **application/json**: `object` ##### get.responses.401.content.application/json.details? [Section titled “get.responses.401.content.application/json.details?”](#getresponses401contentapplicationjsondetails-1) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-169) Additional error context ##### get.responses.401.content.application/json.error\_code [Section titled “get.responses.401.content.application/json.error\_code”](#getresponses401contentapplicationjsonerror_code-1) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-170) Machine-readable error code ###### Example [Section titled “Example”](#example-86) ```ts INVALID_REQUEST @enum {string} ``` ##### get.responses.401.content.application/json.message [Section titled “get.responses.401.content.application/json.message”](#getresponses401contentapplicationjsonmessage-1) > **message**: `string` ###### Description [Section titled “Description”](#description-171) Human-readable error message ###### Example [Section titled “Example”](#example-87) ```ts The request is malformed or contains invalid data. ``` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-25) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-172) Forbidden ##### get.responses.403.content [Section titled “get.responses.403.content”](#getresponses403content-1) > **content**: `object` ##### get.responses.403.content.application/json [Section titled “get.responses.403.content.application/json”](#getresponses403contentapplicationjson-1) > **application/json**: `object` ##### get.responses.403.content.application/json.details? [Section titled “get.responses.403.content.application/json.details?”](#getresponses403contentapplicationjsondetails-1) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-173) Additional error context ##### get.responses.403.content.application/json.error\_code [Section titled “get.responses.403.content.application/json.error\_code”](#getresponses403contentapplicationjsonerror_code-1) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-174) Machine-readable error code ###### Example [Section titled “Example”](#example-88) ```ts INVALID_REQUEST @enum {string} ``` ##### get.responses.403.content.application/json.message [Section titled “get.responses.403.content.application/json.message”](#getresponses403contentapplicationjsonmessage-1) > **message**: `string` ###### Description [Section titled “Description”](#description-175) Human-readable error message ###### Example [Section titled “Example”](#example-89) ```ts The request is malformed or contains invalid data. ``` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-26) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-176) Record not found ##### get.responses.404.content [Section titled “get.responses.404.content”](#getresponses404content) > **content**: `object` ##### get.responses.404.content.application/json [Section titled “get.responses.404.content.application/json”](#getresponses404contentapplicationjson) > **application/json**: `object` ##### get.responses.404.content.application/json.details? [Section titled “get.responses.404.content.application/json.details?”](#getresponses404contentapplicationjsondetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-177) Additional error context ##### get.responses.404.content.application/json.error\_code [Section titled “get.responses.404.content.application/json.error\_code”](#getresponses404contentapplicationjsonerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-178) Machine-readable error code ###### Example [Section titled “Example”](#example-90) ```ts INVALID_REQUEST @enum {string} ``` ##### get.responses.404.content.application/json.message [Section titled “get.responses.404.content.application/json.message”](#getresponses404contentapplicationjsonmessage) > **message**: `string` ###### Description [Section titled “Description”](#description-179) Human-readable error message ###### Example [Section titled “Example”](#example-91) ```ts The request is malformed or contains invalid data. ``` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-27) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-1) > **500**: `object` ###### Description [Section titled “Description”](#description-180) Internal server error ##### get.responses.500.content [Section titled “get.responses.500.content”](#getresponses500content-1) > **content**: `object` ##### get.responses.500.content.application/json [Section titled “get.responses.500.content.application/json”](#getresponses500contentapplicationjson-1) > **application/json**: `object` ##### get.responses.500.content.application/json.details? [Section titled “get.responses.500.content.application/json.details?”](#getresponses500contentapplicationjsondetails-1) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-181) Additional error context ##### get.responses.500.content.application/json.error\_code [Section titled “get.responses.500.content.application/json.error\_code”](#getresponses500contentapplicationjsonerror_code-1) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-182) Machine-readable error code ###### Example [Section titled “Example”](#example-92) ```ts INVALID_REQUEST @enum {string} ``` ##### get.responses.500.content.application/json.message [Section titled “get.responses.500.content.application/json.message”](#getresponses500contentapplicationjsonmessage-1) > **message**: `string` ###### Description [Section titled “Description”](#description-183) Human-readable error message ###### Example [Section titled “Example”](#example-93) ```ts The request is malformed or contains invalid data. ``` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-28) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-4) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-4) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-4) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-4) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-4) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-4) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-4) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-4) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-4) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-4) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-4) > `optional` **trace?**: `undefined` *** ### /v3/accounting/records/export-results [Section titled “/v3/accounting/records/export-results”](#v3accountingrecordsexport-results) > **/v3/accounting/records/export-results**: `object` Defined in: [src/accounting/types.gen.ts:127](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/types.gen.ts#L127) #### delete? [Section titled “delete?”](#delete-5) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-5) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-5) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-5) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-5) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-5) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-5) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-5) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-5) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-5) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-5) > **post**: `object` Report accounting export results ##### Description [Section titled “Description”](#description-184) Report export success or failure for accounting records. ##### post.parameters [Section titled “post.parameters”](#postparameters-3) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-3) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-3) > `optional` **header?**: `undefined` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath-3) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-3) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-3) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-1) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-1) > **application/json**: `object` ##### post.requestBody.content.application/json.results [Section titled “post.requestBody.content.application/json.results”](#postrequestbodycontentapplicationjsonresults) > **results**: ({ `accounting_record_id`: `string`; `failure`: { `error_message`: `string`; }; } | { `accounting_record_id`: `string`; `success`: { `deep_link_url?`: `string`; `reference_id?`: `string` | `null`; }; })\[] ###### Description [Section titled “Description”](#description-185) Array of export results (must contain at least one result) ##### post.responses [Section titled “post.responses”](#postresponses-3) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-3) > **200**: `object` ###### Description [Section titled “Description”](#description-186) Export results processed successfully ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-3) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-3) > **application/json**: `object` ##### post.responses.200.content.application/json.updated\_accounting\_record\_ids [Section titled “post.responses.200.content.application/json.updated\_accounting\_record\_ids”](#postresponses200contentapplicationjsonupdated_accounting_record_ids) > **updated\_accounting\_record\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-187) Accounting record ids that were updated by the request ###### Example [Section titled “Example”](#example-94) ```ts [ "accr_abc123", "accr_def456" ] ``` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-29) \[`name`: `string`]: `unknown` ##### post.responses.404 [Section titled “post.responses.404”](#postresponses404-2) > **404**: `object` ###### Description [Section titled “Description”](#description-188) Not found - Given accounting record id is not found ##### post.responses.404.content [Section titled “post.responses.404.content”](#postresponses404content-2) > **content**: `object` ##### post.responses.404.content.application/json [Section titled “post.responses.404.content.application/json”](#postresponses404contentapplicationjson-2) > **application/json**: `object` ##### post.responses.404.content.application/json.details? [Section titled “post.responses.404.content.application/json.details?”](#postresponses404contentapplicationjsondetails-2) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-189) Additional error context ##### post.responses.404.content.application/json.error\_code [Section titled “post.responses.404.content.application/json.error\_code”](#postresponses404contentapplicationjsonerror_code-2) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-190) Machine-readable error code ###### Example [Section titled “Example”](#example-95) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.404.content.application/json.message [Section titled “post.responses.404.content.application/json.message”](#postresponses404contentapplicationjsonmessage-2) > **message**: `string` ###### Description [Section titled “Description”](#description-191) Human-readable error message ###### Example [Section titled “Example”](#example-96) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.404.headers [Section titled “post.responses.404.headers”](#postresponses404headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-30) \[`name`: `string`]: `unknown` ##### post.responses.422 [Section titled “post.responses.422”](#postresponses422) > **422**: `object` ###### Description [Section titled “Description”](#description-192) Validation failed (duplicate accounting record ids or records not READY\_FOR\_EXPORT) ##### post.responses.422.content [Section titled “post.responses.422.content”](#postresponses422content) > **content**: `object` ##### post.responses.422.content.application/json [Section titled “post.responses.422.content.application/json”](#postresponses422contentapplicationjson) > **application/json**: `object` ##### post.responses.422.content.application/json.details? [Section titled “post.responses.422.content.application/json.details?”](#postresponses422contentapplicationjsondetails) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-193) Additional error context ##### post.responses.422.content.application/json.error\_code [Section titled “post.responses.422.content.application/json.error\_code”](#postresponses422contentapplicationjsonerror_code) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-194) Machine-readable error code ###### Example [Section titled “Example”](#example-97) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.422.content.application/json.message [Section titled “post.responses.422.content.application/json.message”](#postresponses422contentapplicationjsonmessage) > **message**: `string` ###### Description [Section titled “Description”](#description-195) Human-readable error message ###### Example [Section titled “Example”](#example-98) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.422.headers [Section titled “post.responses.422.headers”](#postresponses422headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-31) \[`name`: `string`]: `unknown` ##### post.responses.500 [Section titled “post.responses.500”](#postresponses500-3) > **500**: `object` ###### Description [Section titled “Description”](#description-196) Internal server error ##### post.responses.500.content [Section titled “post.responses.500.content”](#postresponses500content-3) > **content**: `object` ##### post.responses.500.content.application/json [Section titled “post.responses.500.content.application/json”](#postresponses500contentapplicationjson-3) > **application/json**: `object` ##### post.responses.500.content.application/json.details? [Section titled “post.responses.500.content.application/json.details?”](#postresponses500contentapplicationjsondetails-3) > `optional` **details?**: `object` & `object` | `null` ###### Description [Section titled “Description”](#description-197) Additional error context ##### post.responses.500.content.application/json.error\_code [Section titled “post.responses.500.content.application/json.error\_code”](#postresponses500contentapplicationjsonerror_code-3) > **error\_code**: `"ACTIVE_INTEGRATION_EXISTS"` | `"FORBIDDEN"` | `"INTEGRATION_NOT_ACTIVE"` | `"INTERNAL_ERROR"` | `"INVALID_REQUEST"` | `"NOT_FOUND"` | `"UNAUTHORIZED"` | `"DUPLICATE_ACCOUNTING_RECORD_IDS"` | `"ACCOUNTING_RECORD_NOT_READY_FOR_EXPORT"` | `"VENDOR_ACCOUNT_ID_MISMATCH"` ###### Description [Section titled “Description”](#description-198) Machine-readable error code ###### Example [Section titled “Example”](#example-99) ```ts INVALID_REQUEST @enum {string} ``` ##### post.responses.500.content.application/json.message [Section titled “post.responses.500.content.application/json.message”](#postresponses500contentapplicationjsonmessage-3) > **message**: `string` ###### Description [Section titled “Description”](#description-199) Human-readable error message ###### Example [Section titled “Example”](#example-100) ```ts The request is malformed or contains invalid data. ``` ##### post.responses.500.headers [Section titled “post.responses.500.headers”](#postresponses500headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-32) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-5) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-5) > `optional` **trace?**: `undefined` # AccountingErrorDetails > **AccountingErrorDetails** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"AccountingErrorDetails"`] Defined in: [src/accounting/schemas.gen.ts:5](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L5) # AccountingErrorResponse > **AccountingErrorResponse** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"AccountingErrorResponse"`] Defined in: [src/accounting/schemas.gen.ts:6](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L6) # AccountingFieldValue > **AccountingFieldValue** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"AccountingFieldValue"`] Defined in: [src/accounting/schemas.gen.ts:7](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L7) # AccountingRecordDetailed > **AccountingRecordDetailed** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"AccountingRecordDetailed"`] Defined in: [src/accounting/schemas.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L8) # AccountingRecordLineItem > **AccountingRecordLineItem** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"AccountingRecordLineItem"`] Defined in: [src/accounting/schemas.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L9) # AccountingRecordsResponse > **AccountingRecordsResponse** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"AccountingRecordsResponse"`] Defined in: [src/accounting/schemas.gen.ts:10](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L10) # Amount > **Amount** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"Amount"`] Defined in: [src/accounting/schemas.gen.ts:11](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L11) # CreateIntegrationRequest > **CreateIntegrationRequest** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"CreateIntegrationRequest"`] Defined in: [src/accounting/schemas.gen.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L12) # ExportFailureDetails > **ExportFailureDetails** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"ExportFailureDetails"`] Defined in: [src/accounting/schemas.gen.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L13) # ExportResultsResponse > **ExportResultsResponse** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"ExportResultsResponse"`] Defined in: [src/accounting/schemas.gen.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L14) # ExportSuccessDetails > **ExportSuccessDetails** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"ExportSuccessDetails"`] Defined in: [src/accounting/schemas.gen.ts:15](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L15) # FailedExportResult > **FailedExportResult** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"FailedExportResult"`] Defined in: [src/accounting/schemas.gen.ts:16](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L16) # Integration > **Integration** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"Integration"`] Defined in: [src/accounting/schemas.gen.ts:17](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L17) # Receipt > **Receipt** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"Receipt"`] Defined in: [src/accounting/schemas.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L18) # ReportExportResultsRequest > **ReportExportResultsRequest** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"ReportExportResultsRequest"`] Defined in: [src/accounting/schemas.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L19) # SuccessfulExportResult > **SuccessfulExportResult** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"SuccessfulExportResult"`] Defined in: [src/accounting/schemas.gen.ts:20](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L20) # UpdatedAtFilter > **UpdatedAtFilter** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"UpdatedAtFilter"`] Defined in: [src/accounting/schemas.gen.ts:21](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L21) # User > **User** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"User"`] Defined in: [src/accounting/schemas.gen.ts:22](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L22) # Vendor > **Vendor** = [`AccountingComponents`](/brex/api/accounting/interfaces/accountingcomponents/)\[`"schemas"`]\[`"Vendor"`] Defined in: [src/accounting/schemas.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/accounting/schemas.gen.ts#L23) # BrexBudgets Defined in: [src/budgets/client.gen.ts:355](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L355) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BrexBudgets**(`core`): `BrexBudgets` Defined in: [src/budgets/client.gen.ts:360](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L360) #### Parameters [Section titled “Parameters”](#parameters) ##### core [Section titled “core”](#core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `BrexBudgets` ## Properties [Section titled “Properties”](#properties) ### budgetPrograms [Section titled “budgetPrograms”](#budgetprograms) > `readonly` **budgetPrograms**: [`BudgetPrograms`](/brex/api/budgets/classes/budgetprograms/) Defined in: [src/budgets/client.gen.ts:356](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L356) *** ### budgets [Section titled “budgets”](#budgets) > `readonly` **budgets**: [`Budgets`](/brex/api/budgets/classes/budgets/) Defined in: [src/budgets/client.gen.ts:357](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L357) *** ### budgetsV1 [Section titled “budgetsV1”](#budgetsv1) > `readonly` **budgetsV1**: [`BudgetsV1`](/brex/api/budgets/classes/budgetsv1/) Defined in: [src/budgets/client.gen.ts:358](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L358) *** ### spendLimits [Section titled “spendLimits”](#spendlimits) > `readonly` **spendLimits**: [`SpendLimits`](/brex/api/budgets/classes/spendlimits/) Defined in: [src/budgets/client.gen.ts:359](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L359) # BudgetPrograms Defined in: [src/budgets/client.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L8) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BudgetPrograms**(`_core`): `BudgetPrograms` Defined in: [src/budgets/client.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L9) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `BudgetPrograms` ## Methods [Section titled “Methods”](#methods) ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `budget_blueprints`: `object`\[]; `budget_program_status`: `"BUDGET_PROGRAM_STATUS_ACTIVE"` | `"BUDGET_PROGRAM_STATUS_INACTIVE"` | `"BUDGET_PROGRAM_STATUS_DELETED"`; `created_at`: `string`; `creator_user_id?`: `string` | `null`; `description?`: `string` | `null`; `employee_filter?`: { `employment_status?`: `"EMPLOYMENT_STATUS_ACTIVE"` | `"EMPLOYMENT_STATUS_INACTIVE"` | `"EMPLOYMENT_STATUS_PENDING"` | `null`; `employment_type?`: `"EMPLOYMENT_TYPE_FULL_TIME"` | `"EMPLOYMENT_TYPE_PART_TIME"` | `"EMPLOYMENT_TYPE_CONTRACTOR"` | `"EMPLOYMENT_TYPE_INTERN"` | `"EMPLOYMENT_TYPE_FREELANCE"` | `null`; } | `null`; `existing_budget_ids?`: `string`\[] | `null`; `id`: `string`; `name`: `string`; `updated_at`: `string`; }> Defined in: [src/budgets/client.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L18) Get Budget Program Retrieves a Budget Program by ID `GET /v1/budget_programs/{id}` — requires OAuth scope: `budgets.readonly`, `budgets` #### Parameters [Section titled “Parameters”](#parameters-1) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `budget_blueprints`: `object`\[]; `budget_program_status`: `"BUDGET_PROGRAM_STATUS_ACTIVE"` | `"BUDGET_PROGRAM_STATUS_INACTIVE"` | `"BUDGET_PROGRAM_STATUS_DELETED"`; `created_at`: `string`; `creator_user_id?`: `string` | `null`; `description?`: `string` | `null`; `employee_filter?`: { `employment_status?`: `"EMPLOYMENT_STATUS_ACTIVE"` | `"EMPLOYMENT_STATUS_INACTIVE"` | `"EMPLOYMENT_STATUS_PENDING"` | `null`; `employment_type?`: `"EMPLOYMENT_TYPE_FULL_TIME"` | `"EMPLOYMENT_TYPE_PART_TIME"` | `"EMPLOYMENT_TYPE_CONTRACTOR"` | `"EMPLOYMENT_TYPE_INTERN"` | `"EMPLOYMENT_TYPE_FREELANCE"` | `null`; } | `null`; `existing_budget_ids?`: `string`\[] | `null`; `id`: `string`; `name`: `string`; `updated_at`: `string`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/budgets/client.gen.ts:37](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L37) List Budget Programs Lists Budget Programs belonging to this account `GET /v1/budget_programs` — requires OAuth scope: `budgets.readonly`, `budgets` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-2) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> # Budgets Defined in: [src/budgets/client.gen.ts:49](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L49) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Budgets**(`_core`): `Budgets` Defined in: [src/budgets/client.gen.ts:50](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L50) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Budgets` ## Methods [Section titled “Methods”](#methods) ### archive() [Section titled “archive()”](#archive) > **archive**(`id`, `options?`): `Promise`<`void`> Defined in: [src/budgets/client.gen.ts:59](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L59) Archive a Budget Archives a Budget, making any Spend Limits beneath it unusable for future expenses and removing it from the UI `POST /v2/budgets/{id}/archive` — requires OAuth scope: `budgets` #### Parameters [Section titled “Parameters”](#parameters-1) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<`void`> *** ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `account_id`: `string`; `amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `budget_id`: `string`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `limit_type?`: `"HARD"` | `"SOFT"` | `null`; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_recurrence_type`: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_budget_status`: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"`; `start_date?`: `string` | `null`; }> Defined in: [src/budgets/client.gen.ts:76](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L76) Create Budget Creates a Budget `POST /v2/budgets` — requires OAuth scope: `budgets` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-2) ##### body [Section titled “body”](#body) ###### amount [Section titled “amount”](#amount) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount.amount [Section titled “amount.amount”](#amountamount) `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 ``` ###### amount.currency [Section titled “amount.currency”](#amountcurrency) `string` | `null` **Description** The type of currency, in ISO 4217 format. **Default** ```ts USD ``` **Example** ```ts USD ``` ###### description [Section titled “description”](#description) `string` **Description** Description of what the Budget is used for. ###### end\_date? [Section titled “end\_date?”](#end_date) `string` | `null` Format: date **Description** The date when the Budget should stop counting. ###### limit\_type? [Section titled “limit\_type?”](#limit_type) `"HARD"` | `"SOFT"` | `null` Deprecated This API is no longer supported and may be removed in a future release. ###### name [Section titled “name”](#name) `string` **Description** Name for the Budget. ###### owner\_user\_ids? [Section titled “owner\_user\_ids?”](#owner_user_ids) `string`\[] | `null` **Description** User IDs of the owners of the Budget. ###### parent\_budget\_id [Section titled “parent\_budget\_id”](#parent_budget_id) `string` **Description** ID of parent Budget. ###### period\_recurrence\_type [Section titled “period\_recurrence\_type”](#period_recurrence_type) `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ###### start\_date? [Section titled “start\_date?”](#start_date) `string` | `null` Format: date **Description** The date when the Budget should start counting. ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `account_id`: `string`; `amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `budget_id`: `string`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `limit_type?`: `"HARD"` | `"SOFT"` | `null`; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_recurrence_type`: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_budget_status`: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"`; `start_date?`: `string` | `null`; }> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `account_id`: `string`; `amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `budget_id`: `string`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `limit_type?`: `"HARD"` | `"SOFT"` | `null`; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_recurrence_type`: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_budget_status`: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"`; `start_date?`: `string` | `null`; }> Defined in: [src/budgets/client.gen.ts:94](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L94) Get Budget Retrieves a Budget by ID `GET /v2/budgets/{id}` — requires OAuth scope: `budgets.readonly`, `budgets` #### Parameters [Section titled “Parameters”](#parameters-3) ##### id [Section titled “id”](#id-1) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `account_id`: `string`; `amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `budget_id`: `string`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `limit_type?`: `"HARD"` | `"SOFT"` | `null`; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_recurrence_type`: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_budget_status`: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"`; `start_date?`: `string` | `null`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/budgets/client.gen.ts:113](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L113) List Budgets Retrieves a list of Budgets `GET /v2/budgets` — requires OAuth scope: `budgets.readonly`, `budgets` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-4) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### update() [Section titled “update()”](#update) > **update**(`id`, `body`, `options?`): `Promise`<{ `account_id`: `string`; `amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `budget_id`: `string`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `limit_type?`: `"HARD"` | `"SOFT"` | `null`; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_recurrence_type`: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_budget_status`: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"`; `start_date?`: `string` | `null`; }> Defined in: [src/budgets/client.gen.ts:130](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L130) Update Budget Updates a Budget `PUT /v2/budgets/{id}` — requires OAuth scope: `budgets` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-5) ##### id [Section titled “id”](#id-2) `string` ##### body [Section titled “body”](#body-1) ###### amount? [Section titled “amount?”](#amount-1) { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### description? [Section titled “description?”](#description-1) `string` | `null` **Description** Description of what the Budget is used for. ###### end\_date? [Section titled “end\_date?”](#end_date-1) `string` | `null` Format: date **Description** The date when the Budget should stop counting. ###### limit\_type? [Section titled “limit\_type?”](#limit_type-1) `"HARD"` | `"SOFT"` | `null` Deprecated This API is no longer supported and may be removed in a future release. ###### name? [Section titled “name?”](#name-1) `string` | `null` **Description** Name for the Budget. ###### owner\_user\_ids? [Section titled “owner\_user\_ids?”](#owner_user_ids-1) `string`\[] | `null` **Description** User IDs of the owners of the Budget. ###### parent\_budget\_id? [Section titled “parent\_budget\_id?”](#parent_budget_id-1) `string` | `null` **Description** ID of parent Budget. ###### period\_recurrence\_type? [Section titled “period\_recurrence\_type?”](#period_recurrence_type-1) `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ###### start\_date? [Section titled “start\_date?”](#start_date-1) `string` | `null` Format: date **Description** The date when the Budget should start counting. ##### options? [Section titled “options?”](#options-4) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-5) `Promise`<{ `account_id`: `string`; `amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `budget_id`: `string`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `limit_type?`: `"HARD"` | `"SOFT"` | `null`; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_recurrence_type`: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_budget_status`: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"`; `start_date?`: `string` | `null`; }> # BudgetsV1 Defined in: [src/budgets/client.gen.ts:149](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L149) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BudgetsV1**(`_core`): `BudgetsV1` Defined in: [src/budgets/client.gen.ts:150](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L150) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `BudgetsV1` ## Methods [Section titled “Methods”](#methods) ### archive() [Section titled “archive()”](#archive) > **archive**(`id`, `options?`): `Promise`<`void`> Defined in: [src/budgets/client.gen.ts:159](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L159) Archive a Spend Limit Archives a Spend Limit, making it unusable for future expenses and removing it from the UI `POST /v1/budgets/{id}/archive` — requires OAuth scope: `budgets` #### Parameters [Section titled “Parameters”](#parameters-1) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<`void`> *** ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `account_id`: `string`; `budget_id`: `string`; `budget_status`: `"DELETED"` | `"APPROVED"` | `"EXPIRED"` | `"TERMINATED"`; `budget_type`: `"BUDGET"` | `"SPEND_LIMIT"`; `creator_user_id?`: `string` | `null`; `current_period_balance?`: { `balance?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } | `null`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `limit_type?`: `"HARD"` | `"SOFT"` | `null`; `limit_visibility`: `"PRIVATE"` | `"SHARED"`; `member_user_ids`: `string`\[]; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_type`: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_type`: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"`; `start_date?`: `string` | `null`; `templateId?`: `string` | `null`; }> Defined in: [src/budgets/client.gen.ts:176](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L176) Create Spend Limit Creates a Spend Limit `POST /v1/budgets` — requires OAuth scope: `budgets` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-2) ##### body [Section titled “body”](#body) ###### description [Section titled “description”](#description) `string` **Description** Description of what the Spend Limit is used for. ###### end\_date? [Section titled “end\_date?”](#end_date) `string` | `null` Format: date **Description** The UTC date when the Spend Limit should stop counting. ###### entity\_id? [Section titled “entity\_id?”](#entity_id) `string` | `null` ###### limit [Section titled “limit”](#limit) { `amount`: `number`; `currency`: `string` | `null`; } ###### limit.amount [Section titled “limit.amount”](#limitamount) `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 ``` ###### limit.currency [Section titled “limit.currency”](#limitcurrency) `string` | `null` **Description** The type of currency, in ISO 4217 format. **Default** ```ts USD ``` **Example** ```ts USD ``` ###### limit\_type [Section titled “limit\_type”](#limit_type) `"HARD"` | `"SOFT"` ###### limit\_visibility [Section titled “limit\_visibility”](#limit_visibility) `"PRIVATE"` | `"SHARED"` ###### member\_user\_ids? [Section titled “member\_user\_ids?”](#member_user_ids) `string`\[] | `null` **Description** User IDs of the members of the Spend Limit. ###### name [Section titled “name”](#name) `string` **Description** Name for the Spend Limit. ###### owner\_user\_ids? [Section titled “owner\_user\_ids?”](#owner_user_ids) `string`\[] | `null` **Description** User IDs of the owners of the Spend Limit. ###### parent\_budget\_id [Section titled “parent\_budget\_id”](#parent_budget_id) `string` **Description** ID of parent Budget. ###### period\_type [Section titled “period\_type”](#period_type) `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ###### policy\_id? [Section titled “policy\_id?”](#policy_id) `string` | `null` ###### spend\_type [Section titled “spend\_type”](#spend_type) `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ###### start\_date? [Section titled “start\_date?”](#start_date) `string` | `null` Format: date **Description** The UTC date when the Spend Limit should start counting. ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `account_id`: `string`; `budget_id`: `string`; `budget_status`: `"DELETED"` | `"APPROVED"` | `"EXPIRED"` | `"TERMINATED"`; `budget_type`: `"BUDGET"` | `"SPEND_LIMIT"`; `creator_user_id?`: `string` | `null`; `current_period_balance?`: { `balance?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } | `null`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `limit_type?`: `"HARD"` | `"SOFT"` | `null`; `limit_visibility`: `"PRIVATE"` | `"SHARED"`; `member_user_ids`: `string`\[]; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_type`: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_type`: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"`; `start_date?`: `string` | `null`; `templateId?`: `string` | `null`; }> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `account_id`: `string`; `budget_id`: `string`; `budget_status`: `"DELETED"` | `"APPROVED"` | `"EXPIRED"` | `"TERMINATED"`; `budget_type`: `"BUDGET"` | `"SPEND_LIMIT"`; `creator_user_id?`: `string` | `null`; `current_period_balance?`: { `balance?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } | `null`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `limit_type?`: `"HARD"` | `"SOFT"` | `null`; `limit_visibility`: `"PRIVATE"` | `"SHARED"`; `member_user_ids`: `string`\[]; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_type`: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_type`: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"`; `start_date?`: `string` | `null`; `templateId?`: `string` | `null`; }> Defined in: [src/budgets/client.gen.ts:194](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L194) Get Spend Limit Retrieves a Spend Limit by ID `GET /v1/budgets/{id}` — requires OAuth scope: `budgets.readonly`, `budgets` #### Parameters [Section titled “Parameters”](#parameters-3) ##### id [Section titled “id”](#id-1) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `account_id`: `string`; `budget_id`: `string`; `budget_status`: `"DELETED"` | `"APPROVED"` | `"EXPIRED"` | `"TERMINATED"`; `budget_type`: `"BUDGET"` | `"SPEND_LIMIT"`; `creator_user_id?`: `string` | `null`; `current_period_balance?`: { `balance?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } | `null`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `limit_type?`: `"HARD"` | `"SOFT"` | `null`; `limit_visibility`: `"PRIVATE"` | `"SHARED"`; `member_user_ids`: `string`\[]; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_type`: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_type`: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"`; `start_date?`: `string` | `null`; `templateId?`: `string` | `null`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/budgets/client.gen.ts:213](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L213) List Spend Limits Lists Spend Limits belonging to this account `GET /v1/budgets` — requires OAuth scope: `budgets.readonly`, `budgets` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-4) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit-1) `number` | `null` ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### update() [Section titled “update()”](#update) > **update**(`id`, `body`, `options?`): `Promise`<{ `account_id`: `string`; `budget_id`: `string`; `budget_status`: `"DELETED"` | `"APPROVED"` | `"EXPIRED"` | `"TERMINATED"`; `budget_type`: `"BUDGET"` | `"SPEND_LIMIT"`; `creator_user_id?`: `string` | `null`; `current_period_balance?`: { `balance?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } | `null`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `limit_type?`: `"HARD"` | `"SOFT"` | `null`; `limit_visibility`: `"PRIVATE"` | `"SHARED"`; `member_user_ids`: `string`\[]; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_type`: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_type`: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"`; `start_date?`: `string` | `null`; `templateId?`: `string` | `null`; }> Defined in: [src/budgets/client.gen.ts:230](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L230) Update Spend Limit Updates a Spend Limit `PUT /v1/budgets/{id}` — requires OAuth scope: `budgets` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-5) ##### id [Section titled “id”](#id-2) `string` ##### body [Section titled “body”](#body-1) ###### description? [Section titled “description?”](#description-1) `string` | `null` **Description** Description of what the Spend Limit is used for. ###### end\_date? [Section titled “end\_date?”](#end_date-1) `string` | `null` Format: date **Description** The UTC date when the Spend Limit should stop counting. ###### limit? [Section titled “limit?”](#limit-2) { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### limit\_type? [Section titled “limit\_type?”](#limit_type-1) `"HARD"` | `"SOFT"` | `null` ###### limit\_visibility? [Section titled “limit\_visibility?”](#limit_visibility-1) `"PRIVATE"` | `"SHARED"` | `null` ###### member\_user\_ids? [Section titled “member\_user\_ids?”](#member_user_ids-1) `string`\[] | `null` **Description** User IDs of the members of the Spend Limit. ###### name? [Section titled “name?”](#name-1) `string` | `null` **Description** Name for the Spend Limit. ###### owner\_user\_ids? [Section titled “owner\_user\_ids?”](#owner_user_ids-1) `string`\[] | `null` **Description** User IDs of the owners of the Spend Limit. ###### period\_type? [Section titled “period\_type?”](#period_type-1) `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ###### spend\_type? [Section titled “spend\_type?”](#spend_type-1) `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` | `null` ###### start\_date? [Section titled “start\_date?”](#start_date-1) `string` | `null` Format: date **Description** The UTC date when the Spend Limit should start counting. ##### options? [Section titled “options?”](#options-4) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-5) `Promise`<{ `account_id`: `string`; `budget_id`: `string`; `budget_status`: `"DELETED"` | `"APPROVED"` | `"EXPIRED"` | `"TERMINATED"`; `budget_type`: `"BUDGET"` | `"SPEND_LIMIT"`; `creator_user_id?`: `string` | `null`; `current_period_balance?`: { `balance?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } | `null`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `limit_type?`: `"HARD"` | `"SOFT"` | `null`; `limit_visibility`: `"PRIVATE"` | `"SHARED"`; `member_user_ids`: `string`\[]; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_type`: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_type`: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"`; `start_date?`: `string` | `null`; `templateId?`: `string` | `null`; }> # SpendLimits Defined in: [src/budgets/client.gen.ts:249](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L249) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new SpendLimits**(`_core`): `SpendLimits` Defined in: [src/budgets/client.gen.ts:250](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L250) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `SpendLimits` ## Methods [Section titled “Methods”](#methods) ### archive() [Section titled “archive()”](#archive) > **archive**(`id`, `options?`): `Promise`<`void`> Defined in: [src/budgets/client.gen.ts:259](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L259) Archive a Spend Limit Archives a Spend Limit, making it unusable for future expenses and removing it from the UI `POST /v2/spend_limits/{id}/archive` — requires OAuth scope: `budgets` #### Parameters [Section titled “Parameters”](#parameters-1) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<`void`> *** ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `account_id`: `string`; `authorization_settings?`: { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } | `null`; `authorization_visibility`: `"PUBLIC"` | `"PRIVATE"`; `auto_create_limit_cards_setting`: `"DISABLED"` | `"ALL_MEMBERS"`; `auto_transfer_cards_setting`: `"DISABLED"` | `"ENABLED"`; `current_period_balance?`: { `amount_spent?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } | `null`; `department_id?`: `string` | `null`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `end_time_utc?`: `string` | `null`; `expense_policy_id`: `string`; `expense_visibility`: `"PRIVATE"` | `"SHARED"`; `id`: `string`; `legal_entity_id?`: `string` | `null`; `limit_approval_policy_id?`: `string` | `null`; `limit_increase_request_policy_id?`: `string` | `null`; `limit_increase_setting`: `"DISABLED"` | `"ENABLED"`; `member_user_ids`: `string`\[]; `merchant_category_controls?`: { `allowed_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; `blocked_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; } | `null`; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_recurrence_type`: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"`; `spend_type`: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"`; `start_date?`: `string` | `null`; `start_time_utc?`: `string` | `null`; `status`: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"`; `transaction_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; }> Defined in: [src/budgets/client.gen.ts:278](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L278) Create Spend Limit Creates a Spend Limit `POST /v2/spend_limits` — requires OAuth scope: `budgets` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-2) ##### body [Section titled “body”](#body) ###### authorization\_settings [Section titled “authorization\_settings”](#authorization_settings) { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } ###### authorization\_settings.authorization\_type [Section titled “authorization\_settings.authorization\_type”](#authorization_settingsauthorization_type) `"HARD"` | `"SOFT"` ###### authorization\_settings.base\_limit [Section titled “authorization\_settings.base\_limit”](#authorization_settingsbase_limit) { `amount`: `number`; `currency`: `string` | `null`; } ###### authorization\_settings.base\_limit.amount [Section titled “authorization\_settings.base\_limit.amount”](#authorization_settingsbase_limitamount) `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 ``` ###### authorization\_settings.base\_limit.currency [Section titled “authorization\_settings.base\_limit.currency”](#authorization_settingsbase_limitcurrency) `string` | `null` **Description** The type of currency, in ISO 4217 format. **Default** ```ts USD ``` **Example** ```ts USD ``` ###### authorization\_settings.limit\_buffer\_percentage? [Section titled “authorization\_settings.limit\_buffer\_percentage?”](#authorization_settingslimit_buffer_percentage) `number` | `null` Format: int32 **Description** The percentage of flexible buffer on the limit as a 0-100 integer. ###### authorization\_settings.rollover\_refresh\_rate [Section titled “authorization\_settings.rollover\_refresh\_rate”](#authorization_settingsrollover_refresh_rate) `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` ###### authorization\_visibility [Section titled “authorization\_visibility”](#authorization_visibility) `"PUBLIC"` | `"PRIVATE"` ###### auto\_create\_limit\_cards\_setting [Section titled “auto\_create\_limit\_cards\_setting”](#auto_create_limit_cards_setting) `"DISABLED"` | `"ALL_MEMBERS"` ###### auto\_transfer\_cards\_setting [Section titled “auto\_transfer\_cards\_setting”](#auto_transfer_cards_setting) `"DISABLED"` | `"ENABLED"` ###### department\_id? [Section titled “department\_id?”](#department_id) `string` | `null` **Description** The department ID to which Spend Limit expenses will be attributed. ###### description? [Section titled “description?”](#description) `string` | `null` **Description** Description of what the Spend Limit is used for. ###### end\_date? [Section titled “end\_date?”](#end_date) `string` | `null` Format: date **Description** The date when the Spend Limit should expire. ###### expense\_policy\_id [Section titled “expense\_policy\_id”](#expense_policy_id) `string` **Description** The ID of the expense policy corresponding to this Spend Limit. ###### expense\_visibility [Section titled “expense\_visibility”](#expense_visibility) `"PRIVATE"` | `"SHARED"` ###### legal\_entity\_id? [Section titled “legal\_entity\_id?”](#legal_entity_id) `string` | `null` **Description** The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity. ###### limit\_approval\_policy\_id? [Section titled “limit\_approval\_policy\_id?”](#limit_approval_policy_id) `string` | `null` **Description** The ID of the policy for limit increase approval requests. Meant to replace limit\_increase\_request\_policy\_id. ###### limit\_increase\_request\_policy\_id? [Section titled “limit\_increase\_request\_policy\_id?”](#limit_increase_request_policy_id) `string` | `null` **Description** The ID of the policy for limit increase requests for this Spend Limit. ###### limit\_increase\_setting [Section titled “limit\_increase\_setting”](#limit_increase_setting) `"DISABLED"` | `"ENABLED"` ###### member\_user\_ids? [Section titled “member\_user\_ids?”](#member_user_ids) `string`\[] | `null` **Description** User IDs of the members of the Spend Limit. ###### name [Section titled “name”](#name) `string` **Description** Name for the Spend Limit. ###### owner\_user\_ids? [Section titled “owner\_user\_ids?”](#owner_user_ids) `string`\[] | `null` **Description** User IDs of the owners of the Spend Limit. ###### parent\_budget\_id? [Section titled “parent\_budget\_id?”](#parent_budget_id) `string` | `null` **Description** ID of parent Budget. ###### period\_recurrence\_type [Section titled “period\_recurrence\_type”](#period_recurrence_type) `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"` ###### spend\_type [Section titled “spend\_type”](#spend_type) `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ###### start\_date? [Section titled “start\_date?”](#start_date) `string` | `null` Format: date **Description** The date when the Spend Limit should start counting. ###### transaction\_limit? [Section titled “transaction\_limit?”](#transaction_limit) { `amount`: `number`; `currency`: `string` | `null`; } | `null` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `account_id`: `string`; `authorization_settings?`: { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } | `null`; `authorization_visibility`: `"PUBLIC"` | `"PRIVATE"`; `auto_create_limit_cards_setting`: `"DISABLED"` | `"ALL_MEMBERS"`; `auto_transfer_cards_setting`: `"DISABLED"` | `"ENABLED"`; `current_period_balance?`: { `amount_spent?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } | `null`; `department_id?`: `string` | `null`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `end_time_utc?`: `string` | `null`; `expense_policy_id`: `string`; `expense_visibility`: `"PRIVATE"` | `"SHARED"`; `id`: `string`; `legal_entity_id?`: `string` | `null`; `limit_approval_policy_id?`: `string` | `null`; `limit_increase_request_policy_id?`: `string` | `null`; `limit_increase_setting`: `"DISABLED"` | `"ENABLED"`; `member_user_ids`: `string`\[]; `merchant_category_controls?`: { `allowed_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; `blocked_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; } | `null`; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_recurrence_type`: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"`; `spend_type`: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"`; `start_date?`: `string` | `null`; `start_time_utc?`: `string` | `null`; `status`: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"`; `transaction_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; }> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `account_id`: `string`; `authorization_settings?`: { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } | `null`; `authorization_visibility`: `"PUBLIC"` | `"PRIVATE"`; `auto_create_limit_cards_setting`: `"DISABLED"` | `"ALL_MEMBERS"`; `auto_transfer_cards_setting`: `"DISABLED"` | `"ENABLED"`; `current_period_balance?`: { `amount_spent?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } | `null`; `department_id?`: `string` | `null`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `end_time_utc?`: `string` | `null`; `expense_policy_id`: `string`; `expense_visibility`: `"PRIVATE"` | `"SHARED"`; `id`: `string`; `legal_entity_id?`: `string` | `null`; `limit_approval_policy_id?`: `string` | `null`; `limit_increase_request_policy_id?`: `string` | `null`; `limit_increase_setting`: `"DISABLED"` | `"ENABLED"`; `member_user_ids`: `string`\[]; `merchant_category_controls?`: { `allowed_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; `blocked_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; } | `null`; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_recurrence_type`: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"`; `spend_type`: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"`; `start_date?`: `string` | `null`; `start_time_utc?`: `string` | `null`; `status`: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"`; `transaction_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; }> Defined in: [src/budgets/client.gen.ts:298](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L298) Get Spend Limit Retrieves a Spend Limit by ID `GET /v2/spend_limits/{id}` — requires OAuth scope: `budgets.readonly`, `budgets` #### Parameters [Section titled “Parameters”](#parameters-3) ##### id [Section titled “id”](#id-1) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `account_id`: `string`; `authorization_settings?`: { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } | `null`; `authorization_visibility`: `"PUBLIC"` | `"PRIVATE"`; `auto_create_limit_cards_setting`: `"DISABLED"` | `"ALL_MEMBERS"`; `auto_transfer_cards_setting`: `"DISABLED"` | `"ENABLED"`; `current_period_balance?`: { `amount_spent?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } | `null`; `department_id?`: `string` | `null`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `end_time_utc?`: `string` | `null`; `expense_policy_id`: `string`; `expense_visibility`: `"PRIVATE"` | `"SHARED"`; `id`: `string`; `legal_entity_id?`: `string` | `null`; `limit_approval_policy_id?`: `string` | `null`; `limit_increase_request_policy_id?`: `string` | `null`; `limit_increase_setting`: `"DISABLED"` | `"ENABLED"`; `member_user_ids`: `string`\[]; `merchant_category_controls?`: { `allowed_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; `blocked_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; } | `null`; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_recurrence_type`: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"`; `spend_type`: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"`; `start_date?`: `string` | `null`; `start_time_utc?`: `string` | `null`; `status`: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"`; `transaction_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/budgets/client.gen.ts:317](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L317) List Spend Limits Retrieves a list of Spend Limits `GET /v2/spend_limits` — requires OAuth scope: `budgets.readonly`, `budgets` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-4) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ###### member\_user\_id\[]? [Section titled “member\_user\_id\[\]?”](#member_user_id) `string`\[] | `null` ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### update() [Section titled “update()”](#update) > **update**(`id`, `body`, `options?`): `Promise`<{ `account_id`: `string`; `authorization_settings?`: { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } | `null`; `authorization_visibility`: `"PUBLIC"` | `"PRIVATE"`; `auto_create_limit_cards_setting`: `"DISABLED"` | `"ALL_MEMBERS"`; `auto_transfer_cards_setting`: `"DISABLED"` | `"ENABLED"`; `current_period_balance?`: { `amount_spent?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } | `null`; `department_id?`: `string` | `null`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `end_time_utc?`: `string` | `null`; `expense_policy_id`: `string`; `expense_visibility`: `"PRIVATE"` | `"SHARED"`; `id`: `string`; `legal_entity_id?`: `string` | `null`; `limit_approval_policy_id?`: `string` | `null`; `limit_increase_request_policy_id?`: `string` | `null`; `limit_increase_setting`: `"DISABLED"` | `"ENABLED"`; `member_user_ids`: `string`\[]; `merchant_category_controls?`: { `allowed_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; `blocked_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; } | `null`; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_recurrence_type`: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"`; `spend_type`: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"`; `start_date?`: `string` | `null`; `start_time_utc?`: `string` | `null`; `status`: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"`; `transaction_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; }> Defined in: [src/budgets/client.gen.ts:336](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/client.gen.ts#L336) Update Spend Limit Updates a Spend Limit `PUT /v2/spend_limits/{id}` — requires OAuth scope: `budgets` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-5) ##### id [Section titled “id”](#id-2) `string` ##### body [Section titled “body”](#body-1) ###### authorization\_settings? [Section titled “authorization\_settings?”](#authorization_settings-1) { `authorization_type?`: `"HARD"` | `"SOFT"` | `null`; `base_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `limit_buffer_percentage?`: `number` | `null`; `rollover_refresh_rate?`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `null`; } | `null` ###### authorization\_visibility? [Section titled “authorization\_visibility?”](#authorization_visibility-1) `"PUBLIC"` | `"PRIVATE"` | `null` ###### auto\_create\_limit\_cards\_setting? [Section titled “auto\_create\_limit\_cards\_setting?”](#auto_create_limit_cards_setting-1) `"DISABLED"` | `"ALL_MEMBERS"` | `null` ###### auto\_transfer\_cards\_setting? [Section titled “auto\_transfer\_cards\_setting?”](#auto_transfer_cards_setting-1) `"DISABLED"` | `"ENABLED"` | `null` ###### department\_id? [Section titled “department\_id?”](#department_id-1) `string` | `null` **Description** The department ID to which Spend Limit expenses will be attributed. ###### description? [Section titled “description?”](#description-1) `string` | `null` **Description** Description of what the Spend Limit is used for. ###### end\_date? [Section titled “end\_date?”](#end_date-1) `string` | `null` Format: date **Description** The date when the Spend Limit should expire. ###### expense\_policy\_id? [Section titled “expense\_policy\_id?”](#expense_policy_id-1) `string` | `null` **Description** The ID of the expense policy corresponding to this Spend Limit. ###### expense\_visibility? [Section titled “expense\_visibility?”](#expense_visibility-1) `"PRIVATE"` | `"SHARED"` | `null` ###### legal\_entity\_id? [Section titled “legal\_entity\_id?”](#legal_entity_id-1) `string` | `null` **Description** The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity. ###### limit\_approval\_policy\_id? [Section titled “limit\_approval\_policy\_id?”](#limit_approval_policy_id-1) `string` | `null` **Description** The ID of the policy for limit increase approval requests. Meant to replace limit\_increase\_request\_policy\_id. ###### limit\_increase\_request\_policy\_id? [Section titled “limit\_increase\_request\_policy\_id?”](#limit_increase_request_policy_id-1) `string` | `null` **Description** The ID of the policy for limit increase requests for this Spend Limit. ###### limit\_increase\_setting? [Section titled “limit\_increase\_setting?”](#limit_increase_setting-1) `"DISABLED"` | `"ENABLED"` | `null` ###### member\_user\_ids? [Section titled “member\_user\_ids?”](#member_user_ids-1) `string`\[] | `null` **Description** User IDs of the members of the Spend Limit. ###### merchant\_category\_controls? [Section titled “merchant\_category\_controls?”](#merchant_category_controls) { `allowed_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; `blocked_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; } | `null` ###### name? [Section titled “name?”](#name-1) `string` | `null` **Description** Name for the Spend Limit. ###### owner\_user\_ids? [Section titled “owner\_user\_ids?”](#owner_user_ids-1) `string`\[] | `null` **Description** User IDs of the owners of the Spend Limit. ###### period\_recurrence\_type? [Section titled “period\_recurrence\_type?”](#period_recurrence_type-1) `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"` | `null` ###### set\_end\_date\_null? [Section titled “set\_end\_date\_null?”](#set_end_date_null) `boolean` | `null` **Description** Set the date when the Spend Limit should expire to null. ###### set\_start\_date\_null? [Section titled “set\_start\_date\_null?”](#set_start_date_null) `boolean` | `null` **Description** Set the date when the Spend Limit should start counting to null. ###### set\_transaction\_limit\_null? [Section titled “set\_transaction\_limit\_null?”](#set_transaction_limit_null) `boolean` | `null` **Description** Set the transaction limit that this Spend Limit will enforce to null. ###### spend\_type? [Section titled “spend\_type?”](#spend_type-1) `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` | `null` ###### start\_date? [Section titled “start\_date?”](#start_date-1) `string` | `null` Format: date **Description** The date when the Spend Limit should start counting. ###### status? [Section titled “status?”](#status) `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` | `null` ###### transaction\_limit? [Section titled “transaction\_limit?”](#transaction_limit-1) { `amount`: `number`; `currency`: `string` | `null`; } | `null` ##### options? [Section titled “options?”](#options-4) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-5) `Promise`<{ `account_id`: `string`; `authorization_settings?`: { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } | `null`; `authorization_visibility`: `"PUBLIC"` | `"PRIVATE"`; `auto_create_limit_cards_setting`: `"DISABLED"` | `"ALL_MEMBERS"`; `auto_transfer_cards_setting`: `"DISABLED"` | `"ENABLED"`; `current_period_balance?`: { `amount_spent?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } | `null`; `department_id?`: `string` | `null`; `description?`: `string` | `null`; `end_date?`: `string` | `null`; `end_time_utc?`: `string` | `null`; `expense_policy_id`: `string`; `expense_visibility`: `"PRIVATE"` | `"SHARED"`; `id`: `string`; `legal_entity_id?`: `string` | `null`; `limit_approval_policy_id?`: `string` | `null`; `limit_increase_request_policy_id?`: `string` | `null`; `limit_increase_setting`: `"DISABLED"` | `"ENABLED"`; `member_user_ids`: `string`\[]; `merchant_category_controls?`: { `allowed_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; `blocked_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; } | `null`; `name`: `string`; `owner_user_ids`: `string`\[]; `parent_budget_id?`: `string` | `null`; `period_recurrence_type`: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"`; `spend_type`: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"`; `start_date?`: `string` | `null`; `start_time_utc?`: `string` | `null`; `status`: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"`; `transaction_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; }> # createBudgetsClient > **createBudgetsClient**(`options`): [`BrexBudgets`](/brex/api/budgets/classes/brexbudgets/) Defined in: [src/budgets/index.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/index.ts#L13) Standalone client for the Brex Budgets API. ## Parameters [Section titled “Parameters”](#parameters) ### options [Section titled “options”](#options) [`BrexOptions`](/brex/api/index/interfaces/brexoptions/) ## Returns [Section titled “Returns”](#returns) [`BrexBudgets`](/brex/api/budgets/classes/brexbudgets/) # BudgetsComponents Defined in: [src/budgets/types.gen.ts:249](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L249) ## Properties [Section titled “Properties”](#properties) ### headers [Section titled “headers”](#headers) > **headers**: `never` Defined in: [src/budgets/types.gen.ts:985](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L985) *** ### parameters [Section titled “parameters”](#parameters) > **parameters**: `never` Defined in: [src/budgets/types.gen.ts:983](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L983) *** ### pathItems [Section titled “pathItems”](#pathitems) > **pathItems**: `never` Defined in: [src/budgets/types.gen.ts:986](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L986) *** ### requestBodies [Section titled “requestBodies”](#requestbodies) > **requestBodies**: `never` Defined in: [src/budgets/types.gen.ts:984](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L984) *** ### responses [Section titled “responses”](#responses) > **responses**: `never` Defined in: [src/budgets/types.gen.ts:982](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L982) *** ### schemas [Section titled “schemas”](#schemas) > **schemas**: `object` Defined in: [src/budgets/types.gen.ts:250](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L250) #### AuthorizationSettings [Section titled “AuthorizationSettings”](#authorizationsettings) > **AuthorizationSettings**: `object` ##### AuthorizationSettings.authorization\_type [Section titled “AuthorizationSettings.authorization\_type”](#authorizationsettingsauthorization_type) > **authorization\_type**: `"HARD"` | `"SOFT"` ##### AuthorizationSettings.base\_limit [Section titled “AuthorizationSettings.base\_limit”](#authorizationsettingsbase_limit) > **base\_limit**: `object` ##### AuthorizationSettings.base\_limit.amount [Section titled “AuthorizationSettings.base\_limit.amount”](#authorizationsettingsbase_limitamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#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 [Section titled “Example”](#example) ```ts 700 ``` ##### AuthorizationSettings.base\_limit.currency [Section titled “AuthorizationSettings.base\_limit.currency”](#authorizationsettingsbase_limitcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-1) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default) ```ts USD ``` ###### Example [Section titled “Example”](#example-1) ```ts USD ``` ##### AuthorizationSettings.limit\_buffer\_percentage? [Section titled “AuthorizationSettings.limit\_buffer\_percentage?”](#authorizationsettingslimit_buffer_percentage) > `optional` **limit\_buffer\_percentage?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-2) The percentage of flexible buffer on the limit as a 0-100 integer. ##### AuthorizationSettings.limit\_with\_increases [Section titled “AuthorizationSettings.limit\_with\_increases”](#authorizationsettingslimit_with_increases) > **limit\_with\_increases**: `object` ##### AuthorizationSettings.limit\_with\_increases.amount [Section titled “AuthorizationSettings.limit\_with\_increases.amount”](#authorizationsettingslimit_with_increasesamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-3) 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 [Section titled “Example”](#example-2) ```ts 700 ``` ##### AuthorizationSettings.limit\_with\_increases.currency [Section titled “AuthorizationSettings.limit\_with\_increases.currency”](#authorizationsettingslimit_with_increasescurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-4) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-1) ```ts USD ``` ###### Example [Section titled “Example”](#example-3) ```ts USD ``` ##### AuthorizationSettings.rollover\_refresh\_rate [Section titled “AuthorizationSettings.rollover\_refresh\_rate”](#authorizationsettingsrollover_refresh_rate) > **rollover\_refresh\_rate**: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` #### AuthorizationType [Section titled “AuthorizationType”](#authorizationtype) > **AuthorizationType**: `"HARD"` | `"SOFT"` ##### Description [Section titled “Description”](#description-5) Whether authorizations will decline based on available balance. #### AuthorizationVisibility [Section titled “AuthorizationVisibility”](#authorizationvisibility) > **AuthorizationVisibility**: `"PUBLIC"` | `"PRIVATE"` ##### Description [Section titled “Description”](#description-6) Describes if the limit of the Spend Limit is visible to all members, or just controllers, bookkeepers, and owners (direct or ancestral). #### AutoCreateLimitCardsSetting [Section titled “AutoCreateLimitCardsSetting”](#autocreatelimitcardssetting) > **AutoCreateLimitCardsSetting**: `"DISABLED"` | `"ALL_MEMBERS"` ##### Description [Section titled “Description”](#description-7) Setting for how auto limit card creation works for members. #### AutoTransferCardsSetting [Section titled “AutoTransferCardsSetting”](#autotransfercardssetting) > **AutoTransferCardsSetting**: `"DISABLED"` | `"ENABLED"` ##### Description [Section titled “Description”](#description-8) Setting for how auto transfer works for virtual cards. #### Budget [Section titled “Budget”](#budget) > **Budget**: `object` ##### Budget.account\_id [Section titled “Budget.account\_id”](#budgetaccount_id) > **account\_id**: `string` ###### Description [Section titled “Description”](#description-9) The Brex account this Spend Limit belongs to. ##### Budget.budget\_id [Section titled “Budget.budget\_id”](#budgetbudget_id) > **budget\_id**: `string` ###### Description [Section titled “Description”](#description-10) Unique ID for the Spend Limit. ##### Budget.budget\_status [Section titled “Budget.budget\_status”](#budgetbudget_status) > **budget\_status**: `"DELETED"` | `"APPROVED"` | `"EXPIRED"` | `"TERMINATED"` ##### Budget.budget\_type [Section titled “Budget.budget\_type”](#budgetbudget_type) > **budget\_type**: `"BUDGET"` | `"SPEND_LIMIT"` ##### Budget.creator\_user\_id? [Section titled “Budget.creator\_user\_id?”](#budgetcreator_user_id) > `optional` **creator\_user\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-11) The ID of the user who originally created this Spend Limit. ##### Budget.current\_period\_balance? [Section titled “Budget.current\_period\_balance?”](#budgetcurrent_period_balance) > `optional` **current\_period\_balance?**: { `balance?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `balance?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } ###### balance? [Section titled “balance?”](#balance) > `optional` **balance?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-12) 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 [Section titled “Example”](#example-4) ```ts 700 ``` ###### currency [Section titled “currency”](#currency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-13) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-2) ```ts USD ``` ###### Example [Section titled “Example”](#example-5) ```ts USD ``` *** `null` ###### end\_date? [Section titled “end\_date?”](#end_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### start\_date? [Section titled “start\_date?”](#start_date) > `optional` **start\_date?**: `string` | `null` Format: date *** `null` ##### Budget.description? [Section titled “Budget.description?”](#budgetdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-14) Description of what the Spend Limit is used for. ##### Budget.end\_date? [Section titled “Budget.end\_date?”](#budgetend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-15) The UTC date when the Spend Limit should stop counting. ##### Budget.limit? [Section titled “Budget.limit?”](#budgetlimit) > `optional` **limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-16) 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 [Section titled “Example”](#example-6) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-17) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-3) ```ts USD ``` ###### Example [Section titled “Example”](#example-7) ```ts USD ``` *** `null` ##### Budget.limit\_type? [Section titled “Budget.limit\_type?”](#budgetlimit_type) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` ##### Budget.limit\_visibility [Section titled “Budget.limit\_visibility”](#budgetlimit_visibility) > **limit\_visibility**: `"PRIVATE"` | `"SHARED"` ##### Budget.member\_user\_ids [Section titled “Budget.member\_user\_ids”](#budgetmember_user_ids) > **member\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-18) User IDs of the members of the Spend Limit. ##### Budget.name [Section titled “Budget.name”](#budgetname) > **name**: `string` ###### Description [Section titled “Description”](#description-19) Name for the Spend Limit. ##### Budget.owner\_user\_ids [Section titled “Budget.owner\_user\_ids”](#budgetowner_user_ids) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-20) User IDs of the owners of the Spend Limit. ##### Budget.parent\_budget\_id? [Section titled “Budget.parent\_budget\_id?”](#budgetparent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-21) ID of parent Budget. ##### Budget.period\_type [Section titled “Budget.period\_type”](#budgetperiod_type) > **period\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### Budget.spend\_type [Section titled “Budget.spend\_type”](#budgetspend_type) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### Budget.start\_date? [Section titled “Budget.start\_date?”](#budgetstart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-22) The UTC date when the Spend Limit should start counting. ##### Budget.templateId? [Section titled “Budget.templateId?”](#budgettemplateid) > `optional` **templateId?**: `string` | `null` #### BudgetBlueprint [Section titled “BudgetBlueprint”](#budgetblueprint) > **BudgetBlueprint**: `object` ##### Description [Section titled “Description”](#description-23) Blueprint for provisioning Spend Limits for a Budget Program. ##### BudgetBlueprint.description? [Section titled “BudgetBlueprint.description?”](#budgetblueprintdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-24) Description of what the Spend Limit is used for. ##### BudgetBlueprint.end\_date? [Section titled “BudgetBlueprint.end\_date?”](#budgetblueprintend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-25) The UTC date when the Spend Limit should stop counting. ##### BudgetBlueprint.id [Section titled “BudgetBlueprint.id”](#budgetblueprintid) > **id**: `string` ##### BudgetBlueprint.limit? [Section titled “BudgetBlueprint.limit?”](#budgetblueprintlimit) > `optional` **limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-3) ###### Type Literal [Section titled “Type Literal”](#type-literal-3) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-2) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-26) 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 [Section titled “Example”](#example-8) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-2) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-27) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-4) ```ts USD ``` ###### Example [Section titled “Example”](#example-9) ```ts USD ``` *** `null` ##### BudgetBlueprint.limit\_type [Section titled “BudgetBlueprint.limit\_type”](#budgetblueprintlimit_type) > **limit\_type**: `"HARD"` | `"SOFT"` ##### BudgetBlueprint.limit\_visibility [Section titled “BudgetBlueprint.limit\_visibility”](#budgetblueprintlimit_visibility) > **limit\_visibility**: `"PRIVATE"` | `"SHARED"` ##### BudgetBlueprint.name [Section titled “BudgetBlueprint.name”](#budgetblueprintname) > **name**: `string` ###### Description [Section titled “Description”](#description-28) Name for the Spend Limit. ##### BudgetBlueprint.owner\_user\_ids [Section titled “BudgetBlueprint.owner\_user\_ids”](#budgetblueprintowner_user_ids) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-29) User IDs of the owners of the Spend Limit. ##### BudgetBlueprint.parent\_budget\_id [Section titled “BudgetBlueprint.parent\_budget\_id”](#budgetblueprintparent_budget_id) > **parent\_budget\_id**: `string` ###### Description [Section titled “Description”](#description-30) ID of parent Budget. ##### BudgetBlueprint.period\_type [Section titled “BudgetBlueprint.period\_type”](#budgetblueprintperiod_type) > **period\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### BudgetBlueprint.spend\_type [Section titled “BudgetBlueprint.spend\_type”](#budgetblueprintspend_type) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### BudgetBlueprint.start\_date? [Section titled “BudgetBlueprint.start\_date?”](#budgetblueprintstart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-31) The UTC date when the Spend Limit should start counting. #### BudgetLimitVisibilityType [Section titled “BudgetLimitVisibilityType”](#budgetlimitvisibilitytype) > **BudgetLimitVisibilityType**: `"PRIVATE"` | `"SHARED"` ##### Description [Section titled “Description”](#description-32) Determines if Spend Limit members are allowed to view the Spend Limit’s limit. #### BudgetPeriodBalance [Section titled “BudgetPeriodBalance”](#budgetperiodbalance) > **BudgetPeriodBalance**: `object` ##### Description [Section titled “Description”](#description-33) Current Spend Limit period balance. ##### BudgetPeriodBalance.balance? [Section titled “BudgetPeriodBalance.balance?”](#budgetperiodbalancebalance) > `optional` **balance?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-4) ###### Type Literal [Section titled “Type Literal”](#type-literal-4) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-3) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-34) 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 [Section titled “Example”](#example-10) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-3) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-35) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-5) ```ts USD ``` ###### Example [Section titled “Example”](#example-11) ```ts USD ``` *** `null` ##### BudgetPeriodBalance.end\_date? [Section titled “BudgetPeriodBalance.end\_date?”](#budgetperiodbalanceend_date) > `optional` **end\_date?**: `string` | `null` Format: date ##### BudgetPeriodBalance.start\_date? [Section titled “BudgetPeriodBalance.start\_date?”](#budgetperiodbalancestart_date) > `optional` **start\_date?**: `string` | `null` Format: date #### BudgetProgram [Section titled “BudgetProgram”](#budgetprogram) > **BudgetProgram**: `object` ##### Description [Section titled “Description”](#description-36) Budget Program used to create Spend Limits for eligible users. ##### BudgetProgram.budget\_blueprints [Section titled “BudgetProgram.budget\_blueprints”](#budgetprogrambudget_blueprints) > **budget\_blueprints**: `object`\[] ##### BudgetProgram.budget\_program\_status [Section titled “BudgetProgram.budget\_program\_status”](#budgetprogrambudget_program_status) > **budget\_program\_status**: `"BUDGET_PROGRAM_STATUS_ACTIVE"` | `"BUDGET_PROGRAM_STATUS_INACTIVE"` | `"BUDGET_PROGRAM_STATUS_DELETED"` ##### BudgetProgram.created\_at [Section titled “BudgetProgram.created\_at”](#budgetprogramcreated_at) > **created\_at**: `string` Format: date ##### BudgetProgram.creator\_user\_id? [Section titled “BudgetProgram.creator\_user\_id?”](#budgetprogramcreator_user_id) > `optional` **creator\_user\_id?**: `string` | `null` ##### BudgetProgram.description? [Section titled “BudgetProgram.description?”](#budgetprogramdescription) > `optional` **description?**: `string` | `null` ##### BudgetProgram.employee\_filter? [Section titled “BudgetProgram.employee\_filter?”](#budgetprogramemployee_filter) > `optional` **employee\_filter?**: { `employment_status?`: `"EMPLOYMENT_STATUS_ACTIVE"` | `"EMPLOYMENT_STATUS_INACTIVE"` | `"EMPLOYMENT_STATUS_PENDING"` | `null`; `employment_type?`: `"EMPLOYMENT_TYPE_FULL_TIME"` | `"EMPLOYMENT_TYPE_PART_TIME"` | `"EMPLOYMENT_TYPE_CONTRACTOR"` | `"EMPLOYMENT_TYPE_INTERN"` | `"EMPLOYMENT_TYPE_FREELANCE"` | `null`; } | `null` ##### BudgetProgram.existing\_budget\_ids? [Section titled “BudgetProgram.existing\_budget\_ids?”](#budgetprogramexisting_budget_ids) > `optional` **existing\_budget\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-37) IDs for existing Spend Limits associated with this Budget Program. ##### BudgetProgram.id [Section titled “BudgetProgram.id”](#budgetprogramid) > **id**: `string` ##### BudgetProgram.name [Section titled “BudgetProgram.name”](#budgetprogramname) > **name**: `string` ##### BudgetProgram.updated\_at [Section titled “BudgetProgram.updated\_at”](#budgetprogramupdated_at) > **updated\_at**: `string` Format: date #### BudgetProgramStatus [Section titled “BudgetProgramStatus”](#budgetprogramstatus) > **BudgetProgramStatus**: `"BUDGET_PROGRAM_STATUS_ACTIVE"` | `"BUDGET_PROGRAM_STATUS_INACTIVE"` | `"BUDGET_PROGRAM_STATUS_DELETED"` #### BudgetStatus [Section titled “BudgetStatus”](#budgetstatus) > **BudgetStatus**: `"DELETED"` | `"APPROVED"` | `"EXPIRED"` | `"TERMINATED"` ##### Description [Section titled “Description”](#description-38) Status of the Spend Limit e.g. APPROVED. #### BudgetType [Section titled “BudgetType”](#budgettype) > **BudgetType**: `"BUDGET"` | `"SPEND_LIMIT"` ##### Description [Section titled “Description”](#description-39) Whether this is a Budget or a Spend Limit for post-bifurcation entities. #### CreateAuthorizationSettings [Section titled “CreateAuthorizationSettings”](#createauthorizationsettings) > **CreateAuthorizationSettings**: `object` ##### CreateAuthorizationSettings.authorization\_type [Section titled “CreateAuthorizationSettings.authorization\_type”](#createauthorizationsettingsauthorization_type) > **authorization\_type**: `"HARD"` | `"SOFT"` ##### CreateAuthorizationSettings.base\_limit [Section titled “CreateAuthorizationSettings.base\_limit”](#createauthorizationsettingsbase_limit) > **base\_limit**: `object` ##### CreateAuthorizationSettings.base\_limit.amount [Section titled “CreateAuthorizationSettings.base\_limit.amount”](#createauthorizationsettingsbase_limitamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-40) 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 [Section titled “Example”](#example-12) ```ts 700 ``` ##### CreateAuthorizationSettings.base\_limit.currency [Section titled “CreateAuthorizationSettings.base\_limit.currency”](#createauthorizationsettingsbase_limitcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-41) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-6) ```ts USD ``` ###### Example [Section titled “Example”](#example-13) ```ts USD ``` ##### CreateAuthorizationSettings.limit\_buffer\_percentage? [Section titled “CreateAuthorizationSettings.limit\_buffer\_percentage?”](#createauthorizationsettingslimit_buffer_percentage) > `optional` **limit\_buffer\_percentage?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-42) The percentage of flexible buffer on the limit as a 0-100 integer. ##### CreateAuthorizationSettings.rollover\_refresh\_rate [Section titled “CreateAuthorizationSettings.rollover\_refresh\_rate”](#createauthorizationsettingsrollover_refresh_rate) > **rollover\_refresh\_rate**: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` #### CreateBudgetBlueprintRequest [Section titled “CreateBudgetBlueprintRequest”](#createbudgetblueprintrequest) > **CreateBudgetBlueprintRequest**: `object` ##### Description [Section titled “Description”](#description-43) Blueprint for provisioning Spend Limits for a Budget Program. ##### CreateBudgetBlueprintRequest.description [Section titled “CreateBudgetBlueprintRequest.description”](#createbudgetblueprintrequestdescription) > **description**: `string` ###### Description [Section titled “Description”](#description-44) Description of what the Spend Limit is used for. ##### CreateBudgetBlueprintRequest.end\_date? [Section titled “CreateBudgetBlueprintRequest.end\_date?”](#createbudgetblueprintrequestend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-45) The UTC date when the Spend Limit should stop counting. ##### CreateBudgetBlueprintRequest.limit [Section titled “CreateBudgetBlueprintRequest.limit”](#createbudgetblueprintrequestlimit) > **limit**: `object` ##### CreateBudgetBlueprintRequest.limit.amount [Section titled “CreateBudgetBlueprintRequest.limit.amount”](#createbudgetblueprintrequestlimitamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-46) 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 [Section titled “Example”](#example-14) ```ts 700 ``` ##### CreateBudgetBlueprintRequest.limit.currency [Section titled “CreateBudgetBlueprintRequest.limit.currency”](#createbudgetblueprintrequestlimitcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-47) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-7) ```ts USD ``` ###### Example [Section titled “Example”](#example-15) ```ts USD ``` ##### CreateBudgetBlueprintRequest.limit\_type [Section titled “CreateBudgetBlueprintRequest.limit\_type”](#createbudgetblueprintrequestlimit_type) > **limit\_type**: `"HARD"` | `"SOFT"` ##### CreateBudgetBlueprintRequest.limit\_visibility [Section titled “CreateBudgetBlueprintRequest.limit\_visibility”](#createbudgetblueprintrequestlimit_visibility) > **limit\_visibility**: `"PRIVATE"` | `"SHARED"` ##### CreateBudgetBlueprintRequest.name [Section titled “CreateBudgetBlueprintRequest.name”](#createbudgetblueprintrequestname) > **name**: `string` ###### Description [Section titled “Description”](#description-48) Name for the Spend Limit. ##### CreateBudgetBlueprintRequest.owner\_user\_ids? [Section titled “CreateBudgetBlueprintRequest.owner\_user\_ids?”](#createbudgetblueprintrequestowner_user_ids) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-49) User IDs of the owners of the Spend Limit. ##### CreateBudgetBlueprintRequest.parent\_budget\_id [Section titled “CreateBudgetBlueprintRequest.parent\_budget\_id”](#createbudgetblueprintrequestparent_budget_id) > **parent\_budget\_id**: `string` ###### Description [Section titled “Description”](#description-50) ID of parent Budget. ##### CreateBudgetBlueprintRequest.period\_type [Section titled “CreateBudgetBlueprintRequest.period\_type”](#createbudgetblueprintrequestperiod_type) > **period\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### CreateBudgetBlueprintRequest.spend\_type [Section titled “CreateBudgetBlueprintRequest.spend\_type”](#createbudgetblueprintrequestspend_type) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### CreateBudgetBlueprintRequest.start\_date? [Section titled “CreateBudgetBlueprintRequest.start\_date?”](#createbudgetblueprintrequeststart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-51) The UTC date when the Spend Limit should start counting. #### CreateBudgetProgramRequest [Section titled “CreateBudgetProgramRequest”](#createbudgetprogramrequest) > **CreateBudgetProgramRequest**: `object` ##### Description [Section titled “Description”](#description-52) Budget Program used to create Spend Limits for eligible users. ##### CreateBudgetProgramRequest.budget\_blueprints [Section titled “CreateBudgetProgramRequest.budget\_blueprints”](#createbudgetprogramrequestbudget_blueprints) > **budget\_blueprints**: `object`\[] ##### CreateBudgetProgramRequest.description? [Section titled “CreateBudgetProgramRequest.description?”](#createbudgetprogramrequestdescription) > `optional` **description?**: `string` | `null` ##### CreateBudgetProgramRequest.employee\_filter? [Section titled “CreateBudgetProgramRequest.employee\_filter?”](#createbudgetprogramrequestemployee_filter) > `optional` **employee\_filter?**: { `employment_status?`: `"EMPLOYMENT_STATUS_ACTIVE"` | `"EMPLOYMENT_STATUS_INACTIVE"` | `"EMPLOYMENT_STATUS_PENDING"` | `null`; `employment_type?`: `"EMPLOYMENT_TYPE_FULL_TIME"` | `"EMPLOYMENT_TYPE_PART_TIME"` | `"EMPLOYMENT_TYPE_CONTRACTOR"` | `"EMPLOYMENT_TYPE_INTERN"` | `"EMPLOYMENT_TYPE_FREELANCE"` | `null`; } | `null` ##### CreateBudgetProgramRequest.existing\_budget\_ids? [Section titled “CreateBudgetProgramRequest.existing\_budget\_ids?”](#createbudgetprogramrequestexisting_budget_ids) > `optional` **existing\_budget\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-53) IDs for existing Spend Limits associated with this Budget Program. ##### CreateBudgetProgramRequest.name [Section titled “CreateBudgetProgramRequest.name”](#createbudgetprogramrequestname) > **name**: `string` #### CreateBudgetRequest [Section titled “CreateBudgetRequest”](#createbudgetrequest) > **CreateBudgetRequest**: `object` ##### CreateBudgetRequest.description [Section titled “CreateBudgetRequest.description”](#createbudgetrequestdescription) > **description**: `string` ###### Description [Section titled “Description”](#description-54) Description of what the Spend Limit is used for. ##### CreateBudgetRequest.end\_date? [Section titled “CreateBudgetRequest.end\_date?”](#createbudgetrequestend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-55) The UTC date when the Spend Limit should stop counting. ##### CreateBudgetRequest.entity\_id? [Section titled “CreateBudgetRequest.entity\_id?”](#createbudgetrequestentity_id) > `optional` **entity\_id?**: `string` | `null` ##### CreateBudgetRequest.limit [Section titled “CreateBudgetRequest.limit”](#createbudgetrequestlimit) > **limit**: `object` ##### CreateBudgetRequest.limit.amount [Section titled “CreateBudgetRequest.limit.amount”](#createbudgetrequestlimitamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-56) 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 [Section titled “Example”](#example-16) ```ts 700 ``` ##### CreateBudgetRequest.limit.currency [Section titled “CreateBudgetRequest.limit.currency”](#createbudgetrequestlimitcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-57) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-8) ```ts USD ``` ###### Example [Section titled “Example”](#example-17) ```ts USD ``` ##### CreateBudgetRequest.limit\_type [Section titled “CreateBudgetRequest.limit\_type”](#createbudgetrequestlimit_type) > **limit\_type**: `"HARD"` | `"SOFT"` ##### CreateBudgetRequest.limit\_visibility [Section titled “CreateBudgetRequest.limit\_visibility”](#createbudgetrequestlimit_visibility) > **limit\_visibility**: `"PRIVATE"` | `"SHARED"` ##### CreateBudgetRequest.member\_user\_ids? [Section titled “CreateBudgetRequest.member\_user\_ids?”](#createbudgetrequestmember_user_ids) > `optional` **member\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-58) User IDs of the members of the Spend Limit. ##### CreateBudgetRequest.name [Section titled “CreateBudgetRequest.name”](#createbudgetrequestname) > **name**: `string` ###### Description [Section titled “Description”](#description-59) Name for the Spend Limit. ##### CreateBudgetRequest.owner\_user\_ids? [Section titled “CreateBudgetRequest.owner\_user\_ids?”](#createbudgetrequestowner_user_ids) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-60) User IDs of the owners of the Spend Limit. ##### CreateBudgetRequest.parent\_budget\_id [Section titled “CreateBudgetRequest.parent\_budget\_id”](#createbudgetrequestparent_budget_id) > **parent\_budget\_id**: `string` ###### Description [Section titled “Description”](#description-61) ID of parent Budget. ##### CreateBudgetRequest.period\_type [Section titled “CreateBudgetRequest.period\_type”](#createbudgetrequestperiod_type) > **period\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### CreateBudgetRequest.policy\_id? [Section titled “CreateBudgetRequest.policy\_id?”](#createbudgetrequestpolicy_id) > `optional` **policy\_id?**: `string` | `null` ##### CreateBudgetRequest.spend\_type [Section titled “CreateBudgetRequest.spend\_type”](#createbudgetrequestspend_type) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### CreateBudgetRequest.start\_date? [Section titled “CreateBudgetRequest.start\_date?”](#createbudgetrequeststart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-62) The UTC date when the Spend Limit should start counting. #### CreateSpendBudgetRequest [Section titled “CreateSpendBudgetRequest”](#createspendbudgetrequest) > **CreateSpendBudgetRequest**: `object` ##### CreateSpendBudgetRequest.amount [Section titled “CreateSpendBudgetRequest.amount”](#createspendbudgetrequestamount) > **amount**: `object` ##### CreateSpendBudgetRequest.amount.amount [Section titled “CreateSpendBudgetRequest.amount.amount”](#createspendbudgetrequestamountamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-63) 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 [Section titled “Example”](#example-18) ```ts 700 ``` ##### CreateSpendBudgetRequest.amount.currency [Section titled “CreateSpendBudgetRequest.amount.currency”](#createspendbudgetrequestamountcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-64) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-9) ```ts USD ``` ###### Example [Section titled “Example”](#example-19) ```ts USD ``` ##### CreateSpendBudgetRequest.description [Section titled “CreateSpendBudgetRequest.description”](#createspendbudgetrequestdescription) > **description**: `string` ###### Description [Section titled “Description”](#description-65) Description of what the Budget is used for. ##### CreateSpendBudgetRequest.end\_date? [Section titled “CreateSpendBudgetRequest.end\_date?”](#createspendbudgetrequestend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-66) The date when the Budget should stop counting. ##### CreateSpendBudgetRequest.limit\_type? [Section titled “CreateSpendBudgetRequest.limit\_type?”](#createspendbudgetrequestlimit_type) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` Deprecated This API is no longer supported and may be removed in a future release. ##### CreateSpendBudgetRequest.name [Section titled “CreateSpendBudgetRequest.name”](#createspendbudgetrequestname) > **name**: `string` ###### Description [Section titled “Description”](#description-67) Name for the Budget. ##### CreateSpendBudgetRequest.owner\_user\_ids? [Section titled “CreateSpendBudgetRequest.owner\_user\_ids?”](#createspendbudgetrequestowner_user_ids) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-68) User IDs of the owners of the Budget. ##### CreateSpendBudgetRequest.parent\_budget\_id [Section titled “CreateSpendBudgetRequest.parent\_budget\_id”](#createspendbudgetrequestparent_budget_id) > **parent\_budget\_id**: `string` ###### Description [Section titled “Description”](#description-69) ID of parent Budget. ##### CreateSpendBudgetRequest.period\_recurrence\_type [Section titled “CreateSpendBudgetRequest.period\_recurrence\_type”](#createspendbudgetrequestperiod_recurrence_type) > **period\_recurrence\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### CreateSpendBudgetRequest.start\_date? [Section titled “CreateSpendBudgetRequest.start\_date?”](#createspendbudgetrequeststart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-70) The date when the Budget should start counting. #### CreateSpendLimitRequest [Section titled “CreateSpendLimitRequest”](#createspendlimitrequest) > **CreateSpendLimitRequest**: `object` ##### CreateSpendLimitRequest.authorization\_settings [Section titled “CreateSpendLimitRequest.authorization\_settings”](#createspendlimitrequestauthorization_settings) > **authorization\_settings**: `object` ##### CreateSpendLimitRequest.authorization\_settings.authorization\_type [Section titled “CreateSpendLimitRequest.authorization\_settings.authorization\_type”](#createspendlimitrequestauthorization_settingsauthorization_type) > **authorization\_type**: `"HARD"` | `"SOFT"` ##### CreateSpendLimitRequest.authorization\_settings.base\_limit [Section titled “CreateSpendLimitRequest.authorization\_settings.base\_limit”](#createspendlimitrequestauthorization_settingsbase_limit) > **base\_limit**: `object` ##### CreateSpendLimitRequest.authorization\_settings.base\_limit.amount [Section titled “CreateSpendLimitRequest.authorization\_settings.base\_limit.amount”](#createspendlimitrequestauthorization_settingsbase_limitamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-71) 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 [Section titled “Example”](#example-20) ```ts 700 ``` ##### CreateSpendLimitRequest.authorization\_settings.base\_limit.currency [Section titled “CreateSpendLimitRequest.authorization\_settings.base\_limit.currency”](#createspendlimitrequestauthorization_settingsbase_limitcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-72) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-10) ```ts USD ``` ###### Example [Section titled “Example”](#example-21) ```ts USD ``` ##### CreateSpendLimitRequest.authorization\_settings.limit\_buffer\_percentage? [Section titled “CreateSpendLimitRequest.authorization\_settings.limit\_buffer\_percentage?”](#createspendlimitrequestauthorization_settingslimit_buffer_percentage) > `optional` **limit\_buffer\_percentage?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-73) The percentage of flexible buffer on the limit as a 0-100 integer. ##### CreateSpendLimitRequest.authorization\_settings.rollover\_refresh\_rate [Section titled “CreateSpendLimitRequest.authorization\_settings.rollover\_refresh\_rate”](#createspendlimitrequestauthorization_settingsrollover_refresh_rate) > **rollover\_refresh\_rate**: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` ##### CreateSpendLimitRequest.authorization\_visibility [Section titled “CreateSpendLimitRequest.authorization\_visibility”](#createspendlimitrequestauthorization_visibility) > **authorization\_visibility**: `"PUBLIC"` | `"PRIVATE"` ##### CreateSpendLimitRequest.auto\_create\_limit\_cards\_setting [Section titled “CreateSpendLimitRequest.auto\_create\_limit\_cards\_setting”](#createspendlimitrequestauto_create_limit_cards_setting) > **auto\_create\_limit\_cards\_setting**: `"DISABLED"` | `"ALL_MEMBERS"` ##### CreateSpendLimitRequest.auto\_transfer\_cards\_setting [Section titled “CreateSpendLimitRequest.auto\_transfer\_cards\_setting”](#createspendlimitrequestauto_transfer_cards_setting) > **auto\_transfer\_cards\_setting**: `"DISABLED"` | `"ENABLED"` ##### CreateSpendLimitRequest.department\_id? [Section titled “CreateSpendLimitRequest.department\_id?”](#createspendlimitrequestdepartment_id) > `optional` **department\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-74) The department ID to which Spend Limit expenses will be attributed. ##### CreateSpendLimitRequest.description? [Section titled “CreateSpendLimitRequest.description?”](#createspendlimitrequestdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-75) Description of what the Spend Limit is used for. ##### CreateSpendLimitRequest.end\_date? [Section titled “CreateSpendLimitRequest.end\_date?”](#createspendlimitrequestend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-76) The date when the Spend Limit should expire. ##### CreateSpendLimitRequest.expense\_policy\_id [Section titled “CreateSpendLimitRequest.expense\_policy\_id”](#createspendlimitrequestexpense_policy_id) > **expense\_policy\_id**: `string` ###### Description [Section titled “Description”](#description-77) The ID of the expense policy corresponding to this Spend Limit. ##### CreateSpendLimitRequest.expense\_visibility [Section titled “CreateSpendLimitRequest.expense\_visibility”](#createspendlimitrequestexpense_visibility) > **expense\_visibility**: `"PRIVATE"` | `"SHARED"` ##### CreateSpendLimitRequest.legal\_entity\_id? [Section titled “CreateSpendLimitRequest.legal\_entity\_id?”](#createspendlimitrequestlegal_entity_id) > `optional` **legal\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-78) The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity. ##### CreateSpendLimitRequest.limit\_approval\_policy\_id? [Section titled “CreateSpendLimitRequest.limit\_approval\_policy\_id?”](#createspendlimitrequestlimit_approval_policy_id) > `optional` **limit\_approval\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-79) The ID of the policy for limit increase approval requests. Meant to replace limit\_increase\_request\_policy\_id. ##### CreateSpendLimitRequest.limit\_increase\_request\_policy\_id? [Section titled “CreateSpendLimitRequest.limit\_increase\_request\_policy\_id?”](#createspendlimitrequestlimit_increase_request_policy_id) > `optional` **limit\_increase\_request\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-80) The ID of the policy for limit increase requests for this Spend Limit. ##### CreateSpendLimitRequest.limit\_increase\_setting [Section titled “CreateSpendLimitRequest.limit\_increase\_setting”](#createspendlimitrequestlimit_increase_setting) > **limit\_increase\_setting**: `"DISABLED"` | `"ENABLED"` ##### CreateSpendLimitRequest.member\_user\_ids? [Section titled “CreateSpendLimitRequest.member\_user\_ids?”](#createspendlimitrequestmember_user_ids) > `optional` **member\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-81) User IDs of the members of the Spend Limit. ##### CreateSpendLimitRequest.name [Section titled “CreateSpendLimitRequest.name”](#createspendlimitrequestname) > **name**: `string` ###### Description [Section titled “Description”](#description-82) Name for the Spend Limit. ##### CreateSpendLimitRequest.owner\_user\_ids? [Section titled “CreateSpendLimitRequest.owner\_user\_ids?”](#createspendlimitrequestowner_user_ids) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-83) User IDs of the owners of the Spend Limit. ##### CreateSpendLimitRequest.parent\_budget\_id? [Section titled “CreateSpendLimitRequest.parent\_budget\_id?”](#createspendlimitrequestparent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-84) ID of parent Budget. ##### CreateSpendLimitRequest.period\_recurrence\_type [Section titled “CreateSpendLimitRequest.period\_recurrence\_type”](#createspendlimitrequestperiod_recurrence_type) > **period\_recurrence\_type**: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"` ##### CreateSpendLimitRequest.spend\_type [Section titled “CreateSpendLimitRequest.spend\_type”](#createspendlimitrequestspend_type) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### CreateSpendLimitRequest.start\_date? [Section titled “CreateSpendLimitRequest.start\_date?”](#createspendlimitrequeststart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-85) The date when the Spend Limit should start counting. ##### CreateSpendLimitRequest.transaction\_limit? [Section titled “CreateSpendLimitRequest.transaction\_limit?”](#createspendlimitrequesttransaction_limit) > `optional` **transaction\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-5) ###### Type Literal [Section titled “Type Literal”](#type-literal-5) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-4) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-86) 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 [Section titled “Example”](#example-22) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-4) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-87) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-11) ```ts USD ``` ###### Example [Section titled “Example”](#example-23) ```ts USD ``` *** `null` #### EmployeeFilter [Section titled “EmployeeFilter”](#employeefilter) > **EmployeeFilter**: `object` ##### Description [Section titled “Description”](#description-88) A filter used to determine if a user adheres to a Budget Program. ##### EmployeeFilter.employment\_status? [Section titled “EmployeeFilter.employment\_status?”](#employeefilteremployment_status) > `optional` **employment\_status?**: `"EMPLOYMENT_STATUS_ACTIVE"` | `"EMPLOYMENT_STATUS_INACTIVE"` | `"EMPLOYMENT_STATUS_PENDING"` | `null` ##### EmployeeFilter.employment\_type? [Section titled “EmployeeFilter.employment\_type?”](#employeefilteremployment_type) > `optional` **employment\_type?**: `"EMPLOYMENT_TYPE_FULL_TIME"` | `"EMPLOYMENT_TYPE_PART_TIME"` | `"EMPLOYMENT_TYPE_CONTRACTOR"` | `"EMPLOYMENT_TYPE_INTERN"` | `"EMPLOYMENT_TYPE_FREELANCE"` | `null` #### EmploymentStatus [Section titled “EmploymentStatus”](#employmentstatus) > **EmploymentStatus**: `"EMPLOYMENT_STATUS_ACTIVE"` | `"EMPLOYMENT_STATUS_INACTIVE"` | `"EMPLOYMENT_STATUS_PENDING"` ##### Description [Section titled “Description”](#description-89) A filter used to determine if a user adheres to a Budget Program. #### EmploymentType [Section titled “EmploymentType”](#employmenttype) > **EmploymentType**: `"EMPLOYMENT_TYPE_FULL_TIME"` | `"EMPLOYMENT_TYPE_PART_TIME"` | `"EMPLOYMENT_TYPE_CONTRACTOR"` | `"EMPLOYMENT_TYPE_INTERN"` | `"EMPLOYMENT_TYPE_FREELANCE"` ##### Description [Section titled “Description”](#description-90) What kind of employment the employee has. #### ExpenseVisibility [Section titled “ExpenseVisibility”](#expensevisibility) > **ExpenseVisibility**: `"PRIVATE"` | `"SHARED"` ##### Description [Section titled “Description”](#description-91) Whether or not expense related to this Spend Limit should be viewable to all members. #### LimitIncreaseSetting [Section titled “LimitIncreaseSetting”](#limitincreasesetting) > **LimitIncreaseSetting**: `"DISABLED"` | `"ENABLED"` ##### Description [Section titled “Description”](#description-92) Whether or not members can request limit increases. #### LimitType [Section titled “LimitType”](#limittype) > **LimitType**: `"HARD"` | `"SOFT"` ##### Description [Section titled “Description”](#description-93) Whether the Spend Limit’s limit blocks spend. #### LimitType\_1 [Section titled “LimitType\_1”](#limittype_1) > **LimitType\_1**: `"HARD"` | `"SOFT"` ##### Description [Section titled “Description”](#description-94) Whether the Budget amount blocks spend. `HARD` is rejected; use `/v2/spend_limits` for hard-auth limits. #### LimitType\_3 [Section titled “LimitType\_3”](#limittype_3) > **LimitType\_3**: `"HARD"` | `"SOFT"` ##### Description [Section titled “Description”](#description-95) Whether the Budget amount blocks spend. `HARD` is rejected; use `/v2/spend_limits` for hard-auth limits. #### LimitType\_4 [Section titled “LimitType\_4”](#limittype_4) > **LimitType\_4**: `"HARD"` | `"SOFT"` ##### Description [Section titled “Description”](#description-96) Whether the Budget amount blocks spend. `HARD` is rejected; use `/v2/spend_limits` for hard-auth limits. #### MerchantCategory [Section titled “MerchantCategory”](#merchantcategory) > **MerchantCategory**: `"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"` #### MerchantCategoryControls [Section titled “MerchantCategoryControls”](#merchantcategorycontrols) > **MerchantCategoryControls**: `object` ##### MerchantCategoryControls.allowed\_merchant\_categories? [Section titled “MerchantCategoryControls.allowed\_merchant\_categories?”](#merchantcategorycontrolsallowed_merchant_categories) > `optional` **allowed\_merchant\_categories?**: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null` ##### MerchantCategoryControls.blocked\_merchant\_categories? [Section titled “MerchantCategoryControls.blocked\_merchant\_categories?”](#merchantcategorycontrolsblocked_merchant_categories) > `optional` **blocked\_merchant\_categories?**: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null` #### Money [Section titled “Money”](#money) > **Money**: `object` ##### Description [Section titled “Description”](#description-97) Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700. ##### Money.amount [Section titled “Money.amount”](#moneyamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-98) 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 [Section titled “Example”](#example-24) ```ts 700 ``` ##### Money.currency [Section titled “Money.currency”](#moneycurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-99) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-12) ```ts USD ``` ###### Example [Section titled “Example”](#example-25) ```ts USD ``` #### Page\_Budget\_ [Section titled “Page\_Budget\_”](#page_budget_) > **Page\_Budget\_**: `object` ##### Page\_Budget\_.items [Section titled “Page\_Budget\_.items”](#page_budget_items) > **items**: `object`\[] ##### Page\_Budget\_.next\_cursor? [Section titled “Page\_Budget\_.next\_cursor?”](#page_budget_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_BudgetProgram\_ [Section titled “Page\_BudgetProgram\_”](#page_budgetprogram_) > **Page\_BudgetProgram\_**: `object` ##### Page\_BudgetProgram\_.items [Section titled “Page\_BudgetProgram\_.items”](#page_budgetprogram_items) > **items**: `object`\[] ##### Page\_BudgetProgram\_.next\_cursor? [Section titled “Page\_BudgetProgram\_.next\_cursor?”](#page_budgetprogram_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_SpendBudget\_ [Section titled “Page\_SpendBudget\_”](#page_spendbudget_) > **Page\_SpendBudget\_**: `object` ##### Page\_SpendBudget\_.items [Section titled “Page\_SpendBudget\_.items”](#page_spendbudget_items) > **items**: `object`\[] ##### Page\_SpendBudget\_.next\_cursor? [Section titled “Page\_SpendBudget\_.next\_cursor?”](#page_spendbudget_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_SpendLimit\_ [Section titled “Page\_SpendLimit\_”](#page_spendlimit_) > **Page\_SpendLimit\_**: `object` ##### Page\_SpendLimit\_.items [Section titled “Page\_SpendLimit\_.items”](#page_spendlimit_items) > **items**: `object`\[] ##### Page\_SpendLimit\_.next\_cursor? [Section titled “Page\_SpendLimit\_.next\_cursor?”](#page_spendlimit_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### PeriodRecurrenceType [Section titled “PeriodRecurrenceType”](#periodrecurrencetype) > **PeriodRecurrenceType**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### Description [Section titled “Description”](#description-100) Period type of the Budget e.g. MONTHLY. #### PeriodType [Section titled “PeriodType”](#periodtype) > **PeriodType**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### Description [Section titled “Description”](#description-101) Period type of the Spend Limit e.g. MONTHLY. #### RolloverRefreshRate [Section titled “RolloverRefreshRate”](#rolloverrefreshrate) > **RolloverRefreshRate**: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` ##### Description [Section titled “Description”](#description-102) The rollover refresh rate for this spend limit (the recurrence by which all rolled over unused funds within the cycle should no longer roll over to the next period). #### SpendBudget [Section titled “SpendBudget”](#spendbudget) > **SpendBudget**: `object` ##### SpendBudget.account\_id [Section titled “SpendBudget.account\_id”](#spendbudgetaccount_id) > **account\_id**: `string` ###### Description [Section titled “Description”](#description-103) The Brex account this Budget belongs to. ##### SpendBudget.amount? [Section titled “SpendBudget.amount?”](#spendbudgetamount) > `optional` **amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-6) ###### Type Literal [Section titled “Type Literal”](#type-literal-6) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-5) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-104) 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 [Section titled “Example”](#example-26) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-5) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-105) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-13) ```ts USD ``` ###### Example [Section titled “Example”](#example-27) ```ts USD ``` *** `null` ##### SpendBudget.budget\_id [Section titled “SpendBudget.budget\_id”](#spendbudgetbudget_id) > **budget\_id**: `string` ###### Description [Section titled “Description”](#description-106) Unique ID for the Budget. ##### SpendBudget.description? [Section titled “SpendBudget.description?”](#spendbudgetdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-107) Description of what the Budget is used for. ##### SpendBudget.end\_date? [Section titled “SpendBudget.end\_date?”](#spendbudgetend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-108) The date when the Budget should stop counting. ##### SpendBudget.limit\_type? [Section titled “SpendBudget.limit\_type?”](#spendbudgetlimit_type) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` Deprecated This API is no longer supported and may be removed in a future release. ##### SpendBudget.name [Section titled “SpendBudget.name”](#spendbudgetname) > **name**: `string` ###### Description [Section titled “Description”](#description-109) Name for the Budget. ##### SpendBudget.owner\_user\_ids [Section titled “SpendBudget.owner\_user\_ids”](#spendbudgetowner_user_ids) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-110) User IDs of the owners of the Budget. ##### SpendBudget.parent\_budget\_id? [Section titled “SpendBudget.parent\_budget\_id?”](#spendbudgetparent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-111) ID of parent Budget. ##### SpendBudget.period\_recurrence\_type [Section titled “SpendBudget.period\_recurrence\_type”](#spendbudgetperiod_recurrence_type) > **period\_recurrence\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### SpendBudget.spend\_budget\_status [Section titled “SpendBudget.spend\_budget\_status”](#spendbudgetspend_budget_status) > **spend\_budget\_status**: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` ##### SpendBudget.start\_date? [Section titled “SpendBudget.start\_date?”](#spendbudgetstart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-112) The date when the Budget should start counting. #### SpendBudgetStatus [Section titled “SpendBudgetStatus”](#spendbudgetstatus) > **SpendBudgetStatus**: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` ##### Description [Section titled “Description”](#description-113) Status of the Budget e.g. ACTIVE. #### SpendLimit [Section titled “SpendLimit”](#spendlimit) > **SpendLimit**: `object` ##### SpendLimit.account\_id [Section titled “SpendLimit.account\_id”](#spendlimitaccount_id) > **account\_id**: `string` ###### Description [Section titled “Description”](#description-114) The Brex account this Spend Limit belongs to. ##### SpendLimit.authorization\_settings? [Section titled “SpendLimit.authorization\_settings?”](#spendlimitauthorization_settings) > `optional` **authorization\_settings?**: { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-7) ###### Type Literal [Section titled “Type Literal”](#type-literal-7) { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } ###### authorization\_type [Section titled “authorization\_type”](#authorization_type) > **authorization\_type**: `"HARD"` | `"SOFT"` ###### base\_limit [Section titled “base\_limit”](#base_limit) > **base\_limit**: `object` ###### base\_limit.amount [Section titled “base\_limit.amount”](#base_limitamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-115) 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 [Section titled “Example”](#example-28) ```ts 700 ``` ###### base\_limit.currency [Section titled “base\_limit.currency”](#base_limitcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-116) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-14) ```ts USD ``` ###### Example [Section titled “Example”](#example-29) ```ts USD ``` ###### limit\_buffer\_percentage? [Section titled “limit\_buffer\_percentage?”](#limit_buffer_percentage) > `optional` **limit\_buffer\_percentage?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-117) The percentage of flexible buffer on the limit as a 0-100 integer. ###### limit\_with\_increases [Section titled “limit\_with\_increases”](#limit_with_increases) > **limit\_with\_increases**: `object` ###### limit\_with\_increases.amount [Section titled “limit\_with\_increases.amount”](#limit_with_increasesamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-118) 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 [Section titled “Example”](#example-30) ```ts 700 ``` ###### limit\_with\_increases.currency [Section titled “limit\_with\_increases.currency”](#limit_with_increasescurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-119) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-15) ```ts USD ``` ###### Example [Section titled “Example”](#example-31) ```ts USD ``` ###### rollover\_refresh\_rate [Section titled “rollover\_refresh\_rate”](#rollover_refresh_rate) > **rollover\_refresh\_rate**: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` *** `null` ##### SpendLimit.authorization\_visibility [Section titled “SpendLimit.authorization\_visibility”](#spendlimitauthorization_visibility) > **authorization\_visibility**: `"PUBLIC"` | `"PRIVATE"` ##### SpendLimit.auto\_create\_limit\_cards\_setting [Section titled “SpendLimit.auto\_create\_limit\_cards\_setting”](#spendlimitauto_create_limit_cards_setting) > **auto\_create\_limit\_cards\_setting**: `"DISABLED"` | `"ALL_MEMBERS"` ##### SpendLimit.auto\_transfer\_cards\_setting [Section titled “SpendLimit.auto\_transfer\_cards\_setting”](#spendlimitauto_transfer_cards_setting) > **auto\_transfer\_cards\_setting**: `"DISABLED"` | `"ENABLED"` ##### SpendLimit.current\_period\_balance? [Section titled “SpendLimit.current\_period\_balance?”](#spendlimitcurrent_period_balance) > `optional` **current\_period\_balance?**: { `amount_spent?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-8) ###### Type Literal [Section titled “Type Literal”](#type-literal-8) { `amount_spent?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } ###### amount\_spent? [Section titled “amount\_spent?”](#amount_spent) > `optional` **amount\_spent?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-9) ###### Type Literal [Section titled “Type Literal”](#type-literal-9) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-6) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-120) 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 [Section titled “Example”](#example-32) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-6) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-121) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-16) ```ts USD ``` ###### Example [Section titled “Example”](#example-33) ```ts USD ``` *** `null` ###### end\_date? [Section titled “end\_date?”](#end_date-1) > `optional` **end\_date?**: `string` | `null` Format: date ###### end\_time? [Section titled “end\_time?”](#end_time) > `optional` **end\_time?**: `string` | `null` Format: date-time ###### rollover\_amount? [Section titled “rollover\_amount?”](#rollover_amount) > `optional` **rollover\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-10) ###### Type Literal [Section titled “Type Literal”](#type-literal-10) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-7) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-122) 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 [Section titled “Example”](#example-34) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-7) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-123) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-17) ```ts USD ``` ###### Example [Section titled “Example”](#example-35) ```ts USD ``` *** `null` ###### start\_date? [Section titled “start\_date?”](#start_date-1) > `optional` **start\_date?**: `string` | `null` Format: date ###### start\_time? [Section titled “start\_time?”](#start_time) > `optional` **start\_time?**: `string` | `null` Format: date-time *** `null` ##### SpendLimit.department\_id? [Section titled “SpendLimit.department\_id?”](#spendlimitdepartment_id) > `optional` **department\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-124) The department ID to which Spend Limit expenses will be attributed. ##### SpendLimit.description? [Section titled “SpendLimit.description?”](#spendlimitdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-125) Description of what the Spend Limit is used for. ##### SpendLimit.end\_date? [Section titled “SpendLimit.end\_date?”](#spendlimitend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-126) The date when the Spend Limit should expire. ##### SpendLimit.end\_time\_utc? [Section titled “SpendLimit.end\_time\_utc?”](#spendlimitend_time_utc) > `optional` **end\_time\_utc?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-127) The UTC time when the Spend Limit should expire. ##### SpendLimit.expense\_policy\_id [Section titled “SpendLimit.expense\_policy\_id”](#spendlimitexpense_policy_id) > **expense\_policy\_id**: `string` ###### Description [Section titled “Description”](#description-128) The ID of the expense policy corresponding to this Spend Limit. ##### SpendLimit.expense\_visibility [Section titled “SpendLimit.expense\_visibility”](#spendlimitexpense_visibility) > **expense\_visibility**: `"PRIVATE"` | `"SHARED"` ##### SpendLimit.id [Section titled “SpendLimit.id”](#spendlimitid) > **id**: `string` ###### Description [Section titled “Description”](#description-129) Unique ID for the Spend Limit. ##### SpendLimit.legal\_entity\_id? [Section titled “SpendLimit.legal\_entity\_id?”](#spendlimitlegal_entity_id) > `optional` **legal\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-130) The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity. ##### SpendLimit.limit\_approval\_policy\_id? [Section titled “SpendLimit.limit\_approval\_policy\_id?”](#spendlimitlimit_approval_policy_id) > `optional` **limit\_approval\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-131) The ID of the policy for limit increase approval requests. Meant to replace limit\_increase\_request\_policy\_id. ##### SpendLimit.limit\_increase\_request\_policy\_id? [Section titled “SpendLimit.limit\_increase\_request\_policy\_id?”](#spendlimitlimit_increase_request_policy_id) > `optional` **limit\_increase\_request\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-132) The ID of the policy for limit increase requests for this Spend Limit. ##### SpendLimit.limit\_increase\_setting [Section titled “SpendLimit.limit\_increase\_setting”](#spendlimitlimit_increase_setting) > **limit\_increase\_setting**: `"DISABLED"` | `"ENABLED"` ##### SpendLimit.member\_user\_ids [Section titled “SpendLimit.member\_user\_ids”](#spendlimitmember_user_ids) > **member\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-133) User IDs of the members of the Spend Limit. ##### SpendLimit.merchant\_category\_controls? [Section titled “SpendLimit.merchant\_category\_controls?”](#spendlimitmerchant_category_controls) > `optional` **merchant\_category\_controls?**: { `allowed_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; `blocked_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; } | `null` ##### SpendLimit.name [Section titled “SpendLimit.name”](#spendlimitname) > **name**: `string` ###### Description [Section titled “Description”](#description-134) Name for the Spend Limit. ##### SpendLimit.owner\_user\_ids [Section titled “SpendLimit.owner\_user\_ids”](#spendlimitowner_user_ids) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-135) User IDs of the owners of the Spend Limit. ##### SpendLimit.parent\_budget\_id? [Section titled “SpendLimit.parent\_budget\_id?”](#spendlimitparent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-136) ID of parent Budget. ##### SpendLimit.period\_recurrence\_type [Section titled “SpendLimit.period\_recurrence\_type”](#spendlimitperiod_recurrence_type) > **period\_recurrence\_type**: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"` ##### SpendLimit.spend\_type [Section titled “SpendLimit.spend\_type”](#spendlimitspend_type) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### SpendLimit.start\_date? [Section titled “SpendLimit.start\_date?”](#spendlimitstart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-137) The date when the Spend Limit should start counting. ##### SpendLimit.start\_time\_utc? [Section titled “SpendLimit.start\_time\_utc?”](#spendlimitstart_time_utc) > `optional` **start\_time\_utc?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-138) The UTC time when the Spend Limit should start counting. ##### SpendLimit.status [Section titled “SpendLimit.status”](#spendlimitstatus) > **status**: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` ##### SpendLimit.transaction\_limit? [Section titled “SpendLimit.transaction\_limit?”](#spendlimittransaction_limit) > `optional` **transaction\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-11) ###### Type Literal [Section titled “Type Literal”](#type-literal-11) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-8) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-139) 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 [Section titled “Example”](#example-36) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-8) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-140) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-18) ```ts USD ``` ###### Example [Section titled “Example”](#example-37) ```ts USD ``` *** `null` #### SpendLimitPeriodBalance [Section titled “SpendLimitPeriodBalance”](#spendlimitperiodbalance) > **SpendLimitPeriodBalance**: `object` ##### SpendLimitPeriodBalance.amount\_spent? [Section titled “SpendLimitPeriodBalance.amount\_spent?”](#spendlimitperiodbalanceamount_spent) > `optional` **amount\_spent?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-12) ###### Type Literal [Section titled “Type Literal”](#type-literal-12) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-9) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-141) 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 [Section titled “Example”](#example-38) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-9) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-142) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-19) ```ts USD ``` ###### Example [Section titled “Example”](#example-39) ```ts USD ``` *** `null` ##### SpendLimitPeriodBalance.end\_date? [Section titled “SpendLimitPeriodBalance.end\_date?”](#spendlimitperiodbalanceend_date) > `optional` **end\_date?**: `string` | `null` Format: date ##### SpendLimitPeriodBalance.end\_time? [Section titled “SpendLimitPeriodBalance.end\_time?”](#spendlimitperiodbalanceend_time) > `optional` **end\_time?**: `string` | `null` Format: date-time ##### SpendLimitPeriodBalance.rollover\_amount? [Section titled “SpendLimitPeriodBalance.rollover\_amount?”](#spendlimitperiodbalancerollover_amount) > `optional` **rollover\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-13) ###### Type Literal [Section titled “Type Literal”](#type-literal-13) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-10) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-143) 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 [Section titled “Example”](#example-40) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-10) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-144) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-20) ```ts USD ``` ###### Example [Section titled “Example”](#example-41) ```ts USD ``` *** `null` ##### SpendLimitPeriodBalance.start\_date? [Section titled “SpendLimitPeriodBalance.start\_date?”](#spendlimitperiodbalancestart_date) > `optional` **start\_date?**: `string` | `null` Format: date ##### SpendLimitPeriodBalance.start\_time? [Section titled “SpendLimitPeriodBalance.start\_time?”](#spendlimitperiodbalancestart_time) > `optional` **start\_time?**: `string` | `null` Format: date-time #### SpendLimitPeriodRecurrenceType [Section titled “SpendLimitPeriodRecurrenceType”](#spendlimitperiodrecurrencetype) > **SpendLimitPeriodRecurrenceType**: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"` ##### Description [Section titled “Description”](#description-145) Period type of the Spend Limit e.g. MONTHLY. #### SpendLimitStatus [Section titled “SpendLimitStatus”](#spendlimitstatus-1) > **SpendLimitStatus**: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` ##### Description [Section titled “Description”](#description-146) Status of the Spend Limit e.g. ACTIVE. #### SpendType [Section titled “SpendType”](#spendtype) > **SpendType**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### Description [Section titled “Description”](#description-147) Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit. #### UpdateAuthorizationSettings [Section titled “UpdateAuthorizationSettings”](#updateauthorizationsettings) > **UpdateAuthorizationSettings**: `object` ##### UpdateAuthorizationSettings.authorization\_type? [Section titled “UpdateAuthorizationSettings.authorization\_type?”](#updateauthorizationsettingsauthorization_type) > `optional` **authorization\_type?**: `"HARD"` | `"SOFT"` | `null` ##### UpdateAuthorizationSettings.base\_limit? [Section titled “UpdateAuthorizationSettings.base\_limit?”](#updateauthorizationsettingsbase_limit) > `optional` **base\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-14) ###### Type Literal [Section titled “Type Literal”](#type-literal-14) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-11) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-148) 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 [Section titled “Example”](#example-42) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-11) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-149) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-21) ```ts USD ``` ###### Example [Section titled “Example”](#example-43) ```ts USD ``` *** `null` ##### UpdateAuthorizationSettings.limit\_buffer\_percentage? [Section titled “UpdateAuthorizationSettings.limit\_buffer\_percentage?”](#updateauthorizationsettingslimit_buffer_percentage) > `optional` **limit\_buffer\_percentage?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-150) The percentage of flexible buffer on the limit as a 0-100 integer. ##### UpdateAuthorizationSettings.rollover\_refresh\_rate? [Section titled “UpdateAuthorizationSettings.rollover\_refresh\_rate?”](#updateauthorizationsettingsrollover_refresh_rate) > `optional` **rollover\_refresh\_rate?**: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `null` #### UpdateBudgetBlueprintRequest [Section titled “UpdateBudgetBlueprintRequest”](#updatebudgetblueprintrequest) > **UpdateBudgetBlueprintRequest**: `object` ##### Description [Section titled “Description”](#description-151) Blueprint for provisioning Spend Limits for a Budget Program. ##### UpdateBudgetBlueprintRequest.description? [Section titled “UpdateBudgetBlueprintRequest.description?”](#updatebudgetblueprintrequestdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-152) Description of what the Spend Limit is used for. ##### UpdateBudgetBlueprintRequest.end\_date? [Section titled “UpdateBudgetBlueprintRequest.end\_date?”](#updatebudgetblueprintrequestend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-153) The UTC date when the Spend Limit should stop counting. ##### UpdateBudgetBlueprintRequest.id? [Section titled “UpdateBudgetBlueprintRequest.id?”](#updatebudgetblueprintrequestid) > `optional` **id?**: `string` | `null` ###### Description [Section titled “Description”](#description-154) ID of budget blueprint to update, omit if adding new budget blueprint to budget program. ##### UpdateBudgetBlueprintRequest.limit? [Section titled “UpdateBudgetBlueprintRequest.limit?”](#updatebudgetblueprintrequestlimit) > `optional` **limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-15) ###### Type Literal [Section titled “Type Literal”](#type-literal-15) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-12) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-155) 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 [Section titled “Example”](#example-44) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-12) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-156) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-22) ```ts USD ``` ###### Example [Section titled “Example”](#example-45) ```ts USD ``` *** `null` ##### UpdateBudgetBlueprintRequest.limit\_type? [Section titled “UpdateBudgetBlueprintRequest.limit\_type?”](#updatebudgetblueprintrequestlimit_type) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` ##### UpdateBudgetBlueprintRequest.name? [Section titled “UpdateBudgetBlueprintRequest.name?”](#updatebudgetblueprintrequestname) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-157) Name for the Spend Limit. ##### UpdateBudgetBlueprintRequest.owner\_user\_ids? [Section titled “UpdateBudgetBlueprintRequest.owner\_user\_ids?”](#updatebudgetblueprintrequestowner_user_ids) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-158) User IDs of the owners of the Spend Limit. ##### UpdateBudgetBlueprintRequest.parent\_budget\_id? [Section titled “UpdateBudgetBlueprintRequest.parent\_budget\_id?”](#updatebudgetblueprintrequestparent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-159) ID of parent Budget. ##### UpdateBudgetBlueprintRequest.period\_type? [Section titled “UpdateBudgetBlueprintRequest.period\_type?”](#updatebudgetblueprintrequestperiod_type) > `optional` **period\_type?**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ##### UpdateBudgetBlueprintRequest.spend\_type? [Section titled “UpdateBudgetBlueprintRequest.spend\_type?”](#updatebudgetblueprintrequestspend_type) > `optional` **spend\_type?**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` | `null` ##### UpdateBudgetBlueprintRequest.start\_date? [Section titled “UpdateBudgetBlueprintRequest.start\_date?”](#updatebudgetblueprintrequeststart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-160) The UTC date when the Spend Limit should start counting. #### UpdateBudgetProgramRequest [Section titled “UpdateBudgetProgramRequest”](#updatebudgetprogramrequest) > **UpdateBudgetProgramRequest**: `object` ##### Description [Section titled “Description”](#description-161) Budget Program used to create Spend Limits for eligible users. ##### UpdateBudgetProgramRequest.budget\_blueprints? [Section titled “UpdateBudgetProgramRequest.budget\_blueprints?”](#updatebudgetprogramrequestbudget_blueprints) > `optional` **budget\_blueprints?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-162) The Blueprints to update the budget program with. Blueprints without an ID are treated as new blueprints to be created. Blueprints that exist currently on the Budget Program, but are missing from the input, will be deleted. ##### UpdateBudgetProgramRequest.description? [Section titled “UpdateBudgetProgramRequest.description?”](#updatebudgetprogramrequestdescription) > `optional` **description?**: `string` | `null` ##### UpdateBudgetProgramRequest.employee\_filter? [Section titled “UpdateBudgetProgramRequest.employee\_filter?”](#updatebudgetprogramrequestemployee_filter) > `optional` **employee\_filter?**: { `employment_status?`: `"EMPLOYMENT_STATUS_ACTIVE"` | `"EMPLOYMENT_STATUS_INACTIVE"` | `"EMPLOYMENT_STATUS_PENDING"` | `null`; `employment_type?`: `"EMPLOYMENT_TYPE_FULL_TIME"` | `"EMPLOYMENT_TYPE_PART_TIME"` | `"EMPLOYMENT_TYPE_CONTRACTOR"` | `"EMPLOYMENT_TYPE_INTERN"` | `"EMPLOYMENT_TYPE_FREELANCE"` | `null`; } | `null` ##### UpdateBudgetProgramRequest.existing\_budget\_ids? [Section titled “UpdateBudgetProgramRequest.existing\_budget\_ids?”](#updatebudgetprogramrequestexisting_budget_ids) > `optional` **existing\_budget\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-163) IDs for existing Spend Limits associated with this Budget Program. ##### UpdateBudgetProgramRequest.name? [Section titled “UpdateBudgetProgramRequest.name?”](#updatebudgetprogramrequestname) > `optional` **name?**: `string` | `null` #### UpdateBudgetRequest [Section titled “UpdateBudgetRequest”](#updatebudgetrequest) > **UpdateBudgetRequest**: `object` ##### UpdateBudgetRequest.description? [Section titled “UpdateBudgetRequest.description?”](#updatebudgetrequestdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-164) Description of what the Spend Limit is used for. ##### UpdateBudgetRequest.end\_date? [Section titled “UpdateBudgetRequest.end\_date?”](#updatebudgetrequestend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-165) The UTC date when the Spend Limit should stop counting. ##### UpdateBudgetRequest.limit? [Section titled “UpdateBudgetRequest.limit?”](#updatebudgetrequestlimit) > `optional` **limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-16) ###### Type Literal [Section titled “Type Literal”](#type-literal-16) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-13) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-166) 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 [Section titled “Example”](#example-46) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-13) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-167) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-23) ```ts USD ``` ###### Example [Section titled “Example”](#example-47) ```ts USD ``` *** `null` ##### UpdateBudgetRequest.limit\_type? [Section titled “UpdateBudgetRequest.limit\_type?”](#updatebudgetrequestlimit_type) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` ##### UpdateBudgetRequest.limit\_visibility? [Section titled “UpdateBudgetRequest.limit\_visibility?”](#updatebudgetrequestlimit_visibility) > `optional` **limit\_visibility?**: `"PRIVATE"` | `"SHARED"` | `null` ##### UpdateBudgetRequest.member\_user\_ids? [Section titled “UpdateBudgetRequest.member\_user\_ids?”](#updatebudgetrequestmember_user_ids) > `optional` **member\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-168) User IDs of the members of the Spend Limit. ##### UpdateBudgetRequest.name? [Section titled “UpdateBudgetRequest.name?”](#updatebudgetrequestname) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-169) Name for the Spend Limit. ##### UpdateBudgetRequest.owner\_user\_ids? [Section titled “UpdateBudgetRequest.owner\_user\_ids?”](#updatebudgetrequestowner_user_ids) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-170) User IDs of the owners of the Spend Limit. ##### UpdateBudgetRequest.period\_type? [Section titled “UpdateBudgetRequest.period\_type?”](#updatebudgetrequestperiod_type) > `optional` **period\_type?**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ##### UpdateBudgetRequest.spend\_type? [Section titled “UpdateBudgetRequest.spend\_type?”](#updatebudgetrequestspend_type) > `optional` **spend\_type?**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` | `null` ##### UpdateBudgetRequest.start\_date? [Section titled “UpdateBudgetRequest.start\_date?”](#updatebudgetrequeststart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-171) The UTC date when the Spend Limit should start counting. #### UpdateSpendBudgetRequest [Section titled “UpdateSpendBudgetRequest”](#updatespendbudgetrequest) > **UpdateSpendBudgetRequest**: `object` ##### UpdateSpendBudgetRequest.amount? [Section titled “UpdateSpendBudgetRequest.amount?”](#updatespendbudgetrequestamount) > `optional` **amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-17) ###### Type Literal [Section titled “Type Literal”](#type-literal-17) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-14) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-172) 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 [Section titled “Example”](#example-48) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-14) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-173) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-24) ```ts USD ``` ###### Example [Section titled “Example”](#example-49) ```ts USD ``` *** `null` ##### UpdateSpendBudgetRequest.description? [Section titled “UpdateSpendBudgetRequest.description?”](#updatespendbudgetrequestdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-174) Description of what the Budget is used for. ##### UpdateSpendBudgetRequest.end\_date? [Section titled “UpdateSpendBudgetRequest.end\_date?”](#updatespendbudgetrequestend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-175) The date when the Budget should stop counting. ##### UpdateSpendBudgetRequest.limit\_type? [Section titled “UpdateSpendBudgetRequest.limit\_type?”](#updatespendbudgetrequestlimit_type) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` Deprecated This API is no longer supported and may be removed in a future release. ##### UpdateSpendBudgetRequest.name? [Section titled “UpdateSpendBudgetRequest.name?”](#updatespendbudgetrequestname) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-176) Name for the Budget. ##### UpdateSpendBudgetRequest.owner\_user\_ids? [Section titled “UpdateSpendBudgetRequest.owner\_user\_ids?”](#updatespendbudgetrequestowner_user_ids) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-177) User IDs of the owners of the Budget. ##### UpdateSpendBudgetRequest.parent\_budget\_id? [Section titled “UpdateSpendBudgetRequest.parent\_budget\_id?”](#updatespendbudgetrequestparent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-178) ID of parent Budget. ##### UpdateSpendBudgetRequest.period\_recurrence\_type? [Section titled “UpdateSpendBudgetRequest.period\_recurrence\_type?”](#updatespendbudgetrequestperiod_recurrence_type) > `optional` **period\_recurrence\_type?**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ##### UpdateSpendBudgetRequest.start\_date? [Section titled “UpdateSpendBudgetRequest.start\_date?”](#updatespendbudgetrequeststart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-179) The date when the Budget should start counting. #### UpdateSpendLimitRequest [Section titled “UpdateSpendLimitRequest”](#updatespendlimitrequest) > **UpdateSpendLimitRequest**: `object` ##### UpdateSpendLimitRequest.authorization\_settings? [Section titled “UpdateSpendLimitRequest.authorization\_settings?”](#updatespendlimitrequestauthorization_settings) > `optional` **authorization\_settings?**: { `authorization_type?`: `"HARD"` | `"SOFT"` | `null`; `base_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `limit_buffer_percentage?`: `number` | `null`; `rollover_refresh_rate?`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-18) ###### Type Literal [Section titled “Type Literal”](#type-literal-18) { `authorization_type?`: `"HARD"` | `"SOFT"` | `null`; `base_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `limit_buffer_percentage?`: `number` | `null`; `rollover_refresh_rate?`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `null`; } ###### authorization\_type? [Section titled “authorization\_type?”](#authorization_type-1) > `optional` **authorization\_type?**: `"HARD"` | `"SOFT"` | `null` ###### base\_limit? [Section titled “base\_limit?”](#base_limit-1) > `optional` **base\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-19) ###### Type Literal [Section titled “Type Literal”](#type-literal-19) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-15) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-180) 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 [Section titled “Example”](#example-50) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-15) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-181) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-25) ```ts USD ``` ###### Example [Section titled “Example”](#example-51) ```ts USD ``` *** `null` ###### limit\_buffer\_percentage? [Section titled “limit\_buffer\_percentage?”](#limit_buffer_percentage-1) > `optional` **limit\_buffer\_percentage?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-182) The percentage of flexible buffer on the limit as a 0-100 integer. ###### rollover\_refresh\_rate? [Section titled “rollover\_refresh\_rate?”](#rollover_refresh_rate-1) > `optional` **rollover\_refresh\_rate?**: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `null` *** `null` ##### UpdateSpendLimitRequest.authorization\_visibility? [Section titled “UpdateSpendLimitRequest.authorization\_visibility?”](#updatespendlimitrequestauthorization_visibility) > `optional` **authorization\_visibility?**: `"PUBLIC"` | `"PRIVATE"` | `null` ##### UpdateSpendLimitRequest.auto\_create\_limit\_cards\_setting? [Section titled “UpdateSpendLimitRequest.auto\_create\_limit\_cards\_setting?”](#updatespendlimitrequestauto_create_limit_cards_setting) > `optional` **auto\_create\_limit\_cards\_setting?**: `"DISABLED"` | `"ALL_MEMBERS"` | `null` ##### UpdateSpendLimitRequest.auto\_transfer\_cards\_setting? [Section titled “UpdateSpendLimitRequest.auto\_transfer\_cards\_setting?”](#updatespendlimitrequestauto_transfer_cards_setting) > `optional` **auto\_transfer\_cards\_setting?**: `"DISABLED"` | `"ENABLED"` | `null` ##### UpdateSpendLimitRequest.department\_id? [Section titled “UpdateSpendLimitRequest.department\_id?”](#updatespendlimitrequestdepartment_id) > `optional` **department\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-183) The department ID to which Spend Limit expenses will be attributed. ##### UpdateSpendLimitRequest.description? [Section titled “UpdateSpendLimitRequest.description?”](#updatespendlimitrequestdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-184) Description of what the Spend Limit is used for. ##### UpdateSpendLimitRequest.end\_date? [Section titled “UpdateSpendLimitRequest.end\_date?”](#updatespendlimitrequestend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-185) The date when the Spend Limit should expire. ##### UpdateSpendLimitRequest.expense\_policy\_id? [Section titled “UpdateSpendLimitRequest.expense\_policy\_id?”](#updatespendlimitrequestexpense_policy_id) > `optional` **expense\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-186) The ID of the expense policy corresponding to this Spend Limit. ##### UpdateSpendLimitRequest.expense\_visibility? [Section titled “UpdateSpendLimitRequest.expense\_visibility?”](#updatespendlimitrequestexpense_visibility) > `optional` **expense\_visibility?**: `"PRIVATE"` | `"SHARED"` | `null` ##### UpdateSpendLimitRequest.legal\_entity\_id? [Section titled “UpdateSpendLimitRequest.legal\_entity\_id?”](#updatespendlimitrequestlegal_entity_id) > `optional` **legal\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-187) The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity. ##### UpdateSpendLimitRequest.limit\_approval\_policy\_id? [Section titled “UpdateSpendLimitRequest.limit\_approval\_policy\_id?”](#updatespendlimitrequestlimit_approval_policy_id) > `optional` **limit\_approval\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-188) The ID of the policy for limit increase approval requests. Meant to replace limit\_increase\_request\_policy\_id. ##### UpdateSpendLimitRequest.limit\_increase\_request\_policy\_id? [Section titled “UpdateSpendLimitRequest.limit\_increase\_request\_policy\_id?”](#updatespendlimitrequestlimit_increase_request_policy_id) > `optional` **limit\_increase\_request\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-189) The ID of the policy for limit increase requests for this Spend Limit. ##### UpdateSpendLimitRequest.limit\_increase\_setting? [Section titled “UpdateSpendLimitRequest.limit\_increase\_setting?”](#updatespendlimitrequestlimit_increase_setting) > `optional` **limit\_increase\_setting?**: `"DISABLED"` | `"ENABLED"` | `null` ##### UpdateSpendLimitRequest.member\_user\_ids? [Section titled “UpdateSpendLimitRequest.member\_user\_ids?”](#updatespendlimitrequestmember_user_ids) > `optional` **member\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-190) User IDs of the members of the Spend Limit. ##### UpdateSpendLimitRequest.merchant\_category\_controls? [Section titled “UpdateSpendLimitRequest.merchant\_category\_controls?”](#updatespendlimitrequestmerchant_category_controls) > `optional` **merchant\_category\_controls?**: { `allowed_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; `blocked_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; } | `null` ##### UpdateSpendLimitRequest.name? [Section titled “UpdateSpendLimitRequest.name?”](#updatespendlimitrequestname) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-191) Name for the Spend Limit. ##### UpdateSpendLimitRequest.owner\_user\_ids? [Section titled “UpdateSpendLimitRequest.owner\_user\_ids?”](#updatespendlimitrequestowner_user_ids) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-192) User IDs of the owners of the Spend Limit. ##### UpdateSpendLimitRequest.period\_recurrence\_type? [Section titled “UpdateSpendLimitRequest.period\_recurrence\_type?”](#updatespendlimitrequestperiod_recurrence_type) > `optional` **period\_recurrence\_type?**: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"` | `null` ##### UpdateSpendLimitRequest.set\_end\_date\_null? [Section titled “UpdateSpendLimitRequest.set\_end\_date\_null?”](#updatespendlimitrequestset_end_date_null) > `optional` **set\_end\_date\_null?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-193) Set the date when the Spend Limit should expire to null. ##### UpdateSpendLimitRequest.set\_start\_date\_null? [Section titled “UpdateSpendLimitRequest.set\_start\_date\_null?”](#updatespendlimitrequestset_start_date_null) > `optional` **set\_start\_date\_null?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-194) Set the date when the Spend Limit should start counting to null. ##### UpdateSpendLimitRequest.set\_transaction\_limit\_null? [Section titled “UpdateSpendLimitRequest.set\_transaction\_limit\_null?”](#updatespendlimitrequestset_transaction_limit_null) > `optional` **set\_transaction\_limit\_null?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-195) Set the transaction limit that this Spend Limit will enforce to null. ##### UpdateSpendLimitRequest.spend\_type? [Section titled “UpdateSpendLimitRequest.spend\_type?”](#updatespendlimitrequestspend_type) > `optional` **spend\_type?**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` | `null` ##### UpdateSpendLimitRequest.start\_date? [Section titled “UpdateSpendLimitRequest.start\_date?”](#updatespendlimitrequeststart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-196) The date when the Spend Limit should start counting. ##### UpdateSpendLimitRequest.status? [Section titled “UpdateSpendLimitRequest.status?”](#updatespendlimitrequeststatus) > `optional` **status?**: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` | `null` ##### UpdateSpendLimitRequest.transaction\_limit? [Section titled “UpdateSpendLimitRequest.transaction\_limit?”](#updatespendlimitrequesttransaction_limit) > `optional` **transaction\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-20) ###### Type Literal [Section titled “Type Literal”](#type-literal-20) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-16) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-197) 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 [Section titled “Example”](#example-52) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-16) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-198) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-26) ```ts USD ``` ###### Example [Section titled “Example”](#example-53) ```ts USD ``` *** `null` # BudgetsPaths Defined in: [src/budgets/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L2) ## Properties [Section titled “Properties”](#properties) ### /v1/budget\_programs [Section titled “/v1/budget\_programs”](#v1budget_programs) > **/v1/budget\_programs**: `object` Defined in: [src/budgets/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L3) #### delete? [Section titled “delete?”](#delete) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get) > **get**: `object` List Budget Programs ##### Description [Section titled “Description”](#description) Lists Budget Programs belonging to this account ##### get.parameters [Section titled “get.parameters”](#getparameters) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit) > `optional` **limit?**: `number` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-1) A page with a list of Budget Programs ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-2) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-1) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-3) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-2) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-4) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-3) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace) > `optional` **trace?**: `undefined` *** ### /v1/budget\_programs/{id} [Section titled “/v1/budget\_programs/{id}”](#v1budget_programsid) > **/v1/budget\_programs/{id}**: `object` Defined in: [src/budgets/types.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L23) #### delete? [Section titled “delete?”](#delete-1) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-1) > **get**: `object` Get Budget Program ##### Description [Section titled “Description”](#description-5) Retrieves a Budget Program by ID ##### get.parameters [Section titled “get.parameters”](#getparameters-1) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-1) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-1) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-1) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-1) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-1) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-1) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-6) The Budget Program that was retrieved ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-1) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-1) > **application/json**: `object` ##### get.responses.200.content.application/json.budget\_blueprints [Section titled “get.responses.200.content.application/json.budget\_blueprints”](#getresponses200contentapplicationjsonbudget_blueprints) > **budget\_blueprints**: `object`\[] ##### get.responses.200.content.application/json.budget\_program\_status [Section titled “get.responses.200.content.application/json.budget\_program\_status”](#getresponses200contentapplicationjsonbudget_program_status) > **budget\_program\_status**: `"BUDGET_PROGRAM_STATUS_ACTIVE"` | `"BUDGET_PROGRAM_STATUS_INACTIVE"` | `"BUDGET_PROGRAM_STATUS_DELETED"` ##### get.responses.200.content.application/json.created\_at [Section titled “get.responses.200.content.application/json.created\_at”](#getresponses200contentapplicationjsoncreated_at) > **created\_at**: `string` Format: date ##### get.responses.200.content.application/json.creator\_user\_id? [Section titled “get.responses.200.content.application/json.creator\_user\_id?”](#getresponses200contentapplicationjsoncreator_user_id) > `optional` **creator\_user\_id?**: `string` | `null` ##### get.responses.200.content.application/json.description? [Section titled “get.responses.200.content.application/json.description?”](#getresponses200contentapplicationjsondescription) > `optional` **description?**: `string` | `null` ##### get.responses.200.content.application/json.employee\_filter? [Section titled “get.responses.200.content.application/json.employee\_filter?”](#getresponses200contentapplicationjsonemployee_filter) > `optional` **employee\_filter?**: { `employment_status?`: `"EMPLOYMENT_STATUS_ACTIVE"` | `"EMPLOYMENT_STATUS_INACTIVE"` | `"EMPLOYMENT_STATUS_PENDING"` | `null`; `employment_type?`: `"EMPLOYMENT_TYPE_FULL_TIME"` | `"EMPLOYMENT_TYPE_PART_TIME"` | `"EMPLOYMENT_TYPE_CONTRACTOR"` | `"EMPLOYMENT_TYPE_INTERN"` | `"EMPLOYMENT_TYPE_FREELANCE"` | `null`; } | `null` ##### get.responses.200.content.application/json.existing\_budget\_ids? [Section titled “get.responses.200.content.application/json.existing\_budget\_ids?”](#getresponses200contentapplicationjsonexisting_budget_ids) > `optional` **existing\_budget\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-7) IDs for existing Spend Limits associated with this Budget Program. ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid) > **id**: `string` ##### get.responses.200.content.application/json.name [Section titled “get.responses.200.content.application/json.name”](#getresponses200contentapplicationjsonname) > **name**: `string` ##### get.responses.200.content.application/json.updated\_at [Section titled “get.responses.200.content.application/json.updated\_at”](#getresponses200contentapplicationjsonupdated_at) > **updated\_at**: `string` Format: date ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-4) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-8) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-1) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-5) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-9) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-1) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-6) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-10) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-1) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-7) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-11) Not Found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-8) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-1) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-1) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-1) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-1) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-1) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-1) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-1) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-1) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-1) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-1) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-1) > `optional` **trace?**: `undefined` *** ### /v1/budgets [Section titled “/v1/budgets”](#v1budgets) > **/v1/budgets**: `object` Defined in: [src/budgets/types.gen.ts:43](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L43) #### delete? [Section titled “delete?”](#delete-2) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-2) > **get**: `object` List Spend Limits ##### Description [Section titled “Description”](#description-12) Lists Spend Limits belonging to this account ##### get.parameters [Section titled “get.parameters”](#getparameters-2) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-2) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-2) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-2) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-2) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-1) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-1) > `optional` **limit?**: `number` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-2) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-2) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-13) A page with a list of Spend Limits ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-2) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-2) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-1) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-1) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-9) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-2) > **400**: `object` ###### Description [Section titled “Description”](#description-14) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-2) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-10) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-2) > **401**: `object` ###### Description [Section titled “Description”](#description-15) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-2) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-11) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-2) > **403**: `object` ###### Description [Section titled “Description”](#description-16) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-2) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-12) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-2) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-2) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-2) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-2) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-2) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-2) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-2) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-2) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-2) > **post**: `object` Create Spend Limit ##### Description [Section titled “Description”](#description-17) Creates a Spend Limit ##### post.parameters [Section titled “post.parameters”](#postparameters) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie) > `optional` **cookie?**: `undefined` ##### post.parameters.header [Section titled “post.parameters.header”](#postparametersheader) > **header**: `object` ##### post.parameters.header.Idempotency-Key [Section titled “post.parameters.header.Idempotency-Key”](#postparametersheaderidempotency-key) > **Idempotency-Key**: `string` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson) > **application/json**: `object` ##### post.requestBody.content.application/json.description [Section titled “post.requestBody.content.application/json.description”](#postrequestbodycontentapplicationjsondescription) > **description**: `string` ###### Description [Section titled “Description”](#description-18) Description of what the Spend Limit is used for. ##### post.requestBody.content.application/json.end\_date? [Section titled “post.requestBody.content.application/json.end\_date?”](#postrequestbodycontentapplicationjsonend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-19) The UTC date when the Spend Limit should stop counting. ##### post.requestBody.content.application/json.entity\_id? [Section titled “post.requestBody.content.application/json.entity\_id?”](#postrequestbodycontentapplicationjsonentity_id) > `optional` **entity\_id?**: `string` | `null` ##### post.requestBody.content.application/json.limit [Section titled “post.requestBody.content.application/json.limit”](#postrequestbodycontentapplicationjsonlimit) > **limit**: `object` ##### post.requestBody.content.application/json.limit.amount [Section titled “post.requestBody.content.application/json.limit.amount”](#postrequestbodycontentapplicationjsonlimitamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-20) 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 [Section titled “Example”](#example) ```ts 700 ``` ##### post.requestBody.content.application/json.limit.currency [Section titled “post.requestBody.content.application/json.limit.currency”](#postrequestbodycontentapplicationjsonlimitcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-21) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default) ```ts USD ``` ###### Example [Section titled “Example”](#example-1) ```ts USD ``` ##### post.requestBody.content.application/json.limit\_type [Section titled “post.requestBody.content.application/json.limit\_type”](#postrequestbodycontentapplicationjsonlimit_type) > **limit\_type**: `"HARD"` | `"SOFT"` ##### post.requestBody.content.application/json.limit\_visibility [Section titled “post.requestBody.content.application/json.limit\_visibility”](#postrequestbodycontentapplicationjsonlimit_visibility) > **limit\_visibility**: `"PRIVATE"` | `"SHARED"` ##### post.requestBody.content.application/json.member\_user\_ids? [Section titled “post.requestBody.content.application/json.member\_user\_ids?”](#postrequestbodycontentapplicationjsonmember_user_ids) > `optional` **member\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-22) User IDs of the members of the Spend Limit. ##### post.requestBody.content.application/json.name [Section titled “post.requestBody.content.application/json.name”](#postrequestbodycontentapplicationjsonname) > **name**: `string` ###### Description [Section titled “Description”](#description-23) Name for the Spend Limit. ##### post.requestBody.content.application/json.owner\_user\_ids? [Section titled “post.requestBody.content.application/json.owner\_user\_ids?”](#postrequestbodycontentapplicationjsonowner_user_ids) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-24) User IDs of the owners of the Spend Limit. ##### post.requestBody.content.application/json.parent\_budget\_id [Section titled “post.requestBody.content.application/json.parent\_budget\_id”](#postrequestbodycontentapplicationjsonparent_budget_id) > **parent\_budget\_id**: `string` ###### Description [Section titled “Description”](#description-25) ID of parent Budget. ##### post.requestBody.content.application/json.period\_type [Section titled “post.requestBody.content.application/json.period\_type”](#postrequestbodycontentapplicationjsonperiod_type) > **period\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### post.requestBody.content.application/json.policy\_id? [Section titled “post.requestBody.content.application/json.policy\_id?”](#postrequestbodycontentapplicationjsonpolicy_id) > `optional` **policy\_id?**: `string` | `null` ##### post.requestBody.content.application/json.spend\_type [Section titled “post.requestBody.content.application/json.spend\_type”](#postrequestbodycontentapplicationjsonspend_type) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### post.requestBody.content.application/json.start\_date? [Section titled “post.requestBody.content.application/json.start\_date?”](#postrequestbodycontentapplicationjsonstart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-26) The UTC date when the Spend Limit should start counting. ##### post.responses [Section titled “post.responses”](#postresponses) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-27) The Spend Limit that was created ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson) > **application/json**: `object` ##### post.responses.200.content.application/json.account\_id [Section titled “post.responses.200.content.application/json.account\_id”](#postresponses200contentapplicationjsonaccount_id) > **account\_id**: `string` ###### Description [Section titled “Description”](#description-28) The Brex account this Spend Limit belongs to. ##### post.responses.200.content.application/json.budget\_id [Section titled “post.responses.200.content.application/json.budget\_id”](#postresponses200contentapplicationjsonbudget_id) > **budget\_id**: `string` ###### Description [Section titled “Description”](#description-29) Unique ID for the Spend Limit. ##### post.responses.200.content.application/json.budget\_status [Section titled “post.responses.200.content.application/json.budget\_status”](#postresponses200contentapplicationjsonbudget_status) > **budget\_status**: `"DELETED"` | `"APPROVED"` | `"EXPIRED"` | `"TERMINATED"` ##### post.responses.200.content.application/json.budget\_type [Section titled “post.responses.200.content.application/json.budget\_type”](#postresponses200contentapplicationjsonbudget_type) > **budget\_type**: `"BUDGET"` | `"SPEND_LIMIT"` ##### post.responses.200.content.application/json.creator\_user\_id? [Section titled “post.responses.200.content.application/json.creator\_user\_id?”](#postresponses200contentapplicationjsoncreator_user_id) > `optional` **creator\_user\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-30) The ID of the user who originally created this Spend Limit. ##### post.responses.200.content.application/json.current\_period\_balance? [Section titled “post.responses.200.content.application/json.current\_period\_balance?”](#postresponses200contentapplicationjsoncurrent_period_balance) > `optional` **current\_period\_balance?**: { `balance?`: { `amount`: `number`; `currency`: … | …; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `balance?`: { `amount`: `number`; `currency`: … | …; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } ###### balance? [Section titled “balance?”](#balance) > `optional` **balance?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-31) 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 [Section titled “Example”](#example-2) ```ts 700 ``` ###### currency [Section titled “currency”](#currency) > **currency**: … | … ###### Description [Section titled “Description”](#description-32) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-1) ```ts USD ``` ###### Example [Section titled “Example”](#example-3) ```ts USD ``` *** `null` ###### end\_date? [Section titled “end\_date?”](#end_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### start\_date? [Section titled “start\_date?”](#start_date) > `optional` **start\_date?**: `string` | `null` Format: date *** `null` ##### post.responses.200.content.application/json.description? [Section titled “post.responses.200.content.application/json.description?”](#postresponses200contentapplicationjsondescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-33) Description of what the Spend Limit is used for. ##### post.responses.200.content.application/json.end\_date? [Section titled “post.responses.200.content.application/json.end\_date?”](#postresponses200contentapplicationjsonend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-34) The UTC date when the Spend Limit should stop counting. ##### post.responses.200.content.application/json.limit? [Section titled “post.responses.200.content.application/json.limit?”](#postresponses200contentapplicationjsonlimit) > `optional` **limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-35) 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 [Section titled “Example”](#example-4) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-36) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-2) ```ts USD ``` ###### Example [Section titled “Example”](#example-5) ```ts USD ``` *** `null` ##### post.responses.200.content.application/json.limit\_type? [Section titled “post.responses.200.content.application/json.limit\_type?”](#postresponses200contentapplicationjsonlimit_type) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` ##### post.responses.200.content.application/json.limit\_visibility [Section titled “post.responses.200.content.application/json.limit\_visibility”](#postresponses200contentapplicationjsonlimit_visibility) > **limit\_visibility**: `"PRIVATE"` | `"SHARED"` ##### post.responses.200.content.application/json.member\_user\_ids [Section titled “post.responses.200.content.application/json.member\_user\_ids”](#postresponses200contentapplicationjsonmember_user_ids) > **member\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-37) User IDs of the members of the Spend Limit. ##### post.responses.200.content.application/json.name [Section titled “post.responses.200.content.application/json.name”](#postresponses200contentapplicationjsonname) > **name**: `string` ###### Description [Section titled “Description”](#description-38) Name for the Spend Limit. ##### post.responses.200.content.application/json.owner\_user\_ids [Section titled “post.responses.200.content.application/json.owner\_user\_ids”](#postresponses200contentapplicationjsonowner_user_ids) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-39) User IDs of the owners of the Spend Limit. ##### post.responses.200.content.application/json.parent\_budget\_id? [Section titled “post.responses.200.content.application/json.parent\_budget\_id?”](#postresponses200contentapplicationjsonparent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-40) ID of parent Budget. ##### post.responses.200.content.application/json.period\_type [Section titled “post.responses.200.content.application/json.period\_type”](#postresponses200contentapplicationjsonperiod_type) > **period\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### post.responses.200.content.application/json.spend\_type [Section titled “post.responses.200.content.application/json.spend\_type”](#postresponses200contentapplicationjsonspend_type) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### post.responses.200.content.application/json.start\_date? [Section titled “post.responses.200.content.application/json.start\_date?”](#postresponses200contentapplicationjsonstart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-41) The UTC date when the Spend Limit should start counting. ##### post.responses.200.content.application/json.templateId? [Section titled “post.responses.200.content.application/json.templateId?”](#postresponses200contentapplicationjsontemplateid) > `optional` **templateId?**: `string` | `null` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-13) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-42) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-14) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-43) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-15) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-44) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-16) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-2) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-2) > `optional` **trace?**: `undefined` *** ### /v1/budgets/{id} [Section titled “/v1/budgets/{id}”](#v1budgetsid) > **/v1/budgets/{id}**: `object` Defined in: [src/budgets/types.gen.ts:67](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L67) #### delete? [Section titled “delete?”](#delete-3) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-3) > **get**: `object` Get Spend Limit ##### Description [Section titled “Description”](#description-45) Retrieves a Spend Limit by ID ##### get.parameters [Section titled “get.parameters”](#getparameters-3) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-3) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-3) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-3) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-1) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-3) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-3) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-3) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-3) > **200**: `object` ###### Description [Section titled “Description”](#description-46) The Spend Limit that was retrieved ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-3) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-3) > **application/json**: `object` ##### get.responses.200.content.application/json.account\_id [Section titled “get.responses.200.content.application/json.account\_id”](#getresponses200contentapplicationjsonaccount_id) > **account\_id**: `string` ###### Description [Section titled “Description”](#description-47) The Brex account this Spend Limit belongs to. ##### get.responses.200.content.application/json.budget\_id [Section titled “get.responses.200.content.application/json.budget\_id”](#getresponses200contentapplicationjsonbudget_id) > **budget\_id**: `string` ###### Description [Section titled “Description”](#description-48) Unique ID for the Spend Limit. ##### get.responses.200.content.application/json.budget\_status [Section titled “get.responses.200.content.application/json.budget\_status”](#getresponses200contentapplicationjsonbudget_status) > **budget\_status**: `"DELETED"` | `"APPROVED"` | `"EXPIRED"` | `"TERMINATED"` ##### get.responses.200.content.application/json.budget\_type [Section titled “get.responses.200.content.application/json.budget\_type”](#getresponses200contentapplicationjsonbudget_type) > **budget\_type**: `"BUDGET"` | `"SPEND_LIMIT"` ##### get.responses.200.content.application/json.creator\_user\_id? [Section titled “get.responses.200.content.application/json.creator\_user\_id?”](#getresponses200contentapplicationjsoncreator_user_id-1) > `optional` **creator\_user\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-49) The ID of the user who originally created this Spend Limit. ##### get.responses.200.content.application/json.current\_period\_balance? [Section titled “get.responses.200.content.application/json.current\_period\_balance?”](#getresponses200contentapplicationjsoncurrent_period_balance) > `optional` **current\_period\_balance?**: { `balance?`: { `amount`: `number`; `currency`: … | …; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-3) ###### Type Literal [Section titled “Type Literal”](#type-literal-3) { `balance?`: { `amount`: `number`; `currency`: … | …; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } ###### balance? [Section titled “balance?”](#balance-1) > `optional` **balance?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-4) ###### Type Literal [Section titled “Type Literal”](#type-literal-4) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-2) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-50) 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 [Section titled “Example”](#example-6) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-2) > **currency**: … | … ###### Description [Section titled “Description”](#description-51) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-3) ```ts USD ``` ###### Example [Section titled “Example”](#example-7) ```ts USD ``` *** `null` ###### end\_date? [Section titled “end\_date?”](#end_date-1) > `optional` **end\_date?**: `string` | `null` Format: date ###### start\_date? [Section titled “start\_date?”](#start_date-1) > `optional` **start\_date?**: `string` | `null` Format: date *** `null` ##### get.responses.200.content.application/json.description? [Section titled “get.responses.200.content.application/json.description?”](#getresponses200contentapplicationjsondescription-1) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-52) Description of what the Spend Limit is used for. ##### get.responses.200.content.application/json.end\_date? [Section titled “get.responses.200.content.application/json.end\_date?”](#getresponses200contentapplicationjsonend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-53) The UTC date when the Spend Limit should stop counting. ##### get.responses.200.content.application/json.limit? [Section titled “get.responses.200.content.application/json.limit?”](#getresponses200contentapplicationjsonlimit) > `optional` **limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-5) ###### Type Literal [Section titled “Type Literal”](#type-literal-5) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-3) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-54) 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 [Section titled “Example”](#example-8) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-3) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-55) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-4) ```ts USD ``` ###### Example [Section titled “Example”](#example-9) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.limit\_type? [Section titled “get.responses.200.content.application/json.limit\_type?”](#getresponses200contentapplicationjsonlimit_type) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` ##### get.responses.200.content.application/json.limit\_visibility [Section titled “get.responses.200.content.application/json.limit\_visibility”](#getresponses200contentapplicationjsonlimit_visibility) > **limit\_visibility**: `"PRIVATE"` | `"SHARED"` ##### get.responses.200.content.application/json.member\_user\_ids [Section titled “get.responses.200.content.application/json.member\_user\_ids”](#getresponses200contentapplicationjsonmember_user_ids) > **member\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-56) User IDs of the members of the Spend Limit. ##### get.responses.200.content.application/json.name [Section titled “get.responses.200.content.application/json.name”](#getresponses200contentapplicationjsonname-1) > **name**: `string` ###### Description [Section titled “Description”](#description-57) Name for the Spend Limit. ##### get.responses.200.content.application/json.owner\_user\_ids [Section titled “get.responses.200.content.application/json.owner\_user\_ids”](#getresponses200contentapplicationjsonowner_user_ids) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-58) User IDs of the owners of the Spend Limit. ##### get.responses.200.content.application/json.parent\_budget\_id? [Section titled “get.responses.200.content.application/json.parent\_budget\_id?”](#getresponses200contentapplicationjsonparent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-59) ID of parent Budget. ##### get.responses.200.content.application/json.period\_type [Section titled “get.responses.200.content.application/json.period\_type”](#getresponses200contentapplicationjsonperiod_type) > **period\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### get.responses.200.content.application/json.spend\_type [Section titled “get.responses.200.content.application/json.spend\_type”](#getresponses200contentapplicationjsonspend_type) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### get.responses.200.content.application/json.start\_date? [Section titled “get.responses.200.content.application/json.start\_date?”](#getresponses200contentapplicationjsonstart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-60) The UTC date when the Spend Limit should start counting. ##### get.responses.200.content.application/json.templateId? [Section titled “get.responses.200.content.application/json.templateId?”](#getresponses200contentapplicationjsontemplateid) > `optional` **templateId?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-17) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-3) > **400**: `object` ###### Description [Section titled “Description”](#description-61) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-3) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-18) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-3) > **401**: `object` ###### Description [Section titled “Description”](#description-62) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-3) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-19) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-3) > **403**: `object` ###### Description [Section titled “Description”](#description-63) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-3) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-20) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404-1) > **404**: `object` ###### Description [Section titled “Description”](#description-64) Not Found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content-1) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-21) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-3) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-3) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-3) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-3) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-3) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-3) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-3) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-3) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-3) > `optional` **post?**: `undefined` #### put [Section titled “put”](#put-3) > **put**: `object` Update Spend Limit ##### Description [Section titled “Description”](#description-65) Updates a Spend Limit ##### put.parameters [Section titled “put.parameters”](#putparameters) > **parameters**: `object` ##### put.parameters.cookie? [Section titled “put.parameters.cookie?”](#putparameterscookie) > `optional` **cookie?**: `undefined` ##### put.parameters.header [Section titled “put.parameters.header”](#putparametersheader) > **header**: `object` ##### put.parameters.header.Idempotency-Key [Section titled “put.parameters.header.Idempotency-Key”](#putparametersheaderidempotency-key) > **Idempotency-Key**: `string` ##### put.parameters.path [Section titled “put.parameters.path”](#putparameterspath) > **path**: `object` ##### put.parameters.path.id [Section titled “put.parameters.path.id”](#putparameterspathid) > **id**: `string` ##### put.parameters.query? [Section titled “put.parameters.query?”](#putparametersquery) > `optional` **query?**: `undefined` ##### put.requestBody [Section titled “put.requestBody”](#putrequestbody) > **requestBody**: `object` ##### put.requestBody.content [Section titled “put.requestBody.content”](#putrequestbodycontent) > **content**: `object` ##### put.requestBody.content.application/json [Section titled “put.requestBody.content.application/json”](#putrequestbodycontentapplicationjson) > **application/json**: `object` ##### put.requestBody.content.application/json.description? [Section titled “put.requestBody.content.application/json.description?”](#putrequestbodycontentapplicationjsondescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-66) Description of what the Spend Limit is used for. ##### put.requestBody.content.application/json.end\_date? [Section titled “put.requestBody.content.application/json.end\_date?”](#putrequestbodycontentapplicationjsonend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-67) The UTC date when the Spend Limit should stop counting. ##### put.requestBody.content.application/json.limit? [Section titled “put.requestBody.content.application/json.limit?”](#putrequestbodycontentapplicationjsonlimit) > `optional` **limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-6) ###### Type Literal [Section titled “Type Literal”](#type-literal-6) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-4) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-68) 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 [Section titled “Example”](#example-10) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-4) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-69) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-5) ```ts USD ``` ###### Example [Section titled “Example”](#example-11) ```ts USD ``` *** `null` ##### put.requestBody.content.application/json.limit\_type? [Section titled “put.requestBody.content.application/json.limit\_type?”](#putrequestbodycontentapplicationjsonlimit_type) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` ##### put.requestBody.content.application/json.limit\_visibility? [Section titled “put.requestBody.content.application/json.limit\_visibility?”](#putrequestbodycontentapplicationjsonlimit_visibility) > `optional` **limit\_visibility?**: `"PRIVATE"` | `"SHARED"` | `null` ##### put.requestBody.content.application/json.member\_user\_ids? [Section titled “put.requestBody.content.application/json.member\_user\_ids?”](#putrequestbodycontentapplicationjsonmember_user_ids) > `optional` **member\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-70) User IDs of the members of the Spend Limit. ##### put.requestBody.content.application/json.name? [Section titled “put.requestBody.content.application/json.name?”](#putrequestbodycontentapplicationjsonname) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-71) Name for the Spend Limit. ##### put.requestBody.content.application/json.owner\_user\_ids? [Section titled “put.requestBody.content.application/json.owner\_user\_ids?”](#putrequestbodycontentapplicationjsonowner_user_ids) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-72) User IDs of the owners of the Spend Limit. ##### put.requestBody.content.application/json.period\_type? [Section titled “put.requestBody.content.application/json.period\_type?”](#putrequestbodycontentapplicationjsonperiod_type) > `optional` **period\_type?**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ##### put.requestBody.content.application/json.spend\_type? [Section titled “put.requestBody.content.application/json.spend\_type?”](#putrequestbodycontentapplicationjsonspend_type) > `optional` **spend\_type?**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` | `null` ##### put.requestBody.content.application/json.start\_date? [Section titled “put.requestBody.content.application/json.start\_date?”](#putrequestbodycontentapplicationjsonstart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-73) The UTC date when the Spend Limit should start counting. ##### put.responses [Section titled “put.responses”](#putresponses) > **responses**: `object` ##### put.responses.200 [Section titled “put.responses.200”](#putresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-74) The Spend Limit that was updated ##### put.responses.200.content [Section titled “put.responses.200.content”](#putresponses200content) > **content**: `object` ##### put.responses.200.content.application/json [Section titled “put.responses.200.content.application/json”](#putresponses200contentapplicationjson) > **application/json**: `object` ##### put.responses.200.content.application/json.account\_id [Section titled “put.responses.200.content.application/json.account\_id”](#putresponses200contentapplicationjsonaccount_id) > **account\_id**: `string` ###### Description [Section titled “Description”](#description-75) The Brex account this Spend Limit belongs to. ##### put.responses.200.content.application/json.budget\_id [Section titled “put.responses.200.content.application/json.budget\_id”](#putresponses200contentapplicationjsonbudget_id) > **budget\_id**: `string` ###### Description [Section titled “Description”](#description-76) Unique ID for the Spend Limit. ##### put.responses.200.content.application/json.budget\_status [Section titled “put.responses.200.content.application/json.budget\_status”](#putresponses200contentapplicationjsonbudget_status) > **budget\_status**: `"DELETED"` | `"APPROVED"` | `"EXPIRED"` | `"TERMINATED"` ##### put.responses.200.content.application/json.budget\_type [Section titled “put.responses.200.content.application/json.budget\_type”](#putresponses200contentapplicationjsonbudget_type) > **budget\_type**: `"BUDGET"` | `"SPEND_LIMIT"` ##### put.responses.200.content.application/json.creator\_user\_id? [Section titled “put.responses.200.content.application/json.creator\_user\_id?”](#putresponses200contentapplicationjsoncreator_user_id) > `optional` **creator\_user\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-77) The ID of the user who originally created this Spend Limit. ##### put.responses.200.content.application/json.current\_period\_balance? [Section titled “put.responses.200.content.application/json.current\_period\_balance?”](#putresponses200contentapplicationjsoncurrent_period_balance) > `optional` **current\_period\_balance?**: { `balance?`: { `amount`: `number`; `currency`: … | …; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-7) ###### Type Literal [Section titled “Type Literal”](#type-literal-7) { `balance?`: { `amount`: `number`; `currency`: … | …; } | `null`; `end_date?`: `string` | `null`; `start_date?`: `string` | `null`; } ###### balance? [Section titled “balance?”](#balance-2) > `optional` **balance?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-8) ###### Type Literal [Section titled “Type Literal”](#type-literal-8) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-5) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-78) 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 [Section titled “Example”](#example-12) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-5) > **currency**: … | … ###### Description [Section titled “Description”](#description-79) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-6) ```ts USD ``` ###### Example [Section titled “Example”](#example-13) ```ts USD ``` *** `null` ###### end\_date? [Section titled “end\_date?”](#end_date-2) > `optional` **end\_date?**: `string` | `null` Format: date ###### start\_date? [Section titled “start\_date?”](#start_date-2) > `optional` **start\_date?**: `string` | `null` Format: date *** `null` ##### put.responses.200.content.application/json.description? [Section titled “put.responses.200.content.application/json.description?”](#putresponses200contentapplicationjsondescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-80) Description of what the Spend Limit is used for. ##### put.responses.200.content.application/json.end\_date? [Section titled “put.responses.200.content.application/json.end\_date?”](#putresponses200contentapplicationjsonend_date) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-81) The UTC date when the Spend Limit should stop counting. ##### put.responses.200.content.application/json.limit? [Section titled “put.responses.200.content.application/json.limit?”](#putresponses200contentapplicationjsonlimit) > `optional` **limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-9) ###### Type Literal [Section titled “Type Literal”](#type-literal-9) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-6) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-82) 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 [Section titled “Example”](#example-14) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-6) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-83) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-7) ```ts USD ``` ###### Example [Section titled “Example”](#example-15) ```ts USD ``` *** `null` ##### put.responses.200.content.application/json.limit\_type? [Section titled “put.responses.200.content.application/json.limit\_type?”](#putresponses200contentapplicationjsonlimit_type) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` ##### put.responses.200.content.application/json.limit\_visibility [Section titled “put.responses.200.content.application/json.limit\_visibility”](#putresponses200contentapplicationjsonlimit_visibility) > **limit\_visibility**: `"PRIVATE"` | `"SHARED"` ##### put.responses.200.content.application/json.member\_user\_ids [Section titled “put.responses.200.content.application/json.member\_user\_ids”](#putresponses200contentapplicationjsonmember_user_ids) > **member\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-84) User IDs of the members of the Spend Limit. ##### put.responses.200.content.application/json.name [Section titled “put.responses.200.content.application/json.name”](#putresponses200contentapplicationjsonname) > **name**: `string` ###### Description [Section titled “Description”](#description-85) Name for the Spend Limit. ##### put.responses.200.content.application/json.owner\_user\_ids [Section titled “put.responses.200.content.application/json.owner\_user\_ids”](#putresponses200contentapplicationjsonowner_user_ids) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-86) User IDs of the owners of the Spend Limit. ##### put.responses.200.content.application/json.parent\_budget\_id? [Section titled “put.responses.200.content.application/json.parent\_budget\_id?”](#putresponses200contentapplicationjsonparent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-87) ID of parent Budget. ##### put.responses.200.content.application/json.period\_type [Section titled “put.responses.200.content.application/json.period\_type”](#putresponses200contentapplicationjsonperiod_type) > **period\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### put.responses.200.content.application/json.spend\_type [Section titled “put.responses.200.content.application/json.spend\_type”](#putresponses200contentapplicationjsonspend_type) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### put.responses.200.content.application/json.start\_date? [Section titled “put.responses.200.content.application/json.start\_date?”](#putresponses200contentapplicationjsonstart_date) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-88) The UTC date when the Spend Limit should start counting. ##### put.responses.200.content.application/json.templateId? [Section titled “put.responses.200.content.application/json.templateId?”](#putresponses200contentapplicationjsontemplateid) > `optional` **templateId?**: `string` | `null` ##### put.responses.200.headers [Section titled “put.responses.200.headers”](#putresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-22) \[`name`: `string`]: `unknown` ##### put.responses.400 [Section titled “put.responses.400”](#putresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-89) Bad request ##### put.responses.400.content? [Section titled “put.responses.400.content?”](#putresponses400content) > `optional` **content?**: `undefined` ##### put.responses.400.headers [Section titled “put.responses.400.headers”](#putresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-23) \[`name`: `string`]: `unknown` ##### put.responses.401 [Section titled “put.responses.401”](#putresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-90) Unauthorized ##### put.responses.401.content? [Section titled “put.responses.401.content?”](#putresponses401content) > `optional` **content?**: `undefined` ##### put.responses.401.headers [Section titled “put.responses.401.headers”](#putresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-24) \[`name`: `string`]: `unknown` ##### put.responses.403 [Section titled “put.responses.403”](#putresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-91) Forbidden ##### put.responses.403.content? [Section titled “put.responses.403.content?”](#putresponses403content) > `optional` **content?**: `undefined` ##### put.responses.403.headers [Section titled “put.responses.403.headers”](#putresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-25) \[`name`: `string`]: `unknown` ##### put.responses.404 [Section titled “put.responses.404”](#putresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-92) Not Found ##### put.responses.404.content? [Section titled “put.responses.404.content?”](#putresponses404content) > `optional` **content?**: `undefined` ##### put.responses.404.headers [Section titled “put.responses.404.headers”](#putresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-26) \[`name`: `string`]: `unknown` #### trace? [Section titled “trace?”](#trace-3) > `optional` **trace?**: `undefined` *** ### /v1/budgets/{id}/archive [Section titled “/v1/budgets/{id}/archive”](#v1budgetsidarchive) > **/v1/budgets/{id}/archive**: `object` Defined in: [src/budgets/types.gen.ts:91](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L91) #### delete? [Section titled “delete?”](#delete-4) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-4) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-4) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-4) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-4) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-4) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-4) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-4) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-4) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-4) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-4) > **post**: `object` Archive a Spend Limit ##### Description [Section titled “Description”](#description-93) Archives a Spend Limit, making it unusable for future expenses and removing it from the UI ##### post.parameters [Section titled “post.parameters”](#postparameters-1) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-1) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-1) > `optional` **header?**: `undefined` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-1) > **path**: `object` ##### post.parameters.path.id [Section titled “post.parameters.path.id”](#postparameterspathid) > **id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-1) > `optional` **query?**: `undefined` ##### post.requestBody? [Section titled “post.requestBody?”](#postrequestbody-1) > `optional` **requestBody?**: `undefined` ##### post.responses [Section titled “post.responses”](#postresponses-1) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-94) The Spend Limit that was archived ##### post.responses.200.content? [Section titled “post.responses.200.content?”](#postresponses200content-1) > `optional` **content?**: `undefined` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-27) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-95) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content-1) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-28) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-96) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content-1) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-29) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-97) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content-1) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-30) \[`name`: `string`]: `unknown` ##### post.responses.404 [Section titled “post.responses.404”](#postresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-98) Not Found ##### post.responses.404.content? [Section titled “post.responses.404.content?”](#postresponses404content) > `optional` **content?**: `undefined` ##### post.responses.404.headers [Section titled “post.responses.404.headers”](#postresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-31) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-4) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-4) > `optional` **trace?**: `undefined` *** ### /v2/budgets [Section titled “/v2/budgets”](#v2budgets) > **/v2/budgets**: `object` Defined in: [src/budgets/types.gen.ts:111](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L111) #### delete? [Section titled “delete?”](#delete-5) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-5) > **get**: `object` List Budgets ##### Description [Section titled “Description”](#description-99) Retrieves a list of Budgets ##### get.parameters [Section titled “get.parameters”](#getparameters-4) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-4) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-4) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-4) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-4) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-2) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-2) > `optional` **limit?**: `number` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-4) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-4) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-4) > **200**: `object` ###### Description [Section titled “Description”](#description-100) A page with a list of Budgets ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-4) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-4) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-2) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-2) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-32) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-4) > **400**: `object` ###### Description [Section titled “Description”](#description-101) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-4) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-33) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-4) > **401**: `object` ###### Description [Section titled “Description”](#description-102) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-4) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-34) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-4) > **403**: `object` ###### Description [Section titled “Description”](#description-103) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-4) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-35) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404-2) > **404**: `object` ###### Description [Section titled “Description”](#description-104) Not Found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content-2) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-36) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-5) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-5) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-5) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-5) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-5) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-5) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-5) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-5) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-5) > **post**: `object` Create Budget ##### Description [Section titled “Description”](#description-105) Creates a Budget ##### post.parameters [Section titled “post.parameters”](#postparameters-2) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-2) > `optional` **cookie?**: `undefined` ##### post.parameters.header [Section titled “post.parameters.header”](#postparametersheader-2) > **header**: `object` ##### post.parameters.header.Idempotency-Key [Section titled “post.parameters.header.Idempotency-Key”](#postparametersheaderidempotency-key-1) > **Idempotency-Key**: `string` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath-2) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-2) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-2) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-1) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-1) > **application/json**: `object` ##### post.requestBody.content.application/json.amount [Section titled “post.requestBody.content.application/json.amount”](#postrequestbodycontentapplicationjsonamount) > **amount**: `object` ##### post.requestBody.content.application/json.amount.amount [Section titled “post.requestBody.content.application/json.amount.amount”](#postrequestbodycontentapplicationjsonamountamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-106) 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 [Section titled “Example”](#example-16) ```ts 700 ``` ##### post.requestBody.content.application/json.amount.currency [Section titled “post.requestBody.content.application/json.amount.currency”](#postrequestbodycontentapplicationjsonamountcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-107) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-8) ```ts USD ``` ###### Example [Section titled “Example”](#example-17) ```ts USD ``` ##### post.requestBody.content.application/json.description [Section titled “post.requestBody.content.application/json.description”](#postrequestbodycontentapplicationjsondescription-1) > **description**: `string` ###### Description [Section titled “Description”](#description-108) Description of what the Budget is used for. ##### post.requestBody.content.application/json.end\_date? [Section titled “post.requestBody.content.application/json.end\_date?”](#postrequestbodycontentapplicationjsonend_date-1) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-109) The date when the Budget should stop counting. ##### post.requestBody.content.application/json.limit\_type? [Section titled “post.requestBody.content.application/json.limit\_type?”](#postrequestbodycontentapplicationjsonlimit_type-1) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` Deprecated This API is no longer supported and may be removed in a future release. ##### post.requestBody.content.application/json.name [Section titled “post.requestBody.content.application/json.name”](#postrequestbodycontentapplicationjsonname-1) > **name**: `string` ###### Description [Section titled “Description”](#description-110) Name for the Budget. ##### post.requestBody.content.application/json.owner\_user\_ids? [Section titled “post.requestBody.content.application/json.owner\_user\_ids?”](#postrequestbodycontentapplicationjsonowner_user_ids-1) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-111) User IDs of the owners of the Budget. ##### post.requestBody.content.application/json.parent\_budget\_id [Section titled “post.requestBody.content.application/json.parent\_budget\_id”](#postrequestbodycontentapplicationjsonparent_budget_id-1) > **parent\_budget\_id**: `string` ###### Description [Section titled “Description”](#description-112) ID of parent Budget. ##### post.requestBody.content.application/json.period\_recurrence\_type [Section titled “post.requestBody.content.application/json.period\_recurrence\_type”](#postrequestbodycontentapplicationjsonperiod_recurrence_type) > **period\_recurrence\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### post.requestBody.content.application/json.start\_date? [Section titled “post.requestBody.content.application/json.start\_date?”](#postrequestbodycontentapplicationjsonstart_date-1) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-113) The date when the Budget should start counting. ##### post.responses [Section titled “post.responses”](#postresponses-2) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-114) The Budget that was created ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-2) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-1) > **application/json**: `object` ##### post.responses.200.content.application/json.account\_id [Section titled “post.responses.200.content.application/json.account\_id”](#postresponses200contentapplicationjsonaccount_id-1) > **account\_id**: `string` ###### Description [Section titled “Description”](#description-115) The Brex account this Budget belongs to. ##### post.responses.200.content.application/json.amount? [Section titled “post.responses.200.content.application/json.amount?”](#postresponses200contentapplicationjsonamount) > `optional` **amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-10) ###### Type Literal [Section titled “Type Literal”](#type-literal-10) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-7) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-116) 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 [Section titled “Example”](#example-18) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-7) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-117) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-9) ```ts USD ``` ###### Example [Section titled “Example”](#example-19) ```ts USD ``` *** `null` ##### post.responses.200.content.application/json.budget\_id [Section titled “post.responses.200.content.application/json.budget\_id”](#postresponses200contentapplicationjsonbudget_id-1) > **budget\_id**: `string` ###### Description [Section titled “Description”](#description-118) Unique ID for the Budget. ##### post.responses.200.content.application/json.description? [Section titled “post.responses.200.content.application/json.description?”](#postresponses200contentapplicationjsondescription-1) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-119) Description of what the Budget is used for. ##### post.responses.200.content.application/json.end\_date? [Section titled “post.responses.200.content.application/json.end\_date?”](#postresponses200contentapplicationjsonend_date-1) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-120) The date when the Budget should stop counting. ##### post.responses.200.content.application/json.limit\_type? [Section titled “post.responses.200.content.application/json.limit\_type?”](#postresponses200contentapplicationjsonlimit_type-1) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` Deprecated This API is no longer supported and may be removed in a future release. ##### post.responses.200.content.application/json.name [Section titled “post.responses.200.content.application/json.name”](#postresponses200contentapplicationjsonname-1) > **name**: `string` ###### Description [Section titled “Description”](#description-121) Name for the Budget. ##### post.responses.200.content.application/json.owner\_user\_ids [Section titled “post.responses.200.content.application/json.owner\_user\_ids”](#postresponses200contentapplicationjsonowner_user_ids-1) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-122) User IDs of the owners of the Budget. ##### post.responses.200.content.application/json.parent\_budget\_id? [Section titled “post.responses.200.content.application/json.parent\_budget\_id?”](#postresponses200contentapplicationjsonparent_budget_id-1) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-123) ID of parent Budget. ##### post.responses.200.content.application/json.period\_recurrence\_type [Section titled “post.responses.200.content.application/json.period\_recurrence\_type”](#postresponses200contentapplicationjsonperiod_recurrence_type) > **period\_recurrence\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### post.responses.200.content.application/json.spend\_budget\_status [Section titled “post.responses.200.content.application/json.spend\_budget\_status”](#postresponses200contentapplicationjsonspend_budget_status) > **spend\_budget\_status**: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` ##### post.responses.200.content.application/json.start\_date? [Section titled “post.responses.200.content.application/json.start\_date?”](#postresponses200contentapplicationjsonstart_date-1) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-124) The date when the Budget should start counting. ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-37) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400-2) > **400**: `object` ###### Description [Section titled “Description”](#description-125) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content-2) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-38) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-2) > **401**: `object` ###### Description [Section titled “Description”](#description-126) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content-2) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-39) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403-2) > **403**: `object` ###### Description [Section titled “Description”](#description-127) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content-2) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-40) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-5) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-5) > `optional` **trace?**: `undefined` *** ### /v2/budgets/{id} [Section titled “/v2/budgets/{id}”](#v2budgetsid) > **/v2/budgets/{id}**: `object` Defined in: [src/budgets/types.gen.ts:135](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L135) #### delete? [Section titled “delete?”](#delete-6) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-6) > **get**: `object` Get Budget ##### Description [Section titled “Description”](#description-128) Retrieves a Budget by ID ##### get.parameters [Section titled “get.parameters”](#getparameters-5) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-5) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-5) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-5) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-2) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-5) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-5) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-5) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-5) > **200**: `object` ###### Description [Section titled “Description”](#description-129) The Budget that was retrieved ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-5) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-5) > **application/json**: `object` ##### get.responses.200.content.application/json.account\_id [Section titled “get.responses.200.content.application/json.account\_id”](#getresponses200contentapplicationjsonaccount_id-1) > **account\_id**: `string` ###### Description [Section titled “Description”](#description-130) The Brex account this Budget belongs to. ##### get.responses.200.content.application/json.amount? [Section titled “get.responses.200.content.application/json.amount?”](#getresponses200contentapplicationjsonamount) > `optional` **amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-11) ###### Type Literal [Section titled “Type Literal”](#type-literal-11) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-8) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-131) 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 [Section titled “Example”](#example-20) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-8) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-132) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-10) ```ts USD ``` ###### Example [Section titled “Example”](#example-21) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.budget\_id [Section titled “get.responses.200.content.application/json.budget\_id”](#getresponses200contentapplicationjsonbudget_id-1) > **budget\_id**: `string` ###### Description [Section titled “Description”](#description-133) Unique ID for the Budget. ##### get.responses.200.content.application/json.description? [Section titled “get.responses.200.content.application/json.description?”](#getresponses200contentapplicationjsondescription-2) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-134) Description of what the Budget is used for. ##### get.responses.200.content.application/json.end\_date? [Section titled “get.responses.200.content.application/json.end\_date?”](#getresponses200contentapplicationjsonend_date-1) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-135) The date when the Budget should stop counting. ##### get.responses.200.content.application/json.limit\_type? [Section titled “get.responses.200.content.application/json.limit\_type?”](#getresponses200contentapplicationjsonlimit_type-1) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` Deprecated This API is no longer supported and may be removed in a future release. ##### get.responses.200.content.application/json.name [Section titled “get.responses.200.content.application/json.name”](#getresponses200contentapplicationjsonname-2) > **name**: `string` ###### Description [Section titled “Description”](#description-136) Name for the Budget. ##### get.responses.200.content.application/json.owner\_user\_ids [Section titled “get.responses.200.content.application/json.owner\_user\_ids”](#getresponses200contentapplicationjsonowner_user_ids-1) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-137) User IDs of the owners of the Budget. ##### get.responses.200.content.application/json.parent\_budget\_id? [Section titled “get.responses.200.content.application/json.parent\_budget\_id?”](#getresponses200contentapplicationjsonparent_budget_id-1) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-138) ID of parent Budget. ##### get.responses.200.content.application/json.period\_recurrence\_type [Section titled “get.responses.200.content.application/json.period\_recurrence\_type”](#getresponses200contentapplicationjsonperiod_recurrence_type) > **period\_recurrence\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### get.responses.200.content.application/json.spend\_budget\_status [Section titled “get.responses.200.content.application/json.spend\_budget\_status”](#getresponses200contentapplicationjsonspend_budget_status) > **spend\_budget\_status**: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` ##### get.responses.200.content.application/json.start\_date? [Section titled “get.responses.200.content.application/json.start\_date?”](#getresponses200contentapplicationjsonstart_date-1) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-139) The date when the Budget should start counting. ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-41) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-5) > **400**: `object` ###### Description [Section titled “Description”](#description-140) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-5) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-42) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-5) > **401**: `object` ###### Description [Section titled “Description”](#description-141) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-5) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-43) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-5) > **403**: `object` ###### Description [Section titled “Description”](#description-142) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-5) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-44) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404-3) > **404**: `object` ###### Description [Section titled “Description”](#description-143) Not Found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content-3) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-45) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-6) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-6) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-6) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-6) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-6) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-6) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-6) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-6) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-6) > `optional` **post?**: `undefined` #### put [Section titled “put”](#put-6) > **put**: `object` Update Budget ##### Description [Section titled “Description”](#description-144) Updates a Budget ##### put.parameters [Section titled “put.parameters”](#putparameters-1) > **parameters**: `object` ##### put.parameters.cookie? [Section titled “put.parameters.cookie?”](#putparameterscookie-1) > `optional` **cookie?**: `undefined` ##### put.parameters.header [Section titled “put.parameters.header”](#putparametersheader-1) > **header**: `object` ##### put.parameters.header.Idempotency-Key [Section titled “put.parameters.header.Idempotency-Key”](#putparametersheaderidempotency-key-1) > **Idempotency-Key**: `string` ##### put.parameters.path [Section titled “put.parameters.path”](#putparameterspath-1) > **path**: `object` ##### put.parameters.path.id [Section titled “put.parameters.path.id”](#putparameterspathid-1) > **id**: `string` ##### put.parameters.query? [Section titled “put.parameters.query?”](#putparametersquery-1) > `optional` **query?**: `undefined` ##### put.requestBody [Section titled “put.requestBody”](#putrequestbody-1) > **requestBody**: `object` ##### put.requestBody.content [Section titled “put.requestBody.content”](#putrequestbodycontent-1) > **content**: `object` ##### put.requestBody.content.application/json [Section titled “put.requestBody.content.application/json”](#putrequestbodycontentapplicationjson-1) > **application/json**: `object` ##### put.requestBody.content.application/json.amount? [Section titled “put.requestBody.content.application/json.amount?”](#putrequestbodycontentapplicationjsonamount) > `optional` **amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-12) ###### Type Literal [Section titled “Type Literal”](#type-literal-12) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-9) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-145) 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 [Section titled “Example”](#example-22) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-9) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-146) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-11) ```ts USD ``` ###### Example [Section titled “Example”](#example-23) ```ts USD ``` *** `null` ##### put.requestBody.content.application/json.description? [Section titled “put.requestBody.content.application/json.description?”](#putrequestbodycontentapplicationjsondescription-1) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-147) Description of what the Budget is used for. ##### put.requestBody.content.application/json.end\_date? [Section titled “put.requestBody.content.application/json.end\_date?”](#putrequestbodycontentapplicationjsonend_date-1) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-148) The date when the Budget should stop counting. ##### put.requestBody.content.application/json.limit\_type? [Section titled “put.requestBody.content.application/json.limit\_type?”](#putrequestbodycontentapplicationjsonlimit_type-1) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` Deprecated This API is no longer supported and may be removed in a future release. ##### put.requestBody.content.application/json.name? [Section titled “put.requestBody.content.application/json.name?”](#putrequestbodycontentapplicationjsonname-1) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-149) Name for the Budget. ##### put.requestBody.content.application/json.owner\_user\_ids? [Section titled “put.requestBody.content.application/json.owner\_user\_ids?”](#putrequestbodycontentapplicationjsonowner_user_ids-1) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-150) User IDs of the owners of the Budget. ##### put.requestBody.content.application/json.parent\_budget\_id? [Section titled “put.requestBody.content.application/json.parent\_budget\_id?”](#putrequestbodycontentapplicationjsonparent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-151) ID of parent Budget. ##### put.requestBody.content.application/json.period\_recurrence\_type? [Section titled “put.requestBody.content.application/json.period\_recurrence\_type?”](#putrequestbodycontentapplicationjsonperiod_recurrence_type) > `optional` **period\_recurrence\_type?**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ##### put.requestBody.content.application/json.start\_date? [Section titled “put.requestBody.content.application/json.start\_date?”](#putrequestbodycontentapplicationjsonstart_date-1) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-152) The date when the Budget should start counting. ##### put.responses [Section titled “put.responses”](#putresponses-1) > **responses**: `object` ##### put.responses.200 [Section titled “put.responses.200”](#putresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-153) The Budget that was updated ##### put.responses.200.content [Section titled “put.responses.200.content”](#putresponses200content-1) > **content**: `object` ##### put.responses.200.content.application/json [Section titled “put.responses.200.content.application/json”](#putresponses200contentapplicationjson-1) > **application/json**: `object` ##### put.responses.200.content.application/json.account\_id [Section titled “put.responses.200.content.application/json.account\_id”](#putresponses200contentapplicationjsonaccount_id-1) > **account\_id**: `string` ###### Description [Section titled “Description”](#description-154) The Brex account this Budget belongs to. ##### put.responses.200.content.application/json.amount? [Section titled “put.responses.200.content.application/json.amount?”](#putresponses200contentapplicationjsonamount) > `optional` **amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-13) ###### Type Literal [Section titled “Type Literal”](#type-literal-13) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-10) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-155) 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 [Section titled “Example”](#example-24) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-10) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-156) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-12) ```ts USD ``` ###### Example [Section titled “Example”](#example-25) ```ts USD ``` *** `null` ##### put.responses.200.content.application/json.budget\_id [Section titled “put.responses.200.content.application/json.budget\_id”](#putresponses200contentapplicationjsonbudget_id-1) > **budget\_id**: `string` ###### Description [Section titled “Description”](#description-157) Unique ID for the Budget. ##### put.responses.200.content.application/json.description? [Section titled “put.responses.200.content.application/json.description?”](#putresponses200contentapplicationjsondescription-1) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-158) Description of what the Budget is used for. ##### put.responses.200.content.application/json.end\_date? [Section titled “put.responses.200.content.application/json.end\_date?”](#putresponses200contentapplicationjsonend_date-1) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-159) The date when the Budget should stop counting. ##### put.responses.200.content.application/json.limit\_type? [Section titled “put.responses.200.content.application/json.limit\_type?”](#putresponses200contentapplicationjsonlimit_type-1) > `optional` **limit\_type?**: `"HARD"` | `"SOFT"` | `null` Deprecated This API is no longer supported and may be removed in a future release. ##### put.responses.200.content.application/json.name [Section titled “put.responses.200.content.application/json.name”](#putresponses200contentapplicationjsonname-1) > **name**: `string` ###### Description [Section titled “Description”](#description-160) Name for the Budget. ##### put.responses.200.content.application/json.owner\_user\_ids [Section titled “put.responses.200.content.application/json.owner\_user\_ids”](#putresponses200contentapplicationjsonowner_user_ids-1) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-161) User IDs of the owners of the Budget. ##### put.responses.200.content.application/json.parent\_budget\_id? [Section titled “put.responses.200.content.application/json.parent\_budget\_id?”](#putresponses200contentapplicationjsonparent_budget_id-1) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-162) ID of parent Budget. ##### put.responses.200.content.application/json.period\_recurrence\_type [Section titled “put.responses.200.content.application/json.period\_recurrence\_type”](#putresponses200contentapplicationjsonperiod_recurrence_type) > **period\_recurrence\_type**: `"WEEKLY"` | `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### put.responses.200.content.application/json.spend\_budget\_status [Section titled “put.responses.200.content.application/json.spend\_budget\_status”](#putresponses200contentapplicationjsonspend_budget_status) > **spend\_budget\_status**: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` ##### put.responses.200.content.application/json.start\_date? [Section titled “put.responses.200.content.application/json.start\_date?”](#putresponses200contentapplicationjsonstart_date-1) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-163) The date when the Budget should start counting. ##### put.responses.200.headers [Section titled “put.responses.200.headers”](#putresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-46) \[`name`: `string`]: `unknown` ##### put.responses.400 [Section titled “put.responses.400”](#putresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-164) Bad request ##### put.responses.400.content? [Section titled “put.responses.400.content?”](#putresponses400content-1) > `optional` **content?**: `undefined` ##### put.responses.400.headers [Section titled “put.responses.400.headers”](#putresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-47) \[`name`: `string`]: `unknown` ##### put.responses.401 [Section titled “put.responses.401”](#putresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-165) Unauthorized ##### put.responses.401.content? [Section titled “put.responses.401.content?”](#putresponses401content-1) > `optional` **content?**: `undefined` ##### put.responses.401.headers [Section titled “put.responses.401.headers”](#putresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-48) \[`name`: `string`]: `unknown` ##### put.responses.403 [Section titled “put.responses.403”](#putresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-166) Forbidden ##### put.responses.403.content? [Section titled “put.responses.403.content?”](#putresponses403content-1) > `optional` **content?**: `undefined` ##### put.responses.403.headers [Section titled “put.responses.403.headers”](#putresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-49) \[`name`: `string`]: `unknown` ##### put.responses.404 [Section titled “put.responses.404”](#putresponses404-1) > **404**: `object` ###### Description [Section titled “Description”](#description-167) Not Found ##### put.responses.404.content? [Section titled “put.responses.404.content?”](#putresponses404content-1) > `optional` **content?**: `undefined` ##### put.responses.404.headers [Section titled “put.responses.404.headers”](#putresponses404headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-50) \[`name`: `string`]: `unknown` #### trace? [Section titled “trace?”](#trace-6) > `optional` **trace?**: `undefined` *** ### /v2/budgets/{id}/archive [Section titled “/v2/budgets/{id}/archive”](#v2budgetsidarchive) > **/v2/budgets/{id}/archive**: `object` Defined in: [src/budgets/types.gen.ts:159](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L159) #### delete? [Section titled “delete?”](#delete-7) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-7) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-7) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-7) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-7) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-7) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-7) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-7) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-7) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-7) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-7) > **post**: `object` Archive a Budget ##### Description [Section titled “Description”](#description-168) Archives a Budget, making any Spend Limits beneath it unusable for future expenses and removing it from the UI ##### post.parameters [Section titled “post.parameters”](#postparameters-3) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-3) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-3) > `optional` **header?**: `undefined` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-3) > **path**: `object` ##### post.parameters.path.id [Section titled “post.parameters.path.id”](#postparameterspathid-1) > **id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-3) > `optional` **query?**: `undefined` ##### post.requestBody? [Section titled “post.requestBody?”](#postrequestbody-3) > `optional` **requestBody?**: `undefined` ##### post.responses [Section titled “post.responses”](#postresponses-3) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-3) > **200**: `object` ###### Description [Section titled “Description”](#description-169) The Budget that was archived ##### post.responses.200.content? [Section titled “post.responses.200.content?”](#postresponses200content-3) > `optional` **content?**: `undefined` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-51) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400-3) > **400**: `object` ###### Description [Section titled “Description”](#description-170) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content-3) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-52) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-3) > **401**: `object` ###### Description [Section titled “Description”](#description-171) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content-3) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-53) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403-3) > **403**: `object` ###### Description [Section titled “Description”](#description-172) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content-3) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-54) \[`name`: `string`]: `unknown` ##### post.responses.404 [Section titled “post.responses.404”](#postresponses404-1) > **404**: `object` ###### Description [Section titled “Description”](#description-173) Not Found ##### post.responses.404.content? [Section titled “post.responses.404.content?”](#postresponses404content-1) > `optional` **content?**: `undefined` ##### post.responses.404.headers [Section titled “post.responses.404.headers”](#postresponses404headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-55) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-7) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-7) > `optional` **trace?**: `undefined` *** ### /v2/spend\_limits [Section titled “/v2/spend\_limits”](#v2spend_limits) > **/v2/spend\_limits**: `object` Defined in: [src/budgets/types.gen.ts:179](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L179) #### delete? [Section titled “delete?”](#delete-8) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-8) > **get**: `object` List Spend Limits ##### Description [Section titled “Description”](#description-174) Retrieves a list of Spend Limits ##### get.parameters [Section titled “get.parameters”](#getparameters-6) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-6) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-6) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-6) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-6) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-3) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-3) > `optional` **limit?**: `number` | `null` ##### get.parameters.query.member\_user\_id\[]? [Section titled “get.parameters.query.member\_user\_id\[\]?”](#getparametersquerymember_user_id) > `optional` **member\_user\_id\[]?**: `string`\[] | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-6) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-6) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-6) > **200**: `object` ###### Description [Section titled “Description”](#description-175) A page with a list of Spend Limits ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-6) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-6) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-3) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-3) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-6) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-56) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-6) > **400**: `object` ###### Description [Section titled “Description”](#description-176) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-6) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-6) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-57) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-6) > **401**: `object` ###### Description [Section titled “Description”](#description-177) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-6) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-6) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-58) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-6) > **403**: `object` ###### Description [Section titled “Description”](#description-178) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-6) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-6) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-59) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404-4) > **404**: `object` ###### Description [Section titled “Description”](#description-179) Not Found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content-4) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-60) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-8) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-8) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-8) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-8) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-8) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-8) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-8) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-8) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-8) > **post**: `object` Create Spend Limit ##### Description [Section titled “Description”](#description-180) Creates a Spend Limit ##### post.parameters [Section titled “post.parameters”](#postparameters-4) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-4) > `optional` **cookie?**: `undefined` ##### post.parameters.header [Section titled “post.parameters.header”](#postparametersheader-4) > **header**: `object` ##### post.parameters.header.Idempotency-Key [Section titled “post.parameters.header.Idempotency-Key”](#postparametersheaderidempotency-key-2) > **Idempotency-Key**: `string` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath-4) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-4) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-4) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-2) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-2) > **application/json**: `object` ##### post.requestBody.content.application/json.authorization\_settings [Section titled “post.requestBody.content.application/json.authorization\_settings”](#postrequestbodycontentapplicationjsonauthorization_settings) > **authorization\_settings**: `object` ##### post.requestBody.content.application/json.authorization\_settings.authorization\_type [Section titled “post.requestBody.content.application/json.authorization\_settings.authorization\_type”](#postrequestbodycontentapplicationjsonauthorization_settingsauthorization_type) > **authorization\_type**: `"HARD"` | `"SOFT"` ##### post.requestBody.content.application/json.authorization\_settings.base\_limit [Section titled “post.requestBody.content.application/json.authorization\_settings.base\_limit”](#postrequestbodycontentapplicationjsonauthorization_settingsbase_limit) > **base\_limit**: `object` ##### post.requestBody.content.application/json.authorization\_settings.base\_limit.amount [Section titled “post.requestBody.content.application/json.authorization\_settings.base\_limit.amount”](#postrequestbodycontentapplicationjsonauthorization_settingsbase_limitamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-181) 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 [Section titled “Example”](#example-26) ```ts 700 ``` ##### post.requestBody.content.application/json.authorization\_settings.base\_limit.currency [Section titled “post.requestBody.content.application/json.authorization\_settings.base\_limit.currency”](#postrequestbodycontentapplicationjsonauthorization_settingsbase_limitcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-182) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-13) ```ts USD ``` ###### Example [Section titled “Example”](#example-27) ```ts USD ``` ##### post.requestBody.content.application/json.authorization\_settings.limit\_buffer\_percentage? [Section titled “post.requestBody.content.application/json.authorization\_settings.limit\_buffer\_percentage?”](#postrequestbodycontentapplicationjsonauthorization_settingslimit_buffer_percentage) > `optional` **limit\_buffer\_percentage?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-183) The percentage of flexible buffer on the limit as a 0-100 integer. ##### post.requestBody.content.application/json.authorization\_settings.rollover\_refresh\_rate [Section titled “post.requestBody.content.application/json.authorization\_settings.rollover\_refresh\_rate”](#postrequestbodycontentapplicationjsonauthorization_settingsrollover_refresh_rate) > **rollover\_refresh\_rate**: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` ##### post.requestBody.content.application/json.authorization\_visibility [Section titled “post.requestBody.content.application/json.authorization\_visibility”](#postrequestbodycontentapplicationjsonauthorization_visibility) > **authorization\_visibility**: `"PUBLIC"` | `"PRIVATE"` ##### post.requestBody.content.application/json.auto\_create\_limit\_cards\_setting [Section titled “post.requestBody.content.application/json.auto\_create\_limit\_cards\_setting”](#postrequestbodycontentapplicationjsonauto_create_limit_cards_setting) > **auto\_create\_limit\_cards\_setting**: `"DISABLED"` | `"ALL_MEMBERS"` ##### post.requestBody.content.application/json.auto\_transfer\_cards\_setting [Section titled “post.requestBody.content.application/json.auto\_transfer\_cards\_setting”](#postrequestbodycontentapplicationjsonauto_transfer_cards_setting) > **auto\_transfer\_cards\_setting**: `"DISABLED"` | `"ENABLED"` ##### post.requestBody.content.application/json.department\_id? [Section titled “post.requestBody.content.application/json.department\_id?”](#postrequestbodycontentapplicationjsondepartment_id) > `optional` **department\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-184) The department ID to which Spend Limit expenses will be attributed. ##### post.requestBody.content.application/json.description? [Section titled “post.requestBody.content.application/json.description?”](#postrequestbodycontentapplicationjsondescription-2) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-185) Description of what the Spend Limit is used for. ##### post.requestBody.content.application/json.end\_date? [Section titled “post.requestBody.content.application/json.end\_date?”](#postrequestbodycontentapplicationjsonend_date-2) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-186) The date when the Spend Limit should expire. ##### post.requestBody.content.application/json.expense\_policy\_id [Section titled “post.requestBody.content.application/json.expense\_policy\_id”](#postrequestbodycontentapplicationjsonexpense_policy_id) > **expense\_policy\_id**: `string` ###### Description [Section titled “Description”](#description-187) The ID of the expense policy corresponding to this Spend Limit. ##### post.requestBody.content.application/json.expense\_visibility [Section titled “post.requestBody.content.application/json.expense\_visibility”](#postrequestbodycontentapplicationjsonexpense_visibility) > **expense\_visibility**: `"PRIVATE"` | `"SHARED"` ##### post.requestBody.content.application/json.legal\_entity\_id? [Section titled “post.requestBody.content.application/json.legal\_entity\_id?”](#postrequestbodycontentapplicationjsonlegal_entity_id) > `optional` **legal\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-188) The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity. ##### post.requestBody.content.application/json.limit\_approval\_policy\_id? [Section titled “post.requestBody.content.application/json.limit\_approval\_policy\_id?”](#postrequestbodycontentapplicationjsonlimit_approval_policy_id) > `optional` **limit\_approval\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-189) The ID of the policy for limit increase approval requests. Meant to replace limit\_increase\_request\_policy\_id. ##### post.requestBody.content.application/json.limit\_increase\_request\_policy\_id? [Section titled “post.requestBody.content.application/json.limit\_increase\_request\_policy\_id?”](#postrequestbodycontentapplicationjsonlimit_increase_request_policy_id) > `optional` **limit\_increase\_request\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-190) The ID of the policy for limit increase requests for this Spend Limit. ##### post.requestBody.content.application/json.limit\_increase\_setting [Section titled “post.requestBody.content.application/json.limit\_increase\_setting”](#postrequestbodycontentapplicationjsonlimit_increase_setting) > **limit\_increase\_setting**: `"DISABLED"` | `"ENABLED"` ##### post.requestBody.content.application/json.member\_user\_ids? [Section titled “post.requestBody.content.application/json.member\_user\_ids?”](#postrequestbodycontentapplicationjsonmember_user_ids-1) > `optional` **member\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-191) User IDs of the members of the Spend Limit. ##### post.requestBody.content.application/json.name [Section titled “post.requestBody.content.application/json.name”](#postrequestbodycontentapplicationjsonname-2) > **name**: `string` ###### Description [Section titled “Description”](#description-192) Name for the Spend Limit. ##### post.requestBody.content.application/json.owner\_user\_ids? [Section titled “post.requestBody.content.application/json.owner\_user\_ids?”](#postrequestbodycontentapplicationjsonowner_user_ids-2) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-193) User IDs of the owners of the Spend Limit. ##### post.requestBody.content.application/json.parent\_budget\_id? [Section titled “post.requestBody.content.application/json.parent\_budget\_id?”](#postrequestbodycontentapplicationjsonparent_budget_id-2) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-194) ID of parent Budget. ##### post.requestBody.content.application/json.period\_recurrence\_type [Section titled “post.requestBody.content.application/json.period\_recurrence\_type”](#postrequestbodycontentapplicationjsonperiod_recurrence_type-1) > **period\_recurrence\_type**: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"` ##### post.requestBody.content.application/json.spend\_type [Section titled “post.requestBody.content.application/json.spend\_type”](#postrequestbodycontentapplicationjsonspend_type-1) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### post.requestBody.content.application/json.start\_date? [Section titled “post.requestBody.content.application/json.start\_date?”](#postrequestbodycontentapplicationjsonstart_date-2) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-195) The date when the Spend Limit should start counting. ##### post.requestBody.content.application/json.transaction\_limit? [Section titled “post.requestBody.content.application/json.transaction\_limit?”](#postrequestbodycontentapplicationjsontransaction_limit) > `optional` **transaction\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-14) ###### Type Literal [Section titled “Type Literal”](#type-literal-14) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-11) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-196) 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 [Section titled “Example”](#example-28) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-11) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-197) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-14) ```ts USD ``` ###### Example [Section titled “Example”](#example-29) ```ts USD ``` *** `null` ##### post.responses [Section titled “post.responses”](#postresponses-4) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-4) > **200**: `object` ###### Description [Section titled “Description”](#description-198) The Spend Limit that was created ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-4) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-2) > **application/json**: `object` ##### post.responses.200.content.application/json.account\_id [Section titled “post.responses.200.content.application/json.account\_id”](#postresponses200contentapplicationjsonaccount_id-2) > **account\_id**: `string` ###### Description [Section titled “Description”](#description-199) The Brex account this Spend Limit belongs to. ##### post.responses.200.content.application/json.authorization\_settings? [Section titled “post.responses.200.content.application/json.authorization\_settings?”](#postresponses200contentapplicationjsonauthorization_settings) > `optional` **authorization\_settings?**: { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-15) ###### Type Literal [Section titled “Type Literal”](#type-literal-15) { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } ###### authorization\_type [Section titled “authorization\_type”](#authorization_type) > **authorization\_type**: `"HARD"` | `"SOFT"` ###### base\_limit [Section titled “base\_limit”](#base_limit) > **base\_limit**: `object` ###### base\_limit.amount [Section titled “base\_limit.amount”](#base_limitamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-200) 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 [Section titled “Example”](#example-30) ```ts 700 ``` ###### base\_limit.currency [Section titled “base\_limit.currency”](#base_limitcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-201) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-15) ```ts USD ``` ###### Example [Section titled “Example”](#example-31) ```ts USD ``` ###### limit\_buffer\_percentage? [Section titled “limit\_buffer\_percentage?”](#limit_buffer_percentage) > `optional` **limit\_buffer\_percentage?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-202) The percentage of flexible buffer on the limit as a 0-100 integer. ###### limit\_with\_increases [Section titled “limit\_with\_increases”](#limit_with_increases) > **limit\_with\_increases**: `object` ###### limit\_with\_increases.amount [Section titled “limit\_with\_increases.amount”](#limit_with_increasesamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-203) 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 [Section titled “Example”](#example-32) ```ts 700 ``` ###### limit\_with\_increases.currency [Section titled “limit\_with\_increases.currency”](#limit_with_increasescurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-204) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-16) ```ts USD ``` ###### Example [Section titled “Example”](#example-33) ```ts USD ``` ###### rollover\_refresh\_rate [Section titled “rollover\_refresh\_rate”](#rollover_refresh_rate) > **rollover\_refresh\_rate**: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` *** `null` ##### post.responses.200.content.application/json.authorization\_visibility [Section titled “post.responses.200.content.application/json.authorization\_visibility”](#postresponses200contentapplicationjsonauthorization_visibility) > **authorization\_visibility**: `"PUBLIC"` | `"PRIVATE"` ##### post.responses.200.content.application/json.auto\_create\_limit\_cards\_setting [Section titled “post.responses.200.content.application/json.auto\_create\_limit\_cards\_setting”](#postresponses200contentapplicationjsonauto_create_limit_cards_setting) > **auto\_create\_limit\_cards\_setting**: `"DISABLED"` | `"ALL_MEMBERS"` ##### post.responses.200.content.application/json.auto\_transfer\_cards\_setting [Section titled “post.responses.200.content.application/json.auto\_transfer\_cards\_setting”](#postresponses200contentapplicationjsonauto_transfer_cards_setting) > **auto\_transfer\_cards\_setting**: `"DISABLED"` | `"ENABLED"` ##### post.responses.200.content.application/json.current\_period\_balance? [Section titled “post.responses.200.content.application/json.current\_period\_balance?”](#postresponses200contentapplicationjsoncurrent_period_balance-1) > `optional` **current\_period\_balance?**: { `amount_spent?`: { `amount`: `number`; `currency`: … | …; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: … | …; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-16) ###### Type Literal [Section titled “Type Literal”](#type-literal-16) { `amount_spent?`: { `amount`: `number`; `currency`: … | …; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: … | …; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } ###### amount\_spent? [Section titled “amount\_spent?”](#amount_spent) > `optional` **amount\_spent?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-17) ###### Type Literal [Section titled “Type Literal”](#type-literal-17) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-12) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-205) 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 [Section titled “Example”](#example-34) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-12) > **currency**: … | … ###### Description [Section titled “Description”](#description-206) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-17) ```ts USD ``` ###### Example [Section titled “Example”](#example-35) ```ts USD ``` *** `null` ###### end\_date? [Section titled “end\_date?”](#end_date-3) > `optional` **end\_date?**: `string` | `null` Format: date ###### end\_time? [Section titled “end\_time?”](#end_time) > `optional` **end\_time?**: `string` | `null` Format: date-time ###### rollover\_amount? [Section titled “rollover\_amount?”](#rollover_amount) > `optional` **rollover\_amount?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-18) ###### Type Literal [Section titled “Type Literal”](#type-literal-18) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-13) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-207) 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 [Section titled “Example”](#example-36) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-13) > **currency**: … | … ###### Description [Section titled “Description”](#description-208) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-18) ```ts USD ``` ###### Example [Section titled “Example”](#example-37) ```ts USD ``` *** `null` ###### start\_date? [Section titled “start\_date?”](#start_date-3) > `optional` **start\_date?**: `string` | `null` Format: date ###### start\_time? [Section titled “start\_time?”](#start_time) > `optional` **start\_time?**: `string` | `null` Format: date-time *** `null` ##### post.responses.200.content.application/json.department\_id? [Section titled “post.responses.200.content.application/json.department\_id?”](#postresponses200contentapplicationjsondepartment_id) > `optional` **department\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-209) The department ID to which Spend Limit expenses will be attributed. ##### post.responses.200.content.application/json.description? [Section titled “post.responses.200.content.application/json.description?”](#postresponses200contentapplicationjsondescription-2) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-210) Description of what the Spend Limit is used for. ##### post.responses.200.content.application/json.end\_date? [Section titled “post.responses.200.content.application/json.end\_date?”](#postresponses200contentapplicationjsonend_date-2) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-211) The date when the Spend Limit should expire. ##### post.responses.200.content.application/json.end\_time\_utc? [Section titled “post.responses.200.content.application/json.end\_time\_utc?”](#postresponses200contentapplicationjsonend_time_utc) > `optional` **end\_time\_utc?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-212) The UTC time when the Spend Limit should expire. ##### post.responses.200.content.application/json.expense\_policy\_id [Section titled “post.responses.200.content.application/json.expense\_policy\_id”](#postresponses200contentapplicationjsonexpense_policy_id) > **expense\_policy\_id**: `string` ###### Description [Section titled “Description”](#description-213) The ID of the expense policy corresponding to this Spend Limit. ##### post.responses.200.content.application/json.expense\_visibility [Section titled “post.responses.200.content.application/json.expense\_visibility”](#postresponses200contentapplicationjsonexpense_visibility) > **expense\_visibility**: `"PRIVATE"` | `"SHARED"` ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-214) Unique ID for the Spend Limit. ##### post.responses.200.content.application/json.legal\_entity\_id? [Section titled “post.responses.200.content.application/json.legal\_entity\_id?”](#postresponses200contentapplicationjsonlegal_entity_id) > `optional` **legal\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-215) The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity. ##### post.responses.200.content.application/json.limit\_approval\_policy\_id? [Section titled “post.responses.200.content.application/json.limit\_approval\_policy\_id?”](#postresponses200contentapplicationjsonlimit_approval_policy_id) > `optional` **limit\_approval\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-216) The ID of the policy for limit increase approval requests. Meant to replace limit\_increase\_request\_policy\_id. ##### post.responses.200.content.application/json.limit\_increase\_request\_policy\_id? [Section titled “post.responses.200.content.application/json.limit\_increase\_request\_policy\_id?”](#postresponses200contentapplicationjsonlimit_increase_request_policy_id) > `optional` **limit\_increase\_request\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-217) The ID of the policy for limit increase requests for this Spend Limit. ##### post.responses.200.content.application/json.limit\_increase\_setting [Section titled “post.responses.200.content.application/json.limit\_increase\_setting”](#postresponses200contentapplicationjsonlimit_increase_setting) > **limit\_increase\_setting**: `"DISABLED"` | `"ENABLED"` ##### post.responses.200.content.application/json.member\_user\_ids [Section titled “post.responses.200.content.application/json.member\_user\_ids”](#postresponses200contentapplicationjsonmember_user_ids-1) > **member\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-218) User IDs of the members of the Spend Limit. ##### post.responses.200.content.application/json.merchant\_category\_controls? [Section titled “post.responses.200.content.application/json.merchant\_category\_controls?”](#postresponses200contentapplicationjsonmerchant_category_controls) > `optional` **merchant\_category\_controls?**: { `allowed_merchant_categories?`: (… | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | …)\[] | `null`; `blocked_merchant_categories?`: (… | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | …)\[] | `null`; } | `null` ##### post.responses.200.content.application/json.name [Section titled “post.responses.200.content.application/json.name”](#postresponses200contentapplicationjsonname-2) > **name**: `string` ###### Description [Section titled “Description”](#description-219) Name for the Spend Limit. ##### post.responses.200.content.application/json.owner\_user\_ids [Section titled “post.responses.200.content.application/json.owner\_user\_ids”](#postresponses200contentapplicationjsonowner_user_ids-2) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-220) User IDs of the owners of the Spend Limit. ##### post.responses.200.content.application/json.parent\_budget\_id? [Section titled “post.responses.200.content.application/json.parent\_budget\_id?”](#postresponses200contentapplicationjsonparent_budget_id-2) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-221) ID of parent Budget. ##### post.responses.200.content.application/json.period\_recurrence\_type [Section titled “post.responses.200.content.application/json.period\_recurrence\_type”](#postresponses200contentapplicationjsonperiod_recurrence_type-1) > **period\_recurrence\_type**: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"` ##### post.responses.200.content.application/json.spend\_type [Section titled “post.responses.200.content.application/json.spend\_type”](#postresponses200contentapplicationjsonspend_type-1) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### post.responses.200.content.application/json.start\_date? [Section titled “post.responses.200.content.application/json.start\_date?”](#postresponses200contentapplicationjsonstart_date-2) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-222) The date when the Spend Limit should start counting. ##### post.responses.200.content.application/json.start\_time\_utc? [Section titled “post.responses.200.content.application/json.start\_time\_utc?”](#postresponses200contentapplicationjsonstart_time_utc) > `optional` **start\_time\_utc?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-223) The UTC time when the Spend Limit should start counting. ##### post.responses.200.content.application/json.status [Section titled “post.responses.200.content.application/json.status”](#postresponses200contentapplicationjsonstatus) > **status**: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` ##### post.responses.200.content.application/json.transaction\_limit? [Section titled “post.responses.200.content.application/json.transaction\_limit?”](#postresponses200contentapplicationjsontransaction_limit) > `optional` **transaction\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-19) ###### Type Literal [Section titled “Type Literal”](#type-literal-19) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-14) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-224) 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 [Section titled “Example”](#example-38) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-14) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-225) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-19) ```ts USD ``` ###### Example [Section titled “Example”](#example-39) ```ts USD ``` *** `null` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-61) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400-4) > **400**: `object` ###### Description [Section titled “Description”](#description-226) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content-4) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-62) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-4) > **401**: `object` ###### Description [Section titled “Description”](#description-227) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content-4) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-63) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403-4) > **403**: `object` ###### Description [Section titled “Description”](#description-228) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content-4) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-64) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-8) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-8) > `optional` **trace?**: `undefined` *** ### /v2/spend\_limits/{id} [Section titled “/v2/spend\_limits/{id}”](#v2spend_limitsid) > **/v2/spend\_limits/{id}**: `object` Defined in: [src/budgets/types.gen.ts:203](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L203) #### delete? [Section titled “delete?”](#delete-9) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-9) > **get**: `object` Get Spend Limit ##### Description [Section titled “Description”](#description-229) Retrieves a Spend Limit by ID ##### get.parameters [Section titled “get.parameters”](#getparameters-7) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-7) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-7) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-7) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-3) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-7) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-7) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-7) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-7) > **200**: `object` ###### Description [Section titled “Description”](#description-230) The Spend Limit that was retrieved ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-7) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-7) > **application/json**: `object` ##### get.responses.200.content.application/json.account\_id [Section titled “get.responses.200.content.application/json.account\_id”](#getresponses200contentapplicationjsonaccount_id-2) > **account\_id**: `string` ###### Description [Section titled “Description”](#description-231) The Brex account this Spend Limit belongs to. ##### get.responses.200.content.application/json.authorization\_settings? [Section titled “get.responses.200.content.application/json.authorization\_settings?”](#getresponses200contentapplicationjsonauthorization_settings) > `optional` **authorization\_settings?**: { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-20) ###### Type Literal [Section titled “Type Literal”](#type-literal-20) { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } ###### authorization\_type [Section titled “authorization\_type”](#authorization_type-1) > **authorization\_type**: `"HARD"` | `"SOFT"` ###### base\_limit [Section titled “base\_limit”](#base_limit-1) > **base\_limit**: `object` ###### base\_limit.amount [Section titled “base\_limit.amount”](#base_limitamount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-232) 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 [Section titled “Example”](#example-40) ```ts 700 ``` ###### base\_limit.currency [Section titled “base\_limit.currency”](#base_limitcurrency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-233) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-20) ```ts USD ``` ###### Example [Section titled “Example”](#example-41) ```ts USD ``` ###### limit\_buffer\_percentage? [Section titled “limit\_buffer\_percentage?”](#limit_buffer_percentage-1) > `optional` **limit\_buffer\_percentage?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-234) The percentage of flexible buffer on the limit as a 0-100 integer. ###### limit\_with\_increases [Section titled “limit\_with\_increases”](#limit_with_increases-1) > **limit\_with\_increases**: `object` ###### limit\_with\_increases.amount [Section titled “limit\_with\_increases.amount”](#limit_with_increasesamount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-235) 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 [Section titled “Example”](#example-42) ```ts 700 ``` ###### limit\_with\_increases.currency [Section titled “limit\_with\_increases.currency”](#limit_with_increasescurrency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-236) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-21) ```ts USD ``` ###### Example [Section titled “Example”](#example-43) ```ts USD ``` ###### rollover\_refresh\_rate [Section titled “rollover\_refresh\_rate”](#rollover_refresh_rate-1) > **rollover\_refresh\_rate**: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` *** `null` ##### get.responses.200.content.application/json.authorization\_visibility [Section titled “get.responses.200.content.application/json.authorization\_visibility”](#getresponses200contentapplicationjsonauthorization_visibility) > **authorization\_visibility**: `"PUBLIC"` | `"PRIVATE"` ##### get.responses.200.content.application/json.auto\_create\_limit\_cards\_setting [Section titled “get.responses.200.content.application/json.auto\_create\_limit\_cards\_setting”](#getresponses200contentapplicationjsonauto_create_limit_cards_setting) > **auto\_create\_limit\_cards\_setting**: `"DISABLED"` | `"ALL_MEMBERS"` ##### get.responses.200.content.application/json.auto\_transfer\_cards\_setting [Section titled “get.responses.200.content.application/json.auto\_transfer\_cards\_setting”](#getresponses200contentapplicationjsonauto_transfer_cards_setting) > **auto\_transfer\_cards\_setting**: `"DISABLED"` | `"ENABLED"` ##### get.responses.200.content.application/json.current\_period\_balance? [Section titled “get.responses.200.content.application/json.current\_period\_balance?”](#getresponses200contentapplicationjsoncurrent_period_balance-1) > `optional` **current\_period\_balance?**: { `amount_spent?`: { `amount`: `number`; `currency`: … | …; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: … | …; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-21) ###### Type Literal [Section titled “Type Literal”](#type-literal-21) { `amount_spent?`: { `amount`: `number`; `currency`: … | …; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: … | …; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } ###### amount\_spent? [Section titled “amount\_spent?”](#amount_spent-1) > `optional` **amount\_spent?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-22) ###### Type Literal [Section titled “Type Literal”](#type-literal-22) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-15) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-237) 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 [Section titled “Example”](#example-44) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-15) > **currency**: … | … ###### Description [Section titled “Description”](#description-238) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-22) ```ts USD ``` ###### Example [Section titled “Example”](#example-45) ```ts USD ``` *** `null` ###### end\_date? [Section titled “end\_date?”](#end_date-4) > `optional` **end\_date?**: `string` | `null` Format: date ###### end\_time? [Section titled “end\_time?”](#end_time-1) > `optional` **end\_time?**: `string` | `null` Format: date-time ###### rollover\_amount? [Section titled “rollover\_amount?”](#rollover_amount-1) > `optional` **rollover\_amount?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-23) ###### Type Literal [Section titled “Type Literal”](#type-literal-23) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-16) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-239) 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 [Section titled “Example”](#example-46) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-16) > **currency**: … | … ###### Description [Section titled “Description”](#description-240) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-23) ```ts USD ``` ###### Example [Section titled “Example”](#example-47) ```ts USD ``` *** `null` ###### start\_date? [Section titled “start\_date?”](#start_date-4) > `optional` **start\_date?**: `string` | `null` Format: date ###### start\_time? [Section titled “start\_time?”](#start_time-1) > `optional` **start\_time?**: `string` | `null` Format: date-time *** `null` ##### get.responses.200.content.application/json.department\_id? [Section titled “get.responses.200.content.application/json.department\_id?”](#getresponses200contentapplicationjsondepartment_id) > `optional` **department\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-241) The department ID to which Spend Limit expenses will be attributed. ##### get.responses.200.content.application/json.description? [Section titled “get.responses.200.content.application/json.description?”](#getresponses200contentapplicationjsondescription-3) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-242) Description of what the Spend Limit is used for. ##### get.responses.200.content.application/json.end\_date? [Section titled “get.responses.200.content.application/json.end\_date?”](#getresponses200contentapplicationjsonend_date-2) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-243) The date when the Spend Limit should expire. ##### get.responses.200.content.application/json.end\_time\_utc? [Section titled “get.responses.200.content.application/json.end\_time\_utc?”](#getresponses200contentapplicationjsonend_time_utc) > `optional` **end\_time\_utc?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-244) The UTC time when the Spend Limit should expire. ##### get.responses.200.content.application/json.expense\_policy\_id [Section titled “get.responses.200.content.application/json.expense\_policy\_id”](#getresponses200contentapplicationjsonexpense_policy_id) > **expense\_policy\_id**: `string` ###### Description [Section titled “Description”](#description-245) The ID of the expense policy corresponding to this Spend Limit. ##### get.responses.200.content.application/json.expense\_visibility [Section titled “get.responses.200.content.application/json.expense\_visibility”](#getresponses200contentapplicationjsonexpense_visibility) > **expense\_visibility**: `"PRIVATE"` | `"SHARED"` ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-246) Unique ID for the Spend Limit. ##### get.responses.200.content.application/json.legal\_entity\_id? [Section titled “get.responses.200.content.application/json.legal\_entity\_id?”](#getresponses200contentapplicationjsonlegal_entity_id) > `optional` **legal\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-247) The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity. ##### get.responses.200.content.application/json.limit\_approval\_policy\_id? [Section titled “get.responses.200.content.application/json.limit\_approval\_policy\_id?”](#getresponses200contentapplicationjsonlimit_approval_policy_id) > `optional` **limit\_approval\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-248) The ID of the policy for limit increase approval requests. Meant to replace limit\_increase\_request\_policy\_id. ##### get.responses.200.content.application/json.limit\_increase\_request\_policy\_id? [Section titled “get.responses.200.content.application/json.limit\_increase\_request\_policy\_id?”](#getresponses200contentapplicationjsonlimit_increase_request_policy_id) > `optional` **limit\_increase\_request\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-249) The ID of the policy for limit increase requests for this Spend Limit. ##### get.responses.200.content.application/json.limit\_increase\_setting [Section titled “get.responses.200.content.application/json.limit\_increase\_setting”](#getresponses200contentapplicationjsonlimit_increase_setting) > **limit\_increase\_setting**: `"DISABLED"` | `"ENABLED"` ##### get.responses.200.content.application/json.member\_user\_ids [Section titled “get.responses.200.content.application/json.member\_user\_ids”](#getresponses200contentapplicationjsonmember_user_ids-1) > **member\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-250) User IDs of the members of the Spend Limit. ##### get.responses.200.content.application/json.merchant\_category\_controls? [Section titled “get.responses.200.content.application/json.merchant\_category\_controls?”](#getresponses200contentapplicationjsonmerchant_category_controls) > `optional` **merchant\_category\_controls?**: { `allowed_merchant_categories?`: (… | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | …)\[] | `null`; `blocked_merchant_categories?`: (… | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | …)\[] | `null`; } | `null` ##### get.responses.200.content.application/json.name [Section titled “get.responses.200.content.application/json.name”](#getresponses200contentapplicationjsonname-3) > **name**: `string` ###### Description [Section titled “Description”](#description-251) Name for the Spend Limit. ##### get.responses.200.content.application/json.owner\_user\_ids [Section titled “get.responses.200.content.application/json.owner\_user\_ids”](#getresponses200contentapplicationjsonowner_user_ids-2) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-252) User IDs of the owners of the Spend Limit. ##### get.responses.200.content.application/json.parent\_budget\_id? [Section titled “get.responses.200.content.application/json.parent\_budget\_id?”](#getresponses200contentapplicationjsonparent_budget_id-2) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-253) ID of parent Budget. ##### get.responses.200.content.application/json.period\_recurrence\_type [Section titled “get.responses.200.content.application/json.period\_recurrence\_type”](#getresponses200contentapplicationjsonperiod_recurrence_type-1) > **period\_recurrence\_type**: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"` ##### get.responses.200.content.application/json.spend\_type [Section titled “get.responses.200.content.application/json.spend\_type”](#getresponses200contentapplicationjsonspend_type-1) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### get.responses.200.content.application/json.start\_date? [Section titled “get.responses.200.content.application/json.start\_date?”](#getresponses200contentapplicationjsonstart_date-2) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-254) The date when the Spend Limit should start counting. ##### get.responses.200.content.application/json.start\_time\_utc? [Section titled “get.responses.200.content.application/json.start\_time\_utc?”](#getresponses200contentapplicationjsonstart_time_utc) > `optional` **start\_time\_utc?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-255) The UTC time when the Spend Limit should start counting. ##### get.responses.200.content.application/json.status [Section titled “get.responses.200.content.application/json.status”](#getresponses200contentapplicationjsonstatus) > **status**: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` ##### get.responses.200.content.application/json.transaction\_limit? [Section titled “get.responses.200.content.application/json.transaction\_limit?”](#getresponses200contentapplicationjsontransaction_limit) > `optional` **transaction\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-24) ###### Type Literal [Section titled “Type Literal”](#type-literal-24) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-17) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-256) 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 [Section titled “Example”](#example-48) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-17) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-257) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-24) ```ts USD ``` ###### Example [Section titled “Example”](#example-49) ```ts USD ``` *** `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-7) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-65) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-7) > **400**: `object` ###### Description [Section titled “Description”](#description-258) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-7) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-7) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-66) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-7) > **401**: `object` ###### Description [Section titled “Description”](#description-259) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-7) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-7) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-67) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-7) > **403**: `object` ###### Description [Section titled “Description”](#description-260) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-7) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-7) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-68) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404-5) > **404**: `object` ###### Description [Section titled “Description”](#description-261) Not Found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content-5) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-69) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-9) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-9) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-9) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-9) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-9) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-9) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-9) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-9) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-9) > `optional` **post?**: `undefined` #### put [Section titled “put”](#put-9) > **put**: `object` Update Spend Limit ##### Description [Section titled “Description”](#description-262) Updates a Spend Limit ##### put.parameters [Section titled “put.parameters”](#putparameters-2) > **parameters**: `object` ##### put.parameters.cookie? [Section titled “put.parameters.cookie?”](#putparameterscookie-2) > `optional` **cookie?**: `undefined` ##### put.parameters.header [Section titled “put.parameters.header”](#putparametersheader-2) > **header**: `object` ##### put.parameters.header.Idempotency-Key [Section titled “put.parameters.header.Idempotency-Key”](#putparametersheaderidempotency-key-2) > **Idempotency-Key**: `string` ##### put.parameters.path [Section titled “put.parameters.path”](#putparameterspath-2) > **path**: `object` ##### put.parameters.path.id [Section titled “put.parameters.path.id”](#putparameterspathid-2) > **id**: `string` ##### put.parameters.query? [Section titled “put.parameters.query?”](#putparametersquery-2) > `optional` **query?**: `undefined` ##### put.requestBody [Section titled “put.requestBody”](#putrequestbody-2) > **requestBody**: `object` ##### put.requestBody.content [Section titled “put.requestBody.content”](#putrequestbodycontent-2) > **content**: `object` ##### put.requestBody.content.application/json [Section titled “put.requestBody.content.application/json”](#putrequestbodycontentapplicationjson-2) > **application/json**: `object` ##### put.requestBody.content.application/json.authorization\_settings? [Section titled “put.requestBody.content.application/json.authorization\_settings?”](#putrequestbodycontentapplicationjsonauthorization_settings) > `optional` **authorization\_settings?**: { `authorization_type?`: `"HARD"` | `"SOFT"` | `null`; `base_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `limit_buffer_percentage?`: `number` | `null`; `rollover_refresh_rate?`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-25) ###### Type Literal [Section titled “Type Literal”](#type-literal-25) { `authorization_type?`: `"HARD"` | `"SOFT"` | `null`; `base_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `limit_buffer_percentage?`: `number` | `null`; `rollover_refresh_rate?`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `null`; } ###### authorization\_type? [Section titled “authorization\_type?”](#authorization_type-2) > `optional` **authorization\_type?**: `"HARD"` | `"SOFT"` | `null` ###### base\_limit? [Section titled “base\_limit?”](#base_limit-2) > `optional` **base\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-26) ###### Type Literal [Section titled “Type Literal”](#type-literal-26) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-18) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-263) 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 [Section titled “Example”](#example-50) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-18) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-264) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-25) ```ts USD ``` ###### Example [Section titled “Example”](#example-51) ```ts USD ``` *** `null` ###### limit\_buffer\_percentage? [Section titled “limit\_buffer\_percentage?”](#limit_buffer_percentage-2) > `optional` **limit\_buffer\_percentage?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-265) The percentage of flexible buffer on the limit as a 0-100 integer. ###### rollover\_refresh\_rate? [Section titled “rollover\_refresh\_rate?”](#rollover_refresh_rate-2) > `optional` **rollover\_refresh\_rate?**: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `null` *** `null` ##### put.requestBody.content.application/json.authorization\_visibility? [Section titled “put.requestBody.content.application/json.authorization\_visibility?”](#putrequestbodycontentapplicationjsonauthorization_visibility) > `optional` **authorization\_visibility?**: `"PUBLIC"` | `"PRIVATE"` | `null` ##### put.requestBody.content.application/json.auto\_create\_limit\_cards\_setting? [Section titled “put.requestBody.content.application/json.auto\_create\_limit\_cards\_setting?”](#putrequestbodycontentapplicationjsonauto_create_limit_cards_setting) > `optional` **auto\_create\_limit\_cards\_setting?**: `"DISABLED"` | `"ALL_MEMBERS"` | `null` ##### put.requestBody.content.application/json.auto\_transfer\_cards\_setting? [Section titled “put.requestBody.content.application/json.auto\_transfer\_cards\_setting?”](#putrequestbodycontentapplicationjsonauto_transfer_cards_setting) > `optional` **auto\_transfer\_cards\_setting?**: `"DISABLED"` | `"ENABLED"` | `null` ##### put.requestBody.content.application/json.department\_id? [Section titled “put.requestBody.content.application/json.department\_id?”](#putrequestbodycontentapplicationjsondepartment_id) > `optional` **department\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-266) The department ID to which Spend Limit expenses will be attributed. ##### put.requestBody.content.application/json.description? [Section titled “put.requestBody.content.application/json.description?”](#putrequestbodycontentapplicationjsondescription-2) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-267) Description of what the Spend Limit is used for. ##### put.requestBody.content.application/json.end\_date? [Section titled “put.requestBody.content.application/json.end\_date?”](#putrequestbodycontentapplicationjsonend_date-2) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-268) The date when the Spend Limit should expire. ##### put.requestBody.content.application/json.expense\_policy\_id? [Section titled “put.requestBody.content.application/json.expense\_policy\_id?”](#putrequestbodycontentapplicationjsonexpense_policy_id) > `optional` **expense\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-269) The ID of the expense policy corresponding to this Spend Limit. ##### put.requestBody.content.application/json.expense\_visibility? [Section titled “put.requestBody.content.application/json.expense\_visibility?”](#putrequestbodycontentapplicationjsonexpense_visibility) > `optional` **expense\_visibility?**: `"PRIVATE"` | `"SHARED"` | `null` ##### put.requestBody.content.application/json.legal\_entity\_id? [Section titled “put.requestBody.content.application/json.legal\_entity\_id?”](#putrequestbodycontentapplicationjsonlegal_entity_id) > `optional` **legal\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-270) The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity. ##### put.requestBody.content.application/json.limit\_approval\_policy\_id? [Section titled “put.requestBody.content.application/json.limit\_approval\_policy\_id?”](#putrequestbodycontentapplicationjsonlimit_approval_policy_id) > `optional` **limit\_approval\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-271) The ID of the policy for limit increase approval requests. Meant to replace limit\_increase\_request\_policy\_id. ##### put.requestBody.content.application/json.limit\_increase\_request\_policy\_id? [Section titled “put.requestBody.content.application/json.limit\_increase\_request\_policy\_id?”](#putrequestbodycontentapplicationjsonlimit_increase_request_policy_id) > `optional` **limit\_increase\_request\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-272) The ID of the policy for limit increase requests for this Spend Limit. ##### put.requestBody.content.application/json.limit\_increase\_setting? [Section titled “put.requestBody.content.application/json.limit\_increase\_setting?”](#putrequestbodycontentapplicationjsonlimit_increase_setting) > `optional` **limit\_increase\_setting?**: `"DISABLED"` | `"ENABLED"` | `null` ##### put.requestBody.content.application/json.member\_user\_ids? [Section titled “put.requestBody.content.application/json.member\_user\_ids?”](#putrequestbodycontentapplicationjsonmember_user_ids-1) > `optional` **member\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-273) User IDs of the members of the Spend Limit. ##### put.requestBody.content.application/json.merchant\_category\_controls? [Section titled “put.requestBody.content.application/json.merchant\_category\_controls?”](#putrequestbodycontentapplicationjsonmerchant_category_controls) > `optional` **merchant\_category\_controls?**: { `allowed_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; `blocked_merchant_categories?`: (`"ADVERTISING_MARKETING"` | `"GROCERY"` | `"TELEPHONY"` | `"OFFICE_SUPPLIES"` | `"PRIVATE_AIR_TRAVEL"` | `"CLOTHING"` | `"CAR_RENTAL"` | `"VEHICLE_EXPENSES"` | `"RESTAURANTS"` | `"GAMBLING"` | `"FLOWERS"` | `"ELECTRONICS"` | `"LEGAL_SERVICES"` | `"UTILITIES"` | `"FURNITURE"` | `"BARS_NIGHTLIFE"` | `"LAUNDRY"` | `"EVENT_EXPENSES"` | `"SHIPPING"` | `"OTHER_TRAVEL_EXPENSES"` | `"CHARITY"` | `"SOFTWARE"` | `"LODGING"` | `"FACILITIES_EXPENSES"` | `"SERVERS"` | `"CONFERENCES"` | `"FOOD_DELIVERY"` | `"RENT"` | `"AIRLINE_EXPENSES"` | `"OTHER_BUSINESS_EXPENSES"` | `"BANK_FINANCIAL_FEES"` | `"BOOKS_NEWSPAPERS"` | `"CONSULTANT_CONTRACTOR"` | `"CORPORATE_INSURANCE"` | `"DIGITAL_GOODS"` | `"LICENSES_TAXES"` | `"GAS_FUEL"` | `"GENERAL_MERCHANDISE"` | `"MEDICAL"` | `"MEMBERSHIPS_CLUBS"` | `"PARKING_EXPENSES"` | `"POLITICAL_DONATIONS"` | `"PUBLIC_TRANSPORTATION"` | `"RECURRING_SOFTWARE_SAAS"` | `"RIDESHARE_TAXI"` | `"TOLL_BRIDGE_FEES"` | `"TRAINING_EDUCATION"` | `"TRAVEL"`)\[] | `null`; } | `null` ##### put.requestBody.content.application/json.name? [Section titled “put.requestBody.content.application/json.name?”](#putrequestbodycontentapplicationjsonname-2) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-274) Name for the Spend Limit. ##### put.requestBody.content.application/json.owner\_user\_ids? [Section titled “put.requestBody.content.application/json.owner\_user\_ids?”](#putrequestbodycontentapplicationjsonowner_user_ids-2) > `optional` **owner\_user\_ids?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-275) User IDs of the owners of the Spend Limit. ##### put.requestBody.content.application/json.period\_recurrence\_type? [Section titled “put.requestBody.content.application/json.period\_recurrence\_type?”](#putrequestbodycontentapplicationjsonperiod_recurrence_type-1) > `optional` **period\_recurrence\_type?**: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"` | `null` ##### put.requestBody.content.application/json.set\_end\_date\_null? [Section titled “put.requestBody.content.application/json.set\_end\_date\_null?”](#putrequestbodycontentapplicationjsonset_end_date_null) > `optional` **set\_end\_date\_null?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-276) Set the date when the Spend Limit should expire to null. ##### put.requestBody.content.application/json.set\_start\_date\_null? [Section titled “put.requestBody.content.application/json.set\_start\_date\_null?”](#putrequestbodycontentapplicationjsonset_start_date_null) > `optional` **set\_start\_date\_null?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-277) Set the date when the Spend Limit should start counting to null. ##### put.requestBody.content.application/json.set\_transaction\_limit\_null? [Section titled “put.requestBody.content.application/json.set\_transaction\_limit\_null?”](#putrequestbodycontentapplicationjsonset_transaction_limit_null) > `optional` **set\_transaction\_limit\_null?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-278) Set the transaction limit that this Spend Limit will enforce to null. ##### put.requestBody.content.application/json.spend\_type? [Section titled “put.requestBody.content.application/json.spend\_type?”](#putrequestbodycontentapplicationjsonspend_type-1) > `optional` **spend\_type?**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` | `null` ##### put.requestBody.content.application/json.start\_date? [Section titled “put.requestBody.content.application/json.start\_date?”](#putrequestbodycontentapplicationjsonstart_date-2) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-279) The date when the Spend Limit should start counting. ##### put.requestBody.content.application/json.status? [Section titled “put.requestBody.content.application/json.status?”](#putrequestbodycontentapplicationjsonstatus) > `optional` **status?**: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` | `null` ##### put.requestBody.content.application/json.transaction\_limit? [Section titled “put.requestBody.content.application/json.transaction\_limit?”](#putrequestbodycontentapplicationjsontransaction_limit) > `optional` **transaction\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-27) ###### Type Literal [Section titled “Type Literal”](#type-literal-27) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-19) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-280) 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 [Section titled “Example”](#example-52) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-19) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-281) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-26) ```ts USD ``` ###### Example [Section titled “Example”](#example-53) ```ts USD ``` *** `null` ##### put.responses [Section titled “put.responses”](#putresponses-2) > **responses**: `object` ##### put.responses.200 [Section titled “put.responses.200”](#putresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-282) The Spend Limit that was updated ##### put.responses.200.content [Section titled “put.responses.200.content”](#putresponses200content-2) > **content**: `object` ##### put.responses.200.content.application/json [Section titled “put.responses.200.content.application/json”](#putresponses200contentapplicationjson-2) > **application/json**: `object` ##### put.responses.200.content.application/json.account\_id [Section titled “put.responses.200.content.application/json.account\_id”](#putresponses200contentapplicationjsonaccount_id-2) > **account\_id**: `string` ###### Description [Section titled “Description”](#description-283) The Brex account this Spend Limit belongs to. ##### put.responses.200.content.application/json.authorization\_settings? [Section titled “put.responses.200.content.application/json.authorization\_settings?”](#putresponses200contentapplicationjsonauthorization_settings) > `optional` **authorization\_settings?**: { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-28) ###### Type Literal [Section titled “Type Literal”](#type-literal-28) { `authorization_type`: `"HARD"` | `"SOFT"`; `base_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; `limit_buffer_percentage?`: `number` | `null`; `limit_with_increases`: { `amount`: `number`; `currency`: `string` | `null`; }; `rollover_refresh_rate`: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"`; } ###### authorization\_type [Section titled “authorization\_type”](#authorization_type-3) > **authorization\_type**: `"HARD"` | `"SOFT"` ###### base\_limit [Section titled “base\_limit”](#base_limit-3) > **base\_limit**: `object` ###### base\_limit.amount [Section titled “base\_limit.amount”](#base_limitamount-2) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-284) 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 [Section titled “Example”](#example-54) ```ts 700 ``` ###### base\_limit.currency [Section titled “base\_limit.currency”](#base_limitcurrency-2) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-285) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-27) ```ts USD ``` ###### Example [Section titled “Example”](#example-55) ```ts USD ``` ###### limit\_buffer\_percentage? [Section titled “limit\_buffer\_percentage?”](#limit_buffer_percentage-3) > `optional` **limit\_buffer\_percentage?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-286) The percentage of flexible buffer on the limit as a 0-100 integer. ###### limit\_with\_increases [Section titled “limit\_with\_increases”](#limit_with_increases-2) > **limit\_with\_increases**: `object` ###### limit\_with\_increases.amount [Section titled “limit\_with\_increases.amount”](#limit_with_increasesamount-2) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-287) 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 [Section titled “Example”](#example-56) ```ts 700 ``` ###### limit\_with\_increases.currency [Section titled “limit\_with\_increases.currency”](#limit_with_increasescurrency-2) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-288) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-28) ```ts USD ``` ###### Example [Section titled “Example”](#example-57) ```ts USD ``` ###### rollover\_refresh\_rate [Section titled “rollover\_refresh\_rate”](#rollover_refresh_rate-3) > **rollover\_refresh\_rate**: `"OFF"` | `"NEVER"` | `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` *** `null` ##### put.responses.200.content.application/json.authorization\_visibility [Section titled “put.responses.200.content.application/json.authorization\_visibility”](#putresponses200contentapplicationjsonauthorization_visibility) > **authorization\_visibility**: `"PUBLIC"` | `"PRIVATE"` ##### put.responses.200.content.application/json.auto\_create\_limit\_cards\_setting [Section titled “put.responses.200.content.application/json.auto\_create\_limit\_cards\_setting”](#putresponses200contentapplicationjsonauto_create_limit_cards_setting) > **auto\_create\_limit\_cards\_setting**: `"DISABLED"` | `"ALL_MEMBERS"` ##### put.responses.200.content.application/json.auto\_transfer\_cards\_setting [Section titled “put.responses.200.content.application/json.auto\_transfer\_cards\_setting”](#putresponses200contentapplicationjsonauto_transfer_cards_setting) > **auto\_transfer\_cards\_setting**: `"DISABLED"` | `"ENABLED"` ##### put.responses.200.content.application/json.current\_period\_balance? [Section titled “put.responses.200.content.application/json.current\_period\_balance?”](#putresponses200contentapplicationjsoncurrent_period_balance-1) > `optional` **current\_period\_balance?**: { `amount_spent?`: { `amount`: `number`; `currency`: … | …; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: … | …; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-29) ###### Type Literal [Section titled “Type Literal”](#type-literal-29) { `amount_spent?`: { `amount`: `number`; `currency`: … | …; } | `null`; `end_date?`: `string` | `null`; `end_time?`: `string` | `null`; `rollover_amount?`: { `amount`: `number`; `currency`: … | …; } | `null`; `start_date?`: `string` | `null`; `start_time?`: `string` | `null`; } ###### amount\_spent? [Section titled “amount\_spent?”](#amount_spent-2) > `optional` **amount\_spent?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-30) ###### Type Literal [Section titled “Type Literal”](#type-literal-30) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-20) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-289) 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 [Section titled “Example”](#example-58) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-20) > **currency**: … | … ###### Description [Section titled “Description”](#description-290) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-29) ```ts USD ``` ###### Example [Section titled “Example”](#example-59) ```ts USD ``` *** `null` ###### end\_date? [Section titled “end\_date?”](#end_date-5) > `optional` **end\_date?**: `string` | `null` Format: date ###### end\_time? [Section titled “end\_time?”](#end_time-2) > `optional` **end\_time?**: `string` | `null` Format: date-time ###### rollover\_amount? [Section titled “rollover\_amount?”](#rollover_amount-2) > `optional` **rollover\_amount?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-31) ###### Type Literal [Section titled “Type Literal”](#type-literal-31) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-21) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-291) 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 [Section titled “Example”](#example-60) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-21) > **currency**: … | … ###### Description [Section titled “Description”](#description-292) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-30) ```ts USD ``` ###### Example [Section titled “Example”](#example-61) ```ts USD ``` *** `null` ###### start\_date? [Section titled “start\_date?”](#start_date-5) > `optional` **start\_date?**: `string` | `null` Format: date ###### start\_time? [Section titled “start\_time?”](#start_time-2) > `optional` **start\_time?**: `string` | `null` Format: date-time *** `null` ##### put.responses.200.content.application/json.department\_id? [Section titled “put.responses.200.content.application/json.department\_id?”](#putresponses200contentapplicationjsondepartment_id) > `optional` **department\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-293) The department ID to which Spend Limit expenses will be attributed. ##### put.responses.200.content.application/json.description? [Section titled “put.responses.200.content.application/json.description?”](#putresponses200contentapplicationjsondescription-2) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-294) Description of what the Spend Limit is used for. ##### put.responses.200.content.application/json.end\_date? [Section titled “put.responses.200.content.application/json.end\_date?”](#putresponses200contentapplicationjsonend_date-2) > `optional` **end\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-295) The date when the Spend Limit should expire. ##### put.responses.200.content.application/json.end\_time\_utc? [Section titled “put.responses.200.content.application/json.end\_time\_utc?”](#putresponses200contentapplicationjsonend_time_utc) > `optional` **end\_time\_utc?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-296) The UTC time when the Spend Limit should expire. ##### put.responses.200.content.application/json.expense\_policy\_id [Section titled “put.responses.200.content.application/json.expense\_policy\_id”](#putresponses200contentapplicationjsonexpense_policy_id) > **expense\_policy\_id**: `string` ###### Description [Section titled “Description”](#description-297) The ID of the expense policy corresponding to this Spend Limit. ##### put.responses.200.content.application/json.expense\_visibility [Section titled “put.responses.200.content.application/json.expense\_visibility”](#putresponses200contentapplicationjsonexpense_visibility) > **expense\_visibility**: `"PRIVATE"` | `"SHARED"` ##### put.responses.200.content.application/json.id [Section titled “put.responses.200.content.application/json.id”](#putresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-298) Unique ID for the Spend Limit. ##### put.responses.200.content.application/json.legal\_entity\_id? [Section titled “put.responses.200.content.application/json.legal\_entity\_id?”](#putresponses200contentapplicationjsonlegal_entity_id) > `optional` **legal\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-299) The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity. ##### put.responses.200.content.application/json.limit\_approval\_policy\_id? [Section titled “put.responses.200.content.application/json.limit\_approval\_policy\_id?”](#putresponses200contentapplicationjsonlimit_approval_policy_id) > `optional` **limit\_approval\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-300) The ID of the policy for limit increase approval requests. Meant to replace limit\_increase\_request\_policy\_id. ##### put.responses.200.content.application/json.limit\_increase\_request\_policy\_id? [Section titled “put.responses.200.content.application/json.limit\_increase\_request\_policy\_id?”](#putresponses200contentapplicationjsonlimit_increase_request_policy_id) > `optional` **limit\_increase\_request\_policy\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-301) The ID of the policy for limit increase requests for this Spend Limit. ##### put.responses.200.content.application/json.limit\_increase\_setting [Section titled “put.responses.200.content.application/json.limit\_increase\_setting”](#putresponses200contentapplicationjsonlimit_increase_setting) > **limit\_increase\_setting**: `"DISABLED"` | `"ENABLED"` ##### put.responses.200.content.application/json.member\_user\_ids [Section titled “put.responses.200.content.application/json.member\_user\_ids”](#putresponses200contentapplicationjsonmember_user_ids-1) > **member\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-302) User IDs of the members of the Spend Limit. ##### put.responses.200.content.application/json.merchant\_category\_controls? [Section titled “put.responses.200.content.application/json.merchant\_category\_controls?”](#putresponses200contentapplicationjsonmerchant_category_controls) > `optional` **merchant\_category\_controls?**: { `allowed_merchant_categories?`: (… | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | …)\[] | `null`; `blocked_merchant_categories?`: (… | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | … | …)\[] | `null`; } | `null` ##### put.responses.200.content.application/json.name [Section titled “put.responses.200.content.application/json.name”](#putresponses200contentapplicationjsonname-2) > **name**: `string` ###### Description [Section titled “Description”](#description-303) Name for the Spend Limit. ##### put.responses.200.content.application/json.owner\_user\_ids [Section titled “put.responses.200.content.application/json.owner\_user\_ids”](#putresponses200contentapplicationjsonowner_user_ids-2) > **owner\_user\_ids**: `string`\[] ###### Description [Section titled “Description”](#description-304) User IDs of the owners of the Spend Limit. ##### put.responses.200.content.application/json.parent\_budget\_id? [Section titled “put.responses.200.content.application/json.parent\_budget\_id?”](#putresponses200contentapplicationjsonparent_budget_id-2) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-305) ID of parent Budget. ##### put.responses.200.content.application/json.period\_recurrence\_type [Section titled “put.responses.200.content.application/json.period\_recurrence\_type”](#putresponses200contentapplicationjsonperiod_recurrence_type-1) > **period\_recurrence\_type**: `"PER_MONTH"` | `"PER_QUARTER"` | `"PER_YEAR"` | `"ONE_TIME"` | `"PER_WEEK"` ##### put.responses.200.content.application/json.spend\_type [Section titled “put.responses.200.content.application/json.spend\_type”](#putresponses200contentapplicationjsonspend_type-1) > **spend\_type**: `"BUDGET_PROVISIONED_CARDS_ONLY"` | `"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"` ##### put.responses.200.content.application/json.start\_date? [Section titled “put.responses.200.content.application/json.start\_date?”](#putresponses200contentapplicationjsonstart_date-2) > `optional` **start\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-306) The date when the Spend Limit should start counting. ##### put.responses.200.content.application/json.start\_time\_utc? [Section titled “put.responses.200.content.application/json.start\_time\_utc?”](#putresponses200contentapplicationjsonstart_time_utc) > `optional` **start\_time\_utc?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-307) The UTC time when the Spend Limit should start counting. ##### put.responses.200.content.application/json.status [Section titled “put.responses.200.content.application/json.status”](#putresponses200contentapplicationjsonstatus) > **status**: `"ACTIVE"` | `"ARCHIVED"` | `"DELETED"` | `"EXPIRED"` ##### put.responses.200.content.application/json.transaction\_limit? [Section titled “put.responses.200.content.application/json.transaction\_limit?”](#putresponses200contentapplicationjsontransaction_limit) > `optional` **transaction\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-32) ###### Type Literal [Section titled “Type Literal”](#type-literal-32) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-22) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-308) 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 [Section titled “Example”](#example-62) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-22) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-309) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-31) ```ts USD ``` ###### Example [Section titled “Example”](#example-63) ```ts USD ``` *** `null` ##### put.responses.200.headers [Section titled “put.responses.200.headers”](#putresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-70) \[`name`: `string`]: `unknown` ##### put.responses.400 [Section titled “put.responses.400”](#putresponses400-2) > **400**: `object` ###### Description [Section titled “Description”](#description-310) Bad request ##### put.responses.400.content? [Section titled “put.responses.400.content?”](#putresponses400content-2) > `optional` **content?**: `undefined` ##### put.responses.400.headers [Section titled “put.responses.400.headers”](#putresponses400headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-71) \[`name`: `string`]: `unknown` ##### put.responses.401 [Section titled “put.responses.401”](#putresponses401-2) > **401**: `object` ###### Description [Section titled “Description”](#description-311) Unauthorized ##### put.responses.401.content? [Section titled “put.responses.401.content?”](#putresponses401content-2) > `optional` **content?**: `undefined` ##### put.responses.401.headers [Section titled “put.responses.401.headers”](#putresponses401headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-72) \[`name`: `string`]: `unknown` ##### put.responses.403 [Section titled “put.responses.403”](#putresponses403-2) > **403**: `object` ###### Description [Section titled “Description”](#description-312) Forbidden ##### put.responses.403.content? [Section titled “put.responses.403.content?”](#putresponses403content-2) > `optional` **content?**: `undefined` ##### put.responses.403.headers [Section titled “put.responses.403.headers”](#putresponses403headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-73) \[`name`: `string`]: `unknown` ##### put.responses.404 [Section titled “put.responses.404”](#putresponses404-2) > **404**: `object` ###### Description [Section titled “Description”](#description-313) Not Found ##### put.responses.404.content? [Section titled “put.responses.404.content?”](#putresponses404content-2) > `optional` **content?**: `undefined` ##### put.responses.404.headers [Section titled “put.responses.404.headers”](#putresponses404headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-74) \[`name`: `string`]: `unknown` #### trace? [Section titled “trace?”](#trace-9) > `optional` **trace?**: `undefined` *** ### /v2/spend\_limits/{id}/archive [Section titled “/v2/spend\_limits/{id}/archive”](#v2spend_limitsidarchive) > **/v2/spend\_limits/{id}/archive**: `object` Defined in: [src/budgets/types.gen.ts:227](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/types.gen.ts#L227) #### delete? [Section titled “delete?”](#delete-10) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-10) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-10) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-10) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-10) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-10) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-10) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-10) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-10) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-10) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-10) > **post**: `object` Archive a Spend Limit ##### Description [Section titled “Description”](#description-314) Archives a Spend Limit, making it unusable for future expenses and removing it from the UI ##### post.parameters [Section titled “post.parameters”](#postparameters-5) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-5) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-5) > `optional` **header?**: `undefined` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-5) > **path**: `object` ##### post.parameters.path.id [Section titled “post.parameters.path.id”](#postparameterspathid-2) > **id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-5) > `optional` **query?**: `undefined` ##### post.requestBody? [Section titled “post.requestBody?”](#postrequestbody-5) > `optional` **requestBody?**: `undefined` ##### post.responses [Section titled “post.responses”](#postresponses-5) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-5) > **200**: `object` ###### Description [Section titled “Description”](#description-315) The Spend Limit that was archived ##### post.responses.200.content? [Section titled “post.responses.200.content?”](#postresponses200content-5) > `optional` **content?**: `undefined` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-75) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400-5) > **400**: `object` ###### Description [Section titled “Description”](#description-316) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content-5) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-76) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-5) > **401**: `object` ###### Description [Section titled “Description”](#description-317) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content-5) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-77) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403-5) > **403**: `object` ###### Description [Section titled “Description”](#description-318) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content-5) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-78) \[`name`: `string`]: `unknown` ##### post.responses.404 [Section titled “post.responses.404”](#postresponses404-2) > **404**: `object` ###### Description [Section titled “Description”](#description-319) Not Found ##### post.responses.404.content? [Section titled “post.responses.404.content?”](#postresponses404content-2) > `optional` **content?**: `undefined` ##### post.responses.404.headers [Section titled “post.responses.404.headers”](#postresponses404headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-79) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-10) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-10) > `optional` **trace?**: `undefined` # AuthorizationSettings > **AuthorizationSettings** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"AuthorizationSettings"`] Defined in: [src/budgets/schemas.gen.ts:5](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L5) # AuthorizationType > **AuthorizationType** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"AuthorizationType"`] Defined in: [src/budgets/schemas.gen.ts:6](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L6) # AuthorizationVisibility > **AuthorizationVisibility** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"AuthorizationVisibility"`] Defined in: [src/budgets/schemas.gen.ts:7](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L7) # AutoCreateLimitCardsSetting > **AutoCreateLimitCardsSetting** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"AutoCreateLimitCardsSetting"`] Defined in: [src/budgets/schemas.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L8) # AutoTransferCardsSetting > **AutoTransferCardsSetting** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"AutoTransferCardsSetting"`] Defined in: [src/budgets/schemas.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L9) # Budget > **Budget** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"Budget"`] Defined in: [src/budgets/schemas.gen.ts:10](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L10) # BudgetBlueprint > **BudgetBlueprint** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"BudgetBlueprint"`] Defined in: [src/budgets/schemas.gen.ts:11](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L11) # BudgetLimitVisibilityType > **BudgetLimitVisibilityType** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"BudgetLimitVisibilityType"`] Defined in: [src/budgets/schemas.gen.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L12) # BudgetPeriodBalance > **BudgetPeriodBalance** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"BudgetPeriodBalance"`] Defined in: [src/budgets/schemas.gen.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L13) # BudgetProgram > **BudgetProgram** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"BudgetProgram"`] Defined in: [src/budgets/schemas.gen.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L14) # BudgetProgramStatus > **BudgetProgramStatus** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"BudgetProgramStatus"`] Defined in: [src/budgets/schemas.gen.ts:15](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L15) # BudgetStatus > **BudgetStatus** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"BudgetStatus"`] Defined in: [src/budgets/schemas.gen.ts:16](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L16) # BudgetType > **BudgetType** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"BudgetType"`] Defined in: [src/budgets/schemas.gen.ts:17](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L17) # CreateAuthorizationSettings > **CreateAuthorizationSettings** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"CreateAuthorizationSettings"`] Defined in: [src/budgets/schemas.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L18) # CreateBudgetBlueprintRequest > **CreateBudgetBlueprintRequest** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"CreateBudgetBlueprintRequest"`] Defined in: [src/budgets/schemas.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L19) # CreateBudgetProgramRequest > **CreateBudgetProgramRequest** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"CreateBudgetProgramRequest"`] Defined in: [src/budgets/schemas.gen.ts:20](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L20) # CreateBudgetRequest > **CreateBudgetRequest** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"CreateBudgetRequest"`] Defined in: [src/budgets/schemas.gen.ts:21](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L21) # CreateSpendBudgetRequest > **CreateSpendBudgetRequest** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"CreateSpendBudgetRequest"`] Defined in: [src/budgets/schemas.gen.ts:22](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L22) # CreateSpendLimitRequest > **CreateSpendLimitRequest** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"CreateSpendLimitRequest"`] Defined in: [src/budgets/schemas.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L23) # EmployeeFilter > **EmployeeFilter** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"EmployeeFilter"`] Defined in: [src/budgets/schemas.gen.ts:24](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L24) # EmploymentStatus > **EmploymentStatus** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"EmploymentStatus"`] Defined in: [src/budgets/schemas.gen.ts:25](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L25) # EmploymentType > **EmploymentType** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"EmploymentType"`] Defined in: [src/budgets/schemas.gen.ts:26](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L26) # ExpenseVisibility > **ExpenseVisibility** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"ExpenseVisibility"`] Defined in: [src/budgets/schemas.gen.ts:27](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L27) # LimitIncreaseSetting > **LimitIncreaseSetting** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"LimitIncreaseSetting"`] Defined in: [src/budgets/schemas.gen.ts:28](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L28) # LimitType > **LimitType** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"LimitType"`] Defined in: [src/budgets/schemas.gen.ts:29](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L29) # LimitType_1 > **LimitType\_1** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"LimitType_1"`] Defined in: [src/budgets/schemas.gen.ts:30](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L30) # LimitType_3 > **LimitType\_3** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"LimitType_3"`] Defined in: [src/budgets/schemas.gen.ts:31](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L31) # LimitType_4 > **LimitType\_4** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"LimitType_4"`] Defined in: [src/budgets/schemas.gen.ts:32](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L32) # MerchantCategory > **MerchantCategory** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"MerchantCategory"`] Defined in: [src/budgets/schemas.gen.ts:33](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L33) # MerchantCategoryControls > **MerchantCategoryControls** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"MerchantCategoryControls"`] Defined in: [src/budgets/schemas.gen.ts:34](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L34) # Money > **Money** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"Money"`] Defined in: [src/budgets/schemas.gen.ts:35](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L35) # Page_Budget_ > **Page\_Budget\_** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"Page_Budget_"`] Defined in: [src/budgets/schemas.gen.ts:37](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L37) # Page_BudgetProgram_ > **Page\_BudgetProgram\_** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"Page_BudgetProgram_"`] Defined in: [src/budgets/schemas.gen.ts:36](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L36) # Page_SpendBudget_ > **Page\_SpendBudget\_** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"Page_SpendBudget_"`] Defined in: [src/budgets/schemas.gen.ts:38](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L38) # Page_SpendLimit_ > **Page\_SpendLimit\_** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"Page_SpendLimit_"`] Defined in: [src/budgets/schemas.gen.ts:39](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L39) # PeriodRecurrenceType > **PeriodRecurrenceType** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"PeriodRecurrenceType"`] Defined in: [src/budgets/schemas.gen.ts:40](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L40) # PeriodType > **PeriodType** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"PeriodType"`] Defined in: [src/budgets/schemas.gen.ts:41](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L41) # RolloverRefreshRate > **RolloverRefreshRate** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"RolloverRefreshRate"`] Defined in: [src/budgets/schemas.gen.ts:42](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L42) # SpendBudget > **SpendBudget** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"SpendBudget"`] Defined in: [src/budgets/schemas.gen.ts:43](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L43) # SpendBudgetStatus > **SpendBudgetStatus** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"SpendBudgetStatus"`] Defined in: [src/budgets/schemas.gen.ts:44](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L44) # SpendLimit > **SpendLimit** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"SpendLimit"`] Defined in: [src/budgets/schemas.gen.ts:45](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L45) # SpendLimitPeriodBalance > **SpendLimitPeriodBalance** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"SpendLimitPeriodBalance"`] Defined in: [src/budgets/schemas.gen.ts:46](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L46) # SpendLimitPeriodRecurrenceType > **SpendLimitPeriodRecurrenceType** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"SpendLimitPeriodRecurrenceType"`] Defined in: [src/budgets/schemas.gen.ts:47](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L47) # SpendLimitStatus > **SpendLimitStatus** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"SpendLimitStatus"`] Defined in: [src/budgets/schemas.gen.ts:49](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L49) # SpendType > **SpendType** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"SpendType"`] Defined in: [src/budgets/schemas.gen.ts:50](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L50) # UpdateAuthorizationSettings > **UpdateAuthorizationSettings** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"UpdateAuthorizationSettings"`] Defined in: [src/budgets/schemas.gen.ts:51](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L51) # UpdateBudgetBlueprintRequest > **UpdateBudgetBlueprintRequest** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"UpdateBudgetBlueprintRequest"`] Defined in: [src/budgets/schemas.gen.ts:52](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L52) # UpdateBudgetProgramRequest > **UpdateBudgetProgramRequest** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"UpdateBudgetProgramRequest"`] Defined in: [src/budgets/schemas.gen.ts:53](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L53) # UpdateBudgetRequest > **UpdateBudgetRequest** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"UpdateBudgetRequest"`] Defined in: [src/budgets/schemas.gen.ts:54](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L54) # UpdateSpendBudgetRequest > **UpdateSpendBudgetRequest** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"UpdateSpendBudgetRequest"`] Defined in: [src/budgets/schemas.gen.ts:55](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L55) # UpdateSpendLimitRequest > **UpdateSpendLimitRequest** = [`BudgetsComponents`](/brex/api/budgets/interfaces/budgetscomponents/)\[`"schemas"`]\[`"UpdateSpendLimitRequest"`] Defined in: [src/budgets/schemas.gen.ts:56](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/budgets/schemas.gen.ts#L56) # BrexExpenses Defined in: [src/expenses/client.gen.ts:167](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L167) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BrexExpenses**(`core`): `BrexExpenses` Defined in: [src/expenses/client.gen.ts:171](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L171) #### Parameters [Section titled “Parameters”](#parameters) ##### core [Section titled “core”](#core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `BrexExpenses` ## Properties [Section titled “Properties”](#properties) ### cardExpenses [Section titled “cardExpenses”](#cardexpenses) > `readonly` **cardExpenses**: [`CardExpenses`](/brex/api/expenses/classes/cardexpenses/) Defined in: [src/expenses/client.gen.ts:168](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L168) *** ### expenses [Section titled “expenses”](#expenses) > `readonly` **expenses**: [`Expenses`](/brex/api/expenses/classes/expenses/) Defined in: [src/expenses/client.gen.ts:169](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L169) *** ### receipts [Section titled “receipts”](#receipts) > `readonly` **receipts**: [`Receipts`](/brex/api/expenses/classes/receipts/) Defined in: [src/expenses/client.gen.ts:170](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L170) # CardExpenses Defined in: [src/expenses/client.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L8) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new CardExpenses**(`_core`): `CardExpenses` Defined in: [src/expenses/client.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L9) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `CardExpenses` ## Methods [Section titled “Methods”](#methods) ### ~~get()~~ [Section titled “get()”](#get) > **get**(`expenseId`, `query?`, `options?`): `Promise`<{ `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`; `approved_at?`: `string` | `null`; `billing_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `billing_entity_id?`: `string` | `null`; `booking_id?`: `string` | `null`; `budget?`: { `id`: `string`; `name`: `string`; } | `null`; `budget_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `budget_id?`: `string` | `null`; `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`; `completion_date?`: `string` | `null`; `custom_fields?`: `object`\[] | `null`; `dashboard_url`: `string`; `department?`: { `id`: `string`; `name`: `string`; } | `null`; `department_id?`: `string` | `null`; `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`; `expense_type?`: `"CARD"` | `"REIMBURSEMENT"` | `"BILLPAY"` | `"CLAWBACK"` | `"UNSET"` | `null`; `exported_at?`: `string` | `null`; `id`: `string`; `integration_billing_entity_id?`: `string` | `null`; `integration_spending_entity_id?`: `string` | `null`; `location?`: { `id`: `string`; `name`: `string`; } | `null`; `location_id?`: `string` | `null`; `memo?`: `string` | `null`; `merchant?`: { `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; } | `null`; `merchant_id?`: `string` | `null`; `original_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `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`; `payment_posted_at?`: `string` | `null`; `payment_status?`: `"NOT_STARTED"` | `"PROCESSING"` | `"CANCELED"` | `"DECLINED"` | `"CLEARED"` | `"REFUNDING"` | `"REFUNDED"` | `"CASH_ADVANCE"` | `"CREDITED"` | `"AWAITING_PAYMENT"` | `"SCHEDULED"` | `null`; `policy?`: { `id`: `string`; `name`: `string`; } | `null`; `purchased_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `purchased_at?`: `string` | `null`; `receipts?`: `object`\[] | `null`; `repayment?`: { `repayment_initiated_by?`: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null`; `repayment_initiation_date?`: `string` | `null`; } | `null`; `review?`: { `approval_steps`: `object`\[] | `null`; `compliance_status`: `string` | `null`; } | `null`; `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`; `spending_entity_id?`: `string` | `null`; `status?`: `"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"` | `null`; `submitted_at?`: `string` | `null`; `trip_id?`: `string` | `null`; `updated_at`: `string`; `usd_equivalent_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `user?`: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null`; `user_id?`: `string` | `null`; }> Defined in: [src/expenses/client.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L19) Get a card expense This endpoint is deprecated. Use the “Get an expense” (`GET /v1/expenses/{id}`) endpoint instead. `GET /v1/expenses/card/{expense_id}` — requires OAuth scope: `expenses.card.readonly`, `expenses.card` Deprecated Marked deprecated in the Brex OpenAPI spec. #### Parameters [Section titled “Parameters”](#parameters-1) ##### expenseId [Section titled “expenseId”](#expenseid) `string` ##### query? [Section titled “query?”](#query) ###### expand\[]? [Section titled “expand\[\]?”](#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 ``` ###### load\_custom\_fields? [Section titled “load\_custom\_fields?”](#load_custom_fields) `boolean` | `null` **Description** Load custom fields for the expense. ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `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`; `approved_at?`: `string` | `null`; `billing_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `billing_entity_id?`: `string` | `null`; `booking_id?`: `string` | `null`; `budget?`: { `id`: `string`; `name`: `string`; } | `null`; `budget_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `budget_id?`: `string` | `null`; `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`; `completion_date?`: `string` | `null`; `custom_fields?`: `object`\[] | `null`; `dashboard_url`: `string`; `department?`: { `id`: `string`; `name`: `string`; } | `null`; `department_id?`: `string` | `null`; `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`; `expense_type?`: `"CARD"` | `"REIMBURSEMENT"` | `"BILLPAY"` | `"CLAWBACK"` | `"UNSET"` | `null`; `exported_at?`: `string` | `null`; `id`: `string`; `integration_billing_entity_id?`: `string` | `null`; `integration_spending_entity_id?`: `string` | `null`; `location?`: { `id`: `string`; `name`: `string`; } | `null`; `location_id?`: `string` | `null`; `memo?`: `string` | `null`; `merchant?`: { `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; } | `null`; `merchant_id?`: `string` | `null`; `original_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `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`; `payment_posted_at?`: `string` | `null`; `payment_status?`: `"NOT_STARTED"` | `"PROCESSING"` | `"CANCELED"` | `"DECLINED"` | `"CLEARED"` | `"REFUNDING"` | `"REFUNDED"` | `"CASH_ADVANCE"` | `"CREDITED"` | `"AWAITING_PAYMENT"` | `"SCHEDULED"` | `null`; `policy?`: { `id`: `string`; `name`: `string`; } | `null`; `purchased_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `purchased_at?`: `string` | `null`; `receipts?`: `object`\[] | `null`; `repayment?`: { `repayment_initiated_by?`: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null`; `repayment_initiation_date?`: `string` | `null`; } | `null`; `review?`: { `approval_steps`: `object`\[] | `null`; `compliance_status`: `string` | `null`; } | `null`; `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`; `spending_entity_id?`: `string` | `null`; `status?`: `"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"` | `null`; `submitted_at?`: `string` | `null`; `trip_id?`: `string` | `null`; `updated_at`: `string`; `usd_equivalent_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `user?`: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null`; `user_id?`: `string` | `null`; }> *** ### ~~list()~~ [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/expenses/client.gen.ts:40](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L40) List card expenses This endpoint is deprecated. Use the “List expenses” (`GET /v1/expenses`) endpoint instead. `GET /v1/expenses/card` — requires OAuth scope: `expenses.card.readonly`, `expenses.card` Await for a single page, or `for await` to iterate items across all pages. Deprecated Marked deprecated in the Brex OpenAPI spec. #### Parameters [Section titled “Parameters”](#parameters-2) ##### query? [Section titled “query?”](#query-1) ###### budget\_id\[]? [Section titled “budget\_id\[\]?”](#budget_id) `string`\[] | `null` ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` **Description** The cursor to use for pagination. This is the `next_cursor` value returned from the previous response. ###### expand\[]? [Section titled “expand\[\]?”](#expand-1) `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 ``` ###### limit? [Section titled “limit?”](#limit) `number` | `null` **Description** Controls the maximum number of expenses returned in the response, can’t be greater than 100 ###### load\_custom\_fields? [Section titled “load\_custom\_fields?”](#load_custom_fields-1) `boolean` | `null` **Description** Load custom fields for the expenses. ###### parent\_expense\_id\[]? [Section titled “parent\_expense\_id\[\]?”](#parent_expense_id) `string`\[] | `null` **Description** Get itemized expenses belong to provided parent expenses ID(s). ###### payment\_posted\_at\_end? [Section titled “payment\_posted\_at\_end?”](#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 ``` ###### payment\_posted\_at\_start? [Section titled “payment\_posted\_at\_start?”](#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 ``` ###### payment\_status\[]? [Section titled “payment\_status\[\]?”](#payment_status) (`"NOT_STARTED"` | `"PROCESSING"` | `"CANCELED"` | `"DECLINED"` | `"CLEARED"` | `"REFUNDING"` | `"REFUNDED"` | `"CASH_ADVANCE"` | `"CREDITED"` | `"AWAITING_PAYMENT"` | `"SCHEDULED"`)\[] | `null` ###### purchased\_at\_end? [Section titled “purchased\_at\_end?”](#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 ``` ###### purchased\_at\_start? [Section titled “purchased\_at\_start?”](#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 ``` ###### spending\_entity\_id\[]? [Section titled “spending\_entity\_id\[\]?”](#spending_entity_id) `string`\[] | `null` ###### status\[]? [Section titled “status\[\]?”](#status) (`"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"`)\[] | `null` ###### updated\_at\_end? [Section titled “updated\_at\_end?”](#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 ``` ###### updated\_at\_start? [Section titled “updated\_at\_start?”](#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 ``` ###### user\_id\[]? [Section titled “user\_id\[\]?”](#user_id) `string`\[] | `null` **Description** Get expenses belong to provided user(s). ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### update() [Section titled “update()”](#update) > **update**(`expenseId`, `body`, `options?`): `Promise`<{ `billing_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `budget_id?`: `string` | `null`; `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`; `department_id?`: `string` | `null`; `id`: `string`; `location_id?`: `string` | `null`; `memo?`: `string` | `null`; `merchant_id?`: `string` | `null`; `original_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `payment_status?`: `"NOT_STARTED"` | `"PROCESSING"` | `"CANCELED"` | `"DECLINED"` | `"CLEARED"` | `"REFUNDING"` | `"REFUNDED"` | `"CASH_ADVANCE"` | `"CREDITED"` | `"AWAITING_PAYMENT"` | `"SCHEDULED"` | `null`; `purchased_at?`: `string` | `null`; `status?`: `"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"` | `null`; `updated_at`: `string`; }> Defined in: [src/expenses/client.gen.ts:58](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L58) Update an expense Update an expense. Admin and bookkeeper have access to any expense, and regular users can only access their own. `PUT /v1/expenses/card/{expense_id}` — requires OAuth scope: `expenses.card` #### Parameters [Section titled “Parameters”](#parameters-3) ##### expenseId [Section titled “expenseId”](#expenseid-1) `string` ##### body [Section titled “body”](#body) ###### memo? [Section titled “memo?”](#memo) `string` | `null` **Description** Expense memo. ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `billing_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `budget_id?`: `string` | `null`; `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`; `department_id?`: `string` | `null`; `id`: `string`; `location_id?`: `string` | `null`; `memo?`: `string` | `null`; `merchant_id?`: `string` | `null`; `original_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `payment_status?`: `"NOT_STARTED"` | `"PROCESSING"` | `"CANCELED"` | `"DECLINED"` | `"CLEARED"` | `"REFUNDING"` | `"REFUNDED"` | `"CASH_ADVANCE"` | `"CREDITED"` | `"AWAITING_PAYMENT"` | `"SCHEDULED"` | `null`; `purchased_at?`: `string` | `null`; `status?`: `"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"` | `null`; `updated_at`: `string`; }> # Expenses Defined in: [src/expenses/client.gen.ts:73](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L73) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Expenses**(`_core`): `Expenses` Defined in: [src/expenses/client.gen.ts:74](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L74) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Expenses` ## Methods [Section titled “Methods”](#methods) ### get() [Section titled “get()”](#get) > **get**(`id`, `query?`, `options?`): `Promise`<{ `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`; `approved_at?`: `string` | `null`; `billing_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `billing_entity_id?`: `string` | `null`; `booking_id?`: `string` | `null`; `budget?`: { `id`: `string`; `name`: `string`; } | `null`; `budget_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `budget_id?`: `string` | `null`; `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`; `completion_date?`: `string` | `null`; `custom_fields?`: `object`\[] | `null`; `dashboard_url`: `string`; `department?`: { `id`: `string`; `name`: `string`; } | `null`; `department_id?`: `string` | `null`; `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`; `expense_type?`: `"CARD"` | `"REIMBURSEMENT"` | `"BILLPAY"` | `"CLAWBACK"` | `"UNSET"` | `null`; `exported_at?`: `string` | `null`; `id`: `string`; `integration_billing_entity_id?`: `string` | `null`; `integration_spending_entity_id?`: `string` | `null`; `location?`: { `id`: `string`; `name`: `string`; } | `null`; `location_id?`: `string` | `null`; `memo?`: `string` | `null`; `merchant?`: { `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; } | `null`; `merchant_id?`: `string` | `null`; `original_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `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`; `payment_posted_at?`: `string` | `null`; `payment_status?`: `"NOT_STARTED"` | `"PROCESSING"` | `"CANCELED"` | `"DECLINED"` | `"CLEARED"` | `"REFUNDING"` | `"REFUNDED"` | `"CASH_ADVANCE"` | `"CREDITED"` | `"AWAITING_PAYMENT"` | `"SCHEDULED"` | `null`; `policy?`: { `id`: `string`; `name`: `string`; } | `null`; `purchased_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `purchased_at?`: `string` | `null`; `receipts?`: `object`\[] | `null`; `repayment?`: { `repayment_initiated_by?`: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null`; `repayment_initiation_date?`: `string` | `null`; } | `null`; `review?`: { `approval_steps`: `object`\[] | `null`; `compliance_status`: `string` | `null`; } | `null`; `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`; `spending_entity_id?`: `string` | `null`; `status?`: `"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"` | `null`; `submitted_at?`: `string` | `null`; `trip_id?`: `string` | `null`; `updated_at`: `string`; `usd_equivalent_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `user?`: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null`; `user_id?`: `string` | `null`; }> Defined in: [src/expenses/client.gen.ts:83](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L83) Get an expense Get an expense by its ID. `GET /v1/expenses/{id}` — requires OAuth scope: `expenses.card.readonly`, `expenses.card` #### Parameters [Section titled “Parameters”](#parameters-1) ##### id [Section titled “id”](#id) `string` ##### query? [Section titled “query?”](#query) ###### expand\[]? [Section titled “expand\[\]?”](#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 ``` ###### load\_custom\_fields? [Section titled “load\_custom\_fields?”](#load_custom_fields) `boolean` | `null` **Description** Load custom fields for the expense. ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `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`; `approved_at?`: `string` | `null`; `billing_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `billing_entity_id?`: `string` | `null`; `booking_id?`: `string` | `null`; `budget?`: { `id`: `string`; `name`: `string`; } | `null`; `budget_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `budget_id?`: `string` | `null`; `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`; `completion_date?`: `string` | `null`; `custom_fields?`: `object`\[] | `null`; `dashboard_url`: `string`; `department?`: { `id`: `string`; `name`: `string`; } | `null`; `department_id?`: `string` | `null`; `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`; `expense_type?`: `"CARD"` | `"REIMBURSEMENT"` | `"BILLPAY"` | `"CLAWBACK"` | `"UNSET"` | `null`; `exported_at?`: `string` | `null`; `id`: `string`; `integration_billing_entity_id?`: `string` | `null`; `integration_spending_entity_id?`: `string` | `null`; `location?`: { `id`: `string`; `name`: `string`; } | `null`; `location_id?`: `string` | `null`; `memo?`: `string` | `null`; `merchant?`: { `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; } | `null`; `merchant_id?`: `string` | `null`; `original_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `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`; `payment_posted_at?`: `string` | `null`; `payment_status?`: `"NOT_STARTED"` | `"PROCESSING"` | `"CANCELED"` | `"DECLINED"` | `"CLEARED"` | `"REFUNDING"` | `"REFUNDED"` | `"CASH_ADVANCE"` | `"CREDITED"` | `"AWAITING_PAYMENT"` | `"SCHEDULED"` | `null`; `policy?`: { `id`: `string`; `name`: `string`; } | `null`; `purchased_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `purchased_at?`: `string` | `null`; `receipts?`: `object`\[] | `null`; `repayment?`: { `repayment_initiated_by?`: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null`; `repayment_initiation_date?`: `string` | `null`; } | `null`; `review?`: { `approval_steps`: `object`\[] | `null`; `compliance_status`: `string` | `null`; } | `null`; `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`; `spending_entity_id?`: `string` | `null`; `status?`: `"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"` | `null`; `submitted_at?`: `string` | `null`; `trip_id?`: `string` | `null`; `updated_at`: `string`; `usd_equivalent_amount?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `user?`: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null`; `user_id?`: `string` | `null`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/expenses/client.gen.ts:103](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L103) List expenses List expenses under the same account. Admin and bookkeeper have access to any expense, and regular users can only access their own. `GET /v1/expenses` — requires OAuth scope: `expenses.card.readonly`, `expenses.card` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-2) ##### query? [Section titled “query?”](#query-1) ###### budget\_id\[]? [Section titled “budget\_id\[\]?”](#budget_id) `string`\[] | `null` ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` **Description** The cursor to use for pagination. This is the `next_cursor` value returned from the previous response. ###### expand\[]? [Section titled “expand\[\]?”](#expand-1) `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 ``` ###### expense\_type\[]? [Section titled “expense\_type\[\]?”](#expense_type) (`"CARD"` | `"REIMBURSEMENT"` | `"BILLPAY"` | `"CLAWBACK"` | `"UNSET"`)\[] | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` **Description** Controls the maximum number of expenses returned in the response, can’t be greater than 100 ###### load\_custom\_fields? [Section titled “load\_custom\_fields?”](#load_custom_fields-1) `boolean` | `null` **Description** Load custom fields for the expenses. ###### parent\_expense\_id\[]? [Section titled “parent\_expense\_id\[\]?”](#parent_expense_id) `string`\[] | `null` **Description** Get itemized expenses belong to provided parent expenses ID(s). ###### payment\_posted\_at\_end? [Section titled “payment\_posted\_at\_end?”](#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 ``` ###### payment\_posted\_at\_start? [Section titled “payment\_posted\_at\_start?”](#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 ``` ###### payment\_status\[]? [Section titled “payment\_status\[\]?”](#payment_status) (`"NOT_STARTED"` | `"PROCESSING"` | `"CANCELED"` | `"DECLINED"` | `"CLEARED"` | `"REFUNDING"` | `"REFUNDED"` | `"CASH_ADVANCE"` | `"CREDITED"` | `"AWAITING_PAYMENT"` | `"SCHEDULED"`)\[] | `null` ###### purchased\_at\_end? [Section titled “purchased\_at\_end?”](#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 ``` ###### purchased\_at\_start? [Section titled “purchased\_at\_start?”](#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 ``` ###### spending\_entity\_id\[]? [Section titled “spending\_entity\_id\[\]?”](#spending_entity_id) `string`\[] | `null` ###### status\[]? [Section titled “status\[\]?”](#status) (`"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"`)\[] | `null` ###### updated\_at\_end? [Section titled “updated\_at\_end?”](#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 ``` ###### updated\_at\_start? [Section titled “updated\_at\_start?”](#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 ``` ###### user\_id\[]? [Section titled “user\_id\[\]?”](#user_id) `string`\[] | `null` **Description** Get expenses belong to provided user(s). ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> # Receipts Defined in: [src/expenses/client.gen.ts:115](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L115) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Receipts**(`_core`): `Receipts` Defined in: [src/expenses/client.gen.ts:116](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L116) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Receipts` ## Methods [Section titled “Methods”](#methods) ### match() [Section titled “match()”](#match) > **match**(`body`, `options?`): `Promise`<{ `id`: `string`; `uri`: `string`; }> Defined in: [src/expenses/client.gen.ts:127](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L127) Create a new receipt match 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 /v1/expenses/card/receipt_match` #### Parameters [Section titled “Parameters”](#parameters-1) ##### body [Section titled “body”](#body) ###### receipt\_name [Section titled “receipt\_name”](#receipt_name) `string` **Description** The name of the receipt (with the file extension). It will be used in the matching result email. ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `id`: `string`; `uri`: `string`; }> *** ### upload() [Section titled “upload()”](#upload) > **upload**(`expenseId`, `body`, `options?`): `Promise`<{ `id`: `string`; `uri`: `string`; }> Defined in: [src/expenses/client.gen.ts:149](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/client.gen.ts#L149) Create a new receipt upload 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 /v1/expenses/card/{expense_id}/receipt_upload` #### Parameters [Section titled “Parameters”](#parameters-2) ##### expenseId [Section titled “expenseId”](#expenseid) `string` ##### body [Section titled “body”](#body-1) ###### receipt\_name [Section titled “receipt\_name”](#receipt_name-1) `string` **Description** The name of the receipt (with the file extension). ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `id`: `string`; `uri`: `string`; }> # createExpensesClient > **createExpensesClient**(`options`): [`BrexExpenses`](/brex/api/expenses/classes/brexexpenses/) Defined in: [src/expenses/index.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/index.ts#L13) Standalone client for the Brex Expenses API. ## Parameters [Section titled “Parameters”](#parameters) ### options [Section titled “options”](#options) [`BrexOptions`](/brex/api/index/interfaces/brexoptions/) ## Returns [Section titled “Returns”](#returns) [`BrexExpenses`](/brex/api/expenses/classes/brexexpenses/) # ExpensesComponents Defined in: [src/expenses/types.gen.ts:135](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L135) ## Properties [Section titled “Properties”](#properties) ### headers [Section titled “headers”](#headers) > **headers**: `never` Defined in: [src/expenses/types.gen.ts:855](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L855) *** ### parameters [Section titled “parameters”](#parameters) > **parameters**: `never` Defined in: [src/expenses/types.gen.ts:853](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L853) *** ### pathItems [Section titled “pathItems”](#pathitems) > **pathItems**: `never` Defined in: [src/expenses/types.gen.ts:856](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L856) *** ### requestBodies [Section titled “requestBodies”](#requestbodies) > **requestBodies**: `never` Defined in: [src/expenses/types.gen.ts:854](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L854) *** ### responses [Section titled “responses”](#responses) > **responses**: `never` Defined in: [src/expenses/types.gen.ts:852](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L852) *** ### schemas [Section titled “schemas”](#schemas) > **schemas**: `object` Defined in: [src/expenses/types.gen.ts:136](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L136) #### Address [Section titled “Address”](#address) > **Address**: `object` ##### Description [Section titled “Description”](#description) Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed). ##### Address.city? [Section titled “Address.city?”](#addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-1) City, district, suburb, town, or village. ##### Address.country? [Section titled “Address.country?”](#addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-2) Two-letter country code (ISO 3166-1 alpha-2). ##### Address.line1? [Section titled “Address.line1?”](#addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-3) Address line 1, no PO Box. ##### Address.line2? [Section titled “Address.line2?”](#addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-4) Address line 2 (e.g., apartment, suite, unit, or building). ##### Address.phone\_number? [Section titled “Address.phone\_number?”](#addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-5) Phone number. ##### Address.postal\_code? [Section titled “Address.postal\_code?”](#addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-6) ZIP or postal code. ##### Address.state? [Section titled “Address.state?”](#addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-7) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. #### ApprovalStepDetails [Section titled “ApprovalStepDetails”](#approvalstepdetails) > **ApprovalStepDetails**: `object` ##### ApprovalStepDetails.copilot\_reviewer? [Section titled “ApprovalStepDetails.copilot\_reviewer?”](#approvalstepdetailscopilot_reviewer) > `optional` **copilot\_reviewer?**: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } ###### department\_id? [Section titled “department\_id?”](#department_id) > `optional` **department\_id?**: `string` | `null` ###### first\_name [Section titled “first\_name”](#first_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-8) First name of the User. ###### id [Section titled “id”](#id) > **id**: `string` ###### Description [Section titled “Description”](#description-9) Unique ID for the User. ###### last\_name [Section titled “last\_name”](#last_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-10) Last name of the User. ###### location\_id? [Section titled “location\_id?”](#location_id) > `optional` **location\_id?**: `string` | `null` *** `null` ##### ApprovalStepDetails.pending\_reviewers? [Section titled “ApprovalStepDetails.pending\_reviewers?”](#approvalstepdetailspending_reviewers) > `optional` **pending\_reviewers?**: `object`\[] | `null` ##### ApprovalStepDetails.resolved\_at? [Section titled “ApprovalStepDetails.resolved\_at?”](#approvalstepdetailsresolved_at) > `optional` **resolved\_at?**: `string` | `null` Format: date-time ##### ApprovalStepDetails.reviewer? [Section titled “ApprovalStepDetails.reviewer?”](#approvalstepdetailsreviewer) > `optional` **reviewer?**: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } ###### department\_id? [Section titled “department\_id?”](#department_id-1) > `optional` **department\_id?**: `string` | `null` ###### first\_name [Section titled “first\_name”](#first_name-1) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-11) First name of the User. ###### id [Section titled “id”](#id-1) > **id**: `string` ###### Description [Section titled “Description”](#description-12) Unique ID for the User. ###### last\_name [Section titled “last\_name”](#last_name-1) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-13) Last name of the User. ###### location\_id? [Section titled “location\_id?”](#location_id-1) > `optional` **location\_id?**: `string` | `null` *** `null` ##### ApprovalStepDetails.status? [Section titled “ApprovalStepDetails.status?”](#approvalstepdetailsstatus) > `optional` **status?**: `string` | `null` #### BooleanListValue [Section titled “BooleanListValue”](#booleanlistvalue) > **BooleanListValue**: `object` & `object` & `object` & `object` & `object` Boolean list value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration) ###### data? [Section titled “data?”](#data) > `optional` **data?**: `boolean`\[] | `null` ###### data\_type [Section titled “data\_type”](#data_type) > **data\_type**: `"BOOLEAN"` ###### Description [Section titled “Description”](#description-14) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-1) ###### value\_type [Section titled “value\_type”](#value_type) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-2) ###### data\_type [Section titled “data\_type”](#data_type-1) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-1) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-3) ###### value\_type [Section titled “value\_type”](#value_type-2) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-4) ###### data\_type [Section titled “data\_type”](#data_type-2) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-15) Boolean list value for a custom field #### BooleanValue [Section titled “BooleanValue”](#booleanvalue) > **BooleanValue**: `object` & `object` & `object` & `object` & `object` Boolean value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-5) ###### data? [Section titled “data?”](#data-1) > `optional` **data?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-16) The data of the custom field. ###### data\_type [Section titled “data\_type”](#data_type-3) > **data\_type**: `"BOOLEAN"` ###### Description [Section titled “Description”](#description-17) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-6) ###### value\_type [Section titled “value\_type”](#value_type-3) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-7) ###### data\_type [Section titled “data\_type”](#data_type-4) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-4) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-8) ###### value\_type [Section titled “value\_type”](#value_type-5) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-9) ###### data\_type [Section titled “data\_type”](#data_type-5) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-18) Boolean value for a custom field #### Budget [Section titled “Budget”](#budget) > **Budget**: `object` ##### Budget.id [Section titled “Budget.id”](#budgetid) > **id**: `string` ###### Description [Section titled “Description”](#description-19) Unique ID for the Budget. ##### Budget.name [Section titled “Budget.name”](#budgetname) > **name**: `string` ###### Description [Section titled “Description”](#description-20) Name for the Budget. #### CardPaymentInstrument [Section titled “CardPaymentInstrument”](#cardpaymentinstrument) > **CardPaymentInstrument**: `object` & `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-10) ###### type [Section titled “type”](#type) > **type**: `"CARD"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-11) ###### id [Section titled “id”](#id-2) > **id**: `string` ###### Description [Section titled “Description”](#description-21) Unique ID for the card. ###### type [Section titled “type”](#type-1) > **type**: `"CARD"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-12) ###### type [Section titled “type”](#type-2) > **type**: `"CARD"` ###### Description [Section titled “Description”](#description-22) discriminator enum property added by openapi-typescript #### Category [Section titled “Category”](#category) > **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"` ##### Description [Section titled “Description”](#description-23) The category of expenses. #### CreateAsyncFileUploadResponse [Section titled “CreateAsyncFileUploadResponse”](#createasyncfileuploadresponse) > **CreateAsyncFileUploadResponse**: `object` ##### Description [Section titled “Description”](#description-24) The pre-signed file upload URI and unique identifier of the request. ##### CreateAsyncFileUploadResponse.id [Section titled “CreateAsyncFileUploadResponse.id”](#createasyncfileuploadresponseid) > **id**: `string` ###### Description [Section titled “Description”](#description-25) The unique identifier for the request. ##### CreateAsyncFileUploadResponse.uri [Section titled “CreateAsyncFileUploadResponse.uri”](#createasyncfileuploadresponseuri) > **uri**: `string` ###### Description [Section titled “Description”](#description-26) The pre-signed S3 link that should be used to upload the file. The maximum size accepted for this document is 50 MB. #### CustomerLocation [Section titled “CustomerLocation”](#customerlocation) > **CustomerLocation**: `object` ##### Description [Section titled “Description”](#description-27) The location associated with the expense. ##### CustomerLocation.id [Section titled “CustomerLocation.id”](#customerlocationid) > **id**: `string` ###### Description [Section titled “Description”](#description-28) The unique identifier for the location. ##### CustomerLocation.name [Section titled “CustomerLocation.name”](#customerlocationname) > **name**: `string` ###### Description [Section titled “Description”](#description-29) The name of the location. #### CustomField [Section titled “CustomField”](#customfield) > **CustomField**: `object` ##### CustomField.key [Section titled “CustomField.key”](#customfieldkey) > **key**: `string` ###### Description [Section titled “Description”](#description-30) The key of the custom field. ##### CustomField.value [Section titled “CustomField.value”](#customfieldvalue) > **value**: `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` | `object` & `object` & `object` & `object` & `object` ##### CustomField.ValueWrapper [Section titled “CustomField.ValueWrapper”](#customfieldvaluewrapper) > **CustomField.ValueWrapper**: `object` ###### Description [Section titled “Description”](#description-31) Base class for custom field values ##### CustomField.ValueWrapper.data\_type [Section titled “CustomField.ValueWrapper.data\_type”](#customfieldvaluewrapperdata_type) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### CustomField.ValueWrapper.value\_type [Section titled “CustomField.ValueWrapper.value\_type”](#customfieldvaluewrappervalue_type) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### CustomField.ValueWrapper.MultipleValueWrapper [Section titled “CustomField.ValueWrapper.MultipleValueWrapper”](#customfieldvaluewrappermultiplevaluewrapper) > **CustomField.ValueWrapper.MultipleValueWrapper**: `object` & `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-13) ###### value\_type [Section titled “value\_type”](#value_type-6) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-14) ###### data\_type [Section titled “data\_type”](#data_type-6) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-7) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-15) ###### value\_type [Section titled “value\_type”](#value_type-8) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ###### Description [Section titled “Description”](#description-32) Multiple value wrapper for custom fields ##### CustomField.ValueWrapper.SingleValueWrapper [Section titled “CustomField.ValueWrapper.SingleValueWrapper”](#customfieldvaluewrappersinglevaluewrapper) > **CustomField.ValueWrapper.SingleValueWrapper**: `object` & `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-16) ###### value\_type [Section titled “value\_type”](#value_type-9) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-17) ###### data\_type [Section titled “data\_type”](#data_type-7) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-10) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-18) ###### value\_type [Section titled “value\_type”](#value_type-11) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ###### Description [Section titled “Description”](#description-33) Single value wrapper for custom fields #### CustomFieldDataType [Section titled “CustomFieldDataType”](#customfielddatatype) > **CustomFieldDataType**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-34) The type of the custom field data. #### CustomFieldValueType [Section titled “CustomFieldValueType”](#customfieldvaluetype) > **CustomFieldValueType**: `"SINGLE_VALUE"` | `"LIST"` ##### Description [Section titled “Description”](#description-35) The type of the custom field value. #### DateListValue [Section titled “DateListValue”](#datelistvalue) > **DateListValue**: `object` & `object` & `object` & `object` & `object` Date list value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-19) ###### data? [Section titled “data?”](#data-2) > `optional` **data?**: `string`\[] | `null` ###### data\_type [Section titled “data\_type”](#data_type-8) > **data\_type**: `"DATE"` ###### Description [Section titled “Description”](#description-36) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-20) ###### value\_type [Section titled “value\_type”](#value_type-12) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-21) ###### data\_type [Section titled “data\_type”](#data_type-9) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-13) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-22) ###### value\_type [Section titled “value\_type”](#value_type-14) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-23) ###### data\_type [Section titled “data\_type”](#data_type-10) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-37) Date list value for a custom field #### DateValue [Section titled “DateValue”](#datevalue) > **DateValue**: `object` & `object` & `object` & `object` & `object` Date value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-24) ###### data? [Section titled “data?”](#data-3) > `optional` **data?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-38) The data of the custom field. ###### data\_type [Section titled “data\_type”](#data_type-11) > **data\_type**: `"DATE"` ###### Description [Section titled “Description”](#description-39) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-25) ###### value\_type [Section titled “value\_type”](#value_type-15) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-26) ###### data\_type [Section titled “data\_type”](#data_type-12) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-16) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-27) ###### value\_type [Section titled “value\_type”](#value_type-17) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-28) ###### data\_type [Section titled “data\_type”](#data_type-13) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-40) Date value for a custom field #### DecimalListValue [Section titled “DecimalListValue”](#decimallistvalue) > **DecimalListValue**: `object` & `object` & `object` & `object` & `object` Decimal list value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-29) ###### data? [Section titled “data?”](#data-4) > `optional` **data?**: `number`\[] | `null` ###### data\_type [Section titled “data\_type”](#data_type-14) > **data\_type**: `"DECIMAL"` ###### Description [Section titled “Description”](#description-41) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-30) ###### value\_type [Section titled “value\_type”](#value_type-18) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-31) ###### data\_type [Section titled “data\_type”](#data_type-15) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-19) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-32) ###### value\_type [Section titled “value\_type”](#value_type-20) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-33) ###### data\_type [Section titled “data\_type”](#data_type-16) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-42) Decimal list value for a custom field #### DecimalValue [Section titled “DecimalValue”](#decimalvalue) > **DecimalValue**: `object` & `object` & `object` & `object` & `object` Decimal value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-34) ###### data? [Section titled “data?”](#data-5) > `optional` **data?**: `number` | `null` ###### Description [Section titled “Description”](#description-43) The data of the custom field. ###### data\_type [Section titled “data\_type”](#data_type-17) > **data\_type**: `"DECIMAL"` ###### Description [Section titled “Description”](#description-44) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-35) ###### value\_type [Section titled “value\_type”](#value_type-21) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-36) ###### data\_type [Section titled “data\_type”](#data_type-18) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-22) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-37) ###### value\_type [Section titled “value\_type”](#value_type-23) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-38) ###### data\_type [Section titled “data\_type”](#data_type-19) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-45) Decimal value for a custom field #### Department [Section titled “Department”](#department) > **Department**: `object` ##### Description [Section titled “Description”](#description-46) The department associated with the expense. ##### Department.id [Section titled “Department.id”](#departmentid) > **id**: `string` ###### Description [Section titled “Description”](#description-47) The unique identifier for the department. ##### Department.name [Section titled “Department.name”](#departmentname) > **name**: `string` ###### Description [Section titled “Description”](#description-48) The name of the department. #### EnumListValue [Section titled “EnumListValue”](#enumlistvalue) > **EnumListValue**: `object` & `object` & `object` & `object` & `object` Enum list value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-39) ###### data? [Section titled “data?”](#data-6) > `optional` **data?**: `string`\[] | `null` ###### data\_type [Section titled “data\_type”](#data_type-20) > **data\_type**: `"ENUM"` ###### Description [Section titled “Description”](#description-49) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-40) ###### value\_type [Section titled “value\_type”](#value_type-24) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-41) ###### data\_type [Section titled “data\_type”](#data_type-21) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-25) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-42) ###### value\_type [Section titled “value\_type”](#value_type-26) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-43) ###### data\_type [Section titled “data\_type”](#data_type-22) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-50) Enum list value for a custom field #### EnumValue [Section titled “EnumValue”](#enumvalue) > **EnumValue**: `object` & `object` & `object` & `object` & `object` Enum value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-44) ###### data? [Section titled “data?”](#data-7) > `optional` **data?**: `string` | `null` Format: enum ###### Description [Section titled “Description”](#description-51) The data of the custom field. ###### data\_type [Section titled “data\_type”](#data_type-23) > **data\_type**: `"ENUM"` ###### Description [Section titled “Description”](#description-52) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-45) ###### value\_type [Section titled “value\_type”](#value_type-27) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-46) ###### data\_type [Section titled “data\_type”](#data_type-24) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-28) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-47) ###### value\_type [Section titled “value\_type”](#value_type-29) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-48) ###### data\_type [Section titled “data\_type”](#data_type-25) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-53) Enum value for a custom field #### ExpandableExpense [Section titled “ExpandableExpense”](#expandableexpense) > **ExpandableExpense**: `object` ##### Description [Section titled “Description”](#description-54) The expense object that has expandable fields, e.g., `location`, `department`, `merchant`, `receipts.download_uris`, `user`, `budget`, `payment`, `spending_entity`, and `policy`. ##### ExpandableExpense.address? [Section titled “ExpandableExpense.address?”](#expandableexpenseaddress) > `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 [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `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? [Section titled “city?”](#city) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-55) City, district, suburb, town, or village. ###### coordinates? [Section titled “coordinates?”](#coordinates) > `optional` **coordinates?**: { `latitude`: `number`; `longitude`: `number`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-3) ###### Type Literal [Section titled “Type Literal”](#type-literal-3) { `latitude`: `number`; `longitude`: `number`; } ###### latitude [Section titled “latitude”](#latitude) > **latitude**: `number` Format: double ###### longitude [Section titled “longitude”](#longitude) > **longitude**: `number` Format: double *** `null` ###### country? [Section titled “country?”](#country) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-56) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-57) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-58) Address line 2 (e.g., apartment, suite, unit, or building). ###### postal\_code? [Section titled “postal\_code?”](#postal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-59) ZIP or postal code. ###### state? [Section titled “state?”](#state) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-60) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### timezone? [Section titled “timezone?”](#timezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-61) Timezone. *** `null` ##### ExpandableExpense.approved\_at? [Section titled “ExpandableExpense.approved\_at?”](#expandableexpenseapproved_at) > `optional` **approved\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-62) The time the expense is approved. ##### ExpandableExpense.billing\_amount? [Section titled “ExpandableExpense.billing\_amount?”](#expandableexpensebilling_amount) > `optional` **billing\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-4) ###### Type Literal [Section titled “Type Literal”](#type-literal-4) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-63) 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 [Section titled “Example”](#example) ```ts 700 ``` ###### currency [Section titled “currency”](#currency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-64) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default) ```ts USD ``` ###### Example [Section titled “Example”](#example-1) ```ts USD ``` *** `null` ##### ExpandableExpense.billing\_entity\_id? [Section titled “ExpandableExpense.billing\_entity\_id?”](#expandableexpensebilling_entity_id) > `optional` **billing\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-65) ID of the legal entity responsible for billing the expense. ##### ExpandableExpense.booking\_id? [Section titled “ExpandableExpense.booking\_id?”](#expandableexpensebooking_id) > `optional` **booking\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-66) The booking ID associated with the expense if it is a trip expense. ##### ExpandableExpense.budget? [Section titled “ExpandableExpense.budget?”](#expandableexpensebudget) > `optional` **budget?**: { `id`: `string`; `name`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-5) ###### Type Literal [Section titled “Type Literal”](#type-literal-5) { `id`: `string`; `name`: `string`; } ###### id [Section titled “id”](#id-3) > **id**: `string` ###### Description [Section titled “Description”](#description-67) Unique ID for the Budget. ###### name [Section titled “name”](#name) > **name**: `string` ###### Description [Section titled “Description”](#description-68) Name for the Budget. *** `null` ##### ExpandableExpense.budget\_amount? [Section titled “ExpandableExpense.budget\_amount?”](#expandableexpensebudget_amount) > `optional` **budget\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-6) ###### Type Literal [Section titled “Type Literal”](#type-literal-6) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-69) 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 [Section titled “Example”](#example-2) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-70) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-1) ```ts USD ``` ###### Example [Section titled “Example”](#example-3) ```ts USD ``` *** `null` ##### ExpandableExpense.budget\_id? [Section titled “ExpandableExpense.budget\_id?”](#expandableexpensebudget_id) > `optional` **budget\_id?**: `string` | `null` ##### ExpandableExpense.category? [Section titled “ExpandableExpense.category?”](#expandableexpensecategory) > `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` ##### ExpandableExpense.completion\_date? [Section titled “ExpandableExpense.completion\_date?”](#expandableexpensecompletion_date) > `optional` **completion\_date?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-71) The time payment will be completed/is completed. ##### ExpandableExpense.custom\_fields? [Section titled “ExpandableExpense.custom\_fields?”](#expandableexpensecustom_fields) > `optional` **custom\_fields?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-72) A list of custom field values associated with the expense. ##### ExpandableExpense.dashboard\_url [Section titled “ExpandableExpense.dashboard\_url”](#expandableexpensedashboard_url) > **dashboard\_url**: `string` ###### Description [Section titled “Description”](#description-73) URL to view the expense in the Brex dashboard. ##### ExpandableExpense.department? [Section titled “ExpandableExpense.department?”](#expandableexpensedepartment) > `optional` **department?**: { `id`: `string`; `name`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-7) ###### Type Literal [Section titled “Type Literal”](#type-literal-7) { `id`: `string`; `name`: `string`; } ###### id [Section titled “id”](#id-4) > **id**: `string` ###### Description [Section titled “Description”](#description-74) The unique identifier for the department. ###### name [Section titled “name”](#name-1) > **name**: `string` ###### Description [Section titled “Description”](#description-75) The name of the department. *** `null` ##### ExpandableExpense.department\_id? [Section titled “ExpandableExpense.department\_id?”](#expandableexpensedepartment_id) > `optional` **department\_id?**: `string` | `null` ##### ExpandableExpense.expense\_line\_items? [Section titled “ExpandableExpense.expense\_line\_items?”](#expandableexpenseexpense_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 [Section titled “Description”](#description-76) The expense line items. Limited to 100 items. ##### ExpandableExpense.expense\_type? [Section titled “ExpandableExpense.expense\_type?”](#expandableexpenseexpense_type) > `optional` **expense\_type?**: `"CARD"` | `"REIMBURSEMENT"` | `"BILLPAY"` | `"CLAWBACK"` | `"UNSET"` | `null` ##### ExpandableExpense.exported\_at? [Section titled “ExpandableExpense.exported\_at?”](#expandableexpenseexported_at) > `optional` **exported\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-77) Timestamp when the expense was exported to the accounting system. ##### ExpandableExpense.id [Section titled “ExpandableExpense.id”](#expandableexpenseid) > **id**: `string` ###### Description [Section titled “Description”](#description-78) Unique ID associated with the expense. ##### ExpandableExpense.integration\_billing\_entity\_id? [Section titled “ExpandableExpense.integration\_billing\_entity\_id?”](#expandableexpenseintegration_billing_entity_id) > `optional` **integration\_billing\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-79) ID of the billing entity in accounting. ##### ExpandableExpense.integration\_spending\_entity\_id? [Section titled “ExpandableExpense.integration\_spending\_entity\_id?”](#expandableexpenseintegration_spending_entity_id) > `optional` **integration\_spending\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-80) ID of the spending entity in accounting. ##### ExpandableExpense.location? [Section titled “ExpandableExpense.location?”](#expandableexpenselocation) > `optional` **location?**: { `id`: `string`; `name`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-8) ###### Type Literal [Section titled “Type Literal”](#type-literal-8) { `id`: `string`; `name`: `string`; } ###### id [Section titled “id”](#id-5) > **id**: `string` ###### Description [Section titled “Description”](#description-81) The unique identifier for the location. ###### name [Section titled “name”](#name-2) > **name**: `string` ###### Description [Section titled “Description”](#description-82) The name of the location. *** `null` ##### ExpandableExpense.location\_id? [Section titled “ExpandableExpense.location\_id?”](#expandableexpenselocation_id) > `optional` **location\_id?**: `string` | `null` ##### ExpandableExpense.memo? [Section titled “ExpandableExpense.memo?”](#expandableexpensememo) > `optional` **memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-83) The memo of the expense. ##### ExpandableExpense.merchant? [Section titled “ExpandableExpense.merchant?”](#expandableexpensemerchant) > `optional` **merchant?**: { `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-9) ###### Type Literal [Section titled “Type Literal”](#type-literal-9) { `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; } ###### country [Section titled “country”](#country-1) > **country**: `string` ###### Description [Section titled “Description”](#description-84) Merchant’s country, in ISO 3166-1 alpha-3 format. ###### mcc [Section titled “mcc”](#mcc) > **mcc**: `string` ###### Description [Section titled “Description”](#description-85) A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to for more details. ###### raw\_descriptor [Section titled “raw\_descriptor”](#raw_descriptor) > **raw\_descriptor**: `string` ###### Description [Section titled “Description”](#description-86) Merchant descriptor, it can be the merchant name. *** `null` ##### ExpandableExpense.merchant\_id? [Section titled “ExpandableExpense.merchant\_id?”](#expandableexpensemerchant_id) > `optional` **merchant\_id?**: `string` | `null` ##### ExpandableExpense.original\_amount? [Section titled “ExpandableExpense.original\_amount?”](#expandableexpenseoriginal_amount) > `optional` **original\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-10) ###### Type Literal [Section titled “Type Literal”](#type-literal-10) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-2) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-87) 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 [Section titled “Example”](#example-4) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-2) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-88) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-2) ```ts USD ``` ###### Example [Section titled “Example”](#example-5) ```ts USD ``` *** `null` ##### ExpandableExpense.payment? [Section titled “ExpandableExpense.payment?”](#expandableexpensepayment) > `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 [Section titled “Union Members”](#union-members-11) ###### Type Literal [Section titled “Type Literal”](#type-literal-11) { `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 [Section titled “id”](#id-6) > **id**: `string` ###### Description [Section titled “Description”](#description-89) Unique ID for the payment. ###### paymentInstrument [Section titled “paymentInstrument”](#paymentinstrument) > **paymentInstrument**: `Omit`<`object` & `object` & `object`, `"type"`> ###### statusReason [Section titled “statusReason”](#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` ##### ExpandableExpense.payment\_posted\_at? [Section titled “ExpandableExpense.payment\_posted\_at?”](#expandableexpensepayment_posted_at) > `optional` **payment\_posted\_at?**: `string` | `null` Format: date-time ##### ExpandableExpense.payment\_status? [Section titled “ExpandableExpense.payment\_status?”](#expandableexpensepayment_status) > `optional` **payment\_status?**: `"NOT_STARTED"` | `"PROCESSING"` | `"CANCELED"` | `"DECLINED"` | `"CLEARED"` | `"REFUNDING"` | `"REFUNDED"` | `"CASH_ADVANCE"` | `"CREDITED"` | `"AWAITING_PAYMENT"` | `"SCHEDULED"` | `null` ##### ExpandableExpense.policy? [Section titled “ExpandableExpense.policy?”](#expandableexpensepolicy) > `optional` **policy?**: { `id`: `string`; `name`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-12) ###### Type Literal [Section titled “Type Literal”](#type-literal-12) { `id`: `string`; `name`: `string`; } ###### id [Section titled “id”](#id-7) > **id**: `string` ###### Description [Section titled “Description”](#description-90) The unique identifier for the policy. ###### name [Section titled “name”](#name-3) > **name**: `string` ###### Description [Section titled “Description”](#description-91) The display name of the policy. *** `null` ##### ExpandableExpense.purchased\_amount? [Section titled “ExpandableExpense.purchased\_amount?”](#expandableexpensepurchased_amount) > `optional` **purchased\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-13) ###### Type Literal [Section titled “Type Literal”](#type-literal-13) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-3) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-92) 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 [Section titled “Example”](#example-6) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-3) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-93) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-3) ```ts USD ``` ###### Example [Section titled “Example”](#example-7) ```ts USD ``` *** `null` ##### ExpandableExpense.purchased\_at? [Section titled “ExpandableExpense.purchased\_at?”](#expandableexpensepurchased_at) > `optional` **purchased\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-94) The time the purchase was made. ##### ExpandableExpense.receipts? [Section titled “ExpandableExpense.receipts?”](#expandableexpensereceipts) > `optional` **receipts?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-95) A list of receipts associated with the expense. ##### ExpandableExpense.repayment? [Section titled “ExpandableExpense.repayment?”](#expandableexpenserepayment) > `optional` **repayment?**: { `repayment_initiated_by?`: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null`; `repayment_initiation_date?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-14) ###### Type Literal [Section titled “Type Literal”](#type-literal-14) { `repayment_initiated_by?`: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null`; `repayment_initiation_date?`: `string` | `null`; } ###### repayment\_initiated\_by? [Section titled “repayment\_initiated\_by?”](#repayment_initiated_by) > `optional` **repayment\_initiated\_by?**: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-15) ###### Type Literal [Section titled “Type Literal”](#type-literal-15) { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } ###### department\_id? [Section titled “department\_id?”](#department_id-2) > `optional` **department\_id?**: `string` | `null` ###### first\_name [Section titled “first\_name”](#first_name-2) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-96) First name of the User. ###### id [Section titled “id”](#id-8) > **id**: `string` ###### Description [Section titled “Description”](#description-97) Unique ID for the User. ###### last\_name [Section titled “last\_name”](#last_name-2) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-98) Last name of the User. ###### location\_id? [Section titled “location\_id?”](#location_id-2) > `optional` **location\_id?**: `string` | `null` *** `null` ###### repayment\_initiation\_date? [Section titled “repayment\_initiation\_date?”](#repayment_initiation_date) > `optional` **repayment\_initiation\_date?**: `string` | `null` Format: date-time *** `null` ##### ExpandableExpense.review? [Section titled “ExpandableExpense.review?”](#expandableexpensereview) > `optional` **review?**: { `approval_steps`: `object`\[] | `null`; `compliance_status`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-16) ###### Type Literal [Section titled “Type Literal”](#type-literal-16) { `approval_steps`: `object`\[] | `null`; `compliance_status`: `string` | `null`; } ###### approval\_steps [Section titled “approval\_steps”](#approval_steps) > **approval\_steps**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-99) Information for each approval step of the expense ###### compliance\_status [Section titled “compliance\_status”](#compliance_status) > **compliance\_status**: `string` | `null` ###### Description [Section titled “Description”](#description-100) Compliance status of the expense *** `null` ##### ExpandableExpense.spending\_entity? [Section titled “ExpandableExpense.spending\_entity?”](#expandableexpensespending_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 [Section titled “Union Members”](#union-members-17) ###### Type Literal [Section titled “Type Literal”](#type-literal-17) { `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 [Section titled “billing\_address”](#billing_address) > **billing\_address**: `object` ###### billing\_address.city? [Section titled “billing\_address.city?”](#billing_addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-101) City, district, suburb, town, or village. ###### billing\_address.country? [Section titled “billing\_address.country?”](#billing_addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-102) Two-letter country code (ISO 3166-1 alpha-2). ###### billing\_address.line1? [Section titled “billing\_address.line1?”](#billing_addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-103) Address line 1, no PO Box. ###### billing\_address.line2? [Section titled “billing\_address.line2?”](#billing_addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-104) Address line 2 (e.g., apartment, suite, unit, or building). ###### billing\_address.phone\_number? [Section titled “billing\_address.phone\_number?”](#billing_addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-105) Phone number. ###### billing\_address.postal\_code? [Section titled “billing\_address.postal\_code?”](#billing_addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-106) ZIP or postal code. ###### billing\_address.state? [Section titled “billing\_address.state?”](#billing_addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-107) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### created\_at [Section titled “created\_at”](#created_at) > **created\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-108) Timestamp, in UTC, when this legal entity was created. ###### display\_name [Section titled “display\_name”](#display_name) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-109) The display name of this legal entity. ###### id [Section titled “id”](#id-9) > **id**: `string` ###### Description [Section titled “Description”](#description-110) The ID of this legal entity. ###### is\_default? [Section titled “is\_default?”](#is_default) > `optional` **is\_default?**: `boolean` ###### Description [Section titled “Description”](#description-111) Whether this is the default entity of the account. ###### status [Section titled “status”](#status) > **status**: `"UNSUBMITTED"` | `"UNVERIFIED"` | `"IN_PROGRESS"` | `"VERIFIED"` | `"REJECTED"` *** `null` ##### ExpandableExpense.spending\_entity\_id? [Section titled “ExpandableExpense.spending\_entity\_id?”](#expandableexpensespending_entity_id) > `optional` **spending\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-112) The spending entity ID associated with the expense. ##### ExpandableExpense.status? [Section titled “ExpandableExpense.status?”](#expandableexpensestatus) > `optional` **status?**: `"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"` | `null` ##### ExpandableExpense.submitted\_at? [Section titled “ExpandableExpense.submitted\_at?”](#expandableexpensesubmitted_at) > `optional` **submitted\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-113) The time the expense is submitted, ##### ExpandableExpense.trip\_id? [Section titled “ExpandableExpense.trip\_id?”](#expandableexpensetrip_id) > `optional` **trip\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-114) The trip ID associated with the expense if it is a trip expense. ##### ExpandableExpense.updated\_at [Section titled “ExpandableExpense.updated\_at”](#expandableexpenseupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-115) The last time the expense was updated. ##### ExpandableExpense.usd\_equivalent\_amount? [Section titled “ExpandableExpense.usd\_equivalent\_amount?”](#expandableexpenseusd_equivalent_amount) > `optional` **usd\_equivalent\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-18) ###### Type Literal [Section titled “Type Literal”](#type-literal-18) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-4) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-116) 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 [Section titled “Example”](#example-8) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-4) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-117) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-4) ```ts USD ``` ###### Example [Section titled “Example”](#example-9) ```ts USD ``` *** `null` ##### ExpandableExpense.user? [Section titled “ExpandableExpense.user?”](#expandableexpenseuser) > `optional` **user?**: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-19) ###### Type Literal [Section titled “Type Literal”](#type-literal-19) { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } ###### department\_id? [Section titled “department\_id?”](#department_id-3) > `optional` **department\_id?**: `string` | `null` ###### first\_name [Section titled “first\_name”](#first_name-3) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-118) First name of the User. ###### id [Section titled “id”](#id-10) > **id**: `string` ###### Description [Section titled “Description”](#description-119) Unique ID for the User. ###### last\_name [Section titled “last\_name”](#last_name-3) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-120) Last name of the User. ###### location\_id? [Section titled “location\_id?”](#location_id-3) > `optional` **location\_id?**: `string` | `null` *** `null` ##### ExpandableExpense.user\_id? [Section titled “ExpandableExpense.user\_id?”](#expandableexpenseuser_id) > `optional` **user\_id?**: `string` | `null` #### Expense [Section titled “Expense”](#expense) > **Expense**: `object` ##### Expense.billing\_amount? [Section titled “Expense.billing\_amount?”](#expensebilling_amount) > `optional` **billing\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-20) ###### Type Literal [Section titled “Type Literal”](#type-literal-20) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-5) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-121) 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 [Section titled “Example”](#example-10) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-5) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-122) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-5) ```ts USD ``` ###### Example [Section titled “Example”](#example-11) ```ts USD ``` *** `null` ##### Expense.budget\_id? [Section titled “Expense.budget\_id?”](#expensebudget_id) > `optional` **budget\_id?**: `string` | `null` ##### Expense.category? [Section titled “Expense.category?”](#expensecategory) > `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` ##### Expense.department\_id? [Section titled “Expense.department\_id?”](#expensedepartment_id) > `optional` **department\_id?**: `string` | `null` ##### Expense.id [Section titled “Expense.id”](#expenseid) > **id**: `string` ###### Description [Section titled “Description”](#description-123) Unique ID associated with the expense. ##### Expense.location\_id? [Section titled “Expense.location\_id?”](#expenselocation_id) > `optional` **location\_id?**: `string` | `null` ##### Expense.memo? [Section titled “Expense.memo?”](#expensememo) > `optional` **memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-124) The memo of the expense. ##### Expense.merchant\_id? [Section titled “Expense.merchant\_id?”](#expensemerchant_id) > `optional` **merchant\_id?**: `string` | `null` ##### Expense.original\_amount? [Section titled “Expense.original\_amount?”](#expenseoriginal_amount) > `optional` **original\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-21) ###### Type Literal [Section titled “Type Literal”](#type-literal-21) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-6) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-125) 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 [Section titled “Example”](#example-12) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-6) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-126) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-6) ```ts USD ``` ###### Example [Section titled “Example”](#example-13) ```ts USD ``` *** `null` ##### Expense.payment\_status? [Section titled “Expense.payment\_status?”](#expensepayment_status) > `optional` **payment\_status?**: `"NOT_STARTED"` | `"PROCESSING"` | `"CANCELED"` | `"DECLINED"` | `"CLEARED"` | `"REFUNDING"` | `"REFUNDED"` | `"CASH_ADVANCE"` | `"CREDITED"` | `"AWAITING_PAYMENT"` | `"SCHEDULED"` | `null` ##### Expense.purchased\_at? [Section titled “Expense.purchased\_at?”](#expensepurchased_at) > `optional` **purchased\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-127) The time the purchase was made. ##### Expense.status? [Section titled “Expense.status?”](#expensestatus) > `optional` **status?**: `"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"` | `null` ##### Expense.updated\_at [Section titled “Expense.updated\_at”](#expenseupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-128) The last time the expense was updated. #### ExpensePaymentStatus [Section titled “ExpensePaymentStatus”](#expensepaymentstatus) > **ExpensePaymentStatus**: `"NOT_STARTED"` | `"PROCESSING"` | `"CANCELED"` | `"DECLINED"` | `"CLEARED"` | `"REFUNDING"` | `"REFUNDED"` | `"CASH_ADVANCE"` | `"CREDITED"` | `"AWAITING_PAYMENT"` | `"SCHEDULED"` #### ExpenseStatus [Section titled “ExpenseStatus”](#expensestatus-1) > **ExpenseStatus**: `"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"` #### ExpenseType [Section titled “ExpenseType”](#expensetype) > **ExpenseType**: `"CARD"` | `"REIMBURSEMENT"` | `"BILLPAY"` | `"CLAWBACK"` | `"UNSET"` #### LegalEntity [Section titled “LegalEntity”](#legalentity) > **LegalEntity**: `object` Legal Entity ##### Description [Section titled “Description”](#description-129) A Brex legal entity. ##### LegalEntity.billing\_address [Section titled “LegalEntity.billing\_address”](#legalentitybilling_address) > **billing\_address**: `object` ##### LegalEntity.billing\_address.city? [Section titled “LegalEntity.billing\_address.city?”](#legalentitybilling_addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-130) City, district, suburb, town, or village. ##### LegalEntity.billing\_address.country? [Section titled “LegalEntity.billing\_address.country?”](#legalentitybilling_addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-131) Two-letter country code (ISO 3166-1 alpha-2). ##### LegalEntity.billing\_address.line1? [Section titled “LegalEntity.billing\_address.line1?”](#legalentitybilling_addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-132) Address line 1, no PO Box. ##### LegalEntity.billing\_address.line2? [Section titled “LegalEntity.billing\_address.line2?”](#legalentitybilling_addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-133) Address line 2 (e.g., apartment, suite, unit, or building). ##### LegalEntity.billing\_address.phone\_number? [Section titled “LegalEntity.billing\_address.phone\_number?”](#legalentitybilling_addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-134) Phone number. ##### LegalEntity.billing\_address.postal\_code? [Section titled “LegalEntity.billing\_address.postal\_code?”](#legalentitybilling_addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-135) ZIP or postal code. ##### LegalEntity.billing\_address.state? [Section titled “LegalEntity.billing\_address.state?”](#legalentitybilling_addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-136) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### LegalEntity.created\_at [Section titled “LegalEntity.created\_at”](#legalentitycreated_at) > **created\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-137) Timestamp, in UTC, when this legal entity was created. ##### LegalEntity.display\_name [Section titled “LegalEntity.display\_name”](#legalentitydisplay_name) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-138) The display name of this legal entity. ##### LegalEntity.id [Section titled “LegalEntity.id”](#legalentityid) > **id**: `string` ###### Description [Section titled “Description”](#description-139) The ID of this legal entity. ##### LegalEntity.is\_default? [Section titled “LegalEntity.is\_default?”](#legalentityis_default) > `optional` **is\_default?**: `boolean` ###### Description [Section titled “Description”](#description-140) Whether this is the default entity of the account. ##### LegalEntity.status [Section titled “LegalEntity.status”](#legalentitystatus) > **status**: `"UNSUBMITTED"` | `"UNVERIFIED"` | `"IN_PROGRESS"` | `"VERIFIED"` | `"REJECTED"` #### LegalEntityStatus [Section titled “LegalEntityStatus”](#legalentitystatus-1) > **LegalEntityStatus**: `"UNSUBMITTED"` | `"UNVERIFIED"` | `"IN_PROGRESS"` | `"VERIFIED"` | `"REJECTED"` ##### Description [Section titled “Description”](#description-141) The possible statuses for an entity’s verification in Brex. #### Location [Section titled “Location”](#location) > **Location**: `object` ##### Description [Section titled “Description”](#description-142) Location ##### Location.city? [Section titled “Location.city?”](#locationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-143) City, district, suburb, town, or village. ##### Location.coordinates? [Section titled “Location.coordinates?”](#locationcoordinates) > `optional` **coordinates?**: { `latitude`: `number`; `longitude`: `number`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-22) ###### Type Literal [Section titled “Type Literal”](#type-literal-22) { `latitude`: `number`; `longitude`: `number`; } ###### latitude [Section titled “latitude”](#latitude-1) > **latitude**: `number` Format: double ###### longitude [Section titled “longitude”](#longitude-1) > **longitude**: `number` Format: double *** `null` ##### Location.country? [Section titled “Location.country?”](#locationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-144) Two-letter country code (ISO 3166-1 alpha-2). ##### Location.line1? [Section titled “Location.line1?”](#locationline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-145) Address line 1, no PO Box. ##### Location.line2? [Section titled “Location.line2?”](#locationline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-146) Address line 2 (e.g., apartment, suite, unit, or building). ##### Location.postal\_code? [Section titled “Location.postal\_code?”](#locationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-147) ZIP or postal code. ##### Location.state? [Section titled “Location.state?”](#locationstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-148) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### Location.timezone? [Section titled “Location.timezone?”](#locationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-149) Timezone. ##### Location.LatLong [Section titled “Location.LatLong”](#locationlatlong) > **Location.LatLong**: `object` ###### Description [Section titled “Description”](#description-150) Latitude and longitude ##### Location.LatLong.latitude [Section titled “Location.LatLong.latitude”](#locationlatlonglatitude) > **latitude**: `number` Format: double ##### Location.LatLong.longitude [Section titled “Location.LatLong.longitude”](#locationlatlonglongitude) > **longitude**: `number` Format: double #### Merchant [Section titled “Merchant”](#merchant) > **Merchant**: `object` ##### Merchant.country [Section titled “Merchant.country”](#merchantcountry) > **country**: `string` ###### Description [Section titled “Description”](#description-151) Merchant’s country, in ISO 3166-1 alpha-3 format. ##### Merchant.mcc [Section titled “Merchant.mcc”](#merchantmcc) > **mcc**: `string` ###### Description [Section titled “Description”](#description-152) A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to for more details. ##### Merchant.raw\_descriptor [Section titled “Merchant.raw\_descriptor”](#merchantraw_descriptor) > **raw\_descriptor**: `string` ###### Description [Section titled “Description”](#description-153) Merchant descriptor, it can be the merchant name. #### Money [Section titled “Money”](#money) > **Money**: `object` ##### Description [Section titled “Description”](#description-154) Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700. ##### Money.amount [Section titled “Money.amount”](#moneyamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-155) 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 [Section titled “Example”](#example-14) ```ts 700 ``` ##### Money.currency [Section titled “Money.currency”](#moneycurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-156) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-7) ```ts USD ``` ###### Example [Section titled “Example”](#example-15) ```ts USD ``` #### MoneyListValue [Section titled “MoneyListValue”](#moneylistvalue) > **MoneyListValue**: `object` & `object` & `object` & `object` & `object` Money list value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-49) ###### data? [Section titled “data?”](#data-8) > `optional` **data?**: `object`\[] | `null` ###### data\_type [Section titled “data\_type”](#data_type-26) > **data\_type**: `"MONEY"` ###### Description [Section titled “Description”](#description-157) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-50) ###### value\_type [Section titled “value\_type”](#value_type-30) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-51) ###### data\_type [Section titled “data\_type”](#data_type-27) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-31) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-52) ###### value\_type [Section titled “value\_type”](#value_type-32) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-53) ###### data\_type [Section titled “data\_type”](#data_type-28) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-158) Money list value for a custom field #### MoneyValue [Section titled “MoneyValue”](#moneyvalue) > **MoneyValue**: `object` & `object` & `object` & `object` & `object` Money value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-54) ###### data? [Section titled “data?”](#data-9) > `optional` **data?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-23) ###### Type Literal [Section titled “Type Literal”](#type-literal-23) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-7) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-159) 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 [Section titled “Example”](#example-16) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-7) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-160) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-8) ```ts USD ``` ###### Example [Section titled “Example”](#example-17) ```ts USD ``` *** `null` ###### data\_type [Section titled “data\_type”](#data_type-29) > **data\_type**: `"MONEY"` ###### Description [Section titled “Description”](#description-161) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-55) ###### value\_type [Section titled “value\_type”](#value_type-33) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-56) ###### data\_type [Section titled “data\_type”](#data_type-30) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-34) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-57) ###### value\_type [Section titled “value\_type”](#value_type-35) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-58) ###### data\_type [Section titled “data\_type”](#data_type-31) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-162) Money value for a custom field #### OptionString [Section titled “OptionString”](#optionstring) > **OptionString**: `object` ##### Description [Section titled “Description”](#description-163) Option string fields have a label and a identifier. ##### OptionString.option\_id? [Section titled “OptionString.option\_id?”](#optionstringoption_id) > `optional` **option\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-164) The identifier when custom field data is of type option string. ##### OptionString.option\_label? [Section titled “OptionString.option\_label?”](#optionstringoption_label) > `optional` **option\_label?**: `string` | `null` ###### Description [Section titled “Description”](#description-165) The label when custom field data is of type option string. #### OptionStringListValue [Section titled “OptionStringListValue”](#optionstringlistvalue) > **OptionStringListValue**: `object` & `object` & `object` & `object` & `object` Option string list value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-59) ###### data? [Section titled “data?”](#data-10) > `optional` **data?**: `object`\[] | `null` ###### data\_type [Section titled “data\_type”](#data_type-32) > **data\_type**: `"OPTION_STRING"` ###### Description [Section titled “Description”](#description-166) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-60) ###### value\_type [Section titled “value\_type”](#value_type-36) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-61) ###### data\_type [Section titled “data\_type”](#data_type-33) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-37) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-62) ###### value\_type [Section titled “value\_type”](#value_type-38) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-63) ###### data\_type [Section titled “data\_type”](#data_type-34) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-167) Option string list value for a custom field #### OptionStringValue [Section titled “OptionStringValue”](#optionstringvalue) > **OptionStringValue**: `object` & `object` & `object` & `object` & `object` Option string value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-64) ###### data? [Section titled “data?”](#data-11) > `optional` **data?**: { `option_id?`: `string` | `null`; `option_label?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-24) ###### Type Literal [Section titled “Type Literal”](#type-literal-24) { `option_id?`: `string` | `null`; `option_label?`: `string` | `null`; } ###### option\_id? [Section titled “option\_id?”](#option_id) > `optional` **option\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-168) The identifier when custom field data is of type option string. ###### option\_label? [Section titled “option\_label?”](#option_label) > `optional` **option\_label?**: `string` | `null` ###### Description [Section titled “Description”](#description-169) The label when custom field data is of type option string. *** `null` ###### data\_type [Section titled “data\_type”](#data_type-35) > **data\_type**: `"OPTION_STRING"` ###### Description [Section titled “Description”](#description-170) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-65) ###### value\_type [Section titled “value\_type”](#value_type-39) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-66) ###### data\_type [Section titled “data\_type”](#data_type-36) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-40) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-67) ###### value\_type [Section titled “value\_type”](#value_type-41) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-68) ###### data\_type [Section titled “data\_type”](#data_type-37) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-171) Option string value for a custom field #### Page\_ExpandableExpense\_ [Section titled “Page\_ExpandableExpense\_”](#page_expandableexpense_) > **Page\_ExpandableExpense\_**: `object` ##### Page\_ExpandableExpense\_.items [Section titled “Page\_ExpandableExpense\_.items”](#page_expandableexpense_items) > **items**: `object`\[] ##### Page\_ExpandableExpense\_.next\_cursor? [Section titled “Page\_ExpandableExpense\_.next\_cursor?”](#page_expandableexpense_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Payment [Section titled “Payment”](#payment) > **Payment**: `object` ##### Description [Section titled “Description”](#description-172) The payment associated with the expense. ##### Payment.id [Section titled “Payment.id”](#paymentid) > **id**: `string` ###### Description [Section titled “Description”](#description-173) Unique ID for the payment. ##### Payment.paymentInstrument [Section titled “Payment.paymentInstrument”](#paymentpaymentinstrument) > **paymentInstrument**: `Omit`<`object` & `object` & `object`, `"type"`> ##### Payment.statusReason [Section titled “Payment.statusReason”](#paymentstatusreason) > **statusReason**: `"APPROVED"` | `"OTHER"` | `"EXCEEDED_BUDGET_LIMIT"` | `"BUDGET_EXPIRED"` | `"NO_BUDGET"` | `"BUDGET_NOT_YET_STARTED"` | `"BUDGET_CATEGORY_RESTRICTION"` | `"BUDGET_MERCHANT_RESTRICTION"` | `"SUSPECTED_FRAUD"` | `"EXCEEDED_GLOBAL_LIMIT"` | `"EXCEEDED_USER_LIMIT"` | `"EXCEEDED_CARD_LIMIT"` | `"INVALID_EXPIRATION_DATE"` | `"CARD_NOT_ACTIVE"` | `"INVALID_CARD_CREDENTIALS"` | `"INVALID_BILLING_ADDRESS"` | `"CARD_SUSPENDED"` | `"CARD_TERMINATED"` | `"CARD_EXPIRED"` | `"MCC_BLOCKED"` | `"USER_SUSPENDED"` | `"INVALID_PIN"` | `"INVALID_CVV"` | `"EXCEEDED_PIN_ATTEMPTS"` | `"INSIDE_SANCTIONED_COUNTRY"` | `"SOFT_EXPIRATION"` | `"TRANSFERRED_CARD_NEW_MERCHANT"` | `"EXCEEDED_ANCESTOR_BUDGET_LIMIT"` | `"EXCEEDED_BUDGET_TRANSACTION_LIMIT"` | `"TOS_BLOCKED"` | `"COMPLIANCE_BLOCKED"` #### PaymentInstrument [Section titled “PaymentInstrument”](#paymentinstrument-1) > **PaymentInstrument**: `object` & `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-69) ###### type [Section titled “type”](#type-3) > **type**: `"CARD"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-70) ###### id [Section titled “id”](#id-11) > **id**: `string` ###### Description [Section titled “Description”](#description-174) Unique ID for the card. ###### type [Section titled “type”](#type-4) > **type**: `"CARD"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-71) ###### type [Section titled “type”](#type-5) > **type**: `"CARD"` ###### Description [Section titled “Description”](#description-175) discriminator enum property added by openapi-typescript #### PaymentInstrumentType [Section titled “PaymentInstrumentType”](#paymentinstrumenttype) > **PaymentInstrumentType**: `"CARD"` #### PaymentStatusReason [Section titled “PaymentStatusReason”](#paymentstatusreason-1) > **PaymentStatusReason**: `"APPROVED"` | `"OTHER"` | `"EXCEEDED_BUDGET_LIMIT"` | `"BUDGET_EXPIRED"` | `"NO_BUDGET"` | `"BUDGET_NOT_YET_STARTED"` | `"BUDGET_CATEGORY_RESTRICTION"` | `"BUDGET_MERCHANT_RESTRICTION"` | `"SUSPECTED_FRAUD"` | `"EXCEEDED_GLOBAL_LIMIT"` | `"EXCEEDED_USER_LIMIT"` | `"EXCEEDED_CARD_LIMIT"` | `"INVALID_EXPIRATION_DATE"` | `"CARD_NOT_ACTIVE"` | `"INVALID_CARD_CREDENTIALS"` | `"INVALID_BILLING_ADDRESS"` | `"CARD_SUSPENDED"` | `"CARD_TERMINATED"` | `"CARD_EXPIRED"` | `"MCC_BLOCKED"` | `"USER_SUSPENDED"` | `"INVALID_PIN"` | `"INVALID_CVV"` | `"EXCEEDED_PIN_ATTEMPTS"` | `"INSIDE_SANCTIONED_COUNTRY"` | `"SOFT_EXPIRATION"` | `"TRANSFERRED_CARD_NEW_MERCHANT"` | `"EXCEEDED_ANCESTOR_BUDGET_LIMIT"` | `"EXCEEDED_BUDGET_TRANSACTION_LIMIT"` | `"TOS_BLOCKED"` | `"COMPLIANCE_BLOCKED"` ##### Description [Section titled “Description”](#description-176) The reason for the payment’s status. #### Policy [Section titled “Policy”](#policy) > **Policy**: `object` ##### Description [Section titled “Description”](#description-177) The policy associated with the expense. ##### Policy.id [Section titled “Policy.id”](#policyid) > **id**: `string` ###### Description [Section titled “Description”](#description-178) The unique identifier for the policy. ##### Policy.name [Section titled “Policy.name”](#policyname) > **name**: `string` ###### Description [Section titled “Description”](#description-179) The display name of the policy. #### Receipt [Section titled “Receipt”](#receipt) > **Receipt**: `object` ##### Description [Section titled “Description”](#description-180) The receipt associated with the expense. ##### Receipt.download\_uris? [Section titled “Receipt.download\_uris?”](#receiptdownload_uris) > `optional` **download\_uris?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-181) [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. ##### Receipt.id [Section titled “Receipt.id”](#receiptid) > **id**: `string` ###### Description [Section titled “Description”](#description-182) The unique identifier for the receipt. #### ReceiptMatchRequest [Section titled “ReceiptMatchRequest”](#receiptmatchrequest) > **ReceiptMatchRequest**: `object` ##### Description [Section titled “Description”](#description-183) The parameter for creating a receipt match. ##### ReceiptMatchRequest.receipt\_name [Section titled “ReceiptMatchRequest.receipt\_name”](#receiptmatchrequestreceipt_name) > **receipt\_name**: `string` ###### Description [Section titled “Description”](#description-184) The name of the receipt (with the file extension). It will be used in the matching result email. #### ReceiptUploadRequest [Section titled “ReceiptUploadRequest”](#receiptuploadrequest) > **ReceiptUploadRequest**: `object` ##### Description [Section titled “Description”](#description-185) The parameter for creating a receipt upload. ##### ReceiptUploadRequest.receipt\_name [Section titled “ReceiptUploadRequest.receipt\_name”](#receiptuploadrequestreceipt_name) > **receipt\_name**: `string` ###### Description [Section titled “Description”](#description-186) The name of the receipt (with the file extension). #### Repayment [Section titled “Repayment”](#repayment) > **Repayment**: `object` ##### Repayment.repayment\_initiated\_by? [Section titled “Repayment.repayment\_initiated\_by?”](#repaymentrepayment_initiated_by) > `optional` **repayment\_initiated\_by?**: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-25) ###### Type Literal [Section titled “Type Literal”](#type-literal-25) { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } ###### department\_id? [Section titled “department\_id?”](#department_id-4) > `optional` **department\_id?**: `string` | `null` ###### first\_name [Section titled “first\_name”](#first_name-4) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-187) First name of the User. ###### id [Section titled “id”](#id-12) > **id**: `string` ###### Description [Section titled “Description”](#description-188) Unique ID for the User. ###### last\_name [Section titled “last\_name”](#last_name-4) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-189) Last name of the User. ###### location\_id? [Section titled “location\_id?”](#location_id-4) > `optional` **location\_id?**: `string` | `null` *** `null` ##### Repayment.repayment\_initiation\_date? [Section titled “Repayment.repayment\_initiation\_date?”](#repaymentrepayment_initiation_date) > `optional` **repayment\_initiation\_date?**: `string` | `null` Format: date-time #### Review [Section titled “Review”](#review) > **Review**: `object` ##### Review\.approval\_steps [Section titled “Review.approval\_steps”](#reviewapproval_steps) > **approval\_steps**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-190) Information for each approval step of the expense ##### Review\.compliance\_status [Section titled “Review.compliance\_status”](#reviewcompliance_status) > **compliance\_status**: `string` | `null` ###### Description [Section titled “Description”](#description-191) Compliance status of the expense #### StringListValue [Section titled “StringListValue”](#stringlistvalue) > **StringListValue**: `object` & `object` & `object` & `object` & `object` String list value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-72) ###### data? [Section titled “data?”](#data-12) > `optional` **data?**: `string`\[] | `null` ###### data\_type [Section titled “data\_type”](#data_type-38) > **data\_type**: `"STRING"` ###### Description [Section titled “Description”](#description-192) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-73) ###### value\_type [Section titled “value\_type”](#value_type-42) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-74) ###### data\_type [Section titled “data\_type”](#data_type-39) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-43) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-75) ###### value\_type [Section titled “value\_type”](#value_type-44) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-76) ###### data\_type [Section titled “data\_type”](#data_type-40) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-193) String list value for a custom field #### StringValue [Section titled “StringValue”](#stringvalue) > **StringValue**: `object` & `object` & `object` & `object` & `object` String value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-77) ###### data? [Section titled “data?”](#data-13) > `optional` **data?**: `string` | `null` ###### Description [Section titled “Description”](#description-194) The data of the custom field. ###### data\_type [Section titled “data\_type”](#data_type-41) > **data\_type**: `"STRING"` ###### Description [Section titled “Description”](#description-195) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-78) ###### value\_type [Section titled “value\_type”](#value_type-45) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-79) ###### data\_type [Section titled “data\_type”](#data_type-42) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-46) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-80) ###### value\_type [Section titled “value\_type”](#value_type-47) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-81) ###### data\_type [Section titled “data\_type”](#data_type-43) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-196) String value for a custom field #### TimestampListValue [Section titled “TimestampListValue”](#timestamplistvalue) > **TimestampListValue**: `object` & `object` & `object` & `object` & `object` Timestamp list value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-82) ###### data? [Section titled “data?”](#data-14) > `optional` **data?**: `string`\[] | `null` ###### data\_type [Section titled “data\_type”](#data_type-44) > **data\_type**: `"TIMESTAMP"` ###### Description [Section titled “Description”](#description-197) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-83) ###### value\_type [Section titled “value\_type”](#value_type-48) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-84) ###### data\_type [Section titled “data\_type”](#data_type-45) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-49) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-85) ###### value\_type [Section titled “value\_type”](#value_type-50) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-86) ###### data\_type [Section titled “data\_type”](#data_type-46) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-198) Timestamp list value for a custom field #### TimestampValue [Section titled “TimestampValue”](#timestampvalue) > **TimestampValue**: `object` & `object` & `object` & `object` & `object` Timestamp value ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-87) ###### data? [Section titled “data?”](#data-15) > `optional` **data?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-199) The data of the custom field. ###### data\_type [Section titled “data\_type”](#data_type-47) > **data\_type**: `"TIMESTAMP"` ###### Description [Section titled “Description”](#description-200) The type of the custom field data. ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-88) ###### value\_type [Section titled “value\_type”](#value_type-51) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-89) ###### data\_type [Section titled “data\_type”](#data_type-48) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ###### value\_type [Section titled “value\_type”](#value_type-52) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-90) ###### value\_type [Section titled “value\_type”](#value_type-53) > **value\_type**: `"SINGLE_VALUE"` | `"LIST"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-91) ###### data\_type [Section titled “data\_type”](#data_type-49) > **data\_type**: `"BOOLEAN"` | `"STRING"` | `"DECIMAL"` | `"ENUM"` | `"TIMESTAMP"` | `"DATE"` | `"MONEY"` | `"OPTION_STRING"` ##### Description [Section titled “Description”](#description-201) Timestamp value for a custom field #### UpdateExpenseRequest [Section titled “UpdateExpenseRequest”](#updateexpenserequest) > **UpdateExpenseRequest**: `object` ##### Description [Section titled “Description”](#description-202) The parameter for updating an expense. ##### UpdateExpenseRequest.memo? [Section titled “UpdateExpenseRequest.memo?”](#updateexpenserequestmemo) > `optional` **memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-203) Expense memo. #### User [Section titled “User”](#user) > **User**: `object` ##### User.department\_id? [Section titled “User.department\_id?”](#userdepartment_id) > `optional` **department\_id?**: `string` | `null` ##### User.first\_name [Section titled “User.first\_name”](#userfirst_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-204) First name of the User. ##### User.id [Section titled “User.id”](#userid) > **id**: `string` ###### Description [Section titled “Description”](#description-205) Unique ID for the User. ##### User.last\_name [Section titled “User.last\_name”](#userlast_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-206) Last name of the User. ##### User.location\_id? [Section titled “User.location\_id?”](#userlocation_id) > `optional` **location\_id?**: `string` | `null` # ExpensesPaths Defined in: [src/expenses/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/types.gen.ts#L2) ## Properties [Section titled “Properties”](#properties) ### /v1/expenses [Section titled “/v1/expenses”](#v1expenses) > **/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? [Section titled “delete?”](#delete) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get) > **get**: `object` List expenses ##### Description [Section titled “Description”](#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 [Section titled “get.parameters”](#getparameters) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery) > `optional` **query?**: `object` ##### get.parameters.query.budget\_id\[]? [Section titled “get.parameters.query.budget\_id\[\]?”](#getparametersquerybudget_id) > `optional` **budget\_id\[]?**: `string`\[] | `null` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor) > `optional` **cursor?**: `string` | `null` ###### Description [Section titled “Description”](#description-1) The cursor to use for pagination. This is the `next_cursor` value returned from the previous response. ##### get.parameters.query.expand\[]? [Section titled “get.parameters.query.expand\[\]?”](#getparametersqueryexpand) > `optional` **expand\[]?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-2) 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 [Section titled “Example”](#example) ```ts ?expand[]=merchant&expand[]=location ``` ##### get.parameters.query.expense\_type\[]? [Section titled “get.parameters.query.expense\_type\[\]?”](#getparametersqueryexpense_type) > `optional` **expense\_type\[]?**: (`"CARD"` | `"REIMBURSEMENT"` | `"BILLPAY"` | `"CLAWBACK"` | `"UNSET"`)\[] | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit) > `optional` **limit?**: `number` | `null` ###### Description [Section titled “Description”](#description-3) Controls the maximum number of expenses returned in the response, can’t be greater than 100 ##### get.parameters.query.load\_custom\_fields? [Section titled “get.parameters.query.load\_custom\_fields?”](#getparametersqueryload_custom_fields) > `optional` **load\_custom\_fields?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-4) Load custom fields for the expenses. ##### get.parameters.query.parent\_expense\_id\[]? [Section titled “get.parameters.query.parent\_expense\_id\[\]?”](#getparametersqueryparent_expense_id) > `optional` **parent\_expense\_id\[]?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-5) Get itemized expenses belong to provided parent expenses ID(s). ##### get.parameters.query.payment\_posted\_at\_end? [Section titled “get.parameters.query.payment\_posted\_at\_end?”](#getparametersquerypayment_posted_at_end) > `optional` **payment\_posted\_at\_end?**: `string` | `null` ###### Description [Section titled “Description”](#description-6) 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 [Section titled “Example”](#example-1) ```ts 2023-01-10T23:59:59.999 ``` ##### get.parameters.query.payment\_posted\_at\_start? [Section titled “get.parameters.query.payment\_posted\_at\_start?”](#getparametersquerypayment_posted_at_start) > `optional` **payment\_posted\_at\_start?**: `string` | `null` ###### Description [Section titled “Description”](#description-7) 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 [Section titled “Example”](#example-2) ```ts 2023-01-01T23:59:59.999 ``` ##### get.parameters.query.payment\_status\[]? [Section titled “get.parameters.query.payment\_status\[\]?”](#getparametersquerypayment_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? [Section titled “get.parameters.query.purchased\_at\_end?”](#getparametersquerypurchased_at_end) > `optional` **purchased\_at\_end?**: `string` | `null` ###### Description [Section titled “Description”](#description-8) 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 [Section titled “Example”](#example-3) ```ts 2023-01-10T23:59:59.999 ``` ##### get.parameters.query.purchased\_at\_start? [Section titled “get.parameters.query.purchased\_at\_start?”](#getparametersquerypurchased_at_start) > `optional` **purchased\_at\_start?**: `string` | `null` ###### Description [Section titled “Description”](#description-9) 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 [Section titled “Example”](#example-4) ```ts 2023-01-01T23:59:59.999 ``` ##### get.parameters.query.spending\_entity\_id\[]? [Section titled “get.parameters.query.spending\_entity\_id\[\]?”](#getparametersqueryspending_entity_id) > `optional` **spending\_entity\_id\[]?**: `string`\[] | `null` ##### get.parameters.query.status\[]? [Section titled “get.parameters.query.status\[\]?”](#getparametersquerystatus) > `optional` **status\[]?**: (`"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"`)\[] | `null` ##### get.parameters.query.updated\_at\_end? [Section titled “get.parameters.query.updated\_at\_end?”](#getparametersqueryupdated_at_end) > `optional` **updated\_at\_end?**: `string` | `null` ###### Description [Section titled “Description”](#description-10) 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 [Section titled “Example”](#example-5) ```ts 2023-01-10T23:59:59.999 ``` ##### get.parameters.query.updated\_at\_start? [Section titled “get.parameters.query.updated\_at\_start?”](#getparametersqueryupdated_at_start) > `optional` **updated\_at\_start?**: `string` | `null` ###### Description [Section titled “Description”](#description-11) 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 [Section titled “Example”](#example-6) ```ts 2023-01-01T23:59:59.999 ``` ##### get.parameters.query.user\_id\[]? [Section titled “get.parameters.query.user\_id\[\]?”](#getparametersqueryuser_id) > `optional` **user\_id\[]?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-12) Get expenses belong to provided user(s). ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-13) List expenses response. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-14) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-1) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-15) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-2) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-16) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-3) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace) > `optional` **trace?**: `undefined` *** ### /v1/expenses/{id} [Section titled “/v1/expenses/{id}”](#v1expensesid) > **/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? [Section titled “delete?”](#delete-1) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-1) > **get**: `object` Get an expense ##### Description [Section titled “Description”](#description-17) Get an expense by its ID. ##### get.parameters [Section titled “get.parameters”](#getparameters-1) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-1) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-1) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-1) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-1) > `optional` **query?**: `object` ##### get.parameters.query.expand\[]? [Section titled “get.parameters.query.expand\[\]?”](#getparametersqueryexpand-1) > `optional` **expand\[]?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-18) 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 [Section titled “Example”](#example-7) ```ts ?expand[]=merchant&expand[]=location ``` ##### get.parameters.query.load\_custom\_fields? [Section titled “get.parameters.query.load\_custom\_fields?”](#getparametersqueryload_custom_fields-1) > `optional` **load\_custom\_fields?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-19) Load custom fields for the expense. ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-1) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-1) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-20) Get an expense response. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-1) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-1) > **application/json**: `object` ##### get.responses.200.content.application/json.address? [Section titled “get.responses.200.content.application/json.address?”](#getresponses200contentapplicationjsonaddress) > `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 [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#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? [Section titled “city?”](#city) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-21) City, district, suburb, town, or village. ###### coordinates? [Section titled “coordinates?”](#coordinates) > `optional` **coordinates?**: { `latitude`: `number`; `longitude`: `number`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `latitude`: `number`; `longitude`: `number`; } ###### latitude [Section titled “latitude”](#latitude) > **latitude**: `number` Format: double ###### longitude [Section titled “longitude”](#longitude) > **longitude**: `number` Format: double *** `null` ###### country? [Section titled “country?”](#country) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-22) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-23) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-24) Address line 2 (e.g., apartment, suite, unit, or building). ###### postal\_code? [Section titled “postal\_code?”](#postal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-25) ZIP or postal code. ###### state? [Section titled “state?”](#state) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-26) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### timezone? [Section titled “timezone?”](#timezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-27) Timezone. *** `null` ##### get.responses.200.content.application/json.approved\_at? [Section titled “get.responses.200.content.application/json.approved\_at?”](#getresponses200contentapplicationjsonapproved_at) > `optional` **approved\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-28) The time the expense is approved. ##### get.responses.200.content.application/json.billing\_amount? [Section titled “get.responses.200.content.application/json.billing\_amount?”](#getresponses200contentapplicationjsonbilling_amount) > `optional` **billing\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-29) 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 [Section titled “Example”](#example-8) ```ts 700 ``` ###### currency [Section titled “currency”](#currency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-30) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default) ```ts USD ``` ###### Example [Section titled “Example”](#example-9) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.billing\_entity\_id? [Section titled “get.responses.200.content.application/json.billing\_entity\_id?”](#getresponses200contentapplicationjsonbilling_entity_id) > `optional` **billing\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-31) ID of the legal entity responsible for billing the expense. ##### get.responses.200.content.application/json.booking\_id? [Section titled “get.responses.200.content.application/json.booking\_id?”](#getresponses200contentapplicationjsonbooking_id) > `optional` **booking\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-32) The booking ID associated with the expense if it is a trip expense. ##### get.responses.200.content.application/json.budget? [Section titled “get.responses.200.content.application/json.budget?”](#getresponses200contentapplicationjsonbudget) > `optional` **budget?**: { `id`: `string`; `name`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-3) ###### Type Literal [Section titled “Type Literal”](#type-literal-3) { `id`: `string`; `name`: `string`; } ###### id [Section titled “id”](#id) > **id**: `string` ###### Description [Section titled “Description”](#description-33) Unique ID for the Budget. ###### name [Section titled “name”](#name) > **name**: `string` ###### Description [Section titled “Description”](#description-34) Name for the Budget. *** `null` ##### get.responses.200.content.application/json.budget\_amount? [Section titled “get.responses.200.content.application/json.budget\_amount?”](#getresponses200contentapplicationjsonbudget_amount) > `optional` **budget\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-4) ###### Type Literal [Section titled “Type Literal”](#type-literal-4) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-35) 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 [Section titled “Example”](#example-10) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-36) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-1) ```ts USD ``` ###### Example [Section titled “Example”](#example-11) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.budget\_id? [Section titled “get.responses.200.content.application/json.budget\_id?”](#getresponses200contentapplicationjsonbudget_id) > `optional` **budget\_id?**: `string` | `null` ##### get.responses.200.content.application/json.category? [Section titled “get.responses.200.content.application/json.category?”](#getresponses200contentapplicationjsoncategory) > `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? [Section titled “get.responses.200.content.application/json.completion\_date?”](#getresponses200contentapplicationjsoncompletion_date) > `optional` **completion\_date?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-37) The time payment will be completed/is completed. ##### get.responses.200.content.application/json.custom\_fields? [Section titled “get.responses.200.content.application/json.custom\_fields?”](#getresponses200contentapplicationjsoncustom_fields) > `optional` **custom\_fields?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-38) A list of custom field values associated with the expense. ##### get.responses.200.content.application/json.dashboard\_url [Section titled “get.responses.200.content.application/json.dashboard\_url”](#getresponses200contentapplicationjsondashboard_url) > **dashboard\_url**: `string` ###### Description [Section titled “Description”](#description-39) URL to view the expense in the Brex dashboard. ##### get.responses.200.content.application/json.department? [Section titled “get.responses.200.content.application/json.department?”](#getresponses200contentapplicationjsondepartment) > `optional` **department?**: { `id`: `string`; `name`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-5) ###### Type Literal [Section titled “Type Literal”](#type-literal-5) { `id`: `string`; `name`: `string`; } ###### id [Section titled “id”](#id-1) > **id**: `string` ###### Description [Section titled “Description”](#description-40) The unique identifier for the department. ###### name [Section titled “name”](#name-1) > **name**: `string` ###### Description [Section titled “Description”](#description-41) The name of the department. *** `null` ##### get.responses.200.content.application/json.department\_id? [Section titled “get.responses.200.content.application/json.department\_id?”](#getresponses200contentapplicationjsondepartment_id) > `optional` **department\_id?**: `string` | `null` ##### get.responses.200.content.application/json.expense\_line\_items? [Section titled “get.responses.200.content.application/json.expense\_line\_items?”](#getresponses200contentapplicationjsonexpense_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 [Section titled “Description”](#description-42) The expense line items. Limited to 100 items. ##### get.responses.200.content.application/json.expense\_type? [Section titled “get.responses.200.content.application/json.expense\_type?”](#getresponses200contentapplicationjsonexpense_type) > `optional` **expense\_type?**: `"CARD"` | `"REIMBURSEMENT"` | `"BILLPAY"` | `"CLAWBACK"` | `"UNSET"` | `null` ##### get.responses.200.content.application/json.exported\_at? [Section titled “get.responses.200.content.application/json.exported\_at?”](#getresponses200contentapplicationjsonexported_at) > `optional` **exported\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-43) Timestamp when the expense was exported to the accounting system. ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-44) Unique ID associated with the expense. ##### get.responses.200.content.application/json.integration\_billing\_entity\_id? [Section titled “get.responses.200.content.application/json.integration\_billing\_entity\_id?”](#getresponses200contentapplicationjsonintegration_billing_entity_id) > `optional` **integration\_billing\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-45) ID of the billing entity in accounting. ##### get.responses.200.content.application/json.integration\_spending\_entity\_id? [Section titled “get.responses.200.content.application/json.integration\_spending\_entity\_id?”](#getresponses200contentapplicationjsonintegration_spending_entity_id) > `optional` **integration\_spending\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-46) ID of the spending entity in accounting. ##### get.responses.200.content.application/json.location? [Section titled “get.responses.200.content.application/json.location?”](#getresponses200contentapplicationjsonlocation) > `optional` **location?**: { `id`: `string`; `name`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-6) ###### Type Literal [Section titled “Type Literal”](#type-literal-6) { `id`: `string`; `name`: `string`; } ###### id [Section titled “id”](#id-2) > **id**: `string` ###### Description [Section titled “Description”](#description-47) The unique identifier for the location. ###### name [Section titled “name”](#name-2) > **name**: `string` ###### Description [Section titled “Description”](#description-48) The name of the location. *** `null` ##### get.responses.200.content.application/json.location\_id? [Section titled “get.responses.200.content.application/json.location\_id?”](#getresponses200contentapplicationjsonlocation_id) > `optional` **location\_id?**: `string` | `null` ##### get.responses.200.content.application/json.memo? [Section titled “get.responses.200.content.application/json.memo?”](#getresponses200contentapplicationjsonmemo) > `optional` **memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-49) The memo of the expense. ##### get.responses.200.content.application/json.merchant? [Section titled “get.responses.200.content.application/json.merchant?”](#getresponses200contentapplicationjsonmerchant) > `optional` **merchant?**: { `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-7) ###### Type Literal [Section titled “Type Literal”](#type-literal-7) { `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; } ###### country [Section titled “country”](#country-1) > **country**: `string` ###### Description [Section titled “Description”](#description-50) Merchant’s country, in ISO 3166-1 alpha-3 format. ###### mcc [Section titled “mcc”](#mcc) > **mcc**: `string` ###### Description [Section titled “Description”](#description-51) A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to for more details. ###### raw\_descriptor [Section titled “raw\_descriptor”](#raw_descriptor) > **raw\_descriptor**: `string` ###### Description [Section titled “Description”](#description-52) Merchant descriptor, it can be the merchant name. *** `null` ##### get.responses.200.content.application/json.merchant\_id? [Section titled “get.responses.200.content.application/json.merchant\_id?”](#getresponses200contentapplicationjsonmerchant_id) > `optional` **merchant\_id?**: `string` | `null` ##### get.responses.200.content.application/json.original\_amount? [Section titled “get.responses.200.content.application/json.original\_amount?”](#getresponses200contentapplicationjsonoriginal_amount) > `optional` **original\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-8) ###### Type Literal [Section titled “Type Literal”](#type-literal-8) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-2) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-53) 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 [Section titled “Example”](#example-12) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-2) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-54) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-2) ```ts USD ``` ###### Example [Section titled “Example”](#example-13) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.payment? [Section titled “get.responses.200.content.application/json.payment?”](#getresponses200contentapplicationjsonpayment) > `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 [Section titled “Union Members”](#union-members-9) ###### Type Literal [Section titled “Type Literal”](#type-literal-9) { `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 [Section titled “id”](#id-3) > **id**: `string` ###### Description [Section titled “Description”](#description-55) Unique ID for the payment. ###### paymentInstrument [Section titled “paymentInstrument”](#paymentinstrument) > **paymentInstrument**: `Omit`<`object` & `object` & `object`, `"type"`> ###### statusReason [Section titled “statusReason”](#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? [Section titled “get.responses.200.content.application/json.payment\_posted\_at?”](#getresponses200contentapplicationjsonpayment_posted_at) > `optional` **payment\_posted\_at?**: `string` | `null` Format: date-time ##### get.responses.200.content.application/json.payment\_status? [Section titled “get.responses.200.content.application/json.payment\_status?”](#getresponses200contentapplicationjsonpayment_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? [Section titled “get.responses.200.content.application/json.policy?”](#getresponses200contentapplicationjsonpolicy) > `optional` **policy?**: { `id`: `string`; `name`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-10) ###### Type Literal [Section titled “Type Literal”](#type-literal-10) { `id`: `string`; `name`: `string`; } ###### id [Section titled “id”](#id-4) > **id**: `string` ###### Description [Section titled “Description”](#description-56) The unique identifier for the policy. ###### name [Section titled “name”](#name-3) > **name**: `string` ###### Description [Section titled “Description”](#description-57) The display name of the policy. *** `null` ##### get.responses.200.content.application/json.purchased\_amount? [Section titled “get.responses.200.content.application/json.purchased\_amount?”](#getresponses200contentapplicationjsonpurchased_amount) > `optional` **purchased\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-11) ###### Type Literal [Section titled “Type Literal”](#type-literal-11) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-3) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-58) 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 [Section titled “Example”](#example-14) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-3) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-59) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-3) ```ts USD ``` ###### Example [Section titled “Example”](#example-15) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.purchased\_at? [Section titled “get.responses.200.content.application/json.purchased\_at?”](#getresponses200contentapplicationjsonpurchased_at) > `optional` **purchased\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-60) The time the purchase was made. ##### get.responses.200.content.application/json.receipts? [Section titled “get.responses.200.content.application/json.receipts?”](#getresponses200contentapplicationjsonreceipts) > `optional` **receipts?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-61) A list of receipts associated with the expense. ##### get.responses.200.content.application/json.repayment? [Section titled “get.responses.200.content.application/json.repayment?”](#getresponses200contentapplicationjsonrepayment) > `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 [Section titled “Union Members”](#union-members-12) ###### Type Literal [Section titled “Type Literal”](#type-literal-12) { `repayment_initiated_by?`: { `department_id?`: … | … | …; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: … | … | …; } | `null`; `repayment_initiation_date?`: `string` | `null`; } ###### repayment\_initiated\_by? [Section titled “repayment\_initiated\_by?”](#repayment_initiated_by) > `optional` **repayment\_initiated\_by?**: { `department_id?`: … | … | …; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: … | … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-13) ###### Type Literal [Section titled “Type Literal”](#type-literal-13) { `department_id?`: … | … | …; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: … | … | …; } ###### department\_id? [Section titled “department\_id?”](#department_id) > `optional` **department\_id?**: … | … | … ###### first\_name [Section titled “first\_name”](#first_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-62) First name of the User. ###### id [Section titled “id”](#id-5) > **id**: `string` ###### Description [Section titled “Description”](#description-63) Unique ID for the User. ###### last\_name [Section titled “last\_name”](#last_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-64) Last name of the User. ###### location\_id? [Section titled “location\_id?”](#location_id) > `optional` **location\_id?**: … | … | … *** `null` ###### repayment\_initiation\_date? [Section titled “repayment\_initiation\_date?”](#repayment_initiation_date) > `optional` **repayment\_initiation\_date?**: `string` | `null` Format: date-time *** `null` ##### get.responses.200.content.application/json.review? [Section titled “get.responses.200.content.application/json.review?”](#getresponses200contentapplicationjsonreview) > `optional` **review?**: { `approval_steps`: `object`\[] | `null`; `compliance_status`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-14) ###### Type Literal [Section titled “Type Literal”](#type-literal-14) { `approval_steps`: `object`\[] | `null`; `compliance_status`: `string` | `null`; } ###### approval\_steps [Section titled “approval\_steps”](#approval_steps) > **approval\_steps**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-65) Information for each approval step of the expense ###### compliance\_status [Section titled “compliance\_status”](#compliance_status) > **compliance\_status**: `string` | `null` ###### Description [Section titled “Description”](#description-66) Compliance status of the expense *** `null` ##### get.responses.200.content.application/json.spending\_entity? [Section titled “get.responses.200.content.application/json.spending\_entity?”](#getresponses200contentapplicationjsonspending_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 [Section titled “Union Members”](#union-members-15) ###### Type Literal [Section titled “Type Literal”](#type-literal-15) { `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 [Section titled “billing\_address”](#billing_address) > **billing\_address**: `object` ###### billing\_address.city? [Section titled “billing\_address.city?”](#billing_addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-67) City, district, suburb, town, or village. ###### billing\_address.country? [Section titled “billing\_address.country?”](#billing_addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-68) Two-letter country code (ISO 3166-1 alpha-2). ###### billing\_address.line1? [Section titled “billing\_address.line1?”](#billing_addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-69) Address line 1, no PO Box. ###### billing\_address.line2? [Section titled “billing\_address.line2?”](#billing_addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-70) Address line 2 (e.g., apartment, suite, unit, or building). ###### billing\_address.phone\_number? [Section titled “billing\_address.phone\_number?”](#billing_addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-71) Phone number. ###### billing\_address.postal\_code? [Section titled “billing\_address.postal\_code?”](#billing_addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-72) ZIP or postal code. ###### billing\_address.state? [Section titled “billing\_address.state?”](#billing_addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-73) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### created\_at [Section titled “created\_at”](#created_at) > **created\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-74) Timestamp, in UTC, when this legal entity was created. ###### display\_name [Section titled “display\_name”](#display_name) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-75) The display name of this legal entity. ###### id [Section titled “id”](#id-6) > **id**: `string` ###### Description [Section titled “Description”](#description-76) The ID of this legal entity. ###### is\_default? [Section titled “is\_default?”](#is_default) > `optional` **is\_default?**: `boolean` ###### Description [Section titled “Description”](#description-77) Whether this is the default entity of the account. ###### status [Section titled “status”](#status) > **status**: `"UNSUBMITTED"` | `"UNVERIFIED"` | `"IN_PROGRESS"` | `"VERIFIED"` | `"REJECTED"` *** `null` ##### get.responses.200.content.application/json.spending\_entity\_id? [Section titled “get.responses.200.content.application/json.spending\_entity\_id?”](#getresponses200contentapplicationjsonspending_entity_id) > `optional` **spending\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-78) The spending entity ID associated with the expense. ##### get.responses.200.content.application/json.status? [Section titled “get.responses.200.content.application/json.status?”](#getresponses200contentapplicationjsonstatus) > `optional` **status?**: `"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"` | `null` ##### get.responses.200.content.application/json.submitted\_at? [Section titled “get.responses.200.content.application/json.submitted\_at?”](#getresponses200contentapplicationjsonsubmitted_at) > `optional` **submitted\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-79) The time the expense is submitted, ##### get.responses.200.content.application/json.trip\_id? [Section titled “get.responses.200.content.application/json.trip\_id?”](#getresponses200contentapplicationjsontrip_id) > `optional` **trip\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-80) The trip ID associated with the expense if it is a trip expense. ##### get.responses.200.content.application/json.updated\_at [Section titled “get.responses.200.content.application/json.updated\_at”](#getresponses200contentapplicationjsonupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-81) The last time the expense was updated. ##### get.responses.200.content.application/json.usd\_equivalent\_amount? [Section titled “get.responses.200.content.application/json.usd\_equivalent\_amount?”](#getresponses200contentapplicationjsonusd_equivalent_amount) > `optional` **usd\_equivalent\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-16) ###### Type Literal [Section titled “Type Literal”](#type-literal-16) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-4) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-82) 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 [Section titled “Example”](#example-16) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-4) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-83) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-4) ```ts USD ``` ###### Example [Section titled “Example”](#example-17) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.user? [Section titled “get.responses.200.content.application/json.user?”](#getresponses200contentapplicationjsonuser) > `optional` **user?**: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-17) ###### Type Literal [Section titled “Type Literal”](#type-literal-17) { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } ###### department\_id? [Section titled “department\_id?”](#department_id-1) > `optional` **department\_id?**: `string` | `null` ###### first\_name [Section titled “first\_name”](#first_name-1) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-84) First name of the User. ###### id [Section titled “id”](#id-7) > **id**: `string` ###### Description [Section titled “Description”](#description-85) Unique ID for the User. ###### last\_name [Section titled “last\_name”](#last_name-1) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-86) Last name of the User. ###### location\_id? [Section titled “location\_id?”](#location_id-1) > `optional` **location\_id?**: `string` | `null` *** `null` ##### get.responses.200.content.application/json.user\_id? [Section titled “get.responses.200.content.application/json.user\_id?”](#getresponses200contentapplicationjsonuser_id) > `optional` **user\_id?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-4) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-87) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-1) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-5) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-88) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-1) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-6) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-89) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-1) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-7) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-90) Not found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-8) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-1) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-1) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-1) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-1) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-1) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-1) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-1) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-1) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-1) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-1) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-1) > `optional` **trace?**: `undefined` *** ### /v1/expenses/card [Section titled “/v1/expenses/card”](#v1expensescard) > **/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? [Section titled “delete?”](#delete-2) > `optional` **delete?**: `undefined` #### ~~get~~ [Section titled “get”](#get-2) > **get**: `object` List card expenses Deprecated This API is no longer supported and may be removed in a future release. ##### Description [Section titled “Description”](#description-91) This endpoint is deprecated. Use the “List expenses” (`GET /v1/expenses`) endpoint instead. ##### get.parameters [Section titled “get.parameters”](#getparameters-2) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-2) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-2) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-2) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-2) > `optional` **query?**: `object` ##### get.parameters.query.budget\_id\[]? [Section titled “get.parameters.query.budget\_id\[\]?”](#getparametersquerybudget_id-1) > `optional` **budget\_id\[]?**: `string`\[] | `null` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-1) > `optional` **cursor?**: `string` | `null` ###### Description [Section titled “Description”](#description-92) The cursor to use for pagination. This is the `next_cursor` value returned from the previous response. ##### get.parameters.query.expand\[]? [Section titled “get.parameters.query.expand\[\]?”](#getparametersqueryexpand-2) > `optional` **expand\[]?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-93) 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 [Section titled “Example”](#example-18) ```ts ?expand[]=merchant&expand[]=location ``` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-1) > `optional` **limit?**: `number` | `null` ###### Description [Section titled “Description”](#description-94) Controls the maximum number of expenses returned in the response, can’t be greater than 100 ##### get.parameters.query.load\_custom\_fields? [Section titled “get.parameters.query.load\_custom\_fields?”](#getparametersqueryload_custom_fields-2) > `optional` **load\_custom\_fields?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-95) Load custom fields for the expenses. ##### get.parameters.query.parent\_expense\_id\[]? [Section titled “get.parameters.query.parent\_expense\_id\[\]?”](#getparametersqueryparent_expense_id-1) > `optional` **parent\_expense\_id\[]?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-96) Get itemized expenses belong to provided parent expenses ID(s). ##### get.parameters.query.payment\_posted\_at\_end? [Section titled “get.parameters.query.payment\_posted\_at\_end?”](#getparametersquerypayment_posted_at_end-1) > `optional` **payment\_posted\_at\_end?**: `string` | `null` ###### Description [Section titled “Description”](#description-97) 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 [Section titled “Example”](#example-19) ```ts 2023-01-10T23:59:59.999 ``` ##### get.parameters.query.payment\_posted\_at\_start? [Section titled “get.parameters.query.payment\_posted\_at\_start?”](#getparametersquerypayment_posted_at_start-1) > `optional` **payment\_posted\_at\_start?**: `string` | `null` ###### Description [Section titled “Description”](#description-98) 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 [Section titled “Example”](#example-20) ```ts 2023-01-01T23:59:59.999 ``` ##### get.parameters.query.payment\_status\[]? [Section titled “get.parameters.query.payment\_status\[\]?”](#getparametersquerypayment_status-1) > `optional` **payment\_status\[]?**: (`"NOT_STARTED"` | `"PROCESSING"` | `"CANCELED"` | `"DECLINED"` | `"CLEARED"` | `"REFUNDING"` | `"REFUNDED"` | `"CASH_ADVANCE"` | `"CREDITED"` | `"AWAITING_PAYMENT"` | `"SCHEDULED"`)\[] | `null` ##### get.parameters.query.purchased\_at\_end? [Section titled “get.parameters.query.purchased\_at\_end?”](#getparametersquerypurchased_at_end-1) > `optional` **purchased\_at\_end?**: `string` | `null` ###### Description [Section titled “Description”](#description-99) 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 [Section titled “Example”](#example-21) ```ts 2023-01-10T23:59:59.999 ``` ##### get.parameters.query.purchased\_at\_start? [Section titled “get.parameters.query.purchased\_at\_start?”](#getparametersquerypurchased_at_start-1) > `optional` **purchased\_at\_start?**: `string` | `null` ###### Description [Section titled “Description”](#description-100) 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 [Section titled “Example”](#example-22) ```ts 2023-01-01T23:59:59.999 ``` ##### get.parameters.query.spending\_entity\_id\[]? [Section titled “get.parameters.query.spending\_entity\_id\[\]?”](#getparametersqueryspending_entity_id-1) > `optional` **spending\_entity\_id\[]?**: `string`\[] | `null` ##### get.parameters.query.status\[]? [Section titled “get.parameters.query.status\[\]?”](#getparametersquerystatus-1) > `optional` **status\[]?**: (`"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"`)\[] | `null` ##### get.parameters.query.updated\_at\_end? [Section titled “get.parameters.query.updated\_at\_end?”](#getparametersqueryupdated_at_end-1) > `optional` **updated\_at\_end?**: `string` | `null` ###### Description [Section titled “Description”](#description-101) 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 [Section titled “Example”](#example-23) ```ts 2023-01-10T23:59:59.999 ``` ##### get.parameters.query.updated\_at\_start? [Section titled “get.parameters.query.updated\_at\_start?”](#getparametersqueryupdated_at_start-1) > `optional` **updated\_at\_start?**: `string` | `null` ###### Description [Section titled “Description”](#description-102) 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 [Section titled “Example”](#example-24) ```ts 2023-01-01T23:59:59.999 ``` ##### get.parameters.query.user\_id\[]? [Section titled “get.parameters.query.user\_id\[\]?”](#getparametersqueryuser_id-1) > `optional` **user\_id\[]?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-103) Get expenses belong to provided user(s). ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-2) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-2) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-104) List expenses response. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-2) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-2) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-1) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-1) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-9) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-2) > **400**: `object` ###### Description [Section titled “Description”](#description-105) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-2) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-10) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-2) > **401**: `object` ###### Description [Section titled “Description”](#description-106) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-2) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-11) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-2) > **403**: `object` ###### Description [Section titled “Description”](#description-107) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-2) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-12) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-2) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-2) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-2) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-2) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-2) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-2) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-2) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-2) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-2) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-2) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-2) > `optional` **trace?**: `undefined` *** ### /v1/expenses/card/{expense\_id} [Section titled “/v1/expenses/card/{expense\_id}”](#v1expensescardexpense_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? [Section titled “delete?”](#delete-3) > `optional` **delete?**: `undefined` #### ~~get~~ [Section titled “get”](#get-3) > **get**: `object` Get a card expense Deprecated This API is no longer supported and may be removed in a future release. ##### Description [Section titled “Description”](#description-108) This endpoint is deprecated. Use the “Get an expense” (`GET /v1/expenses/{id}`) endpoint instead. ##### get.parameters [Section titled “get.parameters”](#getparameters-3) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-3) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-3) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-3) > **path**: `object` ##### get.parameters.path.expense\_id [Section titled “get.parameters.path.expense\_id”](#getparameterspathexpense_id) > **expense\_id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-3) > `optional` **query?**: `object` ##### get.parameters.query.expand\[]? [Section titled “get.parameters.query.expand\[\]?”](#getparametersqueryexpand-3) > `optional` **expand\[]?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-109) 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 [Section titled “Example”](#example-25) ```ts ?expand[]=merchant&expand[]=location ``` ##### get.parameters.query.load\_custom\_fields? [Section titled “get.parameters.query.load\_custom\_fields?”](#getparametersqueryload_custom_fields-3) > `optional` **load\_custom\_fields?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-110) Load custom fields for the expense. ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-3) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-3) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-3) > **200**: `object` ###### Description [Section titled “Description”](#description-111) Get an expense response. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-3) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-3) > **application/json**: `object` ##### get.responses.200.content.application/json.address? [Section titled “get.responses.200.content.application/json.address?”](#getresponses200contentapplicationjsonaddress-1) > `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 [Section titled “Union Members”](#union-members-18) ###### Type Literal [Section titled “Type Literal”](#type-literal-18) { `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?~~ [Section titled “city?”](#city-1) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-112) City, district, suburb, town, or village. ###### ~~coordinates?~~ [Section titled “coordinates?”](#coordinates-1) > `optional` **coordinates?**: { `latitude`: `number`; `longitude`: `number`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-19) ###### Type Literal [Section titled “Type Literal”](#type-literal-19) { `latitude`: `number`; `longitude`: `number`; } ###### ~~latitude~~ [Section titled “latitude”](#latitude-1) > **latitude**: `number` Format: double ###### ~~longitude~~ [Section titled “longitude”](#longitude-1) > **longitude**: `number` Format: double *** `null` ###### ~~country?~~ [Section titled “country?”](#country-2) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-113) Two-letter country code (ISO 3166-1 alpha-2). ###### ~~line1?~~ [Section titled “line1?”](#line1-1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-114) Address line 1, no PO Box. ###### ~~line2?~~ [Section titled “line2?”](#line2-1) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-115) Address line 2 (e.g., apartment, suite, unit, or building). ###### ~~postal\_code?~~ [Section titled “postal\_code?”](#postal_code-1) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-116) ZIP or postal code. ###### ~~state?~~ [Section titled “state?”](#state-1) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-117) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### ~~timezone?~~ [Section titled “timezone?”](#timezone-1) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-118) Timezone. *** `null` ##### get.responses.200.content.application/json.approved\_at? [Section titled “get.responses.200.content.application/json.approved\_at?”](#getresponses200contentapplicationjsonapproved_at-1) > `optional` **approved\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-119) The time the expense is approved. ##### get.responses.200.content.application/json.billing\_amount? [Section titled “get.responses.200.content.application/json.billing\_amount?”](#getresponses200contentapplicationjsonbilling_amount-1) > `optional` **billing\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-20) ###### Type Literal [Section titled “Type Literal”](#type-literal-20) { `amount`: `number`; `currency`: `string` | `null`; } ###### ~~amount~~ [Section titled “amount”](#amount-5) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-120) 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 [Section titled “Example”](#example-26) ```ts 700 ``` ###### ~~currency~~ [Section titled “currency”](#currency-5) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-121) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-5) ```ts USD ``` ###### Example [Section titled “Example”](#example-27) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.billing\_entity\_id? [Section titled “get.responses.200.content.application/json.billing\_entity\_id?”](#getresponses200contentapplicationjsonbilling_entity_id-1) > `optional` **billing\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-122) ID of the legal entity responsible for billing the expense. ##### get.responses.200.content.application/json.booking\_id? [Section titled “get.responses.200.content.application/json.booking\_id?”](#getresponses200contentapplicationjsonbooking_id-1) > `optional` **booking\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-123) The booking ID associated with the expense if it is a trip expense. ##### get.responses.200.content.application/json.budget? [Section titled “get.responses.200.content.application/json.budget?”](#getresponses200contentapplicationjsonbudget-1) > `optional` **budget?**: { `id`: `string`; `name`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-21) ###### Type Literal [Section titled “Type Literal”](#type-literal-21) { `id`: `string`; `name`: `string`; } ###### ~~id~~ [Section titled “id”](#id-8) > **id**: `string` ###### Description [Section titled “Description”](#description-124) Unique ID for the Budget. ###### ~~name~~ [Section titled “name”](#name-4) > **name**: `string` ###### Description [Section titled “Description”](#description-125) Name for the Budget. *** `null` ##### get.responses.200.content.application/json.budget\_amount? [Section titled “get.responses.200.content.application/json.budget\_amount?”](#getresponses200contentapplicationjsonbudget_amount-1) > `optional` **budget\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-22) ###### Type Literal [Section titled “Type Literal”](#type-literal-22) { `amount`: `number`; `currency`: `string` | `null`; } ###### ~~amount~~ [Section titled “amount”](#amount-6) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-126) 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 [Section titled “Example”](#example-28) ```ts 700 ``` ###### ~~currency~~ [Section titled “currency”](#currency-6) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-127) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-6) ```ts USD ``` ###### Example [Section titled “Example”](#example-29) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.budget\_id? [Section titled “get.responses.200.content.application/json.budget\_id?”](#getresponses200contentapplicationjsonbudget_id-1) > `optional` **budget\_id?**: `string` | `null` ##### get.responses.200.content.application/json.category? [Section titled “get.responses.200.content.application/json.category?”](#getresponses200contentapplicationjsoncategory-1) > `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? [Section titled “get.responses.200.content.application/json.completion\_date?”](#getresponses200contentapplicationjsoncompletion_date-1) > `optional` **completion\_date?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-128) The time payment will be completed/is completed. ##### get.responses.200.content.application/json.custom\_fields? [Section titled “get.responses.200.content.application/json.custom\_fields?”](#getresponses200contentapplicationjsoncustom_fields-1) > `optional` **custom\_fields?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-129) A list of custom field values associated with the expense. ##### get.responses.200.content.application/json.dashboard\_url [Section titled “get.responses.200.content.application/json.dashboard\_url”](#getresponses200contentapplicationjsondashboard_url-1) > **dashboard\_url**: `string` ###### Description [Section titled “Description”](#description-130) URL to view the expense in the Brex dashboard. ##### get.responses.200.content.application/json.department? [Section titled “get.responses.200.content.application/json.department?”](#getresponses200contentapplicationjsondepartment-1) > `optional` **department?**: { `id`: `string`; `name`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-23) ###### Type Literal [Section titled “Type Literal”](#type-literal-23) { `id`: `string`; `name`: `string`; } ###### ~~id~~ [Section titled “id”](#id-9) > **id**: `string` ###### Description [Section titled “Description”](#description-131) The unique identifier for the department. ###### ~~name~~ [Section titled “name”](#name-5) > **name**: `string` ###### Description [Section titled “Description”](#description-132) The name of the department. *** `null` ##### get.responses.200.content.application/json.department\_id? [Section titled “get.responses.200.content.application/json.department\_id?”](#getresponses200contentapplicationjsondepartment_id-1) > `optional` **department\_id?**: `string` | `null` ##### get.responses.200.content.application/json.expense\_line\_items? [Section titled “get.responses.200.content.application/json.expense\_line\_items?”](#getresponses200contentapplicationjsonexpense_line_items-1) > `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 [Section titled “Description”](#description-133) The expense line items. Limited to 100 items. ##### get.responses.200.content.application/json.expense\_type? [Section titled “get.responses.200.content.application/json.expense\_type?”](#getresponses200contentapplicationjsonexpense_type-1) > `optional` **expense\_type?**: `"CARD"` | `"REIMBURSEMENT"` | `"BILLPAY"` | `"CLAWBACK"` | `"UNSET"` | `null` ##### get.responses.200.content.application/json.exported\_at? [Section titled “get.responses.200.content.application/json.exported\_at?”](#getresponses200contentapplicationjsonexported_at-1) > `optional` **exported\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-134) Timestamp when the expense was exported to the accounting system. ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-135) Unique ID associated with the expense. ##### get.responses.200.content.application/json.integration\_billing\_entity\_id? [Section titled “get.responses.200.content.application/json.integration\_billing\_entity\_id?”](#getresponses200contentapplicationjsonintegration_billing_entity_id-1) > `optional` **integration\_billing\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-136) ID of the billing entity in accounting. ##### get.responses.200.content.application/json.integration\_spending\_entity\_id? [Section titled “get.responses.200.content.application/json.integration\_spending\_entity\_id?”](#getresponses200contentapplicationjsonintegration_spending_entity_id-1) > `optional` **integration\_spending\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-137) ID of the spending entity in accounting. ##### get.responses.200.content.application/json.location? [Section titled “get.responses.200.content.application/json.location?”](#getresponses200contentapplicationjsonlocation-1) > `optional` **location?**: { `id`: `string`; `name`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-24) ###### Type Literal [Section titled “Type Literal”](#type-literal-24) { `id`: `string`; `name`: `string`; } ###### ~~id~~ [Section titled “id”](#id-10) > **id**: `string` ###### Description [Section titled “Description”](#description-138) The unique identifier for the location. ###### ~~name~~ [Section titled “name”](#name-6) > **name**: `string` ###### Description [Section titled “Description”](#description-139) The name of the location. *** `null` ##### get.responses.200.content.application/json.location\_id? [Section titled “get.responses.200.content.application/json.location\_id?”](#getresponses200contentapplicationjsonlocation_id-1) > `optional` **location\_id?**: `string` | `null` ##### get.responses.200.content.application/json.memo? [Section titled “get.responses.200.content.application/json.memo?”](#getresponses200contentapplicationjsonmemo-1) > `optional` **memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-140) The memo of the expense. ##### get.responses.200.content.application/json.merchant? [Section titled “get.responses.200.content.application/json.merchant?”](#getresponses200contentapplicationjsonmerchant-1) > `optional` **merchant?**: { `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-25) ###### Type Literal [Section titled “Type Literal”](#type-literal-25) { `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; } ###### ~~country~~ [Section titled “country”](#country-3) > **country**: `string` ###### Description [Section titled “Description”](#description-141) Merchant’s country, in ISO 3166-1 alpha-3 format. ###### ~~mcc~~ [Section titled “mcc”](#mcc-1) > **mcc**: `string` ###### Description [Section titled “Description”](#description-142) A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to for more details. ###### ~~raw\_descriptor~~ [Section titled “raw\_descriptor”](#raw_descriptor-1) > **raw\_descriptor**: `string` ###### Description [Section titled “Description”](#description-143) Merchant descriptor, it can be the merchant name. *** `null` ##### get.responses.200.content.application/json.merchant\_id? [Section titled “get.responses.200.content.application/json.merchant\_id?”](#getresponses200contentapplicationjsonmerchant_id-1) > `optional` **merchant\_id?**: `string` | `null` ##### get.responses.200.content.application/json.original\_amount? [Section titled “get.responses.200.content.application/json.original\_amount?”](#getresponses200contentapplicationjsonoriginal_amount-1) > `optional` **original\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-26) ###### Type Literal [Section titled “Type Literal”](#type-literal-26) { `amount`: `number`; `currency`: `string` | `null`; } ###### ~~amount~~ [Section titled “amount”](#amount-7) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-144) 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 [Section titled “Example”](#example-30) ```ts 700 ``` ###### ~~currency~~ [Section titled “currency”](#currency-7) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-145) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-7) ```ts USD ``` ###### Example [Section titled “Example”](#example-31) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.payment? [Section titled “get.responses.200.content.application/json.payment?”](#getresponses200contentapplicationjsonpayment-1) > `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 [Section titled “Union Members”](#union-members-27) ###### Type Literal [Section titled “Type Literal”](#type-literal-27) { `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~~ [Section titled “id”](#id-11) > **id**: `string` ###### Description [Section titled “Description”](#description-146) Unique ID for the payment. ###### ~~paymentInstrument~~ [Section titled “paymentInstrument”](#paymentinstrument-1) > **paymentInstrument**: `Omit`<`object` & `object` & `object`, `"type"`> ###### ~~statusReason~~ [Section titled “statusReason”](#statusreason-1) > **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? [Section titled “get.responses.200.content.application/json.payment\_posted\_at?”](#getresponses200contentapplicationjsonpayment_posted_at-1) > `optional` **payment\_posted\_at?**: `string` | `null` Format: date-time ##### get.responses.200.content.application/json.payment\_status? [Section titled “get.responses.200.content.application/json.payment\_status?”](#getresponses200contentapplicationjsonpayment_status-1) > `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? [Section titled “get.responses.200.content.application/json.policy?”](#getresponses200contentapplicationjsonpolicy-1) > `optional` **policy?**: { `id`: `string`; `name`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-28) ###### Type Literal [Section titled “Type Literal”](#type-literal-28) { `id`: `string`; `name`: `string`; } ###### ~~id~~ [Section titled “id”](#id-12) > **id**: `string` ###### Description [Section titled “Description”](#description-147) The unique identifier for the policy. ###### ~~name~~ [Section titled “name”](#name-7) > **name**: `string` ###### Description [Section titled “Description”](#description-148) The display name of the policy. *** `null` ##### get.responses.200.content.application/json.purchased\_amount? [Section titled “get.responses.200.content.application/json.purchased\_amount?”](#getresponses200contentapplicationjsonpurchased_amount-1) > `optional` **purchased\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-29) ###### Type Literal [Section titled “Type Literal”](#type-literal-29) { `amount`: `number`; `currency`: `string` | `null`; } ###### ~~amount~~ [Section titled “amount”](#amount-8) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-149) 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 [Section titled “Example”](#example-32) ```ts 700 ``` ###### ~~currency~~ [Section titled “currency”](#currency-8) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-150) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-8) ```ts USD ``` ###### Example [Section titled “Example”](#example-33) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.purchased\_at? [Section titled “get.responses.200.content.application/json.purchased\_at?”](#getresponses200contentapplicationjsonpurchased_at-1) > `optional` **purchased\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-151) The time the purchase was made. ##### get.responses.200.content.application/json.receipts? [Section titled “get.responses.200.content.application/json.receipts?”](#getresponses200contentapplicationjsonreceipts-1) > `optional` **receipts?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-152) A list of receipts associated with the expense. ##### get.responses.200.content.application/json.repayment? [Section titled “get.responses.200.content.application/json.repayment?”](#getresponses200contentapplicationjsonrepayment-1) > `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 [Section titled “Union Members”](#union-members-30) ###### Type Literal [Section titled “Type Literal”](#type-literal-30) { `repayment_initiated_by?`: { `department_id?`: … | … | …; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: … | … | …; } | `null`; `repayment_initiation_date?`: `string` | `null`; } ###### ~~repayment\_initiated\_by?~~ [Section titled “repayment\_initiated\_by?”](#repayment_initiated_by-1) > `optional` **repayment\_initiated\_by?**: { `department_id?`: … | … | …; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: … | … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-31) ###### Type Literal [Section titled “Type Literal”](#type-literal-31) { `department_id?`: … | … | …; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: … | … | …; } ###### ~~department\_id?~~ [Section titled “department\_id?”](#department_id-2) > `optional` **department\_id?**: … | … | … ###### ~~first\_name~~ [Section titled “first\_name”](#first_name-2) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-153) First name of the User. ###### ~~id~~ [Section titled “id”](#id-13) > **id**: `string` ###### Description [Section titled “Description”](#description-154) Unique ID for the User. ###### ~~last\_name~~ [Section titled “last\_name”](#last_name-2) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-155) Last name of the User. ###### ~~location\_id?~~ [Section titled “location\_id?”](#location_id-2) > `optional` **location\_id?**: … | … | … *** `null` ###### ~~repayment\_initiation\_date?~~ [Section titled “repayment\_initiation\_date?”](#repayment_initiation_date-1) > `optional` **repayment\_initiation\_date?**: `string` | `null` Format: date-time *** `null` ##### get.responses.200.content.application/json.review? [Section titled “get.responses.200.content.application/json.review?”](#getresponses200contentapplicationjsonreview-1) > `optional` **review?**: { `approval_steps`: `object`\[] | `null`; `compliance_status`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-32) ###### Type Literal [Section titled “Type Literal”](#type-literal-32) { `approval_steps`: `object`\[] | `null`; `compliance_status`: `string` | `null`; } ###### ~~approval\_steps~~ [Section titled “approval\_steps”](#approval_steps-1) > **approval\_steps**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-156) Information for each approval step of the expense ###### ~~compliance\_status~~ [Section titled “compliance\_status”](#compliance_status-1) > **compliance\_status**: `string` | `null` ###### Description [Section titled “Description”](#description-157) Compliance status of the expense *** `null` ##### get.responses.200.content.application/json.spending\_entity? [Section titled “get.responses.200.content.application/json.spending\_entity?”](#getresponses200contentapplicationjsonspending_entity-1) > `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 [Section titled “Union Members”](#union-members-33) ###### Type Literal [Section titled “Type Literal”](#type-literal-33) { `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~~ [Section titled “billing\_address”](#billing_address-1) > **billing\_address**: `object` ###### billing\_address.city? [Section titled “billing\_address.city?”](#billing_addresscity-1) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-158) City, district, suburb, town, or village. ###### billing\_address.country? [Section titled “billing\_address.country?”](#billing_addresscountry-1) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-159) Two-letter country code (ISO 3166-1 alpha-2). ###### billing\_address.line1? [Section titled “billing\_address.line1?”](#billing_addressline1-1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-160) Address line 1, no PO Box. ###### billing\_address.line2? [Section titled “billing\_address.line2?”](#billing_addressline2-1) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-161) Address line 2 (e.g., apartment, suite, unit, or building). ###### billing\_address.phone\_number? [Section titled “billing\_address.phone\_number?”](#billing_addressphone_number-1) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-162) Phone number. ###### billing\_address.postal\_code? [Section titled “billing\_address.postal\_code?”](#billing_addresspostal_code-1) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-163) ZIP or postal code. ###### billing\_address.state? [Section titled “billing\_address.state?”](#billing_addressstate-1) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-164) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### ~~created\_at~~ [Section titled “created\_at”](#created_at-1) > **created\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-165) Timestamp, in UTC, when this legal entity was created. ###### ~~display\_name~~ [Section titled “display\_name”](#display_name-1) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-166) The display name of this legal entity. ###### ~~id~~ [Section titled “id”](#id-14) > **id**: `string` ###### Description [Section titled “Description”](#description-167) The ID of this legal entity. ###### ~~is\_default?~~ [Section titled “is\_default?”](#is_default-1) > `optional` **is\_default?**: `boolean` ###### Description [Section titled “Description”](#description-168) Whether this is the default entity of the account. ###### ~~status~~ [Section titled “status”](#status-1) > **status**: `"UNSUBMITTED"` | `"UNVERIFIED"` | `"IN_PROGRESS"` | `"VERIFIED"` | `"REJECTED"` *** `null` ##### get.responses.200.content.application/json.spending\_entity\_id? [Section titled “get.responses.200.content.application/json.spending\_entity\_id?”](#getresponses200contentapplicationjsonspending_entity_id-1) > `optional` **spending\_entity\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-169) The spending entity ID associated with the expense. ##### get.responses.200.content.application/json.status? [Section titled “get.responses.200.content.application/json.status?”](#getresponses200contentapplicationjsonstatus-1) > `optional` **status?**: `"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"` | `null` ##### get.responses.200.content.application/json.submitted\_at? [Section titled “get.responses.200.content.application/json.submitted\_at?”](#getresponses200contentapplicationjsonsubmitted_at-1) > `optional` **submitted\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-170) The time the expense is submitted, ##### get.responses.200.content.application/json.trip\_id? [Section titled “get.responses.200.content.application/json.trip\_id?”](#getresponses200contentapplicationjsontrip_id-1) > `optional` **trip\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-171) The trip ID associated with the expense if it is a trip expense. ##### get.responses.200.content.application/json.updated\_at [Section titled “get.responses.200.content.application/json.updated\_at”](#getresponses200contentapplicationjsonupdated_at-1) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-172) The last time the expense was updated. ##### get.responses.200.content.application/json.usd\_equivalent\_amount? [Section titled “get.responses.200.content.application/json.usd\_equivalent\_amount?”](#getresponses200contentapplicationjsonusd_equivalent_amount-1) > `optional` **usd\_equivalent\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-34) ###### Type Literal [Section titled “Type Literal”](#type-literal-34) { `amount`: `number`; `currency`: `string` | `null`; } ###### ~~amount~~ [Section titled “amount”](#amount-9) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-173) 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 [Section titled “Example”](#example-34) ```ts 700 ``` ###### ~~currency~~ [Section titled “currency”](#currency-9) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-174) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-9) ```ts USD ``` ###### Example [Section titled “Example”](#example-35) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.user? [Section titled “get.responses.200.content.application/json.user?”](#getresponses200contentapplicationjsonuser-1) > `optional` **user?**: { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-35) ###### Type Literal [Section titled “Type Literal”](#type-literal-35) { `department_id?`: `string` | `null`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; } ###### ~~department\_id?~~ [Section titled “department\_id?”](#department_id-3) > `optional` **department\_id?**: `string` | `null` ###### ~~first\_name~~ [Section titled “first\_name”](#first_name-3) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-175) First name of the User. ###### ~~id~~ [Section titled “id”](#id-15) > **id**: `string` ###### Description [Section titled “Description”](#description-176) Unique ID for the User. ###### ~~last\_name~~ [Section titled “last\_name”](#last_name-3) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-177) Last name of the User. ###### ~~location\_id?~~ [Section titled “location\_id?”](#location_id-3) > `optional` **location\_id?**: `string` | `null` *** `null` ##### get.responses.200.content.application/json.user\_id? [Section titled “get.responses.200.content.application/json.user\_id?”](#getresponses200contentapplicationjsonuser_id-1) > `optional` **user\_id?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-13) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-3) > **400**: `object` ###### Description [Section titled “Description”](#description-178) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-3) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-14) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-3) > **401**: `object` ###### Description [Section titled “Description”](#description-179) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-3) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-15) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-3) > **403**: `object` ###### Description [Section titled “Description”](#description-180) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-3) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-16) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404-1) > **404**: `object` ###### Description [Section titled “Description”](#description-181) Not found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content-1) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-17) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-3) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-3) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-3) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-3) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-3) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-3) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-3) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-3) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-3) > `optional` **post?**: `undefined` #### put [Section titled “put”](#put-3) > **put**: `object` Update an expense ##### Description [Section titled “Description”](#description-182) Update an expense. Admin and bookkeeper have access to any expense, and regular users can only access their own. ##### put.parameters [Section titled “put.parameters”](#putparameters) > **parameters**: `object` ##### put.parameters.cookie? [Section titled “put.parameters.cookie?”](#putparameterscookie) > `optional` **cookie?**: `undefined` ##### put.parameters.header? [Section titled “put.parameters.header?”](#putparametersheader) > `optional` **header?**: `undefined` ##### put.parameters.path [Section titled “put.parameters.path”](#putparameterspath) > **path**: `object` ##### put.parameters.path.expense\_id [Section titled “put.parameters.path.expense\_id”](#putparameterspathexpense_id) > **expense\_id**: `string` ##### put.parameters.query? [Section titled “put.parameters.query?”](#putparametersquery) > `optional` **query?**: `undefined` ##### put.requestBody [Section titled “put.requestBody”](#putrequestbody) > **requestBody**: `object` ##### put.requestBody.content [Section titled “put.requestBody.content”](#putrequestbodycontent) > **content**: `object` ##### put.requestBody.content.application/json [Section titled “put.requestBody.content.application/json”](#putrequestbodycontentapplicationjson) > **application/json**: `object` ##### put.requestBody.content.application/json.memo? [Section titled “put.requestBody.content.application/json.memo?”](#putrequestbodycontentapplicationjsonmemo) > `optional` **memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-183) Expense memo. ##### put.responses [Section titled “put.responses”](#putresponses) > **responses**: `object` ##### put.responses.200 [Section titled “put.responses.200”](#putresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-184) Update an expense response. ##### put.responses.200.content [Section titled “put.responses.200.content”](#putresponses200content) > **content**: `object` ##### put.responses.200.content.application/json [Section titled “put.responses.200.content.application/json”](#putresponses200contentapplicationjson) > **application/json**: `object` ##### put.responses.200.content.application/json.billing\_amount? [Section titled “put.responses.200.content.application/json.billing\_amount?”](#putresponses200contentapplicationjsonbilling_amount) > `optional` **billing\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-36) ###### Type Literal [Section titled “Type Literal”](#type-literal-36) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-10) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-185) 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 [Section titled “Example”](#example-36) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-10) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-186) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-10) ```ts USD ``` ###### Example [Section titled “Example”](#example-37) ```ts USD ``` *** `null` ##### put.responses.200.content.application/json.budget\_id? [Section titled “put.responses.200.content.application/json.budget\_id?”](#putresponses200contentapplicationjsonbudget_id) > `optional` **budget\_id?**: `string` | `null` ##### put.responses.200.content.application/json.category? [Section titled “put.responses.200.content.application/json.category?”](#putresponses200contentapplicationjsoncategory) > `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? [Section titled “put.responses.200.content.application/json.department\_id?”](#putresponses200contentapplicationjsondepartment_id) > `optional` **department\_id?**: `string` | `null` ##### put.responses.200.content.application/json.id [Section titled “put.responses.200.content.application/json.id”](#putresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-187) Unique ID associated with the expense. ##### put.responses.200.content.application/json.location\_id? [Section titled “put.responses.200.content.application/json.location\_id?”](#putresponses200contentapplicationjsonlocation_id) > `optional` **location\_id?**: `string` | `null` ##### put.responses.200.content.application/json.memo? [Section titled “put.responses.200.content.application/json.memo?”](#putresponses200contentapplicationjsonmemo) > `optional` **memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-188) The memo of the expense. ##### put.responses.200.content.application/json.merchant\_id? [Section titled “put.responses.200.content.application/json.merchant\_id?”](#putresponses200contentapplicationjsonmerchant_id) > `optional` **merchant\_id?**: `string` | `null` ##### put.responses.200.content.application/json.original\_amount? [Section titled “put.responses.200.content.application/json.original\_amount?”](#putresponses200contentapplicationjsonoriginal_amount) > `optional` **original\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-37) ###### Type Literal [Section titled “Type Literal”](#type-literal-37) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-11) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-189) 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 [Section titled “Example”](#example-38) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-11) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-190) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-11) ```ts USD ``` ###### Example [Section titled “Example”](#example-39) ```ts USD ``` *** `null` ##### put.responses.200.content.application/json.payment\_status? [Section titled “put.responses.200.content.application/json.payment\_status?”](#putresponses200contentapplicationjsonpayment_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? [Section titled “put.responses.200.content.application/json.purchased\_at?”](#putresponses200contentapplicationjsonpurchased_at) > `optional` **purchased\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-191) The time the purchase was made. ##### put.responses.200.content.application/json.status? [Section titled “put.responses.200.content.application/json.status?”](#putresponses200contentapplicationjsonstatus) > `optional` **status?**: `"APPROVED"` | `"CANCELED"` | `"DRAFT"` | `"SUBMITTED"` | `"OUT_OF_POLICY"` | `"VOID"` | `"SPLIT"` | `"SETTLED"` | `null` ##### put.responses.200.content.application/json.updated\_at [Section titled “put.responses.200.content.application/json.updated\_at”](#putresponses200contentapplicationjsonupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-192) The last time the expense was updated. ##### put.responses.200.headers [Section titled “put.responses.200.headers”](#putresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-18) \[`name`: `string`]: `unknown` ##### put.responses.400 [Section titled “put.responses.400”](#putresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-193) Bad request ##### put.responses.400.content? [Section titled “put.responses.400.content?”](#putresponses400content) > `optional` **content?**: `undefined` ##### put.responses.400.headers [Section titled “put.responses.400.headers”](#putresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-19) \[`name`: `string`]: `unknown` ##### put.responses.401 [Section titled “put.responses.401”](#putresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-194) Unauthorized ##### put.responses.401.content? [Section titled “put.responses.401.content?”](#putresponses401content) > `optional` **content?**: `undefined` ##### put.responses.401.headers [Section titled “put.responses.401.headers”](#putresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-20) \[`name`: `string`]: `unknown` ##### put.responses.403 [Section titled “put.responses.403”](#putresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-195) Forbidden ##### put.responses.403.content? [Section titled “put.responses.403.content?”](#putresponses403content) > `optional` **content?**: `undefined` ##### put.responses.403.headers [Section titled “put.responses.403.headers”](#putresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-21) \[`name`: `string`]: `unknown` ##### put.responses.404 [Section titled “put.responses.404”](#putresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-196) Not found ##### put.responses.404.content? [Section titled “put.responses.404.content?”](#putresponses404content) > `optional` **content?**: `undefined` ##### put.responses.404.headers [Section titled “put.responses.404.headers”](#putresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-22) \[`name`: `string`]: `unknown` #### trace? [Section titled “trace?”](#trace-3) > `optional` **trace?**: `undefined` *** ### /v1/expenses/card/{expense\_id}/receipt\_upload [Section titled “/v1/expenses/card/{expense\_id}/receipt\_upload”](#v1expensescardexpense_idreceipt_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? [Section titled “delete?”](#delete-4) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-4) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-4) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-4) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-4) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-4) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-4) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-4) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-4) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-4) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-4) > **post**: `object` Create a new receipt upload ##### Description [Section titled “Description”](#description-197) 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. ```plaintext 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 [Section titled “post.parameters”](#postparameters) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader) > `optional` **header?**: `undefined` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath) > **path**: `object` ##### post.parameters.path.expense\_id [Section titled “post.parameters.path.expense\_id”](#postparameterspathexpense_id) > **expense\_id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson) > **application/json**: `object` ##### post.requestBody.content.application/json.receipt\_name [Section titled “post.requestBody.content.application/json.receipt\_name”](#postrequestbodycontentapplicationjsonreceipt_name) > **receipt\_name**: `string` ###### Description [Section titled “Description”](#description-198) The name of the receipt (with the file extension). ##### post.responses [Section titled “post.responses”](#postresponses) > **responses**: `object` ##### post.responses.201 [Section titled “post.responses.201”](#postresponses201) > **201**: `object` ###### Description [Section titled “Description”](#description-199) Upload a new receipt response. ##### post.responses.201.content [Section titled “post.responses.201.content”](#postresponses201content) > **content**: `object` ##### post.responses.201.content.application/json [Section titled “post.responses.201.content.application/json”](#postresponses201contentapplicationjson) > **application/json**: `object` ##### post.responses.201.content.application/json.id [Section titled “post.responses.201.content.application/json.id”](#postresponses201contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-200) The unique identifier for the request. ##### post.responses.201.content.application/json.uri [Section titled “post.responses.201.content.application/json.uri”](#postresponses201contentapplicationjsonuri) > **uri**: `string` ###### Description [Section titled “Description”](#description-201) 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 [Section titled “post.responses.201.headers”](#postresponses201headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-23) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-202) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-24) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-203) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-25) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-204) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-26) \[`name`: `string`]: `unknown` ##### post.responses.404 [Section titled “post.responses.404”](#postresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-205) Not found ##### post.responses.404.content? [Section titled “post.responses.404.content?”](#postresponses404content) > `optional` **content?**: `undefined` ##### post.responses.404.headers [Section titled “post.responses.404.headers”](#postresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-27) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-4) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-4) > `optional` **trace?**: `undefined` *** ### /v1/expenses/card/receipt\_match [Section titled “/v1/expenses/card/receipt\_match”](#v1expensescardreceipt_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? [Section titled “delete?”](#delete-5) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-5) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-5) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-5) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-5) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-5) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-5) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-5) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-5) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-5) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-5) > **post**: `object` Create a new receipt match ##### Description [Section titled “Description”](#description-206) 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. ```plaintext 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 [Section titled “post.parameters”](#postparameters-1) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-1) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-1) > `optional` **header?**: `undefined` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath-1) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-1) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-1) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-1) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-1) > **application/json**: `object` ##### post.requestBody.content.application/json.receipt\_name [Section titled “post.requestBody.content.application/json.receipt\_name”](#postrequestbodycontentapplicationjsonreceipt_name-1) > **receipt\_name**: `string` ###### Description [Section titled “Description”](#description-207) The name of the receipt (with the file extension). It will be used in the matching result email. ##### post.responses [Section titled “post.responses”](#postresponses-1) > **responses**: `object` ##### post.responses.201 [Section titled “post.responses.201”](#postresponses201-1) > **201**: `object` ###### Description [Section titled “Description”](#description-208) Create a new receipt match response. ##### post.responses.201.content [Section titled “post.responses.201.content”](#postresponses201content-1) > **content**: `object` ##### post.responses.201.content.application/json [Section titled “post.responses.201.content.application/json”](#postresponses201contentapplicationjson-1) > **application/json**: `object` ##### post.responses.201.content.application/json.id [Section titled “post.responses.201.content.application/json.id”](#postresponses201contentapplicationjsonid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-209) The unique identifier for the request. ##### post.responses.201.content.application/json.uri [Section titled “post.responses.201.content.application/json.uri”](#postresponses201contentapplicationjsonuri-1) > **uri**: `string` ###### Description [Section titled “Description”](#description-210) 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 [Section titled “post.responses.201.headers”](#postresponses201headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-28) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-211) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content-1) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-29) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-212) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content-1) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-30) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-5) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-5) > `optional` **trace?**: `undefined` # Address > **Address** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Address"`] Defined in: [src/expenses/schemas.gen.ts:5](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L5) # ApprovalStepDetails > **ApprovalStepDetails** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"ApprovalStepDetails"`] Defined in: [src/expenses/schemas.gen.ts:6](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L6) # BooleanListValue > **BooleanListValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"BooleanListValue"`] Defined in: [src/expenses/schemas.gen.ts:7](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L7) # BooleanValue > **BooleanValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"BooleanValue"`] Defined in: [src/expenses/schemas.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L8) # Budget > **Budget** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Budget"`] Defined in: [src/expenses/schemas.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L9) # CardPaymentInstrument > **CardPaymentInstrument** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"CardPaymentInstrument"`] Defined in: [src/expenses/schemas.gen.ts:10](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L10) # Category > **Category** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Category"`] Defined in: [src/expenses/schemas.gen.ts:11](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L11) # CreateAsyncFileUploadResponse > **CreateAsyncFileUploadResponse** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"CreateAsyncFileUploadResponse"`] Defined in: [src/expenses/schemas.gen.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L12) # CustomerLocation > **CustomerLocation** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"CustomerLocation"`] Defined in: [src/expenses/schemas.gen.ts:21](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L21) # CustomField > **CustomField** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"CustomField"`] Defined in: [src/expenses/schemas.gen.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L13) # CustomField_ValueWrapper > **CustomField\_ValueWrapper** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"CustomField.ValueWrapper"`] Defined in: [src/expenses/schemas.gen.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L14) # CustomField_ValueWrapper_MultipleValueWrapper > **CustomField\_ValueWrapper\_MultipleValueWrapper** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"CustomField.ValueWrapper.MultipleValueWrapper"`] Defined in: [src/expenses/schemas.gen.ts:15](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L15) # CustomField_ValueWrapper_SingleValueWrapper > **CustomField\_ValueWrapper\_SingleValueWrapper** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"CustomField.ValueWrapper.SingleValueWrapper"`] Defined in: [src/expenses/schemas.gen.ts:17](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L17) # CustomFieldDataType > **CustomFieldDataType** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"CustomFieldDataType"`] Defined in: [src/expenses/schemas.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L19) # CustomFieldValueType > **CustomFieldValueType** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"CustomFieldValueType"`] Defined in: [src/expenses/schemas.gen.ts:20](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L20) # DateListValue > **DateListValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"DateListValue"`] Defined in: [src/expenses/schemas.gen.ts:22](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L22) # DateValue > **DateValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"DateValue"`] Defined in: [src/expenses/schemas.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L23) # DecimalListValue > **DecimalListValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"DecimalListValue"`] Defined in: [src/expenses/schemas.gen.ts:24](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L24) # DecimalValue > **DecimalValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"DecimalValue"`] Defined in: [src/expenses/schemas.gen.ts:25](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L25) # Department > **Department** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Department"`] Defined in: [src/expenses/schemas.gen.ts:26](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L26) # EnumListValue > **EnumListValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"EnumListValue"`] Defined in: [src/expenses/schemas.gen.ts:27](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L27) # EnumValue > **EnumValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"EnumValue"`] Defined in: [src/expenses/schemas.gen.ts:28](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L28) # ExpandableExpense > **ExpandableExpense** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"ExpandableExpense"`] Defined in: [src/expenses/schemas.gen.ts:29](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L29) # Expense > **Expense** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Expense"`] Defined in: [src/expenses/schemas.gen.ts:30](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L30) # ExpensePaymentStatus > **ExpensePaymentStatus** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"ExpensePaymentStatus"`] Defined in: [src/expenses/schemas.gen.ts:31](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L31) # ExpenseStatus > **ExpenseStatus** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"ExpenseStatus"`] Defined in: [src/expenses/schemas.gen.ts:32](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L32) # ExpenseType > **ExpenseType** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"ExpenseType"`] Defined in: [src/expenses/schemas.gen.ts:33](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L33) # LegalEntity > **LegalEntity** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"LegalEntity"`] Defined in: [src/expenses/schemas.gen.ts:34](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L34) # LegalEntityStatus > **LegalEntityStatus** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"LegalEntityStatus"`] Defined in: [src/expenses/schemas.gen.ts:35](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L35) # Location > **Location** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Location"`] Defined in: [src/expenses/schemas.gen.ts:36](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L36) # Location_LatLong > **Location\_LatLong** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Location.LatLong"`] Defined in: [src/expenses/schemas.gen.ts:37](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L37) # Merchant > **Merchant** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Merchant"`] Defined in: [src/expenses/schemas.gen.ts:38](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L38) # Money > **Money** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Money"`] Defined in: [src/expenses/schemas.gen.ts:39](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L39) # MoneyListValue > **MoneyListValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"MoneyListValue"`] Defined in: [src/expenses/schemas.gen.ts:40](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L40) # MoneyValue > **MoneyValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"MoneyValue"`] Defined in: [src/expenses/schemas.gen.ts:41](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L41) # OptionString > **OptionString** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"OptionString"`] Defined in: [src/expenses/schemas.gen.ts:42](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L42) # OptionStringListValue > **OptionStringListValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"OptionStringListValue"`] Defined in: [src/expenses/schemas.gen.ts:43](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L43) # OptionStringValue > **OptionStringValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"OptionStringValue"`] Defined in: [src/expenses/schemas.gen.ts:44](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L44) # Page_ExpandableExpense_ > **Page\_ExpandableExpense\_** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Page_ExpandableExpense_"`] Defined in: [src/expenses/schemas.gen.ts:45](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L45) # Payment > **Payment** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Payment"`] Defined in: [src/expenses/schemas.gen.ts:46](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L46) # PaymentInstrument > **PaymentInstrument** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"PaymentInstrument"`] Defined in: [src/expenses/schemas.gen.ts:47](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L47) # PaymentInstrumentType > **PaymentInstrumentType** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"PaymentInstrumentType"`] Defined in: [src/expenses/schemas.gen.ts:48](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L48) # PaymentStatusReason > **PaymentStatusReason** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"PaymentStatusReason"`] Defined in: [src/expenses/schemas.gen.ts:49](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L49) # Policy > **Policy** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Policy"`] Defined in: [src/expenses/schemas.gen.ts:50](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L50) # Receipt > **Receipt** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Receipt"`] Defined in: [src/expenses/schemas.gen.ts:51](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L51) # ReceiptMatchRequest > **ReceiptMatchRequest** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"ReceiptMatchRequest"`] Defined in: [src/expenses/schemas.gen.ts:52](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L52) # ReceiptUploadRequest > **ReceiptUploadRequest** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"ReceiptUploadRequest"`] Defined in: [src/expenses/schemas.gen.ts:53](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L53) # Repayment > **Repayment** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Repayment"`] Defined in: [src/expenses/schemas.gen.ts:54](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L54) # Review > **Review** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"Review"`] Defined in: [src/expenses/schemas.gen.ts:55](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L55) # StringListValue > **StringListValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"StringListValue"`] Defined in: [src/expenses/schemas.gen.ts:56](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L56) # StringValue > **StringValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"StringValue"`] Defined in: [src/expenses/schemas.gen.ts:57](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L57) # TimestampListValue > **TimestampListValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"TimestampListValue"`] Defined in: [src/expenses/schemas.gen.ts:58](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L58) # TimestampValue > **TimestampValue** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"TimestampValue"`] Defined in: [src/expenses/schemas.gen.ts:59](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L59) # UpdateExpenseRequest > **UpdateExpenseRequest** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"UpdateExpenseRequest"`] Defined in: [src/expenses/schemas.gen.ts:60](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L60) # User > **User** = [`ExpensesComponents`](/brex/api/expenses/interfaces/expensescomponents/)\[`"schemas"`]\[`"User"`] Defined in: [src/expenses/schemas.gen.ts:61](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/expenses/schemas.gen.ts#L61) # BrexFields Defined in: [src/fields/client.gen.ts:212](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L212) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BrexFields**(`core`): `BrexFields` Defined in: [src/fields/client.gen.ts:215](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L215) #### Parameters [Section titled “Parameters”](#parameters) ##### core [Section titled “core”](#core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `BrexFields` ## Properties [Section titled “Properties”](#properties) ### fields [Section titled “fields”](#fields) > `readonly` **fields**: [`Fields`](/brex/api/fields/classes/fields/) Defined in: [src/fields/client.gen.ts:213](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L213) *** ### fieldValues [Section titled “fieldValues”](#fieldvalues) > `readonly` **fieldValues**: [`FieldValues`](/brex/api/fields/classes/fieldvalues/) Defined in: [src/fields/client.gen.ts:214](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L214) # Fields Defined in: [src/fields/client.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L8) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Fields**(`_core`): `Fields` Defined in: [src/fields/client.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L9) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Fields` ## Methods [Section titled “Methods”](#methods) ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `brex_id`: `string`; `group?`: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` | `null`; `is_disabled`: `boolean`; `name`: `string` | `null`; `remote_id?`: `string` | `null`; `updated_at`: `string`; }> Defined in: [src/fields/client.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L19) Create a custom field Create a custom field `POST /v1/fields` — requires OAuth scope: `fields.write` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-1) ##### body [Section titled “body”](#body) ###### group [Section titled “group”](#group) `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` ###### integration\_id? [Section titled “integration\_id?”](#integration_id) `string` | `null` **Description** The ID of the Accounting Integration to associate this field with. This property is **required** when `group` is `ERP`: it must reference an existing Accounting Integration, and requests that omit it or send `null` for an `ERP` field are rejected. For all other groups (`ACCOUNTING`, `USER`, `TRAVEL`) `integration_id` is not applicable and should be left null. **Example** ```ts int_123 ``` ###### is\_disabled? [Section titled “is\_disabled?”](#is_disabled) `boolean` | `null` **Description** Indicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected. ###### name [Section titled “name”](#name) `string` **Description** The name of the field ###### remote\_id? [Section titled “remote\_id?”](#remote_id) `string` | `null` **Description** Remote/external ID of custom field from external system (e.g. ERP or HRIS system) **Example** ```ts foo_bar ``` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `brex_id`: `string`; `group?`: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` | `null`; `is_disabled`: `boolean`; `name`: `string` | `null`; `remote_id?`: `string` | `null`; `updated_at`: `string`; }> *** ### delete() [Section titled “delete()”](#delete) > **delete**(`id`, `options?`): `Promise`<`void`> Defined in: [src/fields/client.gen.ts:37](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L37) Delete a custom field Delete a custom field by Brex ID `DELETE /v1/fields/{id}` — requires OAuth scope: `fields.write` #### Parameters [Section titled “Parameters”](#parameters-2) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<`void`> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `brex_id`: `string`; `group?`: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` | `null`; `is_disabled`: `boolean`; `name`: `string` | `null`; `remote_id?`: `string` | `null`; `updated_at`: `string`; }> Defined in: [src/fields/client.gen.ts:53](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L53) Get custom field Get a custom field by Brex ID `GET /v1/fields/{id}` — requires OAuth scope: `fields.read`, `fields.write` #### Parameters [Section titled “Parameters”](#parameters-3) ##### id [Section titled “id”](#id-1) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `brex_id`: `string`; `group?`: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` | `null`; `is_disabled`: `boolean`; `name`: `string` | `null`; `remote_id?`: `string` | `null`; `updated_at`: `string`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/fields/client.gen.ts:70](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L70) List custom fields List custom fields under the same account `GET /v1/fields` — requires OAuth scope: `fields.read`, `fields.write` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-4) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` **Description** The cursor to use for pagination. This is the `next_cursor` value returned from the previous response. ###### field\_id\[]? [Section titled “field\_id\[\]?”](#field_id) `string`\[] | `null` **Description** The Brex identifiers of the field to filter by **Example** ```ts extended_field_foobar ``` ###### limit? [Section titled “limit?”](#limit) `number` | `null` **Description** Controls the maximum number of field values returned in the response. It can’t be greater than 1000. ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### update() [Section titled “update()”](#update) > **update**(`id`, `body`, `options?`): `Promise`<{ `brex_id`: `string`; `group?`: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` | `null`; `is_disabled`: `boolean`; `name`: `string` | `null`; `remote_id?`: `string` | `null`; `updated_at`: `string`; }> Defined in: [src/fields/client.gen.ts:86](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L86) Update a custom field Update a field by ID `PUT /v1/fields/{id}` — requires OAuth scope: `fields.write` #### Parameters [Section titled “Parameters”](#parameters-5) ##### id [Section titled “id”](#id-2) `string` ##### body [Section titled “body”](#body-1) ###### is\_disabled? [Section titled “is\_disabled?”](#is_disabled-1) `boolean` | `null` **Description** Indicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected. ###### name? [Section titled “name?”](#name-1) `string` | `null` **Description** The name of the field ##### options? [Section titled “options?”](#options-4) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-5) `Promise`<{ `brex_id`: `string`; `group?`: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` | `null`; `is_disabled`: `boolean`; `name`: `string` | `null`; `remote_id?`: `string` | `null`; `updated_at`: `string`; }> # FieldValues Defined in: [src/fields/client.gen.ts:99](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L99) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new FieldValues**(`_core`): `FieldValues` Defined in: [src/fields/client.gen.ts:100](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L100) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `FieldValues` ## Methods [Section titled “Methods”](#methods) ### create() [Section titled “create()”](#create) > **create**(`fieldId`, `body`, `options?`): `Promise`<{ `items`: `object`\[]; }> Defined in: [src/fields/client.gen.ts:110](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L110) Create custom field values Create custom field values (up to 1000 values at once) for a specific field `POST /v1/fields/{field_id}/values` — requires OAuth scope: `field_values.write` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-1) ##### fieldId [Section titled “fieldId”](#fieldid) `string` ##### body [Section titled “body”](#body) ###### items [Section titled “items”](#items) `object`\[] **Description** The list of field values to be created ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `items`: `object`\[]; }> *** ### delete() [Section titled “delete()”](#delete) > **delete**(`fieldId`, `body`, `options?`): `Promise`<`Record`<`string`, `never`>> Defined in: [src/fields/client.gen.ts:135](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L135) Delete custom field values Delete custom field values (up to 1000 values at once) for a specific field `DELETE /v1/fields/{field_id}/values` — requires OAuth scope: `fields.write` #### Parameters [Section titled “Parameters”](#parameters-2) ##### fieldId [Section titled “fieldId”](#fieldid-1) `string` ##### body [Section titled “body”](#body-1) ###### items [Section titled “items”](#items-1) ({ `brex_id`: `string`; } | { `remote_id`: `string`; } | { `value_id`: `string`; })\[] ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<`Record`<`string`, `never`>> *** ### get() [Section titled “get()”](#get) > **get**(`fieldId`, `brexId`, `options?`): `Promise`<{ `brex_id`: `string`; `field_id`: `string`; `is_disabled`: `boolean`; `remote_id?`: `string` | `null`; `updated_at`: `string`; `value`: `string`; `value_id?`: `string` | `null`; }> Defined in: [src/fields/client.gen.ts:156](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L156) Get a field value Get a field value by field ID and field value ID `GET /v1/fields/{field_id}/values/{brex_id}` — requires OAuth scope: `field_values.read`, `field_values.write` #### Parameters [Section titled “Parameters”](#parameters-3) ##### fieldId [Section titled “fieldId”](#fieldid-2) `string` ##### brexId [Section titled “brexId”](#brexid) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `brex_id`: `string`; `field_id`: `string`; `is_disabled`: `boolean`; `remote_id?`: `string` | `null`; `updated_at`: `string`; `value`: `string`; `value_id?`: `string` | `null`; }> *** ### list() [Section titled “list()”](#list) > **list**(`fieldId`, `query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/fields/client.gen.ts:178](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L178) List custom field values List values under the same custom field `GET /v1/fields/{field_id}/values` — requires OAuth scope: `field_values.read`, `field_values.write` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-4) ##### fieldId [Section titled “fieldId”](#fieldid-3) `string` ##### query? [Section titled “query?”](#query) ###### brex\_id\[]? [Section titled “brex\_id\[\]?”](#brex_id) `string`\[] | `null` **Description** Field value Brex identifier(s) to filter by **Example** ```ts efo_foobar ``` ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` **Description** The cursor to use for pagination. This is the `next_cursor` value returned from the previous response. ###### limit? [Section titled “limit?”](#limit) `number` | `null` **Description** Controls the maximum number of field values returned in the response. It can’t be greater than 1000. ###### remote\_id\[]? [Section titled “remote\_id\[\]?”](#remote_id) `string`\[] | `null` **Description** Field value remote identifier(s) to filter by **Example** ```ts foo_bar ``` ###### value? [Section titled “value?”](#value) `string` | `null` **Description** Field value’s value to filter by **Example** ```ts Foobar ``` ###### value\_id\[]? [Section titled “value\_id\[\]?”](#value_id) `string`\[] | `null` **Description** Field value identifier(s) to filter by **Example** ```ts FooBar ``` ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### update() [Section titled “update()”](#update) > **update**(`fieldId`, `body`, `options?`): `Promise`<{ `items`: `object`\[]; }> Defined in: [src/fields/client.gen.ts:197](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/client.gen.ts#L197) Update custom field values Update custom field values (up to 1000 values at once) for a specific field `PUT /v1/fields/{field_id}/values` — requires OAuth scope: `field_values.write` #### Parameters [Section titled “Parameters”](#parameters-5) ##### fieldId [Section titled “fieldId”](#fieldid-4) `string` ##### body [Section titled “body”](#body-2) ###### items [Section titled “items”](#items-2) ({ `brex_id`: `string`; `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; } | { `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; `remote_id`: `string`; } | { `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; `value_id`: `string`; })\[] ##### options? [Section titled “options?”](#options-4) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-5) `Promise`<{ `items`: `object`\[]; }> # createFieldsClient > **createFieldsClient**(`options`): [`BrexFields`](/brex/api/fields/classes/brexfields/) Defined in: [src/fields/index.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/index.ts#L13) Standalone client for the Brex Fields API. ## Parameters [Section titled “Parameters”](#parameters) ### options [Section titled “options”](#options) [`BrexOptions`](/brex/api/index/interfaces/brexoptions/) ## Returns [Section titled “Returns”](#returns) [`BrexFields`](/brex/api/fields/classes/brexfields/) # FieldsComponents Defined in: [src/fields/types.gen.ts:109](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L109) ## Properties [Section titled “Properties”](#properties) ### headers [Section titled “headers”](#headers) > **headers**: `never` Defined in: [src/fields/types.gen.ts:386](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L386) *** ### parameters [Section titled “parameters”](#parameters) > **parameters**: `never` Defined in: [src/fields/types.gen.ts:384](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L384) *** ### pathItems [Section titled “pathItems”](#pathitems) > **pathItems**: `never` Defined in: [src/fields/types.gen.ts:387](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L387) *** ### requestBodies [Section titled “requestBodies”](#requestbodies) > **requestBodies**: `never` Defined in: [src/fields/types.gen.ts:385](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L385) *** ### responses [Section titled “responses”](#responses) > **responses**: `never` Defined in: [src/fields/types.gen.ts:383](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L383) *** ### schemas [Section titled “schemas”](#schemas) > **schemas**: `object` Defined in: [src/fields/types.gen.ts:110](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L110) #### CreateFieldValueBody [Section titled “CreateFieldValueBody”](#createfieldvaluebody) > **CreateFieldValueBody**: `object` Field value creation ##### Description [Section titled “Description”](#description) Represents the data needed to create a field value ##### CreateFieldValueBody.is\_disabled? [Section titled “CreateFieldValueBody.is\_disabled?”](#createfieldvaluebodyis_disabled) > `optional` **is\_disabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-1) Indicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected. ##### CreateFieldValueBody.remote\_id? [Section titled “CreateFieldValueBody.remote\_id?”](#createfieldvaluebodyremote_id) > `optional` **remote\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-2) Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example) ```ts foo_bar ``` ##### CreateFieldValueBody.value [Section titled “CreateFieldValueBody.value”](#createfieldvaluebodyvalue) > **value**: `string` ###### Description [Section titled “Description”](#description-3) The display name of the field value ##### CreateFieldValueBody.value\_id? [Section titled “CreateFieldValueBody.value\_id?”](#createfieldvaluebodyvalue_id) > `optional` **value\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-4) The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system ###### Example [Section titled “Example”](#example-1) ```ts FooBar ``` #### CreateFieldValueListBody [Section titled “CreateFieldValueListBody”](#createfieldvaluelistbody) > **CreateFieldValueListBody**: `object` Field value list creation ##### Description [Section titled “Description”](#description-5) Represents the data needed to create multiple field values. It can’t contain more than 1000 values at once. ##### CreateFieldValueListBody.items [Section titled “CreateFieldValueListBody.items”](#createfieldvaluelistbodyitems) > **items**: `object`\[] ###### Description [Section titled “Description”](#description-6) The list of field values to be created #### CreateFieldValueListResponse [Section titled “CreateFieldValueListResponse”](#createfieldvaluelistresponse) > **CreateFieldValueListResponse**: `object` Field value list ##### Description [Section titled “Description”](#description-7) Represents a list of field values definition ##### CreateFieldValueListResponse.items [Section titled “CreateFieldValueListResponse.items”](#createfieldvaluelistresponseitems) > **items**: `object`\[] ###### Description [Section titled “Description”](#description-8) The list of created field values #### DeletedFieldValueListResponse [Section titled “DeletedFieldValueListResponse”](#deletedfieldvaluelistresponse) > **DeletedFieldValueListResponse**: `Record`<`string`, `never`> Field value deleted response ##### Description [Section titled “Description”](#description-9) Represents the confirmation of number of deleted field values ##### DeleteFieldValue.ByBrexId [Section titled “DeleteFieldValue.ByBrexId”](#deletefieldvaluebybrexid) > **DeleteFieldValue.ByBrexId**: `object` by `brex_id` ###### Description [Section titled “Description”](#description-10) Represents the data needed to delete a field value using its `brex_id`. ##### DeleteFieldValue.ByBrexId.brex\_id [Section titled “DeleteFieldValue.ByBrexId.brex\_id”](#deletefieldvaluebybrexidbrex_id) > **brex\_id**: `string` ###### Description [Section titled “Description”](#description-11) The internal Brex ID of the field value ###### Example [Section titled “Example”](#example-2) ```ts efo_foobar ``` ##### DeleteFieldValue.ByRemoteId [Section titled “DeleteFieldValue.ByRemoteId”](#deletefieldvaluebyremoteid) > **DeleteFieldValue.ByRemoteId**: `object` by `remote_id` ###### Description [Section titled “Description”](#description-12) Represents the data needed to delete a field value using its `remote_id`. ##### DeleteFieldValue.ByRemoteId.remote\_id [Section titled “DeleteFieldValue.ByRemoteId.remote\_id”](#deletefieldvaluebyremoteidremote_id) > **remote\_id**: `string` ###### Description [Section titled “Description”](#description-13) Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example-3) ```ts foo_bar ``` ##### DeleteFieldValue.ByValueId [Section titled “DeleteFieldValue.ByValueId”](#deletefieldvaluebyvalueid) > **DeleteFieldValue.ByValueId**: `object` by `value_id` ###### Description [Section titled “Description”](#description-14) Represents the data needed to delete a field value using its `value_id`. ##### DeleteFieldValue.ByValueId.value\_id [Section titled “DeleteFieldValue.ByValueId.value\_id”](#deletefieldvaluebyvalueidvalue_id) > **value\_id**: `string` ###### Description [Section titled “Description”](#description-15) The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system ###### Example [Section titled “Example”](#example-4) ```ts FooBar ``` #### DeleteFieldValueBody [Section titled “DeleteFieldValueBody”](#deletefieldvaluebody) > **DeleteFieldValueBody**: { `brex_id`: `string`; } | { `remote_id`: `string`; } | { `value_id`: `string`; } Field value to delete ##### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `brex_id`: `string`; } ###### brex\_id [Section titled “brex\_id”](#brex_id) > **brex\_id**: `string` ###### Description [Section titled “Description”](#description-16) The internal Brex ID of the field value ###### Example [Section titled “Example”](#example-5) ```ts efo_foobar ``` *** ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `remote_id`: `string`; } ###### remote\_id [Section titled “remote\_id”](#remote_id) > **remote\_id**: `string` ###### Description [Section titled “Description”](#description-17) Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example-6) ```ts foo_bar ``` *** ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `value_id`: `string`; } ###### value\_id [Section titled “value\_id”](#value_id) > **value\_id**: `string` ###### Description [Section titled “Description”](#description-18) The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system ###### Example [Section titled “Example”](#example-7) ```ts FooBar ``` ##### Description [Section titled “Description”](#description-19) Represents the data needed to delete a field value. #### DeleteFieldValueListBody [Section titled “DeleteFieldValueListBody”](#deletefieldvaluelistbody) > **DeleteFieldValueListBody**: `object` Field value list deletion ##### Description [Section titled “Description”](#description-20) Represents the data needed to delete field values. It can’t contain more than 1000 values at once. ##### DeleteFieldValueListBody.items [Section titled “DeleteFieldValueListBody.items”](#deletefieldvaluelistbodyitems) > **items**: ({ `brex_id`: `string`; } | { `remote_id`: `string`; } | { `value_id`: `string`; })\[] #### Field [Section titled “Field”](#field) > **Field**: `object` Field ##### Description [Section titled “Description”](#description-21) Represents a field definition ##### Field.brex\_id [Section titled “Field.brex\_id”](#fieldbrex_id) > **brex\_id**: `string` ###### Description [Section titled “Description”](#description-22) The internal Brex ID of the field ###### Example [Section titled “Example”](#example-8) ```ts extended_field_foobar ``` ##### Field.group? [Section titled “Field.group?”](#fieldgroup) > `optional` **group?**: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` | `null` ##### Field.is\_disabled [Section titled “Field.is\_disabled”](#fieldis_disabled) > **is\_disabled**: `boolean` ###### Description [Section titled “Description”](#description-23) Indicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected. ##### Field.name [Section titled “Field.name”](#fieldname) > **name**: `string` | `null` ###### Description [Section titled “Description”](#description-24) The name of the field ##### Field.remote\_id? [Section titled “Field.remote\_id?”](#fieldremote_id) > `optional` **remote\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-25) Remote/external ID of custom field from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example-9) ```ts foo_bar ``` ##### Field.updated\_at [Section titled “Field.updated\_at”](#fieldupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-26) The last updated timestamp of the field #### FieldCreateBody [Section titled “FieldCreateBody”](#fieldcreatebody) > **FieldCreateBody**: `object` Field creation ##### Description [Section titled “Description”](#description-27) Represents the data needed to create a field. To create a field in the `ERP` group you must first set up an Accounting Integration and supply its `integration_id`. ##### FieldCreateBody.group [Section titled “FieldCreateBody.group”](#fieldcreatebodygroup) > **group**: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` ##### FieldCreateBody.integration\_id? [Section titled “FieldCreateBody.integration\_id?”](#fieldcreatebodyintegration_id) > `optional` **integration\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-28) The ID of the Accounting Integration to associate this field with. This property is **required** when `group` is `ERP`: it must reference an existing Accounting Integration, and requests that omit it or send `null` for an `ERP` field are rejected. For all other groups (`ACCOUNTING`, `USER`, `TRAVEL`) `integration_id` is not applicable and should be left null. ###### Example [Section titled “Example”](#example-10) ```ts int_123 ``` ##### FieldCreateBody.is\_disabled? [Section titled “FieldCreateBody.is\_disabled?”](#fieldcreatebodyis_disabled) > `optional` **is\_disabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-29) Indicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected. ##### FieldCreateBody.name [Section titled “FieldCreateBody.name”](#fieldcreatebodyname) > **name**: `string` ###### Description [Section titled “Description”](#description-30) The name of the field ##### FieldCreateBody.remote\_id? [Section titled “FieldCreateBody.remote\_id?”](#fieldcreatebodyremote_id) > `optional` **remote\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-31) Remote/external ID of custom field from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example-11) ```ts foo_bar ``` #### FieldGroup [Section titled “FieldGroup”](#fieldgroup-1) > **FieldGroup**: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` ##### Description [Section titled “Description”](#description-32) The category of the field, indicating its purpose or context. Supported groups are: ```plaintext * `ACCOUNTING` — Fields used to categorize transactions for accounting purposes (for example, expense categories or cost centers) that are managed directly within Brex. * `USER` — Fields associated with users, used to capture user-specific attributes. * `ERP` — Fields that are synced with an external ERP/accounting system through an Accounting Integration. Creating an Accounting Integration is a prerequisite for creating fields in the `ERP` group, and each `ERP` field must reference that integration through `integration_id`. * `TRAVEL` — Fields used in the context of travel bookings and expenses. ``` #### FieldUpdateBody [Section titled “FieldUpdateBody”](#fieldupdatebody) > **FieldUpdateBody**: `object` Field update ##### Description [Section titled “Description”](#description-33) Represents the data needed to update a field ##### FieldUpdateBody.is\_disabled? [Section titled “FieldUpdateBody.is\_disabled?”](#fieldupdatebodyis_disabled) > `optional` **is\_disabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-34) Indicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected. ##### FieldUpdateBody.name? [Section titled “FieldUpdateBody.name?”](#fieldupdatebodyname) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-35) The name of the field #### FieldValue [Section titled “FieldValue”](#fieldvalue) > **FieldValue**: `object` Field value ##### Description [Section titled “Description”](#description-36) Represents a field value definition ##### FieldValue.brex\_id [Section titled “FieldValue.brex\_id”](#fieldvaluebrex_id) > **brex\_id**: `string` ###### Description [Section titled “Description”](#description-37) The internal Brex ID of the field value ###### Example [Section titled “Example”](#example-12) ```ts efo_foobar ``` ##### FieldValue.field\_id [Section titled “FieldValue.field\_id”](#fieldvaluefield_id) > **field\_id**: `string` ###### Description [Section titled “Description”](#description-38) The ID of the parent field this value belongs to ###### Example [Section titled “Example”](#example-13) ```ts extended_field_foobar ``` ##### FieldValue.is\_disabled [Section titled “FieldValue.is\_disabled”](#fieldvalueis_disabled) > **is\_disabled**: `boolean` ###### Description [Section titled “Description”](#description-39) Indicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected. ##### FieldValue.remote\_id? [Section titled “FieldValue.remote\_id?”](#fieldvalueremote_id) > `optional` **remote\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-40) Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example-14) ```ts foo_bar ``` ##### FieldValue.updated\_at [Section titled “FieldValue.updated\_at”](#fieldvalueupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-41) The last updated timestamp of the field value ##### FieldValue.value [Section titled “FieldValue.value”](#fieldvaluevalue) > **value**: `string` ###### Description [Section titled “Description”](#description-42) The display name of the field value ##### FieldValue.value\_id? [Section titled “FieldValue.value\_id?”](#fieldvaluevalue_id) > `optional` **value\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-43) The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system ###### Example [Section titled “Example”](#example-15) ```ts foo_bar ``` #### Page\_Field\_ [Section titled “Page\_Field\_”](#page_field_) > **Page\_Field\_**: `object` ##### Page\_Field\_.items [Section titled “Page\_Field\_.items”](#page_field_items) > **items**: `object`\[] ##### Page\_Field\_.next\_cursor? [Section titled “Page\_Field\_.next\_cursor?”](#page_field_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_FieldValue\_ [Section titled “Page\_FieldValue\_”](#page_fieldvalue_) > **Page\_FieldValue\_**: `object` ##### Page\_FieldValue\_.items [Section titled “Page\_FieldValue\_.items”](#page_fieldvalue_items) > **items**: `object`\[] ##### Page\_FieldValue\_.next\_cursor? [Section titled “Page\_FieldValue\_.next\_cursor?”](#page_fieldvalue_next_cursor) > `optional` **next\_cursor?**: `string` | `null` ##### UpdateFieldValue.ByBrexId [Section titled “UpdateFieldValue.ByBrexId”](#updatefieldvaluebybrexid) > **UpdateFieldValue.ByBrexId**: `object` by `brex_id` ###### Description [Section titled “Description”](#description-44) Represents the data needed to update a field value using its `brex_id`. ##### UpdateFieldValue.ByBrexId.brex\_id [Section titled “UpdateFieldValue.ByBrexId.brex\_id”](#updatefieldvaluebybrexidbrex_id) > **brex\_id**: `string` ###### Description [Section titled “Description”](#description-45) The internal Brex ID of the field value ###### Example [Section titled “Example”](#example-16) ```ts efo_foobar ``` ##### UpdateFieldValue.ByBrexId.data [Section titled “UpdateFieldValue.ByBrexId.data”](#updatefieldvaluebybrexiddata) > **data**: `object` ##### UpdateFieldValue.ByBrexId.data.is\_disabled? [Section titled “UpdateFieldValue.ByBrexId.data.is\_disabled?”](#updatefieldvaluebybrexiddatais_disabled) > `optional` **is\_disabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-46) Indicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected. ##### UpdateFieldValue.ByBrexId.data.value? [Section titled “UpdateFieldValue.ByBrexId.data.value?”](#updatefieldvaluebybrexiddatavalue) > `optional` **value?**: `string` | `null` ###### Description [Section titled “Description”](#description-47) The display name of the field value ##### UpdateFieldValue.ByRemoteId [Section titled “UpdateFieldValue.ByRemoteId”](#updatefieldvaluebyremoteid) > **UpdateFieldValue.ByRemoteId**: `object` by `remote_id` ###### Description [Section titled “Description”](#description-48) Represents the data needed to update a field value using its `remote_id`. ##### UpdateFieldValue.ByRemoteId.data [Section titled “UpdateFieldValue.ByRemoteId.data”](#updatefieldvaluebyremoteiddata) > **data**: `object` ##### UpdateFieldValue.ByRemoteId.data.is\_disabled? [Section titled “UpdateFieldValue.ByRemoteId.data.is\_disabled?”](#updatefieldvaluebyremoteiddatais_disabled) > `optional` **is\_disabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-49) Indicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected. ##### UpdateFieldValue.ByRemoteId.data.value? [Section titled “UpdateFieldValue.ByRemoteId.data.value?”](#updatefieldvaluebyremoteiddatavalue) > `optional` **value?**: `string` | `null` ###### Description [Section titled “Description”](#description-50) The display name of the field value ##### UpdateFieldValue.ByRemoteId.remote\_id [Section titled “UpdateFieldValue.ByRemoteId.remote\_id”](#updatefieldvaluebyremoteidremote_id) > **remote\_id**: `string` ###### Description [Section titled “Description”](#description-51) Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example-17) ```ts foo_bar ``` ##### UpdateFieldValue.ByValueId [Section titled “UpdateFieldValue.ByValueId”](#updatefieldvaluebyvalueid) > **UpdateFieldValue.ByValueId**: `object` by `value_id` ###### Description [Section titled “Description”](#description-52) Represents the data needed to update a field value using its `value_id`. ##### UpdateFieldValue.ByValueId.data [Section titled “UpdateFieldValue.ByValueId.data”](#updatefieldvaluebyvalueiddata) > **data**: `object` ##### UpdateFieldValue.ByValueId.data.is\_disabled? [Section titled “UpdateFieldValue.ByValueId.data.is\_disabled?”](#updatefieldvaluebyvalueiddatais_disabled) > `optional` **is\_disabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-53) Indicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected. ##### UpdateFieldValue.ByValueId.data.value? [Section titled “UpdateFieldValue.ByValueId.data.value?”](#updatefieldvaluebyvalueiddatavalue) > `optional` **value?**: `string` | `null` ###### Description [Section titled “Description”](#description-54) The display name of the field value ##### UpdateFieldValue.ByValueId.value\_id [Section titled “UpdateFieldValue.ByValueId.value\_id”](#updatefieldvaluebyvalueidvalue_id) > **value\_id**: `string` ###### Description [Section titled “Description”](#description-55) The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system ###### Example [Section titled “Example”](#example-18) ```ts FooBar ``` #### UpdateFieldValueBody [Section titled “UpdateFieldValueBody”](#updatefieldvaluebody) > **UpdateFieldValueBody**: { `brex_id`: `string`; `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; } | { `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; `remote_id`: `string`; } | { `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; `value_id`: `string`; } Field value to update ##### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-3) { `brex_id`: `string`; `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; } ###### brex\_id [Section titled “brex\_id”](#brex_id-1) > **brex\_id**: `string` ###### Description [Section titled “Description”](#description-56) The internal Brex ID of the field value ###### Example [Section titled “Example”](#example-19) ```ts efo_foobar ``` ###### data [Section titled “data”](#data) > **data**: `object` ###### data.is\_disabled? [Section titled “data.is\_disabled?”](#datais_disabled) > `optional` **is\_disabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-57) Indicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected. ###### data.value? [Section titled “data.value?”](#datavalue) > `optional` **value?**: `string` | `null` ###### Description [Section titled “Description”](#description-58) The display name of the field value *** ###### Type Literal [Section titled “Type Literal”](#type-literal-4) { `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; `remote_id`: `string`; } ###### data [Section titled “data”](#data-1) > **data**: `object` ###### data.is\_disabled? [Section titled “data.is\_disabled?”](#datais_disabled-1) > `optional` **is\_disabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-59) Indicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected. ###### data.value? [Section titled “data.value?”](#datavalue-1) > `optional` **value?**: `string` | `null` ###### Description [Section titled “Description”](#description-60) The display name of the field value ###### remote\_id [Section titled “remote\_id”](#remote_id-1) > **remote\_id**: `string` ###### Description [Section titled “Description”](#description-61) Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example-20) ```ts foo_bar ``` *** ###### Type Literal [Section titled “Type Literal”](#type-literal-5) { `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; `value_id`: `string`; } ###### data [Section titled “data”](#data-2) > **data**: `object` ###### data.is\_disabled? [Section titled “data.is\_disabled?”](#datais_disabled-2) > `optional` **is\_disabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-62) Indicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected. ###### data.value? [Section titled “data.value?”](#datavalue-2) > `optional` **value?**: `string` | `null` ###### Description [Section titled “Description”](#description-63) The display name of the field value ###### value\_id [Section titled “value\_id”](#value_id-1) > **value\_id**: `string` ###### Description [Section titled “Description”](#description-64) The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system ###### Example [Section titled “Example”](#example-21) ```ts FooBar ``` ##### Description [Section titled “Description”](#description-65) Represents the data needed to update a field value. #### UpdateFieldValueDataBody [Section titled “UpdateFieldValueDataBody”](#updatefieldvaluedatabody) > **UpdateFieldValueDataBody**: `object` Field value update data ##### Description [Section titled “Description”](#description-66) Represents the updated data of a field value ##### UpdateFieldValueDataBody.is\_disabled? [Section titled “UpdateFieldValueDataBody.is\_disabled?”](#updatefieldvaluedatabodyis_disabled) > `optional` **is\_disabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-67) Indicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected. ##### UpdateFieldValueDataBody.value? [Section titled “UpdateFieldValueDataBody.value?”](#updatefieldvaluedatabodyvalue) > `optional` **value?**: `string` | `null` ###### Description [Section titled “Description”](#description-68) The display name of the field value #### UpdateFieldValueListBody [Section titled “UpdateFieldValueListBody”](#updatefieldvaluelistbody) > **UpdateFieldValueListBody**: `object` Field value list update ##### Description [Section titled “Description”](#description-69) Represents the data needed to update multiple field values. It can’t contain more than 1000 values at once. ##### UpdateFieldValueListBody.items [Section titled “UpdateFieldValueListBody.items”](#updatefieldvaluelistbodyitems) > **items**: ({ `brex_id`: `string`; `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; } | { `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; `remote_id`: `string`; } | { `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; `value_id`: `string`; })\[] #### UpdateFieldValueListResponse [Section titled “UpdateFieldValueListResponse”](#updatefieldvaluelistresponse) > **UpdateFieldValueListResponse**: `object` Field value updated list ##### Description [Section titled “Description”](#description-70) Represents a list of updated field values ##### UpdateFieldValueListResponse.items [Section titled “UpdateFieldValueListResponse.items”](#updatefieldvaluelistresponseitems) > **items**: `object`\[] ###### Description [Section titled “Description”](#description-71) The list of updated field values # FieldsPaths Defined in: [src/fields/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L2) ## Properties [Section titled “Properties”](#properties) ### /v1/fields [Section titled “/v1/fields”](#v1fields) > **/v1/fields**: `object` Defined in: [src/fields/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L3) #### delete? [Section titled “delete?”](#delete) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get) > **get**: `object` List custom fields ##### Description [Section titled “Description”](#description) List custom fields under the same account ##### get.parameters [Section titled “get.parameters”](#getparameters) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor) > `optional` **cursor?**: `string` | `null` ###### Description [Section titled “Description”](#description-1) The cursor to use for pagination. This is the `next_cursor` value returned from the previous response. ##### get.parameters.query.field\_id\[]? [Section titled “get.parameters.query.field\_id\[\]?”](#getparametersqueryfield_id) > `optional` **field\_id\[]?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-2) The Brex identifiers of the field to filter by ###### Example [Section titled “Example”](#example) ```ts extended_field_foobar ``` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit) > `optional` **limit?**: `number` | `null` ###### Description [Section titled “Description”](#description-3) Controls the maximum number of field values returned in the response. It can’t be greater than 1000. ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-4) List custom fields response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-5) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-1) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-6) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-2) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-7) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-3) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500) > **500**: `object` ###### Description [Section titled “Description”](#description-8) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-4) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post) > **post**: `object` Create a custom field ##### Description [Section titled “Description”](#description-9) Create a custom field ##### post.parameters [Section titled “post.parameters”](#postparameters) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie) > `optional` **cookie?**: `undefined` ##### post.parameters.header [Section titled “post.parameters.header”](#postparametersheader) > **header**: `object` ##### post.parameters.header.Idempotency-Key [Section titled “post.parameters.header.Idempotency-Key”](#postparametersheaderidempotency-key) > **Idempotency-Key**: `string` ###### Description [Section titled “Description”](#description-10) Idempotency key for this request. ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson) > **application/json**: `object` ##### post.requestBody.content.application/json.group [Section titled “post.requestBody.content.application/json.group”](#postrequestbodycontentapplicationjsongroup) > **group**: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` ##### post.requestBody.content.application/json.integration\_id? [Section titled “post.requestBody.content.application/json.integration\_id?”](#postrequestbodycontentapplicationjsonintegration_id) > `optional` **integration\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-11) The ID of the Accounting Integration to associate this field with. This property is **required** when `group` is `ERP`: it must reference an existing Accounting Integration, and requests that omit it or send `null` for an `ERP` field are rejected. For all other groups (`ACCOUNTING`, `USER`, `TRAVEL`) `integration_id` is not applicable and should be left null. ###### Example [Section titled “Example”](#example-1) ```ts int_123 ``` ##### post.requestBody.content.application/json.is\_disabled? [Section titled “post.requestBody.content.application/json.is\_disabled?”](#postrequestbodycontentapplicationjsonis_disabled) > `optional` **is\_disabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-12) Indicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected. ##### post.requestBody.content.application/json.name [Section titled “post.requestBody.content.application/json.name”](#postrequestbodycontentapplicationjsonname) > **name**: `string` ###### Description [Section titled “Description”](#description-13) The name of the field ##### post.requestBody.content.application/json.remote\_id? [Section titled “post.requestBody.content.application/json.remote\_id?”](#postrequestbodycontentapplicationjsonremote_id) > `optional` **remote\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-14) Remote/external ID of custom field from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example-2) ```ts foo_bar ``` ##### post.responses [Section titled “post.responses”](#postresponses) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-15) Create custom field response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson) > **application/json**: `object` ##### post.responses.200.content.application/json.brex\_id [Section titled “post.responses.200.content.application/json.brex\_id”](#postresponses200contentapplicationjsonbrex_id) > **brex\_id**: `string` ###### Description [Section titled “Description”](#description-16) The internal Brex ID of the field ###### Example [Section titled “Example”](#example-3) ```ts extended_field_foobar ``` ##### post.responses.200.content.application/json.group? [Section titled “post.responses.200.content.application/json.group?”](#postresponses200contentapplicationjsongroup) > `optional` **group?**: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` | `null` ##### post.responses.200.content.application/json.is\_disabled [Section titled “post.responses.200.content.application/json.is\_disabled”](#postresponses200contentapplicationjsonis_disabled) > **is\_disabled**: `boolean` ###### Description [Section titled “Description”](#description-17) Indicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected. ##### post.responses.200.content.application/json.name [Section titled “post.responses.200.content.application/json.name”](#postresponses200contentapplicationjsonname) > **name**: `string` | `null` ###### Description [Section titled “Description”](#description-18) The name of the field ##### post.responses.200.content.application/json.remote\_id? [Section titled “post.responses.200.content.application/json.remote\_id?”](#postresponses200contentapplicationjsonremote_id) > `optional` **remote\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-19) Remote/external ID of custom field from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example-4) ```ts foo_bar ``` ##### post.responses.200.content.application/json.updated\_at [Section titled “post.responses.200.content.application/json.updated\_at”](#postresponses200contentapplicationjsonupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-20) The last updated timestamp of the field ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-5) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-21) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-6) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-22) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-7) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-23) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-8) \[`name`: `string`]: `unknown` ##### post.responses.404 [Section titled “post.responses.404”](#postresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-24) Not found ##### post.responses.404.content? [Section titled “post.responses.404.content?”](#postresponses404content) > `optional` **content?**: `undefined` ##### post.responses.404.headers [Section titled “post.responses.404.headers”](#postresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-9) \[`name`: `string`]: `unknown` ##### post.responses.500 [Section titled “post.responses.500”](#postresponses500) > **500**: `object` ###### Description [Section titled “Description”](#description-25) Internal server error ##### post.responses.500.content? [Section titled “post.responses.500.content?”](#postresponses500content) > `optional` **content?**: `undefined` ##### post.responses.500.headers [Section titled “post.responses.500.headers”](#postresponses500headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-10) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace) > `optional` **trace?**: `undefined` *** ### /v1/fields/{field\_id}/values [Section titled “/v1/fields/{field\_id}/values”](#v1fieldsfield_idvalues) > **/v1/fields/{field\_id}/values**: `object` Defined in: [src/fields/types.gen.ts:27](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L27) #### delete [Section titled “delete”](#delete-1) > **delete**: `object` Delete custom field values ##### Description [Section titled “Description”](#description-26) Delete custom field values (up to 1000 values at once) for a specific field ##### delete.parameters [Section titled “delete.parameters”](#deleteparameters) > **parameters**: `object` ##### delete.parameters.cookie? [Section titled “delete.parameters.cookie?”](#deleteparameterscookie) > `optional` **cookie?**: `undefined` ##### delete.parameters.header? [Section titled “delete.parameters.header?”](#deleteparametersheader) > `optional` **header?**: `undefined` ##### delete.parameters.path [Section titled “delete.parameters.path”](#deleteparameterspath) > **path**: `object` ##### delete.parameters.path.field\_id [Section titled “delete.parameters.path.field\_id”](#deleteparameterspathfield_id) > **field\_id**: `string` ###### Description [Section titled “Description”](#description-27) The Field Brex identifier ###### Example [Section titled “Example”](#example-5) ```ts extended_field_foobar ``` ##### delete.parameters.query? [Section titled “delete.parameters.query?”](#deleteparametersquery) > `optional` **query?**: `undefined` ##### delete.requestBody [Section titled “delete.requestBody”](#deleterequestbody) > **requestBody**: `object` ##### delete.requestBody.content [Section titled “delete.requestBody.content”](#deleterequestbodycontent) > **content**: `object` ##### delete.requestBody.content.application/json [Section titled “delete.requestBody.content.application/json”](#deleterequestbodycontentapplicationjson) > **application/json**: `object` ##### delete.requestBody.content.application/json.items [Section titled “delete.requestBody.content.application/json.items”](#deleterequestbodycontentapplicationjsonitems) > **items**: ({ `brex_id`: `string`; } | { `remote_id`: `string`; } | { `value_id`: `string`; })\[] ##### delete.responses [Section titled “delete.responses”](#deleteresponses) > **responses**: `object` ##### delete.responses.200 [Section titled “delete.responses.200”](#deleteresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-28) Delete custom field value list response ##### delete.responses.200.content [Section titled “delete.responses.200.content”](#deleteresponses200content) > **content**: `object` ##### delete.responses.200.content.application/json [Section titled “delete.responses.200.content.application/json”](#deleteresponses200contentapplicationjson) > **application/json**: `Record`<`string`, `never`> ##### delete.responses.200.headers [Section titled “delete.responses.200.headers”](#deleteresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-11) \[`name`: `string`]: `unknown` ##### delete.responses.400 [Section titled “delete.responses.400”](#deleteresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-29) Bad request ##### delete.responses.400.content? [Section titled “delete.responses.400.content?”](#deleteresponses400content) > `optional` **content?**: `undefined` ##### delete.responses.400.headers [Section titled “delete.responses.400.headers”](#deleteresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-12) \[`name`: `string`]: `unknown` ##### delete.responses.401 [Section titled “delete.responses.401”](#deleteresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-30) Unauthorized ##### delete.responses.401.content? [Section titled “delete.responses.401.content?”](#deleteresponses401content) > `optional` **content?**: `undefined` ##### delete.responses.401.headers [Section titled “delete.responses.401.headers”](#deleteresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-13) \[`name`: `string`]: `unknown` ##### delete.responses.403 [Section titled “delete.responses.403”](#deleteresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-31) Forbidden ##### delete.responses.403.content? [Section titled “delete.responses.403.content?”](#deleteresponses403content) > `optional` **content?**: `undefined` ##### delete.responses.403.headers [Section titled “delete.responses.403.headers”](#deleteresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-14) \[`name`: `string`]: `unknown` ##### delete.responses.404 [Section titled “delete.responses.404”](#deleteresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-32) Not found ##### delete.responses.404.content? [Section titled “delete.responses.404.content?”](#deleteresponses404content) > `optional` **content?**: `undefined` ##### delete.responses.404.headers [Section titled “delete.responses.404.headers”](#deleteresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-15) \[`name`: `string`]: `unknown` ##### delete.responses.500 [Section titled “delete.responses.500”](#deleteresponses500) > **500**: `object` ###### Description [Section titled “Description”](#description-33) Internal server error ##### delete.responses.500.content? [Section titled “delete.responses.500.content?”](#deleteresponses500content) > `optional` **content?**: `undefined` ##### delete.responses.500.headers [Section titled “delete.responses.500.headers”](#deleteresponses500headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-16) \[`name`: `string`]: `unknown` #### get [Section titled “get”](#get-1) > **get**: `object` List custom field values ##### Description [Section titled “Description”](#description-34) List values under the same custom field ##### get.parameters [Section titled “get.parameters”](#getparameters-1) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-1) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-1) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-1) > **path**: `object` ##### get.parameters.path.field\_id [Section titled “get.parameters.path.field\_id”](#getparameterspathfield_id) > **field\_id**: `string` ###### Description [Section titled “Description”](#description-35) The Field Brex identifier ###### Example [Section titled “Example”](#example-6) ```ts extended_field_foobar ``` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-1) > `optional` **query?**: `object` ##### get.parameters.query.brex\_id\[]? [Section titled “get.parameters.query.brex\_id\[\]?”](#getparametersquerybrex_id) > `optional` **brex\_id\[]?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-36) Field value Brex identifier(s) to filter by ###### Example [Section titled “Example”](#example-7) ```ts efo_foobar ``` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-1) > `optional` **cursor?**: `string` | `null` ###### Description [Section titled “Description”](#description-37) The cursor to use for pagination. This is the `next_cursor` value returned from the previous response. ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-1) > `optional` **limit?**: `number` | `null` ###### Description [Section titled “Description”](#description-38) Controls the maximum number of field values returned in the response. It can’t be greater than 1000. ##### get.parameters.query.remote\_id\[]? [Section titled “get.parameters.query.remote\_id\[\]?”](#getparametersqueryremote_id) > `optional` **remote\_id\[]?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-39) Field value remote identifier(s) to filter by ###### Example [Section titled “Example”](#example-8) ```ts foo_bar ``` ##### get.parameters.query.value? [Section titled “get.parameters.query.value?”](#getparametersqueryvalue) > `optional` **value?**: `string` | `null` ###### Description [Section titled “Description”](#description-40) Field value’s value to filter by ###### Example [Section titled “Example”](#example-9) ```ts Foobar ``` ##### get.parameters.query.value\_id\[]? [Section titled “get.parameters.query.value\_id\[\]?”](#getparametersqueryvalue_id) > `optional` **value\_id\[]?**: `string`\[] | `null` ###### Description [Section titled “Description”](#description-41) Field value identifier(s) to filter by ###### Example [Section titled “Example”](#example-10) ```ts FooBar ``` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-1) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-1) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-42) List custom field values response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-1) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-1) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-1) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-1) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-17) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-43) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-1) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-18) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-44) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-1) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-19) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-45) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-1) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-20) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-1) > **500**: `object` ###### Description [Section titled “Description”](#description-46) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-1) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-21) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-1) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-1) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-1) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-1) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-1) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-1) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-1) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-1) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-1) > **post**: `object` Create custom field values ##### Description [Section titled “Description”](#description-47) Create custom field values (up to 1000 values at once) for a specific field ##### post.parameters [Section titled “post.parameters”](#postparameters-1) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-1) > `optional` **cookie?**: `undefined` ##### post.parameters.header [Section titled “post.parameters.header”](#postparametersheader-1) > **header**: `object` ##### post.parameters.header.Idempotency-Key [Section titled “post.parameters.header.Idempotency-Key”](#postparametersheaderidempotency-key-1) > **Idempotency-Key**: `string` ###### Description [Section titled “Description”](#description-48) Idempotency key for this request. ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-1) > **path**: `object` ##### post.parameters.path.field\_id [Section titled “post.parameters.path.field\_id”](#postparameterspathfield_id) > **field\_id**: `string` ###### Description [Section titled “Description”](#description-49) The Field Brex identifier ###### Example [Section titled “Example”](#example-11) ```ts extended_field_foobar ``` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-1) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-1) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-1) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-1) > **application/json**: `object` ##### post.requestBody.content.application/json.items [Section titled “post.requestBody.content.application/json.items”](#postrequestbodycontentapplicationjsonitems) > **items**: `object`\[] ###### Description [Section titled “Description”](#description-50) The list of field values to be created ##### post.responses [Section titled “post.responses”](#postresponses-1) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-51) Create custom field values response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-1) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-1) > **application/json**: `object` ##### post.responses.200.content.application/json.items [Section titled “post.responses.200.content.application/json.items”](#postresponses200contentapplicationjsonitems) > **items**: `object`\[] ###### Description [Section titled “Description”](#description-52) The list of created field values ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-22) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-53) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content-1) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-23) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-54) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content-1) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-24) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-55) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content-1) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-25) \[`name`: `string`]: `unknown` ##### post.responses.404 [Section titled “post.responses.404”](#postresponses404-1) > **404**: `object` ###### Description [Section titled “Description”](#description-56) Not found ##### post.responses.404.content? [Section titled “post.responses.404.content?”](#postresponses404content-1) > `optional` **content?**: `undefined` ##### post.responses.404.headers [Section titled “post.responses.404.headers”](#postresponses404headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-26) \[`name`: `string`]: `unknown` ##### post.responses.500 [Section titled “post.responses.500”](#postresponses500-1) > **500**: `object` ###### Description [Section titled “Description”](#description-57) Internal server error ##### post.responses.500.content? [Section titled “post.responses.500.content?”](#postresponses500content-1) > `optional` **content?**: `undefined` ##### post.responses.500.headers [Section titled “post.responses.500.headers”](#postresponses500headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-27) \[`name`: `string`]: `unknown` #### put [Section titled “put”](#put-1) > **put**: `object` Update custom field values ##### Description [Section titled “Description”](#description-58) Update custom field values (up to 1000 values at once) for a specific field ##### put.parameters [Section titled “put.parameters”](#putparameters) > **parameters**: `object` ##### put.parameters.cookie? [Section titled “put.parameters.cookie?”](#putparameterscookie) > `optional` **cookie?**: `undefined` ##### put.parameters.header? [Section titled “put.parameters.header?”](#putparametersheader) > `optional` **header?**: `undefined` ##### put.parameters.path [Section titled “put.parameters.path”](#putparameterspath) > **path**: `object` ##### put.parameters.path.field\_id [Section titled “put.parameters.path.field\_id”](#putparameterspathfield_id) > **field\_id**: `string` ###### Description [Section titled “Description”](#description-59) The Field Brex identifier ###### Example [Section titled “Example”](#example-12) ```ts extended_field_foobar ``` ##### put.parameters.query? [Section titled “put.parameters.query?”](#putparametersquery) > `optional` **query?**: `undefined` ##### put.requestBody [Section titled “put.requestBody”](#putrequestbody) > **requestBody**: `object` ##### put.requestBody.content [Section titled “put.requestBody.content”](#putrequestbodycontent) > **content**: `object` ##### put.requestBody.content.application/json [Section titled “put.requestBody.content.application/json”](#putrequestbodycontentapplicationjson) > **application/json**: `object` ##### put.requestBody.content.application/json.items [Section titled “put.requestBody.content.application/json.items”](#putrequestbodycontentapplicationjsonitems) > **items**: ({ `brex_id`: `string`; `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; } | { `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; `remote_id`: `string`; } | { `data`: { `is_disabled?`: `boolean` | `null`; `value?`: `string` | `null`; }; `value_id`: `string`; })\[] ##### put.responses [Section titled “put.responses”](#putresponses) > **responses**: `object` ##### put.responses.200 [Section titled “put.responses.200”](#putresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-60) Update custom field value list response ##### put.responses.200.content [Section titled “put.responses.200.content”](#putresponses200content) > **content**: `object` ##### put.responses.200.content.application/json [Section titled “put.responses.200.content.application/json”](#putresponses200contentapplicationjson) > **application/json**: `object` ##### put.responses.200.content.application/json.items [Section titled “put.responses.200.content.application/json.items”](#putresponses200contentapplicationjsonitems) > **items**: `object`\[] ###### Description [Section titled “Description”](#description-61) The list of updated field values ##### put.responses.200.headers [Section titled “put.responses.200.headers”](#putresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-28) \[`name`: `string`]: `unknown` ##### put.responses.400 [Section titled “put.responses.400”](#putresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-62) Bad request ##### put.responses.400.content? [Section titled “put.responses.400.content?”](#putresponses400content) > `optional` **content?**: `undefined` ##### put.responses.400.headers [Section titled “put.responses.400.headers”](#putresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-29) \[`name`: `string`]: `unknown` ##### put.responses.401 [Section titled “put.responses.401”](#putresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-63) Unauthorized ##### put.responses.401.content? [Section titled “put.responses.401.content?”](#putresponses401content) > `optional` **content?**: `undefined` ##### put.responses.401.headers [Section titled “put.responses.401.headers”](#putresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-30) \[`name`: `string`]: `unknown` ##### put.responses.403 [Section titled “put.responses.403”](#putresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-64) Forbidden ##### put.responses.403.content? [Section titled “put.responses.403.content?”](#putresponses403content) > `optional` **content?**: `undefined` ##### put.responses.403.headers [Section titled “put.responses.403.headers”](#putresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-31) \[`name`: `string`]: `unknown` ##### put.responses.404 [Section titled “put.responses.404”](#putresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-65) Not found ##### put.responses.404.content? [Section titled “put.responses.404.content?”](#putresponses404content) > `optional` **content?**: `undefined` ##### put.responses.404.headers [Section titled “put.responses.404.headers”](#putresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-32) \[`name`: `string`]: `unknown` ##### put.responses.500 [Section titled “put.responses.500”](#putresponses500) > **500**: `object` ###### Description [Section titled “Description”](#description-66) Internal server error ##### put.responses.500.content? [Section titled “put.responses.500.content?”](#putresponses500content) > `optional` **content?**: `undefined` ##### put.responses.500.headers [Section titled “put.responses.500.headers”](#putresponses500headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-33) \[`name`: `string`]: `unknown` #### trace? [Section titled “trace?”](#trace-1) > `optional` **trace?**: `undefined` *** ### /v1/fields/{field\_id}/values/{brex\_id} [Section titled “/v1/fields/{field\_id}/values/{brex\_id}”](#v1fieldsfield_idvaluesbrex_id) > **/v1/fields/{field\_id}/values/{brex\_id}**: `object` Defined in: [src/fields/types.gen.ts:59](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L59) #### delete? [Section titled “delete?”](#delete-2) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-2) > **get**: `object` Get a field value ##### Description [Section titled “Description”](#description-67) Get a field value by field ID and field value ID ##### get.parameters [Section titled “get.parameters”](#getparameters-2) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-2) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-2) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-2) > **path**: `object` ##### get.parameters.path.brex\_id [Section titled “get.parameters.path.brex\_id”](#getparameterspathbrex_id) > **brex\_id**: `string` ###### Description [Section titled “Description”](#description-68) The field value ID (`brex_id`) to retrieve. ###### Example [Section titled “Example”](#example-13) ```ts efo_foobar ``` ##### get.parameters.path.field\_id [Section titled “get.parameters.path.field\_id”](#getparameterspathfield_id-1) > **field\_id**: `string` ###### Description [Section titled “Description”](#description-69) The Field Brex identifier ###### Example [Section titled “Example”](#example-14) ```ts extended_field_foobar ``` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-2) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-2) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-2) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-70) Get a field value response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-2) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-2) > **application/json**: `object` ##### get.responses.200.content.application/json.brex\_id [Section titled “get.responses.200.content.application/json.brex\_id”](#getresponses200contentapplicationjsonbrex_id) > **brex\_id**: `string` ###### Description [Section titled “Description”](#description-71) The internal Brex ID of the field value ###### Example [Section titled “Example”](#example-15) ```ts efo_foobar ``` ##### get.responses.200.content.application/json.field\_id [Section titled “get.responses.200.content.application/json.field\_id”](#getresponses200contentapplicationjsonfield_id) > **field\_id**: `string` ###### Description [Section titled “Description”](#description-72) The ID of the parent field this value belongs to ###### Example [Section titled “Example”](#example-16) ```ts extended_field_foobar ``` ##### get.responses.200.content.application/json.is\_disabled [Section titled “get.responses.200.content.application/json.is\_disabled”](#getresponses200contentapplicationjsonis_disabled) > **is\_disabled**: `boolean` ###### Description [Section titled “Description”](#description-73) Indicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected. ##### get.responses.200.content.application/json.remote\_id? [Section titled “get.responses.200.content.application/json.remote\_id?”](#getresponses200contentapplicationjsonremote_id) > `optional` **remote\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-74) Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example-17) ```ts foo_bar ``` ##### get.responses.200.content.application/json.updated\_at [Section titled “get.responses.200.content.application/json.updated\_at”](#getresponses200contentapplicationjsonupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-75) The last updated timestamp of the field value ##### get.responses.200.content.application/json.value [Section titled “get.responses.200.content.application/json.value”](#getresponses200contentapplicationjsonvalue) > **value**: `string` ###### Description [Section titled “Description”](#description-76) The display name of the field value ##### get.responses.200.content.application/json.value\_id? [Section titled “get.responses.200.content.application/json.value\_id?”](#getresponses200contentapplicationjsonvalue_id) > `optional` **value\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-77) The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system ###### Example [Section titled “Example”](#example-18) ```ts foo_bar ``` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-34) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-2) > **400**: `object` ###### Description [Section titled “Description”](#description-78) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-2) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-35) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-2) > **401**: `object` ###### Description [Section titled “Description”](#description-79) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-2) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-36) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-2) > **403**: `object` ###### Description [Section titled “Description”](#description-80) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-2) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-37) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-81) Not found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-38) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-2) > **500**: `object` ###### Description [Section titled “Description”](#description-82) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-2) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-39) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-2) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-2) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-2) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-2) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-2) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-2) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-2) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-2) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-2) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-2) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-2) > `optional` **trace?**: `undefined` *** ### /v1/fields/{id} [Section titled “/v1/fields/{id}”](#v1fieldsid) > **/v1/fields/{id}**: `object` Defined in: [src/fields/types.gen.ts:79](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L79) #### delete [Section titled “delete”](#delete-3) > **delete**: `object` Delete a custom field ##### Description [Section titled “Description”](#description-83) Delete a custom field by Brex ID ##### delete.parameters [Section titled “delete.parameters”](#deleteparameters-1) > **parameters**: `object` ##### delete.parameters.cookie? [Section titled “delete.parameters.cookie?”](#deleteparameterscookie-1) > `optional` **cookie?**: `undefined` ##### delete.parameters.header? [Section titled “delete.parameters.header?”](#deleteparametersheader-1) > `optional` **header?**: `undefined` ##### delete.parameters.path [Section titled “delete.parameters.path”](#deleteparameterspath-1) > **path**: `object` ##### delete.parameters.path.id [Section titled “delete.parameters.path.id”](#deleteparameterspathid) > **id**: `string` ###### Description [Section titled “Description”](#description-84) The Brex identifier of the field to delete ###### Example [Section titled “Example”](#example-19) ```ts extended_field_foobar ``` ##### delete.parameters.query? [Section titled “delete.parameters.query?”](#deleteparametersquery-1) > `optional` **query?**: `undefined` ##### delete.requestBody? [Section titled “delete.requestBody?”](#deleterequestbody-1) > `optional` **requestBody?**: `undefined` ##### delete.responses [Section titled “delete.responses”](#deleteresponses-1) > **responses**: `object` ##### delete.responses.200 [Section titled “delete.responses.200”](#deleteresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-85) Delete custom field response ##### delete.responses.200.content? [Section titled “delete.responses.200.content?”](#deleteresponses200content-1) > `optional` **content?**: `undefined` ##### delete.responses.200.headers [Section titled “delete.responses.200.headers”](#deleteresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-40) \[`name`: `string`]: `unknown` ##### delete.responses.400 [Section titled “delete.responses.400”](#deleteresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-86) Bad request ##### delete.responses.400.content? [Section titled “delete.responses.400.content?”](#deleteresponses400content-1) > `optional` **content?**: `undefined` ##### delete.responses.400.headers [Section titled “delete.responses.400.headers”](#deleteresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-41) \[`name`: `string`]: `unknown` ##### delete.responses.401 [Section titled “delete.responses.401”](#deleteresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-87) Unauthorized ##### delete.responses.401.content? [Section titled “delete.responses.401.content?”](#deleteresponses401content-1) > `optional` **content?**: `undefined` ##### delete.responses.401.headers [Section titled “delete.responses.401.headers”](#deleteresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-42) \[`name`: `string`]: `unknown` ##### delete.responses.403 [Section titled “delete.responses.403”](#deleteresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-88) Forbidden ##### delete.responses.403.content? [Section titled “delete.responses.403.content?”](#deleteresponses403content-1) > `optional` **content?**: `undefined` ##### delete.responses.403.headers [Section titled “delete.responses.403.headers”](#deleteresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-43) \[`name`: `string`]: `unknown` ##### delete.responses.404 [Section titled “delete.responses.404”](#deleteresponses404-1) > **404**: `object` ###### Description [Section titled “Description”](#description-89) Not found ##### delete.responses.404.content? [Section titled “delete.responses.404.content?”](#deleteresponses404content-1) > `optional` **content?**: `undefined` ##### delete.responses.404.headers [Section titled “delete.responses.404.headers”](#deleteresponses404headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-44) \[`name`: `string`]: `unknown` ##### delete.responses.500 [Section titled “delete.responses.500”](#deleteresponses500-1) > **500**: `object` ###### Description [Section titled “Description”](#description-90) Internal server error ##### delete.responses.500.content? [Section titled “delete.responses.500.content?”](#deleteresponses500content-1) > `optional` **content?**: `undefined` ##### delete.responses.500.headers [Section titled “delete.responses.500.headers”](#deleteresponses500headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-45) \[`name`: `string`]: `unknown` #### get [Section titled “get”](#get-3) > **get**: `object` Get custom field ##### Description [Section titled “Description”](#description-91) Get a custom field by Brex ID ##### get.parameters [Section titled “get.parameters”](#getparameters-3) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-3) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-3) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-3) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid) > **id**: `string` ###### Description [Section titled “Description”](#description-92) The Brex identifier of the field to retrieve ###### Example [Section titled “Example”](#example-20) ```ts extended_field_foobar ``` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-3) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-3) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-3) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-3) > **200**: `object` ###### Description [Section titled “Description”](#description-93) Get custom field response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-3) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-3) > **application/json**: `object` ##### get.responses.200.content.application/json.brex\_id [Section titled “get.responses.200.content.application/json.brex\_id”](#getresponses200contentapplicationjsonbrex_id-1) > **brex\_id**: `string` ###### Description [Section titled “Description”](#description-94) The internal Brex ID of the field ###### Example [Section titled “Example”](#example-21) ```ts extended_field_foobar ``` ##### get.responses.200.content.application/json.group? [Section titled “get.responses.200.content.application/json.group?”](#getresponses200contentapplicationjsongroup) > `optional` **group?**: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` | `null` ##### get.responses.200.content.application/json.is\_disabled [Section titled “get.responses.200.content.application/json.is\_disabled”](#getresponses200contentapplicationjsonis_disabled-1) > **is\_disabled**: `boolean` ###### Description [Section titled “Description”](#description-95) Indicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected. ##### get.responses.200.content.application/json.name [Section titled “get.responses.200.content.application/json.name”](#getresponses200contentapplicationjsonname) > **name**: `string` | `null` ###### Description [Section titled “Description”](#description-96) The name of the field ##### get.responses.200.content.application/json.remote\_id? [Section titled “get.responses.200.content.application/json.remote\_id?”](#getresponses200contentapplicationjsonremote_id-1) > `optional` **remote\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-97) Remote/external ID of custom field from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example-22) ```ts foo_bar ``` ##### get.responses.200.content.application/json.updated\_at [Section titled “get.responses.200.content.application/json.updated\_at”](#getresponses200contentapplicationjsonupdated_at-1) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-98) The last updated timestamp of the field ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-46) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-3) > **400**: `object` ###### Description [Section titled “Description”](#description-99) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-3) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-47) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-3) > **401**: `object` ###### Description [Section titled “Description”](#description-100) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-3) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-48) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-3) > **403**: `object` ###### Description [Section titled “Description”](#description-101) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-3) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-49) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404-1) > **404**: `object` ###### Description [Section titled “Description”](#description-102) Not found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content-1) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-50) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-3) > **500**: `object` ###### Description [Section titled “Description”](#description-103) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-3) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-51) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-3) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-3) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-3) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-3) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-3) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-3) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-3) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-3) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-3) > `optional` **post?**: `undefined` #### put [Section titled “put”](#put-3) > **put**: `object` Update a custom field ##### Description [Section titled “Description”](#description-104) Update a field by ID ##### put.parameters [Section titled “put.parameters”](#putparameters-1) > **parameters**: `object` ##### put.parameters.cookie? [Section titled “put.parameters.cookie?”](#putparameterscookie-1) > `optional` **cookie?**: `undefined` ##### put.parameters.header? [Section titled “put.parameters.header?”](#putparametersheader-1) > `optional` **header?**: `undefined` ##### put.parameters.path [Section titled “put.parameters.path”](#putparameterspath-1) > **path**: `object` ##### put.parameters.path.id [Section titled “put.parameters.path.id”](#putparameterspathid) > **id**: `string` ###### Description [Section titled “Description”](#description-105) The Brex identifier of the field to update ###### Example [Section titled “Example”](#example-23) ```ts extended_field_foobar ``` ##### put.parameters.query? [Section titled “put.parameters.query?”](#putparametersquery-1) > `optional` **query?**: `undefined` ##### put.requestBody [Section titled “put.requestBody”](#putrequestbody-1) > **requestBody**: `object` ##### put.requestBody.content [Section titled “put.requestBody.content”](#putrequestbodycontent-1) > **content**: `object` ##### put.requestBody.content.application/json [Section titled “put.requestBody.content.application/json”](#putrequestbodycontentapplicationjson-1) > **application/json**: `object` ##### put.requestBody.content.application/json.is\_disabled? [Section titled “put.requestBody.content.application/json.is\_disabled?”](#putrequestbodycontentapplicationjsonis_disabled) > `optional` **is\_disabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-106) Indicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected. ##### put.requestBody.content.application/json.name? [Section titled “put.requestBody.content.application/json.name?”](#putrequestbodycontentapplicationjsonname) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-107) The name of the field ##### put.responses [Section titled “put.responses”](#putresponses-1) > **responses**: `object` ##### put.responses.200 [Section titled “put.responses.200”](#putresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-108) Update custom field response ##### put.responses.200.content [Section titled “put.responses.200.content”](#putresponses200content-1) > **content**: `object` ##### put.responses.200.content.application/json [Section titled “put.responses.200.content.application/json”](#putresponses200contentapplicationjson-1) > **application/json**: `object` ##### put.responses.200.content.application/json.brex\_id [Section titled “put.responses.200.content.application/json.brex\_id”](#putresponses200contentapplicationjsonbrex_id) > **brex\_id**: `string` ###### Description [Section titled “Description”](#description-109) The internal Brex ID of the field ###### Example [Section titled “Example”](#example-24) ```ts extended_field_foobar ``` ##### put.responses.200.content.application/json.group? [Section titled “put.responses.200.content.application/json.group?”](#putresponses200contentapplicationjsongroup) > `optional` **group?**: `"TRAVEL"` | `"ACCOUNTING"` | `"USER"` | `"ERP"` | `null` ##### put.responses.200.content.application/json.is\_disabled [Section titled “put.responses.200.content.application/json.is\_disabled”](#putresponses200contentapplicationjsonis_disabled) > **is\_disabled**: `boolean` ###### Description [Section titled “Description”](#description-110) Indicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected. ##### put.responses.200.content.application/json.name [Section titled “put.responses.200.content.application/json.name”](#putresponses200contentapplicationjsonname) > **name**: `string` | `null` ###### Description [Section titled “Description”](#description-111) The name of the field ##### put.responses.200.content.application/json.remote\_id? [Section titled “put.responses.200.content.application/json.remote\_id?”](#putresponses200contentapplicationjsonremote_id) > `optional` **remote\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-112) Remote/external ID of custom field from external system (e.g. ERP or HRIS system) ###### Example [Section titled “Example”](#example-25) ```ts foo_bar ``` ##### put.responses.200.content.application/json.updated\_at [Section titled “put.responses.200.content.application/json.updated\_at”](#putresponses200contentapplicationjsonupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-113) The last updated timestamp of the field ##### put.responses.200.headers [Section titled “put.responses.200.headers”](#putresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-52) \[`name`: `string`]: `unknown` ##### put.responses.400 [Section titled “put.responses.400”](#putresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-114) Bad request ##### put.responses.400.content? [Section titled “put.responses.400.content?”](#putresponses400content-1) > `optional` **content?**: `undefined` ##### put.responses.400.headers [Section titled “put.responses.400.headers”](#putresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-53) \[`name`: `string`]: `unknown` ##### put.responses.401 [Section titled “put.responses.401”](#putresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-115) Unauthorized ##### put.responses.401.content? [Section titled “put.responses.401.content?”](#putresponses401content-1) > `optional` **content?**: `undefined` ##### put.responses.401.headers [Section titled “put.responses.401.headers”](#putresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-54) \[`name`: `string`]: `unknown` ##### put.responses.403 [Section titled “put.responses.403”](#putresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-116) Forbidden ##### put.responses.403.content? [Section titled “put.responses.403.content?”](#putresponses403content-1) > `optional` **content?**: `undefined` ##### put.responses.403.headers [Section titled “put.responses.403.headers”](#putresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-55) \[`name`: `string`]: `unknown` ##### put.responses.404 [Section titled “put.responses.404”](#putresponses404-1) > **404**: `object` ###### Description [Section titled “Description”](#description-117) Not found ##### put.responses.404.content? [Section titled “put.responses.404.content?”](#putresponses404content-1) > `optional` **content?**: `undefined` ##### put.responses.404.headers [Section titled “put.responses.404.headers”](#putresponses404headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-56) \[`name`: `string`]: `unknown` ##### put.responses.500 [Section titled “put.responses.500”](#putresponses500-1) > **500**: `object` ###### Description [Section titled “Description”](#description-118) Internal server error ##### put.responses.500.content? [Section titled “put.responses.500.content?”](#putresponses500content-1) > `optional` **content?**: `undefined` ##### put.responses.500.headers [Section titled “put.responses.500.headers”](#putresponses500headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-57) \[`name`: `string`]: `unknown` #### trace? [Section titled “trace?”](#trace-3) > `optional` **trace?**: `undefined` # CreateFieldValueBody > **CreateFieldValueBody** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"CreateFieldValueBody"`] Defined in: [src/fields/schemas.gen.ts:5](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L5) # CreateFieldValueListBody > **CreateFieldValueListBody** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"CreateFieldValueListBody"`] Defined in: [src/fields/schemas.gen.ts:6](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L6) # CreateFieldValueListResponse > **CreateFieldValueListResponse** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"CreateFieldValueListResponse"`] Defined in: [src/fields/schemas.gen.ts:7](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L7) # DeletedFieldValueListResponse > **DeletedFieldValueListResponse** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"DeletedFieldValueListResponse"`] Defined in: [src/fields/schemas.gen.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L13) # DeleteFieldValue_ByBrexId > **DeleteFieldValue\_ByBrexId** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"DeleteFieldValue.ByBrexId"`] Defined in: [src/fields/schemas.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L8) # DeleteFieldValue_ByRemoteId > **DeleteFieldValue\_ByRemoteId** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"DeleteFieldValue.ByRemoteId"`] Defined in: [src/fields/schemas.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L9) # DeleteFieldValue_ByValueId > **DeleteFieldValue\_ByValueId** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"DeleteFieldValue.ByValueId"`] Defined in: [src/fields/schemas.gen.ts:10](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L10) # DeleteFieldValueBody > **DeleteFieldValueBody** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"DeleteFieldValueBody"`] Defined in: [src/fields/schemas.gen.ts:11](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L11) # DeleteFieldValueListBody > **DeleteFieldValueListBody** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"DeleteFieldValueListBody"`] Defined in: [src/fields/schemas.gen.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L12) # Field > **Field** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"Field"`] Defined in: [src/fields/schemas.gen.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L14) # FieldCreateBody > **FieldCreateBody** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"FieldCreateBody"`] Defined in: [src/fields/schemas.gen.ts:15](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L15) # FieldGroup > **FieldGroup** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"FieldGroup"`] Defined in: [src/fields/schemas.gen.ts:16](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L16) # FieldUpdateBody > **FieldUpdateBody** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"FieldUpdateBody"`] Defined in: [src/fields/schemas.gen.ts:17](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L17) # FieldValue > **FieldValue** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"FieldValue"`] Defined in: [src/fields/schemas.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L18) # Page_Field_ > **Page\_Field\_** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"Page_Field_"`] Defined in: [src/fields/schemas.gen.ts:20](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L20) # Page_FieldValue_ > **Page\_FieldValue\_** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"Page_FieldValue_"`] Defined in: [src/fields/schemas.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L19) # UpdateFieldValue_ByBrexId > **UpdateFieldValue\_ByBrexId** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"UpdateFieldValue.ByBrexId"`] Defined in: [src/fields/schemas.gen.ts:21](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L21) # UpdateFieldValue_ByRemoteId > **UpdateFieldValue\_ByRemoteId** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"UpdateFieldValue.ByRemoteId"`] Defined in: [src/fields/schemas.gen.ts:22](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L22) # UpdateFieldValue_ByValueId > **UpdateFieldValue\_ByValueId** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"UpdateFieldValue.ByValueId"`] Defined in: [src/fields/schemas.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L23) # UpdateFieldValueBody > **UpdateFieldValueBody** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"UpdateFieldValueBody"`] Defined in: [src/fields/schemas.gen.ts:24](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L24) # UpdateFieldValueDataBody > **UpdateFieldValueDataBody** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"UpdateFieldValueDataBody"`] Defined in: [src/fields/schemas.gen.ts:25](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L25) # UpdateFieldValueListBody > **UpdateFieldValueListBody** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"UpdateFieldValueListBody"`] Defined in: [src/fields/schemas.gen.ts:26](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L26) # UpdateFieldValueListResponse > **UpdateFieldValueListResponse** = [`FieldsComponents`](/brex/api/fields/interfaces/fieldscomponents/)\[`"schemas"`]\[`"UpdateFieldValueListResponse"`] Defined in: [src/fields/schemas.gen.ts:27](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/schemas.gen.ts#L27) # Brex Defined in: [src/index.ts:32](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L32) Unified client covering every Brex API. Importing `Brex` pulls in all ten API surfaces; if bundle size matters, import a single API from its subpath instead (e.g. `brex/payments`). ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Brex**(`options`): `Brex` Defined in: [src/index.ts:61](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L61) #### Parameters [Section titled “Parameters”](#parameters) ##### options [Section titled “options”](#options) [`BrexOptions`](/brex/api/index/interfaces/brexoptions/) #### Returns [Section titled “Returns”](#returns) `Brex` ## Properties [Section titled “Properties”](#properties) ### accountingIntegrations [Section titled “accountingIntegrations”](#accountingintegrations) > `readonly` **accountingIntegrations**: [`AccountingIntegrations`](/brex/api/accounting/classes/accountingintegrations/) Defined in: [src/index.ts:33](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L33) *** ### accountingRecords [Section titled “accountingRecords”](#accountingrecords) > `readonly` **accountingRecords**: [`AccountingRecords`](/brex/api/accounting/classes/accountingrecords/) Defined in: [src/index.ts:34](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L34) *** ### accounts [Section titled “accounts”](#accounts) > `readonly` **accounts**: [`Accounts`](/brex/api/transactions/classes/accounts/) Defined in: [src/index.ts:35](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L35) *** ### budgetPrograms [Section titled “budgetPrograms”](#budgetprograms) > `readonly` **budgetPrograms**: [`BudgetPrograms`](/brex/api/budgets/classes/budgetprograms/) Defined in: [src/index.ts:36](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L36) *** ### budgets [Section titled “budgets”](#budgets) > `readonly` **budgets**: [`Budgets`](/brex/api/budgets/classes/budgets/) Defined in: [src/index.ts:37](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L37) *** ### budgetsV1 [Section titled “budgetsV1”](#budgetsv1) > `readonly` **budgetsV1**: [`BudgetsV1`](/brex/api/budgets/classes/budgetsv1/) Defined in: [src/index.ts:38](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L38) *** ### cardExpenses [Section titled “cardExpenses”](#cardexpenses) > `readonly` **cardExpenses**: [`CardExpenses`](/brex/api/expenses/classes/cardexpenses/) Defined in: [src/index.ts:39](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L39) *** ### cards [Section titled “cards”](#cards) > `readonly` **cards**: [`Cards`](/brex/api/team/classes/cards/) Defined in: [src/index.ts:40](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L40) *** ### companies [Section titled “companies”](#companies) > `readonly` **companies**: [`Companies`](/brex/api/team/classes/companies/) Defined in: [src/index.ts:41](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L41) *** ### departments [Section titled “departments”](#departments) > `readonly` **departments**: [`Departments`](/brex/api/team/classes/departments/) Defined in: [src/index.ts:42](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L42) *** ### expenses [Section titled “expenses”](#expenses) > `readonly` **expenses**: [`Expenses`](/brex/api/expenses/classes/expenses/) Defined in: [src/index.ts:43](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L43) *** ### fields [Section titled “fields”](#fields) > `readonly` **fields**: [`Fields`](/brex/api/fields/classes/fields/) Defined in: [src/index.ts:44](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L44) *** ### fieldValues [Section titled “fieldValues”](#fieldvalues) > `readonly` **fieldValues**: [`FieldValues`](/brex/api/fields/classes/fieldvalues/) Defined in: [src/index.ts:45](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L45) *** ### legalEntities [Section titled “legalEntities”](#legalentities) > `readonly` **legalEntities**: [`LegalEntities`](/brex/api/team/classes/legalentities/) Defined in: [src/index.ts:46](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L46) *** ### linkedAccounts [Section titled “linkedAccounts”](#linkedaccounts) > `readonly` **linkedAccounts**: [`LinkedAccounts`](/brex/api/payments/classes/linkedaccounts/) Defined in: [src/index.ts:47](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L47) *** ### locations [Section titled “locations”](#locations) > `readonly` **locations**: [`Locations`](/brex/api/team/classes/locations/) Defined in: [src/index.ts:48](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L48) *** ### receipts [Section titled “receipts”](#receipts) > `readonly` **receipts**: [`Receipts`](/brex/api/expenses/classes/receipts/) Defined in: [src/index.ts:49](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L49) *** ### referrals [Section titled “referrals”](#referrals) > `readonly` **referrals**: [`Referrals`](/brex/api/onboarding/classes/referrals/) Defined in: [src/index.ts:50](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L50) *** ### spendLimits [Section titled “spendLimits”](#spendlimits) > `readonly` **spendLimits**: [`SpendLimits`](/brex/api/budgets/classes/spendlimits/) Defined in: [src/index.ts:51](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L51) *** ### titles [Section titled “titles”](#titles) > `readonly` **titles**: [`Titles`](/brex/api/team/classes/titles/) Defined in: [src/index.ts:52](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L52) *** ### transactions [Section titled “transactions”](#transactions) > `readonly` **transactions**: [`Transactions`](/brex/api/transactions/classes/transactions/) Defined in: [src/index.ts:53](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L53) *** ### transfers [Section titled “transfers”](#transfers) > `readonly` **transfers**: [`Transfers`](/brex/api/payments/classes/transfers/) Defined in: [src/index.ts:54](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L54) *** ### trips [Section titled “trips”](#trips) > `readonly` **trips**: [`Trips`](/brex/api/travel/classes/trips/) Defined in: [src/index.ts:55](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L55) *** ### users [Section titled “users”](#users) > `readonly` **users**: [`Users`](/brex/api/team/classes/users/) Defined in: [src/index.ts:56](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L56) *** ### vendors [Section titled “vendors”](#vendors) > `readonly` **vendors**: [`Vendors`](/brex/api/payments/classes/vendors/) Defined in: [src/index.ts:57](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L57) *** ### webhookGroups [Section titled “webhookGroups”](#webhookgroups) > `readonly` **webhookGroups**: [`WebhookGroups`](/brex/api/webhooks/classes/webhookgroups/) Defined in: [src/index.ts:58](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L58) *** ### webhooks [Section titled “webhooks”](#webhooks) > `readonly` **webhooks**: [`Webhooks`](/brex/api/webhooks/classes/webhooks/) Defined in: [src/index.ts:59](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/index.ts#L59) # BrexCore Defined in: [src/core/client.ts:35](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L35) The shared HTTP engine behind every generated resource class. Not part of the typed API surface — use the `Brex` class or a per-API client instead. ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BrexCore**(`options`): `BrexCore` Defined in: [src/core/client.ts:39](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L39) #### Parameters [Section titled “Parameters”](#parameters) ##### options [Section titled “options”](#options) [`BrexOptions`](/brex/api/index/interfaces/brexoptions/) #### Returns [Section titled “Returns”](#returns) `BrexCore` ## Methods [Section titled “Methods”](#methods) ### list() [Section titled “list()”](#list) > **list**<`P`>(`path`, `args?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<`P`> Defined in: [src/core/client.ts:91](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L91) #### Type Parameters [Section titled “Type Parameters”](#type-parameters) ##### P [Section titled “P”](#p) `P` *extends* [`PageShape`](/brex/api/index/interfaces/pageshape/) #### Parameters [Section titled “Parameters”](#parameters-1) ##### path [Section titled “path”](#path) `string` ##### args? [Section titled “args?”](#args) [`RequestArgs`](/brex/api/index/interfaces/requestargs/) = `{}` #### Returns [Section titled “Returns”](#returns-1) [`PagePromise`](/brex/api/index/classes/pagepromise/)<`P`> *** ### request() [Section titled “request()”](#request) > **request**<`T`>(`method`, `path`, `args?`): `Promise`<`T`> Defined in: [src/core/client.ts:50](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L50) #### Type Parameters [Section titled “Type Parameters”](#type-parameters-1) ##### T [Section titled “T”](#t) `T` #### Parameters [Section titled “Parameters”](#parameters-2) ##### method [Section titled “method”](#method) `string` ##### path [Section titled “path”](#path-1) `string` ##### args? [Section titled “args?”](#args-1) [`RequestArgs`](/brex/api/index/interfaces/requestargs/) = `{}` #### Returns [Section titled “Returns”](#returns-2) `Promise`<`T`> # BrexError Defined in: [src/core/error.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/error.ts#L2) Error thrown for any non-2xx Brex API response. ## Extends [Section titled “Extends”](#extends) * `Error` ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BrexError**(`args`): `BrexError` Defined in: [src/core/error.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/error.ts#L14) #### Parameters [Section titled “Parameters”](#parameters) ##### args [Section titled “args”](#args) ###### body [Section titled “body”](#body) `unknown` ###### headers [Section titled “headers”](#headers) `Headers` ###### method [Section titled “method”](#method) `string` ###### status [Section titled “status”](#status) `number` ###### url [Section titled “url”](#url) `string` #### Returns [Section titled “Returns”](#returns) `BrexError` #### Overrides [Section titled “Overrides”](#overrides) `Error.constructor` ## Properties [Section titled “Properties”](#properties) ### body [Section titled “body”](#body-1) > `readonly` **body**: `unknown` Defined in: [src/core/error.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/error.ts#L8) Parsed JSON error body when the response was JSON, otherwise the raw text. *** ### cause? [Section titled “cause?”](#cause) > `optional` **cause?**: `unknown` Defined in: docs/node\_modules/typescript/lib/lib.es2022.error.d.ts:26 #### Inherited from [Section titled “Inherited from”](#inherited-from) `Error.cause` *** ### headers [Section titled “headers”](#headers-1) > `readonly` **headers**: `Headers` Defined in: [src/core/error.ts:10](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/error.ts#L10) Full response headers, as an escape hatch. *** ### message [Section titled “message”](#message) > **message**: `string` Defined in: docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 #### Inherited from [Section titled “Inherited from”](#inherited-from-1) `Error.message` *** ### method [Section titled “method”](#method-1) > `readonly` **method**: `string` Defined in: [src/core/error.ts:11](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/error.ts#L11) *** ### name [Section titled “name”](#name) > **name**: `string` Defined in: docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 #### Inherited from [Section titled “Inherited from”](#inherited-from-2) `Error.name` *** ### requestId [Section titled “requestId”](#requestid) > `readonly` **requestId**: `string` | `undefined` Defined in: [src/core/error.ts:6](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/error.ts#L6) Brex request id (from the `x-request-id` response header), if present. *** ### stack? [Section titled “stack?”](#stack) > `optional` **stack?**: `string` Defined in: docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 #### Inherited from [Section titled “Inherited from”](#inherited-from-3) `Error.stack` *** ### status [Section titled “status”](#status-1) > `readonly` **status**: `number` Defined in: [src/core/error.ts:4](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/error.ts#L4) HTTP status code. *** ### url [Section titled “url”](#url-1) > `readonly` **url**: `string` Defined in: [src/core/error.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/error.ts#L12) # PagePromise Defined in: [src/core/pagination.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/pagination.ts#L19) Return type of every paginated SDK method — both a promise and an iterator: * `await client.vendors.list()` → the first page; * `for await (const vendor of client.vendors.list())` → every item, across pages, following `next_cursor` automatically; * `for await (const page of client.vendors.list().pages())` → page-by-page. Each `await`/iteration starts its own request(s). ## Type Parameters [Section titled “Type Parameters”](#type-parameters) ### P [Section titled “P”](#p) `P` *extends* [`PageShape`](/brex/api/index/interfaces/pageshape/) ## Implements [Section titled “Implements”](#implements) * `PromiseLike`<`P`> * `AsyncIterable`<[`PageItem`](/brex/api/index/type-aliases/pageitem/)<`P`>> ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new PagePromise**<`P`>(`fetchPage`): `PagePromise`<`P`> Defined in: [src/core/pagination.ts:24](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/pagination.ts#L24) #### Parameters [Section titled “Parameters”](#parameters) ##### fetchPage [Section titled “fetchPage”](#fetchpage) (`cursor?`) => `Promise`<`P`> #### Returns [Section titled “Returns”](#returns) `PagePromise`<`P`> ## Methods [Section titled “Methods”](#methods) ### \[asyncIterator]\() [Section titled “\[asyncIterator\]()”](#asynciterator) > **\[asyncIterator]**(): `AsyncGenerator`<[`PageItem`](/brex/api/index/type-aliases/pageitem/)<`P`>, `void`, `undefined`> Defined in: [src/core/pagination.ts:47](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/pagination.ts#L47) Iterate every item across all pages. #### Returns [Section titled “Returns”](#returns-1) `AsyncGenerator`<[`PageItem`](/brex/api/index/type-aliases/pageitem/)<`P`>, `void`, `undefined`> #### Implementation of [Section titled “Implementation of”](#implementation-of) `AsyncIterable.[asyncIterator]` *** ### pages() [Section titled “pages()”](#pages) > **pages**(): `AsyncGenerator`<`P`, `void`, `undefined`> Defined in: [src/core/pagination.ts:37](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/pagination.ts#L37) Iterate page-by-page, following `next_cursor` until exhausted. #### Returns [Section titled “Returns”](#returns-2) `AsyncGenerator`<`P`, `void`, `undefined`> *** ### then() [Section titled “then()”](#then) > **then**<`TResult1`, `TResult2`>(`onfulfilled?`, `onrejected?`): `Promise`<`TResult1` | `TResult2`> Defined in: [src/core/pagination.ts:29](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/pagination.ts#L29) Attaches callbacks for the resolution and/or rejection of the Promise. #### Type Parameters [Section titled “Type Parameters”](#type-parameters-1) ##### TResult1 [Section titled “TResult1”](#tresult1) `TResult1` = `P` ##### TResult2 [Section titled “TResult2”](#tresult2) `TResult2` = `never` #### Parameters [Section titled “Parameters”](#parameters-1) ##### onfulfilled? [Section titled “onfulfilled?”](#onfulfilled) ((`value`) => `TResult1` | `PromiseLike`<`TResult1`>) | `null` The callback to execute when the Promise is resolved. ##### onrejected? [Section titled “onrejected?”](#onrejected) ((`reason`) => `TResult2` | `PromiseLike`<`TResult2`>) | `null` The callback to execute when the Promise is rejected. #### Returns [Section titled “Returns”](#returns-3) `Promise`<`TResult1` | `TResult2`> A Promise for the completion of which ever callback is executed. #### Implementation of [Section titled “Implementation of”](#implementation-of-1) `PromiseLike.then` # serializeQuery > **serializeQuery**(`query`): `string` Defined in: [src/core/query.ts:6](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/query.ts#L6) Serializes query params the way the Brex API expects (`form` + `explode`): arrays repeat their key verbatim per element — bracket-style names like `expand[]` are part of the parameter name, never synthesized. ## Parameters [Section titled “Parameters”](#parameters) ### query [Section titled “query”](#query) `Record`<`string`, `unknown`> | `undefined` ## Returns [Section titled “Returns”](#returns) `string` # BrexOptions Defined in: [src/core/options.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/options.ts#L2) Options for constructing a Brex client. ## Properties [Section titled “Properties”](#properties) ### baseUrl? [Section titled “baseUrl?”](#baseurl) > `optional` **baseUrl?**: `string` & `object` | `"production"` | `"staging"` Defined in: [src/core/options.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/options.ts#L12) `"production"` (default), `"staging"`, or any absolute base URL. Note: staging is not a sandbox; it does not accept customer tokens. *** ### defaultHeaders? [Section titled “defaultHeaders?”](#defaultheaders) > `optional` **defaultHeaders?**: `Record`<`string`, `string`> Defined in: [src/core/options.ts:16](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/options.ts#L16) Headers merged into every request (per-request headers win). *** ### fetch? [Section titled “fetch?”](#fetch) > `optional` **fetch?**: (`input`, `init?`) => `Promise`<`Response`> Defined in: [src/core/options.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/options.ts#L14) Injectable fetch for tests, proxies, or custom retry layers. Defaults to global fetch. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch) #### Parameters [Section titled “Parameters”](#parameters) ##### input [Section titled “input”](#input) `RequestInfo` | `URL` ##### init? [Section titled “init?”](#init) `RequestInit` #### Returns [Section titled “Returns”](#returns) `Promise`<`Response`> *** ### token [Section titled “token”](#token) > **token**: `string` | (() => `string` | `Promise`<`string`>) Defined in: [src/core/options.ts:7](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/options.ts#L7) A Brex API token, or a provider called before every request — useful for OAuth flows where tokens refresh. # PageShape Defined in: [src/core/pagination.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/pagination.ts#L2) The cursor envelope shared by every paginated Brex endpoint. ## Properties [Section titled “Properties”](#properties) ### items? [Section titled “items?”](#items) > `optional` **items?**: readonly `unknown`\[] Defined in: [src/core/pagination.ts:4](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/pagination.ts#L4) *** ### next\_cursor? [Section titled “next\_cursor?”](#next_cursor) > `optional` **next\_cursor?**: `string` | `null` Defined in: [src/core/pagination.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/pagination.ts#L3) # RequestArgs Defined in: [src/core/client.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L14) ## Properties [Section titled “Properties”](#properties) ### body? [Section titled “body?”](#body) > `optional` **body?**: `unknown` Defined in: [src/core/client.ts:15](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L15) *** ### idempotency? [Section titled “idempotency?”](#idempotency) > `optional` **idempotency?**: [`Idempotency`](/brex/api/index/type-aliases/idempotency/) Defined in: [src/core/client.ts:17](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L17) *** ### options? [Section titled “options?”](#options) > `optional` **options?**: [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) Defined in: [src/core/client.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L18) *** ### query? [Section titled “query?”](#query) > `optional` **query?**: `Record`<`string`, `unknown`> Defined in: [src/core/client.ts:16](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L16) # RequestOptions Defined in: [src/core/options.ts:20](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/options.ts#L20) Per-request options accepted by every SDK method. ## Properties [Section titled “Properties”](#properties) ### headers? [Section titled “headers?”](#headers) > `optional` **headers?**: `Record`<`string`, `string`> Defined in: [src/core/options.ts:22](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/options.ts#L22) Extra headers for this request (override defaults). *** ### idempotencyKey? [Section titled “idempotencyKey?”](#idempotencykey) > `optional` **idempotencyKey?**: `string` Defined in: [src/core/options.ts:30](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/options.ts#L30) Idempotency-Key header value. Where Brex requires one (most creates) and none is given, a random UUID is generated for you — pass your own to make retries of *your* operation idempotent. *** ### signal? [Section titled “signal?”](#signal) > `optional` **signal?**: `AbortSignal` Defined in: [src/core/options.ts:24](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/options.ts#L24) Abort/timeout control, e.g. `AbortSignal.timeout(10_000)`. # Idempotency > **Idempotency** = `"required"` | `"optional"` | `"none"` Defined in: [src/core/client.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L12) Whether the operation’s spec declares an Idempotency-Key header, and if it’s required. # PageItem > **PageItem**<`P`> = `NonNullable`<`P`\[`"items"`]>\[`number`] Defined in: [src/core/pagination.ts:7](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/pagination.ts#L7) ## Type Parameters [Section titled “Type Parameters”](#type-parameters) ### P [Section titled “P”](#p) `P` *extends* [`PageShape`](/brex/api/index/interfaces/pageshape/) # BrexOnboarding Defined in: [src/onboarding/client.gen.ts:117](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/client.gen.ts#L117) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BrexOnboarding**(`core`): `BrexOnboarding` Defined in: [src/onboarding/client.gen.ts:119](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/client.gen.ts#L119) #### Parameters [Section titled “Parameters”](#parameters) ##### core [Section titled “core”](#core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `BrexOnboarding` ## Properties [Section titled “Properties”](#properties) ### referrals [Section titled “referrals”](#referrals) > `readonly` **referrals**: [`Referrals`](/brex/api/onboarding/classes/referrals/) Defined in: [src/onboarding/client.gen.ts:118](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/client.gen.ts#L118) # Referrals Defined in: [src/onboarding/client.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/client.gen.ts#L8) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Referrals**(`_core`): `Referrals` Defined in: [src/onboarding/client.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/client.gen.ts#L9) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Referrals` ## Methods [Section titled “Methods”](#methods) ### createDocument() [Section titled “createDocument()”](#createdocument) > **createDocument**(`id`, `body`, `options?`): `Promise`<{ `id`: `string`; `uri`: `string`; }> Defined in: [src/onboarding/client.gen.ts:20](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/client.gen.ts#L20) Create a new document upload The `uri` will be a presigned S3 URL allowing you to upload the referral doc 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 use this to prefill the application. Refer to these [docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/PresignedUrlUploadObject.html) on how to upload to this presigned S3 URL. We highly recommend using one of AWS SDKs if they’re available for your language to upload these files. `POST /v1/referrals/{id}/document_upload` #### Parameters [Section titled “Parameters”](#parameters-1) ##### id [Section titled “id”](#id) `string` ##### body [Section titled “body”](#body) ###### type [Section titled “type”](#type) `"ARTICLES_OF_INCORPORATION"` | `"IRS_EIN_CONFIRMATION"` | `"IRS_EIN_APPLICATION"` | `"CERTIFICATE_GOOD_STANDING"` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `id`: `string`; `uri`: `string`; }> *** ### createRequest() [Section titled “createRequest()”](#createrequest) > **createRequest**(`body`, `options?`): `Promise`<{ `customer_email?`: `string` | `null`; `expires_at`: `string`; `id`: `string`; `products`: `object`\[]; `referral_signup_url`: `string`; `status`: `"ACTIVE"` | `"EXPIRED"` | `"CLOSED"` | `"UNCLAIMED"`; }> Defined in: [src/onboarding/client.gen.ts:41](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/client.gen.ts#L41) Creates a referral This creates new referrals. The response will contain an identifier and a unique personalized link to an application flow. Many fields are optional and when they’re provided they’ll prefill the application flow for Brex. You should handle and store these references securely as they contain sensitive information about the referral. `POST /v1/referrals` #### Parameters [Section titled “Parameters”](#parameters-2) ##### body [Section titled “body”](#body-1) ###### applicant [Section titled “applicant”](#applicant) { `email`: `string`; `first_name`: `string`; `last_name`: `string`; } ###### applicant.email [Section titled “applicant.email”](#applicantemail) `string` Format: email **Description** Business email of the applying customer. **Example** ```ts jane.smith@example.com ``` ###### applicant.first\_name [Section titled “applicant.first\_name”](#applicantfirst_name) `string` **Description** First name of the applying customer. **Example** ```ts Jane ``` ###### applicant.last\_name [Section titled “applicant.last\_name”](#applicantlast_name) `string` **Description** Last name of the applying customer. **Example** ```ts Smith ``` ###### business? [Section titled “business?”](#business) { `activity_description?`: `string` | `null`; `address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `alternate_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `beneficial_owners?`: `object`\[] | `null`; `employer_identification_number?`: `string` | `null`; `incorporation_state?`: `string` | `null`; `incorporation_type?`: `"C_CORP"` | `"S_CORP"` | `"B_CORP"` | `"LLC"` | `"LLP"` | `"SOLE_PROP"` | `"ORG_501C3"` | `"LP"` | `null`; `incorporation_year?`: `number` | `null`; `legal_name?`: `string` | `null`; `website_url?`: `string` | `null`; } | `null` ###### contact\_preference? [Section titled “contact\_preference?”](#contact_preference) `"NO_OUTBOUND"` | `"EMAIL_OUTBOUND"` | `null` ###### referral\_code [Section titled “referral\_code”](#referral_code) `string` **Description** Referral code that attributes credit to you if the prospect signs up for a Brex account. **Example** ```ts partner_abc123 ``` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `customer_email?`: `string` | `null`; `expires_at`: `string`; `id`: `string`; `products`: `object`\[]; `referral_signup_url`: `string`; `status`: `"ACTIVE"` | `"EXPIRED"` | `"CLOSED"` | `"UNCLAIMED"`; }> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `customer_email?`: `string` | `null`; `expires_at`: `string`; `id`: `string`; `products`: `object`\[]; `referral_signup_url`: `string`; `status`: `"ACTIVE"` | `"EXPIRED"` | `"CLOSED"` | `"UNCLAIMED"`; }> Defined in: [src/onboarding/client.gen.ts:59](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/client.gen.ts#L59) Gets a referral by ID Returns a referral object by ID if it exists. `GET /v1/referrals/{id}` #### Parameters [Section titled “Parameters”](#parameters-3) ##### id [Section titled “id”](#id-1) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `customer_email?`: `string` | `null`; `expires_at`: `string`; `id`: `string`; `products`: `object`\[]; `referral_signup_url`: `string`; `status`: `"ACTIVE"` | `"EXPIRED"` | `"CLOSED"` | `"UNCLAIMED"`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/onboarding/client.gen.ts:79](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/client.gen.ts#L79) List referrals Returns referrals created. *Note*: This doesn’t include referrals that have expired. `GET /v1/referrals` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-4) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### processDelayedEINDocument() [Section titled “processDelayedEINDocument()”](#processdelayedeindocument) > **processDelayedEINDocument**(`id`, `body`, `options?`): `Promise`<`void`> Defined in: [src/onboarding/client.gen.ts:102](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/client.gen.ts#L102) Process a delayed EIN document after upload Processes a delayed EIN document after it has been uploaded. This endpoint should be called after successfully uploading an IRS EIN Confirmation document (CP-575, CP-575 fax sheet, or 147C) using the standard document upload flow (`/v1/referrals/{id}/document_upload` with `type: IRS_EIN_CONFIRMATION`). The `document_id` should be the `id` returned from the document upload request. `POST /v1/referrals/{id}/process_ein_document` #### Parameters [Section titled “Parameters”](#parameters-5) ##### id [Section titled “id”](#id-2) `string` ##### body [Section titled “body”](#body-2) ###### document\_id [Section titled “document\_id”](#document_id) `string` **Description** The document ID returned from the initial document creation request ##### options? [Section titled “options?”](#options-4) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-5) `Promise`<`void`> # createOnboardingClient > **createOnboardingClient**(`options`): [`BrexOnboarding`](/brex/api/onboarding/classes/brexonboarding/) Defined in: [src/onboarding/index.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/index.ts#L13) Standalone client for the Brex Onboarding API. ## Parameters [Section titled “Parameters”](#parameters) ### options [Section titled “options”](#options) [`BrexOptions`](/brex/api/index/interfaces/brexoptions/) ## Returns [Section titled “Returns”](#returns) [`BrexOnboarding`](/brex/api/onboarding/classes/brexonboarding/) # OnboardingComponents Defined in: [src/onboarding/types.gen.ts:97](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L97) ## Properties [Section titled “Properties”](#properties) ### headers [Section titled “headers”](#headers) > **headers**: `never` Defined in: [src/onboarding/types.gen.ts:414](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L414) *** ### parameters [Section titled “parameters”](#parameters) > **parameters**: `never` Defined in: [src/onboarding/types.gen.ts:412](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L412) *** ### pathItems [Section titled “pathItems”](#pathitems) > **pathItems**: `never` Defined in: [src/onboarding/types.gen.ts:415](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L415) *** ### requestBodies [Section titled “requestBodies”](#requestbodies) > **requestBodies**: `never` Defined in: [src/onboarding/types.gen.ts:413](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L413) *** ### responses [Section titled “responses”](#responses) > **responses**: `never` Defined in: [src/onboarding/types.gen.ts:411](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L411) *** ### schemas [Section titled “schemas”](#schemas) > **schemas**: `object` Defined in: [src/onboarding/types.gen.ts:98](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L98) #### Account [Section titled “Account”](#account) > **Account**: `object` ##### Description [Section titled “Description”](#description) If the application status is ACTIVE, array of bank cash management accounts (note there is currently only one account per customer). ##### Account.created\_at [Section titled “Account.created\_at”](#accountcreated_at) > **created\_at**: `string` Format: date-time ##### Account.id [Section titled “Account.id”](#accountid) > **id**: `string` ###### Description [Section titled “Description”](#description-1) Brex Cash management account ID. ##### Account.instructions? [Section titled “Account.instructions?”](#accountinstructions) > `optional` **instructions?**: { `domestic`: { `account_type`: `string`; `bank_account_number`: `string`; `bank_address`: `string`; `bank_name`: `string`; `bank_routing_number`: `string`; `beneficiary_address`: `string`; `beneficiary_name`: `string`; }; `international`: { `account_type`: `string`; `bank_address`: `string`; `bank_name`: `string`; `beneficiary_address`: `string`; `beneficiary_name`: `string`; `special_instructions`: `string`; `swift_account_number`: `string`; `swift_bank_number`: `string`; }; } | `null` #### Address [Section titled “Address”](#address) > **Address**: `object` ##### Description [Section titled “Description”](#description-2) Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed). ##### Address.city? [Section titled “Address.city?”](#addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-3) City, district, suburb, town, or village. ##### Address.country? [Section titled “Address.country?”](#addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-4) Two-letter country code (ISO 3166-1 alpha-2). ##### Address.line1? [Section titled “Address.line1?”](#addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-5) Address line 1, no PO Box. ##### Address.line2? [Section titled “Address.line2?”](#addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-6) Address line 2 (e.g., apartment, suite, unit, or building). ##### Address.phone\_number? [Section titled “Address.phone\_number?”](#addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-7) Phone number. ##### Address.postal\_code? [Section titled “Address.postal\_code?”](#addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-8) ZIP or postal code. ##### Address.state? [Section titled “Address.state?”](#addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-9) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. #### Applicant [Section titled “Applicant”](#applicant) > **Applicant**: `object` ##### Description [Section titled “Description”](#description-10) Required information about the referred prospect. ##### Applicant.email [Section titled “Applicant.email”](#applicantemail) > **email**: `string` Format: email ###### Description [Section titled “Description”](#description-11) Business email of the applying customer. ###### Example [Section titled “Example”](#example) ```ts jane.smith@example.com ``` ##### Applicant.first\_name [Section titled “Applicant.first\_name”](#applicantfirst_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-12) First name of the applying customer. ###### Example [Section titled “Example”](#example-1) ```ts Jane ``` ##### Applicant.last\_name [Section titled “Applicant.last\_name”](#applicantlast_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-13) Last name of the applying customer. ###### Example [Section titled “Example”](#example-2) ```ts Smith ``` #### Application [Section titled “Application”](#application) > **Application**: `object` ##### Application.status [Section titled “Application.status”](#applicationstatus) > **status**: `"ACTIVE"` | `"PROCESSING"` | `"REJECTED"` | `"NO_ACCOUNT"` | `"NOT_SUBMITTED"` | `"INFORMATION_PENDING"` | `"MANUAL_REVIEW"` | `"CLOSED"` #### ApplicationStatus [Section titled “ApplicationStatus”](#applicationstatus-1) > **ApplicationStatus**: `"ACTIVE"` | `"PROCESSING"` | `"REJECTED"` | `"NO_ACCOUNT"` | `"NOT_SUBMITTED"` | `"INFORMATION_PENDING"` | `"MANUAL_REVIEW"` | `"CLOSED"` ##### Description [Section titled “Description”](#description-14) Application status of a product. ```plaintext `NO_ACCOUNT` - There is no active application, and the product account is not provisioned. `ACTIVE` - The application is approved, and the product account is provisioned. `NOT_SUBMITTED` - The application is started but not yet submitted. `INFORMATION_PENDING` - The application is submitted and additional information is requested. `MANUAL_REVIEW` - The application is under manual review. `PROCESSING` - The application is submitted and is under review. `REJECTED` - The application is rejected. `CLOSED` - The product account is closed. ``` #### BeneficialOwner [Section titled “BeneficialOwner”](#beneficialowner) > **BeneficialOwner**: `object` ##### Description [Section titled “Description”](#description-15) Federal law requires us to collect information for anyone who owns 25% or more of the company. ##### BeneficialOwner.address? [Section titled “BeneficialOwner.address?”](#beneficialowneraddress) > `optional` **address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-16) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-17) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-18) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-19) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-20) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-21) ZIP or postal code. ###### state? [Section titled “state?”](#state) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-22) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### BeneficialOwner.company\_relationship? [Section titled “BeneficialOwner.company\_relationship?”](#beneficialownercompany_relationship) > `optional` **company\_relationship?**: `"OTHER"` | `"FOUNDER"` | `"EXECUTIVE"` | `"SENIOR_LEADERSHIP"` | `null` ##### BeneficialOwner.date\_of\_birth? [Section titled “BeneficialOwner.date\_of\_birth?”](#beneficialownerdate_of_birth) > `optional` **date\_of\_birth?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-23) Date of birth. ##### BeneficialOwner.identity\_document? [Section titled “BeneficialOwner.identity\_document?”](#beneficialowneridentity_document) > `optional` **identity\_document?**: { `country`: `string`; `number`: `string`; `type`: `"SSN"` | `"PASSPORT"`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `country`: `string`; `number`: `string`; `type`: `"SSN"` | `"PASSPORT"`; } ###### country [Section titled “country”](#country-1) > **country**: `string` ###### Description [Section titled “Description”](#description-24) Country where the identity document was issued. ###### number [Section titled “number”](#number) > **number**: `string` ###### Description [Section titled “Description”](#description-25) US SSN or passport number. ###### type [Section titled “type”](#type) > **type**: `"SSN"` | `"PASSPORT"` *** `null` ##### BeneficialOwner.legal\_name [Section titled “BeneficialOwner.legal\_name”](#beneficialownerlegal_name) > **legal\_name**: `string` ###### Description [Section titled “Description”](#description-26) Legal full name. ##### BeneficialOwner.ownership\_percentage? [Section titled “BeneficialOwner.ownership\_percentage?”](#beneficialownerownership_percentage) > `optional` **ownership\_percentage?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-27) Ownership percentage (25-100). Only populated for individuals with ownership stakes (25% or more). ###### Example [Section titled “Example”](#example-3) ```ts 25 ``` ##### BeneficialOwner.prong [Section titled “BeneficialOwner.prong”](#beneficialownerprong) > **prong**: `"OWNERSHIP"` | `"CONTROL"` | `"BOTH"` #### Business [Section titled “Business”](#business) > **Business**: `object` ##### Description [Section titled “Description”](#description-28) Information about the business the application is for. ```plaintext You can optionally set the `alternate_address`, if the business has an additional address which is different from the registration address. For instance, for international companies where their operational address may be different than where the company was incorporated. ``` ##### Business.activity\_description? [Section titled “Business.activity\_description?”](#businessactivity_description) > `optional` **activity\_description?**: `string` | `null` ###### Description [Section titled “Description”](#description-29) Brief description of the business activity. ###### Example [Section titled “Example”](#example-4) ```ts Software as a Service platform for project management ``` ##### Business.address? [Section titled “Business.address?”](#businessaddress) > `optional` **address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city-1) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-30) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country-2) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-31) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1-1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-32) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2-1) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-33) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number-1) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-34) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code-1) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-35) ZIP or postal code. ###### state? [Section titled “state?”](#state-1) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-36) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### Business.alternate\_address? [Section titled “Business.alternate\_address?”](#businessalternate_address) > `optional` **alternate\_address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-3) ###### Type Literal [Section titled “Type Literal”](#type-literal-3) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city-2) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-37) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country-3) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-38) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1-2) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-39) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2-2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-40) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number-2) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-41) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code-2) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-42) ZIP or postal code. ###### state? [Section titled “state?”](#state-2) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-43) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### Business.beneficial\_owners? [Section titled “Business.beneficial\_owners?”](#businessbeneficial_owners) > `optional` **beneficial\_owners?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-44) List of beneficial owners of the company ##### Business.employer\_identification\_number? [Section titled “Business.employer\_identification\_number?”](#businessemployer_identification_number) > `optional` **employer\_identification\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-45) Company Employer Identification Number(EIN). ###### Example [Section titled “Example”](#example-5) ```ts 123456789 ``` ##### Business.incorporation\_state? [Section titled “Business.incorporation\_state?”](#businessincorporation_state) > `optional` **incorporation\_state?**: `string` | `null` ###### Description [Section titled “Description”](#description-46) State of incorporation (US state abbreviation). ###### Example [Section titled “Example”](#example-6) ```ts CA ``` ##### Business.incorporation\_type? [Section titled “Business.incorporation\_type?”](#businessincorporation_type) > `optional` **incorporation\_type?**: `"C_CORP"` | `"S_CORP"` | `"B_CORP"` | `"LLC"` | `"LLP"` | `"SOLE_PROP"` | `"ORG_501C3"` | `"LP"` | `null` ##### Business.incorporation\_year? [Section titled “Business.incorporation\_year?”](#businessincorporation_year) > `optional` **incorporation\_year?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-47) Year of incorporation (YYYY format). ###### Example [Section titled “Example”](#example-7) ```ts 2023 ``` ##### Business.legal\_name? [Section titled “Business.legal\_name?”](#businesslegal_name) > `optional` **legal\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-48) Company legal name. ###### Example [Section titled “Example”](#example-8) ```ts Acme Corporation ``` ##### Business.website\_url? [Section titled “Business.website\_url?”](#businesswebsite_url) > `optional` **website\_url?**: `string` | `null` ###### Description [Section titled “Description”](#description-49) Business website (or link to ecommerce store for sellers). ###### Example [Section titled “Example”](#example-9) ```ts https://www.acmecorp.com ``` #### Cash [Section titled “Cash”](#cash) > **Cash**: `object` ##### Description [Section titled “Description”](#description-50) Available if customer applied for Brex Cash. ##### Cash.accounts? [Section titled “Cash.accounts?”](#cashaccounts) > `optional` **accounts?**: `object`\[] | `null` ##### Cash.application [Section titled “Cash.application”](#cashapplication) > **application**: `object` ##### Cash.application.status [Section titled “Cash.application.status”](#cashapplicationstatus) > **status**: `"ACTIVE"` | `"PROCESSING"` | `"REJECTED"` | `"NO_ACCOUNT"` | `"NOT_SUBMITTED"` | `"INFORMATION_PENDING"` | `"MANUAL_REVIEW"` | `"CLOSED"` #### CompanyRelationship [Section titled “CompanyRelationship”](#companyrelationship) > **CompanyRelationship**: `"OTHER"` | `"FOUNDER"` | `"EXECUTIVE"` | `"SENIOR_LEADERSHIP"` ##### Description [Section titled “Description”](#description-51) Relationship of this beneficial owner for this company. #### ContactPreference [Section titled “ContactPreference”](#contactpreference) > **ContactPreference**: `"NO_OUTBOUND"` | `"EMAIL_OUTBOUND"` ##### Description [Section titled “Description”](#description-52) When set to `EMAIL_OUTBOUND`, Brex will email the referred prospective customer directly to prompt them to create their account rather than rely on you to direct them to claim the account. If not provided, you are responsible for contacting the prospect and the value defaults to `NO_OUTBOUND`. #### CreateDocumentRequest [Section titled “CreateDocumentRequest”](#createdocumentrequest) > **CreateDocumentRequest**: `object` ##### Description [Section titled “Description”](#description-53) Request for creating new document upload URL. ##### CreateDocumentRequest.type [Section titled “CreateDocumentRequest.type”](#createdocumentrequesttype) > **type**: `"ARTICLES_OF_INCORPORATION"` | `"IRS_EIN_CONFIRMATION"` | `"IRS_EIN_APPLICATION"` | `"CERTIFICATE_GOOD_STANDING"` #### CreateReferralRequest [Section titled “CreateReferralRequest”](#createreferralrequest) > **CreateReferralRequest**: `object` ##### Description [Section titled “Description”](#description-54) Submit a new referral to Brex for onboarding. ##### CreateReferralRequest.applicant [Section titled “CreateReferralRequest.applicant”](#createreferralrequestapplicant) > **applicant**: `object` ##### CreateReferralRequest.applicant.email [Section titled “CreateReferralRequest.applicant.email”](#createreferralrequestapplicantemail) > **email**: `string` Format: email ###### Description [Section titled “Description”](#description-55) Business email of the applying customer. ###### Example [Section titled “Example”](#example-10) ```ts jane.smith@example.com ``` ##### CreateReferralRequest.applicant.first\_name [Section titled “CreateReferralRequest.applicant.first\_name”](#createreferralrequestapplicantfirst_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-56) First name of the applying customer. ###### Example [Section titled “Example”](#example-11) ```ts Jane ``` ##### CreateReferralRequest.applicant.last\_name [Section titled “CreateReferralRequest.applicant.last\_name”](#createreferralrequestapplicantlast_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-57) Last name of the applying customer. ###### Example [Section titled “Example”](#example-12) ```ts Smith ``` ##### CreateReferralRequest.business? [Section titled “CreateReferralRequest.business?”](#createreferralrequestbusiness) > `optional` **business?**: { `activity_description?`: `string` | `null`; `address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `alternate_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `beneficial_owners?`: `object`\[] | `null`; `employer_identification_number?`: `string` | `null`; `incorporation_state?`: `string` | `null`; `incorporation_type?`: `"C_CORP"` | `"S_CORP"` | `"B_CORP"` | `"LLC"` | `"LLP"` | `"SOLE_PROP"` | `"ORG_501C3"` | `"LP"` | `null`; `incorporation_year?`: `number` | `null`; `legal_name?`: `string` | `null`; `website_url?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-4) ###### Type Literal [Section titled “Type Literal”](#type-literal-4) { `activity_description?`: `string` | `null`; `address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `alternate_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `beneficial_owners?`: `object`\[] | `null`; `employer_identification_number?`: `string` | `null`; `incorporation_state?`: `string` | `null`; `incorporation_type?`: `"C_CORP"` | `"S_CORP"` | `"B_CORP"` | `"LLC"` | `"LLP"` | `"SOLE_PROP"` | `"ORG_501C3"` | `"LP"` | `null`; `incorporation_year?`: `number` | `null`; `legal_name?`: `string` | `null`; `website_url?`: `string` | `null`; } ###### activity\_description? [Section titled “activity\_description?”](#activity_description) > `optional` **activity\_description?**: `string` | `null` ###### Description [Section titled “Description”](#description-58) Brief description of the business activity. ###### Example [Section titled “Example”](#example-13) ```ts Software as a Service platform for project management ``` ###### address? [Section titled “address?”](#address-1) > `optional` **address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-5) ###### Type Literal [Section titled “Type Literal”](#type-literal-5) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city-3) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-59) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country-4) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-60) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1-3) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-61) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2-3) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-62) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number-3) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-63) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code-3) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-64) ZIP or postal code. ###### state? [Section titled “state?”](#state-3) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-65) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ###### alternate\_address? [Section titled “alternate\_address?”](#alternate_address) > `optional` **alternate\_address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-6) ###### Type Literal [Section titled “Type Literal”](#type-literal-6) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city-4) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-66) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country-5) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-67) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1-4) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-68) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2-4) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-69) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number-4) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-70) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code-4) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-71) ZIP or postal code. ###### state? [Section titled “state?”](#state-4) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-72) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ###### beneficial\_owners? [Section titled “beneficial\_owners?”](#beneficial_owners) > `optional` **beneficial\_owners?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-73) List of beneficial owners of the company ###### employer\_identification\_number? [Section titled “employer\_identification\_number?”](#employer_identification_number) > `optional` **employer\_identification\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-74) Company Employer Identification Number(EIN). ###### Example [Section titled “Example”](#example-14) ```ts 123456789 ``` ###### incorporation\_state? [Section titled “incorporation\_state?”](#incorporation_state) > `optional` **incorporation\_state?**: `string` | `null` ###### Description [Section titled “Description”](#description-75) State of incorporation (US state abbreviation). ###### Example [Section titled “Example”](#example-15) ```ts CA ``` ###### incorporation\_type? [Section titled “incorporation\_type?”](#incorporation_type) > `optional` **incorporation\_type?**: `"C_CORP"` | `"S_CORP"` | `"B_CORP"` | `"LLC"` | `"LLP"` | `"SOLE_PROP"` | `"ORG_501C3"` | `"LP"` | `null` ###### incorporation\_year? [Section titled “incorporation\_year?”](#incorporation_year) > `optional` **incorporation\_year?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-76) Year of incorporation (YYYY format). ###### Example [Section titled “Example”](#example-16) ```ts 2023 ``` ###### legal\_name? [Section titled “legal\_name?”](#legal_name) > `optional` **legal\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-77) Company legal name. ###### Example [Section titled “Example”](#example-17) ```ts Acme Corporation ``` ###### website\_url? [Section titled “website\_url?”](#website_url) > `optional` **website\_url?**: `string` | `null` ###### Description [Section titled “Description”](#description-78) Business website (or link to ecommerce store for sellers). ###### Example [Section titled “Example”](#example-18) ```ts https://www.acmecorp.com ``` *** `null` ##### CreateReferralRequest.contact\_preference? [Section titled “CreateReferralRequest.contact\_preference?”](#createreferralrequestcontact_preference) > `optional` **contact\_preference?**: `"NO_OUTBOUND"` | `"EMAIL_OUTBOUND"` | `null` ##### CreateReferralRequest.referral\_code [Section titled “CreateReferralRequest.referral\_code”](#createreferralrequestreferral_code) > **referral\_code**: `string` ###### Description [Section titled “Description”](#description-79) Referral code that attributes credit to you if the prospect signs up for a Brex account. ###### Example [Section titled “Example”](#example-19) ```ts partner_abc123 ``` #### Document [Section titled “Document”](#document) > **Document**: `object` ##### Document.id [Section titled “Document.id”](#documentid) > **id**: `string` ###### Description [Section titled “Description”](#description-80) Unique identifier for the document. ###### Example [Section titled “Example”](#example-20) ```ts prefdoc_a1b2c3d4e5 ``` ##### Document.uri [Section titled “Document.uri”](#documenturi) > **uri**: `string` ###### Description [Section titled “Description”](#description-81) This is a presigned S3 link that should be used to attach the document. The maximum size accepted for this document is 50 MB. ###### Example [Section titled “Example”](#example-21) ```ts https://brex-documents.s3.amazonaws.com/upload/abc123?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1234567890&Signature=example ``` #### DocumentType [Section titled “DocumentType”](#documenttype) > **DocumentType**: `"ARTICLES_OF_INCORPORATION"` | `"IRS_EIN_CONFIRMATION"` | `"IRS_EIN_APPLICATION"` | `"CERTIFICATE_GOOD_STANDING"` ##### Description [Section titled “Description”](#description-82) Type of document being submitted. Allowable types: - ARTICLES\_OF\_INCORPORATION - IRS\_EIN\_CONFIRMATION (IRS CP 575, CP 575 fax sheet, or 147C form) - IRS\_EIN\_APPLICATION (IRS SS4 form) - CERTIFICATE\_GOOD\_STANDING #### DomesticInstruction [Section titled “DomesticInstruction”](#domesticinstruction) > **DomesticInstruction**: `object` ##### Description [Section titled “Description”](#description-83) Domestic ACH/wire instructions. ##### DomesticInstruction.account\_type [Section titled “DomesticInstruction.account\_type”](#domesticinstructionaccount_type) > **account\_type**: `string` ##### DomesticInstruction.bank\_account\_number [Section titled “DomesticInstruction.bank\_account\_number”](#domesticinstructionbank_account_number) > **bank\_account\_number**: `string` ##### DomesticInstruction.bank\_address [Section titled “DomesticInstruction.bank\_address”](#domesticinstructionbank_address) > **bank\_address**: `string` ##### DomesticInstruction.bank\_name [Section titled “DomesticInstruction.bank\_name”](#domesticinstructionbank_name) > **bank\_name**: `string` ##### DomesticInstruction.bank\_routing\_number [Section titled “DomesticInstruction.bank\_routing\_number”](#domesticinstructionbank_routing_number) > **bank\_routing\_number**: `string` ##### DomesticInstruction.beneficiary\_address [Section titled “DomesticInstruction.beneficiary\_address”](#domesticinstructionbeneficiary_address) > **beneficiary\_address**: `string` ##### DomesticInstruction.beneficiary\_name [Section titled “DomesticInstruction.beneficiary\_name”](#domesticinstructionbeneficiary_name) > **beneficiary\_name**: `string` #### IdentityDocument [Section titled “IdentityDocument”](#identitydocument) > **IdentityDocument**: `object` ##### Description [Section titled “Description”](#description-84) Document identifying the owner. ##### IdentityDocument.country [Section titled “IdentityDocument.country”](#identitydocumentcountry) > **country**: `string` ###### Description [Section titled “Description”](#description-85) Country where the identity document was issued. ##### IdentityDocument.number [Section titled “IdentityDocument.number”](#identitydocumentnumber) > **number**: `string` ###### Description [Section titled “Description”](#description-86) US SSN or passport number. ##### IdentityDocument.type [Section titled “IdentityDocument.type”](#identitydocumenttype) > **type**: `"SSN"` | `"PASSPORT"` #### IdentityDocumentType [Section titled “IdentityDocumentType”](#identitydocumenttype-1) > **IdentityDocumentType**: `"SSN"` | `"PASSPORT"` ##### Description [Section titled “Description”](#description-87) Either a US SSN or US/international passport. #### IncorporationType [Section titled “IncorporationType”](#incorporationtype) > **IncorporationType**: `"C_CORP"` | `"S_CORP"` | `"B_CORP"` | `"LLC"` | `"LLP"` | `"SOLE_PROP"` | `"ORG_501C3"` | `"LP"` ##### Description [Section titled “Description”](#description-88) Incorporation type of the company referred. #### Instruction [Section titled “Instruction”](#instruction) > **Instruction**: `object` ##### Description [Section titled “Description”](#description-89) Domestic and international ACH/wire instructions. ##### Instruction.domestic [Section titled “Instruction.domestic”](#instructiondomestic) > **domestic**: `object` ##### Instruction.domestic.account\_type [Section titled “Instruction.domestic.account\_type”](#instructiondomesticaccount_type) > **account\_type**: `string` ##### Instruction.domestic.bank\_account\_number [Section titled “Instruction.domestic.bank\_account\_number”](#instructiondomesticbank_account_number) > **bank\_account\_number**: `string` ##### Instruction.domestic.bank\_address [Section titled “Instruction.domestic.bank\_address”](#instructiondomesticbank_address) > **bank\_address**: `string` ##### Instruction.domestic.bank\_name [Section titled “Instruction.domestic.bank\_name”](#instructiondomesticbank_name) > **bank\_name**: `string` ##### Instruction.domestic.bank\_routing\_number [Section titled “Instruction.domestic.bank\_routing\_number”](#instructiondomesticbank_routing_number) > **bank\_routing\_number**: `string` ##### Instruction.domestic.beneficiary\_address [Section titled “Instruction.domestic.beneficiary\_address”](#instructiondomesticbeneficiary_address) > **beneficiary\_address**: `string` ##### Instruction.domestic.beneficiary\_name [Section titled “Instruction.domestic.beneficiary\_name”](#instructiondomesticbeneficiary_name) > **beneficiary\_name**: `string` ##### Instruction.international [Section titled “Instruction.international”](#instructioninternational) > **international**: `object` ##### Instruction.international.account\_type [Section titled “Instruction.international.account\_type”](#instructioninternationalaccount_type) > **account\_type**: `string` ##### Instruction.international.bank\_address [Section titled “Instruction.international.bank\_address”](#instructioninternationalbank_address) > **bank\_address**: `string` ##### Instruction.international.bank\_name [Section titled “Instruction.international.bank\_name”](#instructioninternationalbank_name) > **bank\_name**: `string` ##### Instruction.international.beneficiary\_address [Section titled “Instruction.international.beneficiary\_address”](#instructioninternationalbeneficiary_address) > **beneficiary\_address**: `string` ##### Instruction.international.beneficiary\_name [Section titled “Instruction.international.beneficiary\_name”](#instructioninternationalbeneficiary_name) > **beneficiary\_name**: `string` ##### Instruction.international.special\_instructions [Section titled “Instruction.international.special\_instructions”](#instructioninternationalspecial_instructions) > **special\_instructions**: `string` ##### Instruction.international.swift\_account\_number [Section titled “Instruction.international.swift\_account\_number”](#instructioninternationalswift_account_number) > **swift\_account\_number**: `string` ##### Instruction.international.swift\_bank\_number [Section titled “Instruction.international.swift\_bank\_number”](#instructioninternationalswift_bank_number) > **swift\_bank\_number**: `string` #### InternationalInstruction [Section titled “InternationalInstruction”](#internationalinstruction) > **InternationalInstruction**: `object` ##### Description [Section titled “Description”](#description-90) International wire instructions. ##### InternationalInstruction.account\_type [Section titled “InternationalInstruction.account\_type”](#internationalinstructionaccount_type) > **account\_type**: `string` ##### InternationalInstruction.bank\_address [Section titled “InternationalInstruction.bank\_address”](#internationalinstructionbank_address) > **bank\_address**: `string` ##### InternationalInstruction.bank\_name [Section titled “InternationalInstruction.bank\_name”](#internationalinstructionbank_name) > **bank\_name**: `string` ##### InternationalInstruction.beneficiary\_address [Section titled “InternationalInstruction.beneficiary\_address”](#internationalinstructionbeneficiary_address) > **beneficiary\_address**: `string` ##### InternationalInstruction.beneficiary\_name [Section titled “InternationalInstruction.beneficiary\_name”](#internationalinstructionbeneficiary_name) > **beneficiary\_name**: `string` ##### InternationalInstruction.special\_instructions [Section titled “InternationalInstruction.special\_instructions”](#internationalinstructionspecial_instructions) > **special\_instructions**: `string` ##### InternationalInstruction.swift\_account\_number [Section titled “InternationalInstruction.swift\_account\_number”](#internationalinstructionswift_account_number) > **swift\_account\_number**: `string` ##### InternationalInstruction.swift\_bank\_number [Section titled “InternationalInstruction.swift\_bank\_number”](#internationalinstructionswift_bank_number) > **swift\_bank\_number**: `string` #### ProcessDelayedEINDocumentRequest [Section titled “ProcessDelayedEINDocumentRequest”](#processdelayedeindocumentrequest) > **ProcessDelayedEINDocumentRequest**: `object` ##### Description [Section titled “Description”](#description-91) Request for processing a delayed EIN document ##### ProcessDelayedEINDocumentRequest.document\_id [Section titled “ProcessDelayedEINDocumentRequest.document\_id”](#processdelayedeindocumentrequestdocument_id) > **document\_id**: `string` ###### Description [Section titled “Description”](#description-92) The document ID returned from the initial document creation request #### Product [Section titled “Product”](#product) > **Product**: `object` ##### Description [Section titled “Description”](#description-93) Array of Brex products that the customer has applied for. This is a gated feature available to select clients only. ##### Product.cash [Section titled “Product.cash”](#productcash) > **cash**: `object` ##### Product.cash.accounts? [Section titled “Product.cash.accounts?”](#productcashaccounts) > `optional` **accounts?**: `object`\[] | `null` ##### Product.cash.application [Section titled “Product.cash.application”](#productcashapplication) > **application**: `object` ##### Product.cash.application.status [Section titled “Product.cash.application.status”](#productcashapplicationstatus) > **status**: `"ACTIVE"` | `"PROCESSING"` | `"REJECTED"` | `"NO_ACCOUNT"` | `"NOT_SUBMITTED"` | `"INFORMATION_PENDING"` | `"MANUAL_REVIEW"` | `"CLOSED"` #### Prong [Section titled “Prong”](#prong) > **Prong**: `"OWNERSHIP"` | `"CONTROL"` | `"BOTH"` ##### Description [Section titled “Description”](#description-94) When using `CONTROL` prong, the beneficial owner is a single individual with significant responsibility to control, manage, or direct a legal entity customer. This includes, an executive officer or senior manager (Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, President), or any other individual who regularly performs similar functions. ```plaintext Under the `OWNERSHIP` prong, a beneficial owner is each individual, if any, who, directly or indirectly, through any contract, arrangement, understanding, relationship or otherwise, owns 25 percent or more of the equity interests of a legal entity customer. If a trust owns directly or indirectly, through any contract, arrangement, understanding, relationship or otherwise, 25 percent or more of the equity interests of a legal entity customer, the beneficial owner is the trustee. Under the `BOTH` prong, the beneficial owner represents both. ``` #### Referral [Section titled “Referral”](#referral) > **Referral**: `object` ##### Referral.customer\_email? [Section titled “Referral.customer\_email?”](#referralcustomer_email) > `optional` **customer\_email?**: `string` | `null` Format: email ###### Description [Section titled “Description”](#description-95) Customer’s email address registered for the Brex application. This field is available only if there’s a signup completed. ##### Referral.expires\_at [Section titled “Referral.expires\_at”](#referralexpires_at) > **expires\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-96) The time at which this referral link expires. ##### Referral.id [Section titled “Referral.id”](#referralid) > **id**: `string` ###### Description [Section titled “Description”](#description-97) Unique identifier for the referral. ###### Example [Section titled “Example”](#example-22) ```ts a1b2c3d4e5f6g7 ``` ##### Referral.products [Section titled “Referral.products”](#referralproducts) > **products**: `object`\[] ##### Referral.referral\_signup\_url [Section titled “Referral.referral\_signup\_url”](#referralreferral_signup_url) > **referral\_signup\_url**: `string` ###### Description [Section titled “Description”](#description-98) Signup URL to redirect prospects to complete their onboarding flow. ```plaintext *Note*: Necessary disclosures must be shown when the prospect clicks on this link. ``` ###### Example [Section titled “Example”](#example-23) ```ts https://brex.com/signup?pref_token=a1b2c3d4e5f6g7 ``` ##### Referral.status [Section titled “Referral.status”](#referralstatus) > **status**: `"ACTIVE"` | `"EXPIRED"` | `"CLOSED"` | `"UNCLAIMED"` #### ReferralPage [Section titled “ReferralPage”](#referralpage) > **ReferralPage**: `object` ##### ReferralPage.items [Section titled “ReferralPage.items”](#referralpageitems) > **items**: `object`\[] ##### ReferralPage.next\_cursor? [Section titled “ReferralPage.next\_cursor?”](#referralpagenext_cursor) > `optional` **next\_cursor?**: `string` | `null` #### ReferralStatus [Section titled “ReferralStatus”](#referralstatus-1) > **ReferralStatus**: `"ACTIVE"` | `"EXPIRED"` | `"CLOSED"` | `"UNCLAIMED"` ##### Description [Section titled “Description”](#description-99) Status of the referral. `UNCLAIMED` or `EXPIRED` unless the customer completes signup. Customers are attributed once `ACTIVE` until the account is `CLOSED`. # OnboardingPaths Defined in: [src/onboarding/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L2) ## Properties [Section titled “Properties”](#properties) ### /v1/referrals [Section titled “/v1/referrals”](#v1referrals) > **/v1/referrals**: `object` Defined in: [src/onboarding/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L3) #### delete? [Section titled “delete?”](#delete) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get) > **get**: `object` List referrals ##### Description [Section titled “Description”](#description) Returns referrals created. *Note*: This doesn’t include referrals that have expired. ##### get.parameters [Section titled “get.parameters”](#getparameters) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor) > `optional` **cursor?**: `string` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-1) Success ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-2) Invalid cursor ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-1) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-3) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-2) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post) > **post**: `object` Creates a referral ##### Description [Section titled “Description”](#description-4) This creates new referrals. The response will contain an identifier and a unique personalized link to an application flow. Many fields are optional and when they’re provided they’ll prefill the application flow for Brex. You should handle and store these references securely as they contain sensitive information about the referral. ##### post.parameters [Section titled “post.parameters”](#postparameters) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader) > `optional` **header?**: `undefined` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson) > **application/json**: `object` ##### post.requestBody.content.application/json.applicant [Section titled “post.requestBody.content.application/json.applicant”](#postrequestbodycontentapplicationjsonapplicant) > **applicant**: `object` ##### post.requestBody.content.application/json.applicant.email [Section titled “post.requestBody.content.application/json.applicant.email”](#postrequestbodycontentapplicationjsonapplicantemail) > **email**: `string` Format: email ###### Description [Section titled “Description”](#description-5) Business email of the applying customer. ###### Example [Section titled “Example”](#example) ```ts jane.smith@example.com ``` ##### post.requestBody.content.application/json.applicant.first\_name [Section titled “post.requestBody.content.application/json.applicant.first\_name”](#postrequestbodycontentapplicationjsonapplicantfirst_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-6) First name of the applying customer. ###### Example [Section titled “Example”](#example-1) ```ts Jane ``` ##### post.requestBody.content.application/json.applicant.last\_name [Section titled “post.requestBody.content.application/json.applicant.last\_name”](#postrequestbodycontentapplicationjsonapplicantlast_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-7) Last name of the applying customer. ###### Example [Section titled “Example”](#example-2) ```ts Smith ``` ##### post.requestBody.content.application/json.business? [Section titled “post.requestBody.content.application/json.business?”](#postrequestbodycontentapplicationjsonbusiness) > `optional` **business?**: { `activity_description?`: `string` | `null`; `address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `alternate_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `beneficial_owners?`: `object`\[] | `null`; `employer_identification_number?`: `string` | `null`; `incorporation_state?`: `string` | `null`; `incorporation_type?`: `"C_CORP"` | `"S_CORP"` | `"B_CORP"` | `"LLC"` | `"LLP"` | `"SOLE_PROP"` | `"ORG_501C3"` | `"LP"` | `null`; `incorporation_year?`: `number` | `null`; `legal_name?`: `string` | `null`; `website_url?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `activity_description?`: `string` | `null`; `address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `alternate_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `beneficial_owners?`: `object`\[] | `null`; `employer_identification_number?`: `string` | `null`; `incorporation_state?`: `string` | `null`; `incorporation_type?`: `"C_CORP"` | `"S_CORP"` | `"B_CORP"` | `"LLC"` | `"LLP"` | `"SOLE_PROP"` | `"ORG_501C3"` | `"LP"` | `null`; `incorporation_year?`: `number` | `null`; `legal_name?`: `string` | `null`; `website_url?`: `string` | `null`; } ###### activity\_description? [Section titled “activity\_description?”](#activity_description) > `optional` **activity\_description?**: `string` | `null` ###### Description [Section titled “Description”](#description-8) Brief description of the business activity. ###### Example [Section titled “Example”](#example-3) ```ts Software as a Service platform for project management ``` ###### address? [Section titled “address?”](#address) > `optional` **address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-9) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-10) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-11) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-12) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-13) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-14) ZIP or postal code. ###### state? [Section titled “state?”](#state) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-15) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ###### alternate\_address? [Section titled “alternate\_address?”](#alternate_address) > `optional` **alternate\_address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city-1) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-16) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country-1) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-17) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1-1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-18) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2-1) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-19) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number-1) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-20) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code-1) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-21) ZIP or postal code. ###### state? [Section titled “state?”](#state-1) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-22) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ###### beneficial\_owners? [Section titled “beneficial\_owners?”](#beneficial_owners) > `optional` **beneficial\_owners?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-23) List of beneficial owners of the company ###### employer\_identification\_number? [Section titled “employer\_identification\_number?”](#employer_identification_number) > `optional` **employer\_identification\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-24) Company Employer Identification Number(EIN). ###### Example [Section titled “Example”](#example-4) ```ts 123456789 ``` ###### incorporation\_state? [Section titled “incorporation\_state?”](#incorporation_state) > `optional` **incorporation\_state?**: `string` | `null` ###### Description [Section titled “Description”](#description-25) State of incorporation (US state abbreviation). ###### Example [Section titled “Example”](#example-5) ```ts CA ``` ###### incorporation\_type? [Section titled “incorporation\_type?”](#incorporation_type) > `optional` **incorporation\_type?**: `"C_CORP"` | `"S_CORP"` | `"B_CORP"` | `"LLC"` | `"LLP"` | `"SOLE_PROP"` | `"ORG_501C3"` | `"LP"` | `null` ###### incorporation\_year? [Section titled “incorporation\_year?”](#incorporation_year) > `optional` **incorporation\_year?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-26) Year of incorporation (YYYY format). ###### Example [Section titled “Example”](#example-6) ```ts 2023 ``` ###### legal\_name? [Section titled “legal\_name?”](#legal_name) > `optional` **legal\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-27) Company legal name. ###### Example [Section titled “Example”](#example-7) ```ts Acme Corporation ``` ###### website\_url? [Section titled “website\_url?”](#website_url) > `optional` **website\_url?**: `string` | `null` ###### Description [Section titled “Description”](#description-28) Business website (or link to ecommerce store for sellers). ###### Example [Section titled “Example”](#example-8) ```ts https://www.acmecorp.com ``` *** `null` ##### post.requestBody.content.application/json.contact\_preference? [Section titled “post.requestBody.content.application/json.contact\_preference?”](#postrequestbodycontentapplicationjsoncontact_preference) > `optional` **contact\_preference?**: `"NO_OUTBOUND"` | `"EMAIL_OUTBOUND"` | `null` ##### post.requestBody.content.application/json.referral\_code [Section titled “post.requestBody.content.application/json.referral\_code”](#postrequestbodycontentapplicationjsonreferral_code) > **referral\_code**: `string` ###### Description [Section titled “Description”](#description-29) Referral code that attributes credit to you if the prospect signs up for a Brex account. ###### Example [Section titled “Example”](#example-9) ```ts partner_abc123 ``` ##### post.responses [Section titled “post.responses”](#postresponses) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-30) Success ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson) > **application/json**: `object` ##### post.responses.200.content.application/json.customer\_email? [Section titled “post.responses.200.content.application/json.customer\_email?”](#postresponses200contentapplicationjsoncustomer_email) > `optional` **customer\_email?**: `string` | `null` Format: email ###### Description [Section titled “Description”](#description-31) Customer’s email address registered for the Brex application. This field is available only if there’s a signup completed. ##### post.responses.200.content.application/json.expires\_at [Section titled “post.responses.200.content.application/json.expires\_at”](#postresponses200contentapplicationjsonexpires_at) > **expires\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-32) The time at which this referral link expires. ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-33) Unique identifier for the referral. ###### Example [Section titled “Example”](#example-10) ```ts a1b2c3d4e5f6g7 ``` ##### post.responses.200.content.application/json.products [Section titled “post.responses.200.content.application/json.products”](#postresponses200contentapplicationjsonproducts) > **products**: `object`\[] ##### post.responses.200.content.application/json.referral\_signup\_url [Section titled “post.responses.200.content.application/json.referral\_signup\_url”](#postresponses200contentapplicationjsonreferral_signup_url) > **referral\_signup\_url**: `string` ###### Description [Section titled “Description”](#description-34) Signup URL to redirect prospects to complete their onboarding flow. ```plaintext *Note*: Necessary disclosures must be shown when the prospect clicks on this link. ``` ###### Example [Section titled “Example”](#example-11) ```ts https://brex.com/signup?pref_token=a1b2c3d4e5f6g7 ``` ##### post.responses.200.content.application/json.status [Section titled “post.responses.200.content.application/json.status”](#postresponses200contentapplicationjsonstatus) > **status**: `"ACTIVE"` | `"EXPIRED"` | `"CLOSED"` | `"UNCLAIMED"` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-3) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-35) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-4) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace) > `optional` **trace?**: `undefined` *** ### /v1/referrals/{id} [Section titled “/v1/referrals/{id}”](#v1referralsid) > **/v1/referrals/{id}**: `object` Defined in: [src/onboarding/types.gen.ts:28](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L28) #### delete? [Section titled “delete?”](#delete-1) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-1) > **get**: `object` Gets a referral by ID ##### Description [Section titled “Description”](#description-36) Returns a referral object by ID if it exists. ##### get.parameters [Section titled “get.parameters”](#getparameters-1) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-1) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-1) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-1) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-1) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-1) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-1) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-37) Success ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-1) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-1) > **application/json**: `object` ##### get.responses.200.content.application/json.customer\_email? [Section titled “get.responses.200.content.application/json.customer\_email?”](#getresponses200contentapplicationjsoncustomer_email) > `optional` **customer\_email?**: `string` | `null` Format: email ###### Description [Section titled “Description”](#description-38) Customer’s email address registered for the Brex application. This field is available only if there’s a signup completed. ##### get.responses.200.content.application/json.expires\_at [Section titled “get.responses.200.content.application/json.expires\_at”](#getresponses200contentapplicationjsonexpires_at) > **expires\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-39) The time at which this referral link expires. ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-40) Unique identifier for the referral. ###### Example [Section titled “Example”](#example-12) ```ts a1b2c3d4e5f6g7 ``` ##### get.responses.200.content.application/json.products [Section titled “get.responses.200.content.application/json.products”](#getresponses200contentapplicationjsonproducts) > **products**: `object`\[] ##### get.responses.200.content.application/json.referral\_signup\_url [Section titled “get.responses.200.content.application/json.referral\_signup\_url”](#getresponses200contentapplicationjsonreferral_signup_url) > **referral\_signup\_url**: `string` ###### Description [Section titled “Description”](#description-41) Signup URL to redirect prospects to complete their onboarding flow. ```plaintext *Note*: Necessary disclosures must be shown when the prospect clicks on this link. ``` ###### Example [Section titled “Example”](#example-13) ```ts https://brex.com/signup?pref_token=a1b2c3d4e5f6g7 ``` ##### get.responses.200.content.application/json.status [Section titled “get.responses.200.content.application/json.status”](#getresponses200contentapplicationjsonstatus) > **status**: `"ACTIVE"` | `"EXPIRED"` | `"CLOSED"` | `"UNCLAIMED"` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-5) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-42) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-1) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-6) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-43) Referral not found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-7) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-1) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-1) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-1) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-1) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-1) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-1) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-1) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-1) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-1) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-1) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-1) > `optional` **trace?**: `undefined` *** ### /v1/referrals/{id}/document\_upload [Section titled “/v1/referrals/{id}/document\_upload”](#v1referralsiddocument_upload) > **/v1/referrals/{id}/document\_upload**: `object` Defined in: [src/onboarding/types.gen.ts:48](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L48) #### delete? [Section titled “delete?”](#delete-2) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-2) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-2) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-2) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-2) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-2) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-2) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-2) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-2) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-2) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-2) > **post**: `object` Create a new document upload ##### Description [Section titled “Description”](#description-44) The `uri` will be a presigned S3 URL allowing you to upload the referral doc 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 use this to prefill the application. ```plaintext Refer to these [docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/PresignedUrlUploadObject.html) on how to upload to this presigned S3 URL. We highly recommend using one of AWS SDKs if they're available for your language to upload these files. ``` ##### post.parameters [Section titled “post.parameters”](#postparameters-1) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-1) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-1) > `optional` **header?**: `undefined` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-1) > **path**: `object` ##### post.parameters.path.id [Section titled “post.parameters.path.id”](#postparameterspathid) > **id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-1) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-1) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-1) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-1) > **application/json**: `object` ##### post.requestBody.content.application/json.type [Section titled “post.requestBody.content.application/json.type”](#postrequestbodycontentapplicationjsontype) > **type**: `"ARTICLES_OF_INCORPORATION"` | `"IRS_EIN_CONFIRMATION"` | `"IRS_EIN_APPLICATION"` | `"CERTIFICATE_GOOD_STANDING"` ##### post.responses [Section titled “post.responses”](#postresponses-1) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-45) Success ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-1) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-1) > **application/json**: `object` ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-46) Unique identifier for the document. ###### Example [Section titled “Example”](#example-14) ```ts prefdoc_a1b2c3d4e5 ``` ##### post.responses.200.content.application/json.uri [Section titled “post.responses.200.content.application/json.uri”](#postresponses200contentapplicationjsonuri) > **uri**: `string` ###### Description [Section titled “Description”](#description-47) This is a presigned S3 link that should be used to attach the document. The maximum size accepted for this document is 50 MB. ###### Example [Section titled “Example”](#example-15) ```ts https://brex-documents.s3.amazonaws.com/upload/abc123?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1234567890&Signature=example ``` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-8) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-48) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content-1) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-9) \[`name`: `string`]: `unknown` ##### post.responses.404 [Section titled “post.responses.404”](#postresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-49) Referral not found ##### post.responses.404.content? [Section titled “post.responses.404.content?”](#postresponses404content) > `optional` **content?**: `undefined` ##### post.responses.404.headers [Section titled “post.responses.404.headers”](#postresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-10) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-2) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-2) > `optional` **trace?**: `undefined` *** ### /v1/referrals/{id}/process\_ein\_document [Section titled “/v1/referrals/{id}/process\_ein\_document”](#v1referralsidprocess_ein_document) > **/v1/referrals/{id}/process\_ein\_document**: `object` Defined in: [src/onboarding/types.gen.ts:70](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L70) #### delete? [Section titled “delete?”](#delete-3) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-3) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-3) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-3) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-3) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-3) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-3) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-3) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-3) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-3) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-3) > **post**: `object` Process a delayed EIN document after upload ##### Description [Section titled “Description”](#description-50) Processes a delayed EIN document after it has been uploaded. ```plaintext This endpoint should be called after successfully uploading an IRS EIN Confirmation document (CP-575, CP-575 fax sheet, or 147C) using the standard document upload flow (`/v1/referrals/{id}/document_upload` with `type: IRS_EIN_CONFIRMATION`). The `document_id` should be the `id` returned from the document upload request. ``` ##### post.parameters [Section titled “post.parameters”](#postparameters-2) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-2) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-2) > `optional` **header?**: `undefined` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-2) > **path**: `object` ##### post.parameters.path.id [Section titled “post.parameters.path.id”](#postparameterspathid-1) > **id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-2) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-2) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-2) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-2) > **application/json**: `object` ##### post.requestBody.content.application/json.document\_id [Section titled “post.requestBody.content.application/json.document\_id”](#postrequestbodycontentapplicationjsondocument_id) > **document\_id**: `string` ###### Description [Section titled “Description”](#description-51) The document ID returned from the initial document creation request ##### post.responses [Section titled “post.responses”](#postresponses-2) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-52) Document processed successfully ##### post.responses.200.content? [Section titled “post.responses.200.content?”](#postresponses200content-2) > `optional` **content?**: `undefined` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-11) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-53) Document not uploaded or invalid ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-12) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-2) > **401**: `object` ###### Description [Section titled “Description”](#description-54) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content-2) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-13) \[`name`: `string`]: `unknown` ##### post.responses.404 [Section titled “post.responses.404”](#postresponses404-1) > **404**: `object` ###### Description [Section titled “Description”](#description-55) Referral not found ##### post.responses.404.content? [Section titled “post.responses.404.content?”](#postresponses404content-1) > `optional` **content?**: `undefined` ##### post.responses.404.headers [Section titled “post.responses.404.headers”](#postresponses404headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-14) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-3) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-3) > `optional` **trace?**: `undefined` # Account > **Account** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"Account"`] Defined in: [src/onboarding/schemas.gen.ts:5](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L5) # Address > **Address** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"Address"`] Defined in: [src/onboarding/schemas.gen.ts:6](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L6) # Applicant > **Applicant** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"Applicant"`] Defined in: [src/onboarding/schemas.gen.ts:7](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L7) # Application > **Application** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"Application"`] Defined in: [src/onboarding/schemas.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L8) # ApplicationStatus > **ApplicationStatus** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"ApplicationStatus"`] Defined in: [src/onboarding/schemas.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L9) # BeneficialOwner > **BeneficialOwner** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"BeneficialOwner"`] Defined in: [src/onboarding/schemas.gen.ts:10](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L10) # Business > **Business** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"Business"`] Defined in: [src/onboarding/schemas.gen.ts:11](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L11) # Cash > **Cash** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"Cash"`] Defined in: [src/onboarding/schemas.gen.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L12) # CompanyRelationship > **CompanyRelationship** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"CompanyRelationship"`] Defined in: [src/onboarding/schemas.gen.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L13) # ContactPreference > **ContactPreference** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"ContactPreference"`] Defined in: [src/onboarding/schemas.gen.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L14) # CreateDocumentRequest > **CreateDocumentRequest** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"CreateDocumentRequest"`] Defined in: [src/onboarding/schemas.gen.ts:15](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L15) # CreateReferralRequest > **CreateReferralRequest** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"CreateReferralRequest"`] Defined in: [src/onboarding/schemas.gen.ts:16](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L16) # Document > **Document** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"Document"`] Defined in: [src/onboarding/schemas.gen.ts:17](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L17) # DocumentType > **DocumentType** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"DocumentType"`] Defined in: [src/onboarding/schemas.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L18) # DomesticInstruction > **DomesticInstruction** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"DomesticInstruction"`] Defined in: [src/onboarding/schemas.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L19) # IdentityDocument > **IdentityDocument** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"IdentityDocument"`] Defined in: [src/onboarding/schemas.gen.ts:20](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L20) # IdentityDocumentType > **IdentityDocumentType** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"IdentityDocumentType"`] Defined in: [src/onboarding/schemas.gen.ts:21](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L21) # IncorporationType > **IncorporationType** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"IncorporationType"`] Defined in: [src/onboarding/schemas.gen.ts:22](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L22) # Instruction > **Instruction** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"Instruction"`] Defined in: [src/onboarding/schemas.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L23) # InternationalInstruction > **InternationalInstruction** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"InternationalInstruction"`] Defined in: [src/onboarding/schemas.gen.ts:24](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L24) # ProcessDelayedEINDocumentRequest > **ProcessDelayedEINDocumentRequest** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"ProcessDelayedEINDocumentRequest"`] Defined in: [src/onboarding/schemas.gen.ts:25](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L25) # Product > **Product** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"Product"`] Defined in: [src/onboarding/schemas.gen.ts:27](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L27) # Prong > **Prong** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"Prong"`] Defined in: [src/onboarding/schemas.gen.ts:28](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L28) # Referral > **Referral** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"Referral"`] Defined in: [src/onboarding/schemas.gen.ts:29](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L29) # ReferralPage > **ReferralPage** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"ReferralPage"`] Defined in: [src/onboarding/schemas.gen.ts:30](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L30) # ReferralStatus > **ReferralStatus** = [`OnboardingComponents`](/brex/api/onboarding/interfaces/onboardingcomponents/)\[`"schemas"`]\[`"ReferralStatus"`] Defined in: [src/onboarding/schemas.gen.ts:31](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/schemas.gen.ts#L31) # BrexPayments Defined in: [src/payments/client.gen.ts:252](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L252) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BrexPayments**(`core`): `BrexPayments` Defined in: [src/payments/client.gen.ts:256](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L256) #### Parameters [Section titled “Parameters”](#parameters) ##### core [Section titled “core”](#core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `BrexPayments` ## Properties [Section titled “Properties”](#properties) ### linkedAccounts [Section titled “linkedAccounts”](#linkedaccounts) > `readonly` **linkedAccounts**: [`LinkedAccounts`](/brex/api/payments/classes/linkedaccounts/) Defined in: [src/payments/client.gen.ts:253](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L253) *** ### transfers [Section titled “transfers”](#transfers) > `readonly` **transfers**: [`Transfers`](/brex/api/payments/classes/transfers/) Defined in: [src/payments/client.gen.ts:254](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L254) *** ### vendors [Section titled “vendors”](#vendors) > `readonly` **vendors**: [`Vendors`](/brex/api/payments/classes/vendors/) Defined in: [src/payments/client.gen.ts:255](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L255) # LinkedAccounts Defined in: [src/payments/client.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L8) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new LinkedAccounts**(`_core`): `LinkedAccounts` Defined in: [src/payments/client.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L9) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `LinkedAccounts` ## Methods [Section titled “Methods”](#methods) ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/payments/client.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L19) Lists linked accounts This endpoint lists all bank connections that are eligible to make ACH transfers to Brex business account `GET /v1/linked_accounts` — requires OAuth scope: `linked_accounts.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-1) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> # Transfers Defined in: [src/payments/client.gen.ts:31](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L31) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Transfers**(`_core`): `Transfers` Defined in: [src/payments/client.gen.ts:32](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L32) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Transfers` ## Methods [Section titled “Methods”](#methods) ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `amount`: { `amount`: `number`; `currency`: `string` | `null`; }; `cancellation_reason?`: `"USER_CANCELLED"` | `"INSUFFICIENT_FUNDS"` | `"APPROVAL_DENIED"` | `"BLOCKED_BY_POSITIVE_PAY"` | `null`; `counterparty?`: `Omit`<`object` & `object`, `"type"`> | `null`; `created_at?`: `string` | `null`; `creator_user_id?`: `string` | `null`; `description?`: `string` | `null`; `display_name?`: `string` | `null`; `estimated_delivery_date?`: `string` | `null`; `external_memo?`: `string` | `null`; `id`: `string`; `is_ppro_enabled?`: `boolean` | `null`; `originating_account`: `object` & `object`; `payment_type`: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"`; `process_date?`: `string` | `null`; `status`: `"PROCESSING"` | `"SCHEDULED"` | `"PENDING_APPROVAL"` | `"FAILED"` | `"PROCESSED"`; }> Defined in: [src/payments/client.gen.ts:61](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L61) Create transfer This endpoint creates a new transfer. Currently, the API can only create transfers for the following payment rails: * ACH * DOMESTIC\_WIRE * CHEQUE * INTERNATIONAL\_WIRES **Transaction Descriptions** * For outgoing check payments, a successful transfer will return a response containing a description value with a format of `Check # to - `. * For book transfers (from one Brex Business account to another), the recipient value will have a format of ` - ` and the sender will have a format of ` - `. * For other payment rails, the format will be ` - `, where Counterparty name is `payment_instrument.beneficiary_name` or `contact.name` For vendors created from the Payments API, the `counterparty_name` will be the `company_name` [field](/openapi/payments_api/#operation/createVendor!path=company_name\&t=request). **Reminder**: You may not use the Brex API for any activity that requires a license or registration from any governmental authority without Brex’s prior review and approval. This includes but is not limited to any money services business or money transmission activity. Please review the [Brex Access Agreement](https://www.brex.com/legal/developer-portal/) and contact us if you have any questions. `POST /v1/transfers` — requires OAuth scope: `transfers` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-1) ##### body [Section titled “body”](#body) ###### amount [Section titled “amount”](#amount) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount.amount [Section titled “amount.amount”](#amountamount) `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 ``` ###### amount.currency [Section titled “amount.currency”](#amountcurrency) `string` | `null` **Description** The type of currency, in ISO 4217 format. **Default** ```ts USD ``` **Example** ```ts USD ``` ###### approval\_type? [Section titled “approval\_type?”](#approval_type) `"MANUAL"` | `null` ###### counterparty [Section titled “counterparty”](#counterparty) `object` & `object` | `object` & `object` ###### description [Section titled “description”](#description) `string` **Description** Description of the transfer for internal use. Not exposed externally. ###### external\_memo [Section titled “external\_memo”](#external_memo) `string` **Description** External memo for the transfer. `Payment Instructions` for Wires and the `Entry Description` for ACH payments. Must be at most 90 characters for `ACH` and `WIRE` transactions and at most 40 characters for `CHEQUES` ###### is\_ppro\_enabled? [Section titled “is\_ppro\_enabled?”](#is_ppro_enabled) `boolean` **Description** When set to true, add Principal Protection (PPRO) to the transaction. PPRO means Brex will cover any fees charged by intemediary or receiving banks. PPRO charges will be billed separately in a monthly statement. PPRO is only available for international wire transactions. ###### originating\_account [Section titled “originating\_account”](#originating_account) `Omit`<`object` & `object`, `"type"`> ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `amount`: { `amount`: `number`; `currency`: `string` | `null`; }; `cancellation_reason?`: `"USER_CANCELLED"` | `"INSUFFICIENT_FUNDS"` | `"APPROVAL_DENIED"` | `"BLOCKED_BY_POSITIVE_PAY"` | `null`; `counterparty?`: `Omit`<`object` & `object`, `"type"`> | `null`; `created_at?`: `string` | `null`; `creator_user_id?`: `string` | `null`; `description?`: `string` | `null`; `display_name?`: `string` | `null`; `estimated_delivery_date?`: `string` | `null`; `external_memo?`: `string` | `null`; `id`: `string`; `is_ppro_enabled?`: `boolean` | `null`; `originating_account`: `object` & `object`; `payment_type`: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"`; `process_date?`: `string` | `null`; `status`: `"PROCESSING"` | `"SCHEDULED"` | `"PENDING_APPROVAL"` | `"FAILED"` | `"PROCESSED"`; }> *** ### createIncoming() [Section titled “createIncoming()”](#createincoming) > **createIncoming**(`body`, `options?`): `Promise`<{ `amount`: { `amount`: `number`; `currency`: `string` | `null`; }; `cancellation_reason?`: `"USER_CANCELLED"` | `"INSUFFICIENT_FUNDS"` | `"APPROVAL_DENIED"` | `"BLOCKED_BY_POSITIVE_PAY"` | `null`; `counterparty?`: `Omit`<`object` & `object`, `"type"`> | `null`; `created_at?`: `string` | `null`; `creator_user_id?`: `string` | `null`; `description?`: `string` | `null`; `display_name?`: `string` | `null`; `estimated_delivery_date?`: `string` | `null`; `external_memo?`: `string` | `null`; `id`: `string`; `is_ppro_enabled?`: `boolean` | `null`; `originating_account`: `object` & `object`; `payment_type`: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"`; `process_date?`: `string` | `null`; `status`: `"PROCESSING"` | `"SCHEDULED"` | `"PENDING_APPROVAL"` | `"FAILED"` | `"PROCESSED"`; }> Defined in: [src/payments/client.gen.ts:88](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L88) Create incoming transfer This endpoint creates a new incoming transfer. You may use use any eligible bank account connection to fund (ACH Debit) any active Brex business account. **Reminder**: You may not use the Brex API for any activity that requires a license or registration from any governmental authority without Brex’s prior review and approval. This includes but is not limited to any money services business or money transmission activity. Please review the [Brex Access Agreement](https://www.brex.com/legal/developer-portal/) and contact us if you have any questions. `POST /v1/incoming_transfers` — requires OAuth scope: `incoming_transfers` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-2) ##### body [Section titled “body”](#body-1) ###### amount [Section titled “amount”](#amount-1) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount.amount [Section titled “amount.amount”](#amountamount-1) `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 ``` ###### amount.currency [Section titled “amount.currency”](#amountcurrency-1) `string` | `null` **Description** The type of currency, in ISO 4217 format. **Default** ```ts USD ``` **Example** ```ts USD ``` ###### counterparty [Section titled “counterparty”](#counterparty-1) `object` & `object` ###### description [Section titled “description”](#description-1) `string` **Description** Description of the transfer for internal use. Not exposed externally. ###### receiving\_account [Section titled “receiving\_account”](#receiving_account) `object` & `object` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `amount`: { `amount`: `number`; `currency`: `string` | `null`; }; `cancellation_reason?`: `"USER_CANCELLED"` | `"INSUFFICIENT_FUNDS"` | `"APPROVAL_DENIED"` | `"BLOCKED_BY_POSITIVE_PAY"` | `null`; `counterparty?`: `Omit`<`object` & `object`, `"type"`> | `null`; `created_at?`: `string` | `null`; `creator_user_id?`: `string` | `null`; `description?`: `string` | `null`; `display_name?`: `string` | `null`; `estimated_delivery_date?`: `string` | `null`; `external_memo?`: `string` | `null`; `id`: `string`; `is_ppro_enabled?`: `boolean` | `null`; `originating_account`: `object` & `object`; `payment_type`: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"`; `process_date?`: `string` | `null`; `status`: `"PROCESSING"` | `"SCHEDULED"` | `"PENDING_APPROVAL"` | `"FAILED"` | `"PROCESSED"`; }> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `amount`: { `amount`: `number`; `currency`: `string` | `null`; }; `cancellation_reason?`: `"USER_CANCELLED"` | `"INSUFFICIENT_FUNDS"` | `"APPROVAL_DENIED"` | `"BLOCKED_BY_POSITIVE_PAY"` | `null`; `counterparty?`: `Omit`<`object` & `object`, `"type"`> | `null`; `created_at?`: `string` | `null`; `creator_user_id?`: `string` | `null`; `description?`: `string` | `null`; `display_name?`: `string` | `null`; `estimated_delivery_date?`: `string` | `null`; `external_memo?`: `string` | `null`; `id`: `string`; `is_ppro_enabled?`: `boolean` | `null`; `originating_account`: `object` & `object`; `payment_type`: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"`; `process_date?`: `string` | `null`; `status`: `"PROCESSING"` | `"SCHEDULED"` | `"PENDING_APPROVAL"` | `"FAILED"` | `"PROCESSED"`; }> Defined in: [src/payments/client.gen.ts:114](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L114) Get transfer This endpoint gets a transfer by ID. Currently, the API can only return transfers for the following payment rails: * ACH * DOMESTIC\_WIRE * CHEQUE * INTERNATIONAL\_WIRE `GET /v1/transfers/{id}` — requires OAuth scope: `transfers.readonly`, `incoming_transfers` #### Parameters [Section titled “Parameters”](#parameters-3) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `amount`: { `amount`: `number`; `currency`: `string` | `null`; }; `cancellation_reason?`: `"USER_CANCELLED"` | `"INSUFFICIENT_FUNDS"` | `"APPROVAL_DENIED"` | `"BLOCKED_BY_POSITIVE_PAY"` | `null`; `counterparty?`: `Omit`<`object` & `object`, `"type"`> | `null`; `created_at?`: `string` | `null`; `creator_user_id?`: `string` | `null`; `description?`: `string` | `null`; `display_name?`: `string` | `null`; `estimated_delivery_date?`: `string` | `null`; `external_memo?`: `string` | `null`; `id`: `string`; `is_ppro_enabled?`: `boolean` | `null`; `originating_account`: `object` & `object`; `payment_type`: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"`; `process_date?`: `string` | `null`; `status`: `"PROCESSING"` | `"SCHEDULED"` | `"PENDING_APPROVAL"` | `"FAILED"` | `"PROCESSED"`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/payments/client.gen.ts:139](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L139) Lists transfers This endpoint lists existing transfers for an account. Currently, the API can only return transfers for the following payment rails: * ACH * DOMESTIC\_WIRE * CHEQUE * INTERNATIONAL\_WIRE `GET /v1/transfers` — requires OAuth scope: `transfers.readonly`, `incoming_transfers` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-4) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> # Vendors Defined in: [src/payments/client.gen.ts:151](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L151) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Vendors**(`_core`): `Vendors` Defined in: [src/payments/client.gen.ts:152](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L152) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Vendors` ## Methods [Section titled “Methods”](#methods) ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `company_name?`: `string` | `null`; `email?`: `string` | `null`; `id`: `string`; `payment_accounts?`: `object`\[] | `null`; `phone?`: `string` | `null`; }> Defined in: [src/payments/client.gen.ts:162](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L162) Create vendor This endpoint creates a new vendor. `POST /v1/vendors` — requires OAuth scope: `vendors` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-1) ##### body [Section titled “body”](#body) ###### company\_name [Section titled “company\_name”](#company_name) `string` **Description** Name for vendor. The name must be unique. ###### email? [Section titled “email?”](#email) `string` | `null` Format: email **Description** Email for vendor. ###### payment\_accounts? [Section titled “payment\_accounts?”](#payment_accounts) `object`\[] | `null` **Description** Payment accounts associated with the vendor. ###### phone? [Section titled “phone?”](#phone) `string` | `null` **Description** Phone number for vendor. ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `company_name?`: `string` | `null`; `email?`: `string` | `null`; `id`: `string`; `payment_accounts?`: `object`\[] | `null`; `phone?`: `string` | `null`; }> *** ### delete() [Section titled “delete()”](#delete) > **delete**(`id`, `options?`): `Promise`<`void`> Defined in: [src/payments/client.gen.ts:180](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L180) Delete vendor. This endpoint deletes a vendor by ID. `DELETE /v1/vendors/{id}` — requires OAuth scope: `vendors` #### Parameters [Section titled “Parameters”](#parameters-2) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<`void`> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `company_name?`: `string` | `null`; `email?`: `string` | `null`; `id`: `string`; `payment_accounts?`: `object`\[] | `null`; `phone?`: `string` | `null`; }> Defined in: [src/payments/client.gen.ts:196](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L196) Get vendor This endpoint gets a vendor by ID. `GET /v1/vendors/{id}` — requires OAuth scope: `vendors.readonly` #### Parameters [Section titled “Parameters”](#parameters-3) ##### id [Section titled “id”](#id-1) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `company_name?`: `string` | `null`; `email?`: `string` | `null`; `id`: `string`; `payment_accounts?`: `object`\[] | `null`; `phone?`: `string` | `null`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/payments/client.gen.ts:216](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L216) Lists vendors This endpoint lists all existing vendors for an account. Takes an optional parameter to match by vendor name. `GET /v1/vendors` — requires OAuth scope: `vendors.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-4) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ###### name? [Section titled “name?”](#name) `string` | `null` ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### update() [Section titled “update()”](#update) > **update**(`id`, `body`, `options?`): `Promise`<{ `company_name?`: `string` | `null`; `email?`: `string` | `null`; `id`: `string`; `payment_accounts?`: `object`\[] | `null`; `phone?`: `string` | `null`; }> Defined in: [src/payments/client.gen.ts:233](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/client.gen.ts#L233) Update vendor Updates an existing vendor by ID. `PUT /v1/vendors/{id}` — requires OAuth scope: `vendors` Supports an optional `Idempotency-Key` via `options.idempotencyKey`. #### Parameters [Section titled “Parameters”](#parameters-5) ##### id [Section titled “id”](#id-2) `string` ##### body [Section titled “body”](#body-1) ###### beneficiary\_name? [Section titled “beneficiary\_name?”](#beneficiary_name) `string` | `null` **Description** Name for the Beneficiary ###### company\_name? [Section titled “company\_name?”](#company_name-1) `string` | `null` **Description** Name for vendor ###### email? [Section titled “email?”](#email-1) `string` | `null` Format: email **Description** Email for vendor ###### payment\_accounts? [Section titled “payment\_accounts?”](#payment_accounts-1) `object`\[] | `null` **Description** To update payment instruments, we require the entire payload for each payment instrument that is being updated. ###### phone? [Section titled “phone?”](#phone-1) `string` | `null` **Description** Phone number for vendor ##### options? [Section titled “options?”](#options-4) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-5) `Promise`<{ `company_name?`: `string` | `null`; `email?`: `string` | `null`; `id`: `string`; `payment_accounts?`: `object`\[] | `null`; `phone?`: `string` | `null`; }> # createPaymentsClient > **createPaymentsClient**(`options`): [`BrexPayments`](/brex/api/payments/classes/brexpayments/) Defined in: [src/payments/index.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/index.ts#L13) Standalone client for the Brex Payments API. ## Parameters [Section titled “Parameters”](#parameters) ### options [Section titled “options”](#options) [`BrexOptions`](/brex/api/index/interfaces/brexoptions/) ## Returns [Section titled “Returns”](#returns) [`BrexPayments`](/brex/api/payments/classes/brexpayments/) # PaymentsComponents Defined in: [src/payments/types.gen.ts:181](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L181) ## Properties [Section titled “Properties”](#properties) ### headers [Section titled “headers”](#headers) > **headers**: `never` Defined in: [src/payments/types.gen.ts:715](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L715) *** ### parameters [Section titled “parameters”](#parameters) > **parameters**: `never` Defined in: [src/payments/types.gen.ts:713](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L713) *** ### pathItems [Section titled “pathItems”](#pathitems) > **pathItems**: `never` Defined in: [src/payments/types.gen.ts:716](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L716) *** ### requestBodies [Section titled “requestBodies”](#requestbodies) > **requestBodies**: `never` Defined in: [src/payments/types.gen.ts:714](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L714) *** ### responses [Section titled “responses”](#responses) > **responses**: `never` Defined in: [src/payments/types.gen.ts:712](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L712) *** ### schemas [Section titled “schemas”](#schemas) > **schemas**: `object` Defined in: [src/payments/types.gen.ts:182](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L182) #### AccountClass [Section titled “AccountClass”](#accountclass) > **AccountClass**: `"BUSINESS"` | `"PERSONAL"` #### AccountType [Section titled “AccountType”](#accounttype) > **AccountType**: `"CHECKING"` | `"SAVING"` #### ACHDetailsRequest [Section titled “ACHDetailsRequest”](#achdetailsrequest) > **ACHDetailsRequest**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration) ###### account\_class [Section titled “account\_class”](#account_class) > **account\_class**: `"BUSINESS"` | `"PERSONAL"` ###### account\_number [Section titled “account\_number”](#account_number) > **account\_number**: `string` ###### account\_type [Section titled “account\_type”](#account_type) > **account\_type**: `"CHECKING"` | `"SAVING"` ###### beneficiary\_name? [Section titled “beneficiary\_name?”](#beneficiary_name) > `optional` **beneficiary\_name?**: `string` | `null` ###### routing\_number [Section titled “routing\_number”](#routing_number) > **routing\_number**: `string` ###### Description [Section titled “Description”](#description) The routing number must follow proper format. ###### type [Section titled “type”](#type) > **type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-1) ###### type [Section titled “type”](#type-1) > **type**: `"ACH"` ###### Description [Section titled “Description”](#description-1) discriminator enum property added by openapi-typescript #### ACHDetailsResponse [Section titled “ACHDetailsResponse”](#achdetailsresponse) > **ACHDetailsResponse**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-2) ###### account\_class? [Section titled “account\_class?”](#account_class-1) > `optional` **account\_class?**: `"BUSINESS"` | `"PERSONAL"` | `null` ###### account\_number [Section titled “account\_number”](#account_number-1) > **account\_number**: `string` ###### account\_type? [Section titled “account\_type?”](#account_type-1) > `optional` **account\_type?**: `"CHECKING"` | `"SAVING"` | `null` ###### payment\_instrument\_id [Section titled “payment\_instrument\_id”](#payment_instrument_id) > **payment\_instrument\_id**: `string` ###### Description [Section titled “Description”](#description-2) Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. ###### routing\_number [Section titled “routing\_number”](#routing_number-1) > **routing\_number**: `string` ###### type [Section titled “type”](#type-2) > **type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-3) ###### type [Section titled “type”](#type-3) > **type**: `"ACH"` ###### Description [Section titled “Description”](#description-3) discriminator enum property added by openapi-typescript #### Address [Section titled “Address”](#address) > **Address**: `object` ##### Description [Section titled “Description”](#description-4) Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed). ##### Address.city? [Section titled “Address.city?”](#addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-5) City, district, suburb, town, or village. ##### Address.country? [Section titled “Address.country?”](#addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-6) Two-letter country code (ISO 3166-1 alpha-2). ##### Address.line1? [Section titled “Address.line1?”](#addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-7) Address line 1, no PO Box. ##### Address.line2? [Section titled “Address.line2?”](#addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-8) Address line 2 (e.g., apartment, suite, unit, or building). ##### Address.phone\_number? [Section titled “Address.phone\_number?”](#addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-9) Phone number. ##### Address.postal\_code? [Section titled “Address.postal\_code?”](#addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-10) ZIP or postal code. ##### Address.state? [Section titled “Address.state?”](#addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-11) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. #### ApprovalType [Section titled “ApprovalType”](#approvaltype) > **ApprovalType**: `"MANUAL"` ##### Description [Section titled “Description”](#description-12) Specifies the approval type for the transaction. `MANUAL` requires a cash admin to approve the transaction before disbursing funds. When not set, the default policy will apply. #### Balance [Section titled “Balance”](#balance) > **Balance**: `object` ##### Balance.amount [Section titled “Balance.amount”](#balanceamount) > **amount**: `object` ##### Balance.amount.amount [Section titled “Balance.amount.amount”](#balanceamountamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-13) 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 [Section titled “Example”](#example) ```ts 700 ``` ##### Balance.amount.currency [Section titled “Balance.amount.currency”](#balanceamountcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-14) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default) ```ts USD ``` ###### Example [Section titled “Example”](#example-1) ```ts USD ``` ##### Balance.as\_of\_date [Section titled “Balance.as\_of\_date”](#balanceas_of_date) > **as\_of\_date**: `string` Format: date #### BankAccountDetailsResponse [Section titled “BankAccountDetailsResponse”](#bankaccountdetailsresponse) > **BankAccountDetailsResponse**: `Omit`<`object` & `object`, `"type"`> & `object` & `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-4) ###### account\_number? [Section titled “account\_number?”](#account_number-2) > `optional` **account\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-15) Account number of a bank account (or IBAN code for international transfer). For incoming cheques, this field might be null. ###### beneficiary\_bank? [Section titled “beneficiary\_bank?”](#beneficiary_bank) > `optional` **beneficiary\_bank?**: { `address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `name?`: `string` | `null`; } | `null` ###### description? [Section titled “description?”](#description-16) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-17) Description of the transfer. ###### external\_memo? [Section titled “external\_memo?”](#external_memo) > `optional` **external\_memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-18) External Memo populated by the sender ###### fed\_reference\_number? [Section titled “fed\_reference\_number?”](#fed_reference_number) > `optional` **fed\_reference\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-19) Fed reference number for incoming wires ###### routing\_number? [Section titled “routing\_number?”](#routing_number-2) > `optional` **routing\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-20) Routing number of a bank account (or SWIFT/BIC code for international transfer). For incoming cheques, this field might be null. ###### type [Section titled “type”](#type-4) > **type**: `"VENDOR"` | `"BOOK_TRANSFER"` | `"BANK_ACCOUNT"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-5) ###### type [Section titled “type”](#type-5) > **type**: `"BANK_ACCOUNT"` ###### Description [Section titled “Description”](#description-21) discriminator enum property added by openapi-typescript ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-6) ###### type [Section titled “type”](#type-6) > **type**: `"BANK_ACCOUNT"` ###### Description [Section titled “Description”](#description-22) discriminator enum property added by openapi-typescript #### BankConnection [Section titled “BankConnection”](#bankconnection) > **BankConnection**: `object` ##### BankConnection.available\_balance? [Section titled “BankConnection.available\_balance?”](#bankconnectionavailable_balance) > `optional` **available\_balance?**: { `amount`: { `amount`: `number`; `currency`: `string` | `null`; }; `as_of_date`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `amount`: { `amount`: `number`; `currency`: `string` | `null`; }; `as_of_date`: `string`; } ###### amount [Section titled “amount”](#amount) > **amount**: `object` ###### amount.amount [Section titled “amount.amount”](#amountamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-23) 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 [Section titled “Example”](#example-2) ```ts 700 ``` ###### amount.currency [Section titled “amount.currency”](#amountcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-24) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-1) ```ts USD ``` ###### Example [Section titled “Example”](#example-3) ```ts USD ``` ###### as\_of\_date [Section titled “as\_of\_date”](#as_of_date) > **as\_of\_date**: `string` Format: date *** `null` ##### BankConnection.bank\_details [Section titled “BankConnection.bank\_details”](#bankconnectionbank_details) > **bank\_details**: `object` ##### BankConnection.bank\_details.name [Section titled “BankConnection.bank\_details.name”](#bankconnectionbank_detailsname) > **name**: `string` ###### Description [Section titled “Description”](#description-25) The name of the bank ##### BankConnection.bank\_details.type [Section titled “BankConnection.bank\_details.type”](#bankconnectionbank_detailstype) > **type**: `"CHECKING"` | `"SAVING"` ##### BankConnection.brex\_account\_id? [Section titled “BankConnection.brex\_account\_id?”](#bankconnectionbrex_account_id) > `optional` **brex\_account\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-26) Brex business account ID ##### BankConnection.current\_balance? [Section titled “BankConnection.current\_balance?”](#bankconnectioncurrent_balance) > `optional` **current\_balance?**: { `amount`: { `amount`: `number`; `currency`: `string` | `null`; }; `as_of_date`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `amount`: { `amount`: `number`; `currency`: `string` | `null`; }; `as_of_date`: `string`; } ###### amount [Section titled “amount”](#amount-1) > **amount**: `object` ###### amount.amount [Section titled “amount.amount”](#amountamount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-27) 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 [Section titled “Example”](#example-4) ```ts 700 ``` ###### amount.currency [Section titled “amount.currency”](#amountcurrency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-28) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-2) ```ts USD ``` ###### Example [Section titled “Example”](#example-5) ```ts USD ``` ###### as\_of\_date [Section titled “as\_of\_date”](#as_of_date-1) > **as\_of\_date**: `string` Format: date *** `null` ##### BankConnection.id [Section titled “BankConnection.id”](#bankconnectionid) > **id**: `string` ##### BankConnection.last\_four [Section titled “BankConnection.last\_four”](#bankconnectionlast_four) > **last\_four**: `string` #### BankDetails [Section titled “BankDetails”](#bankdetails) > **BankDetails**: `object` ##### BankDetails.name [Section titled “BankDetails.name”](#bankdetailsname) > **name**: `string` ###### Description [Section titled “Description”](#description-29) The name of the bank ##### BankDetails.type [Section titled “BankDetails.type”](#bankdetailstype) > **type**: `"CHECKING"` | `"SAVING"` #### BankType [Section titled “BankType”](#banktype) > **BankType**: `"CHECKING"` | `"SAVING"` #### BeneficiaryBank [Section titled “BeneficiaryBank”](#beneficiarybank) > **BeneficiaryBank**: `object` ##### BeneficiaryBank.address? [Section titled “BeneficiaryBank.address?”](#beneficiarybankaddress) > `optional` **address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-30) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-31) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-32) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-33) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-34) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-35) ZIP or postal code. ###### state? [Section titled “state?”](#state) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-36) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### BeneficiaryBank.name? [Section titled “BeneficiaryBank.name?”](#beneficiarybankname) > `optional` **name?**: `string` | `null` #### BookTransferDetails [Section titled “BookTransferDetails”](#booktransferdetails) > **BookTransferDetails**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-7) ###### recipient [Section titled “recipient”](#recipient) > **recipient**: `object` ###### recipient.id [Section titled “recipient.id”](#recipientid) > **id**: `string` ###### recipient.type [Section titled “recipient.type”](#recipienttype) > **type**: `"ACCOUNT_ID"` | `"PAYMENT_INSTRUMENT_ID"` ###### type [Section titled “type”](#type-7) > **type**: `"VENDOR"` | `"BOOK_TRANSFER"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-8) ###### type [Section titled “type”](#type-8) > **type**: `"BOOK_TRANSFER"` ###### Description [Section titled “Description”](#description-37) discriminator enum property added by openapi-typescript #### BookTransferDetailsResponse [Section titled “BookTransferDetailsResponse”](#booktransferdetailsresponse) > **BookTransferDetailsResponse**: `Omit`<`object` & `object`, `"type"`> & `object` & `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-9) ###### deposit\_account\_id [Section titled “deposit\_account\_id”](#deposit_account_id) > **deposit\_account\_id**: `string` ###### Description [Section titled “Description”](#description-38) This feature is currently limited to certain customers, please reach out if you are interested ###### type [Section titled “type”](#type-9) > **type**: `"VENDOR"` | `"BOOK_TRANSFER"` | `"BANK_ACCOUNT"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-10) ###### type [Section titled “type”](#type-10) > **type**: `"BOOK_TRANSFER"` ###### Description [Section titled “Description”](#description-39) discriminator enum property added by openapi-typescript ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-11) ###### type [Section titled “type”](#type-11) > **type**: `"BOOK_TRANSFER"` ###### Description [Section titled “Description”](#description-40) discriminator enum property added by openapi-typescript #### BrexCashAccountDetails [Section titled “BrexCashAccountDetails”](#brexcashaccountdetails) > **BrexCashAccountDetails**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-12) ###### id [Section titled “id”](#id) > **id**: `string` ###### Description [Section titled “Description”](#description-41) ID of the Brex Business account: Can be found from the `/accounts` endpoint where instrument type is `CASH`. ###### type [Section titled “type”](#type-12) > **type**: `"BREX_CASH"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-13) ###### type [Section titled “type”](#type-13) > **type**: `"BREX_CASH"` ###### Description [Section titled “Description”](#description-42) discriminator enum property added by openapi-typescript #### BrexCashAccountDetailsResponse [Section titled “BrexCashAccountDetailsResponse”](#brexcashaccountdetailsresponse) > **BrexCashAccountDetailsResponse**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-14) ###### id [Section titled “id”](#id-1) > **id**: `string` ###### Description [Section titled “Description”](#description-43) ID of the Brex Business account. ###### type [Section titled “type”](#type-14) > **type**: `"BREX_CASH"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-15) ###### type [Section titled “type”](#type-15) > **type**: `"BREX_CASH"` ###### Description [Section titled “Description”](#description-44) discriminator enum property added by openapi-typescript #### BrexCashDetails [Section titled “BrexCashDetails”](#brexcashdetails) > **BrexCashDetails**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-16) ###### id [Section titled “id”](#id-2) > **id**: `string` ###### Description [Section titled “Description”](#description-45) ID of the Brex business account: Can be found from the [List business accounts](/openapi/transactions_api/#operation/listAccounts) endpoint ###### type [Section titled “type”](#type-16) > **type**: `"BREX_CASH"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-17) ###### type [Section titled “type”](#type-17) > **type**: `"BREX_CASH"` ###### Description [Section titled “Description”](#description-46) discriminator enum property added by openapi-typescript #### ChequeDetailsRequest [Section titled “ChequeDetailsRequest”](#chequedetailsrequest) > **ChequeDetailsRequest**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-18) ###### beneficiary\_name? [Section titled “beneficiary\_name?”](#beneficiary_name-1) > `optional` **beneficiary\_name?**: `string` | `null` ###### mailing\_address [Section titled “mailing\_address”](#mailing_address) > **mailing\_address**: `object` ###### mailing\_address.city? [Section titled “mailing\_address.city?”](#mailing_addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-47) City, district, suburb, town, or village. ###### mailing\_address.country? [Section titled “mailing\_address.country?”](#mailing_addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-48) Two-letter country code (ISO 3166-1 alpha-2). ###### mailing\_address.line1? [Section titled “mailing\_address.line1?”](#mailing_addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-49) Address line 1, no PO Box. ###### mailing\_address.line2? [Section titled “mailing\_address.line2?”](#mailing_addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-50) Address line 2 (e.g., apartment, suite, unit, or building). ###### mailing\_address.phone\_number? [Section titled “mailing\_address.phone\_number?”](#mailing_addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-51) Phone number. ###### mailing\_address.postal\_code? [Section titled “mailing\_address.postal\_code?”](#mailing_addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-52) ZIP or postal code. ###### mailing\_address.state? [Section titled “mailing\_address.state?”](#mailing_addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-53) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### recipient\_name [Section titled “recipient\_name”](#recipient_name) > **recipient\_name**: `string` ###### type [Section titled “type”](#type-18) > **type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-19) ###### type [Section titled “type”](#type-19) > **type**: `"CHEQUE"` ###### Description [Section titled “Description”](#description-54) discriminator enum property added by openapi-typescript #### ChequeDetailsResponse [Section titled “ChequeDetailsResponse”](#chequedetailsresponse) > **ChequeDetailsResponse**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-20) ###### mailing\_address [Section titled “mailing\_address”](#mailing_address-1) > **mailing\_address**: `object` ###### mailing\_address.city? [Section titled “mailing\_address.city?”](#mailing_addresscity-1) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-55) City, district, suburb, town, or village. ###### mailing\_address.country? [Section titled “mailing\_address.country?”](#mailing_addresscountry-1) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-56) Two-letter country code (ISO 3166-1 alpha-2). ###### mailing\_address.line1? [Section titled “mailing\_address.line1?”](#mailing_addressline1-1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-57) Address line 1, no PO Box. ###### mailing\_address.line2? [Section titled “mailing\_address.line2?”](#mailing_addressline2-1) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-58) Address line 2 (e.g., apartment, suite, unit, or building). ###### mailing\_address.phone\_number? [Section titled “mailing\_address.phone\_number?”](#mailing_addressphone_number-1) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-59) Phone number. ###### mailing\_address.postal\_code? [Section titled “mailing\_address.postal\_code?”](#mailing_addresspostal_code-1) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-60) ZIP or postal code. ###### mailing\_address.state? [Section titled “mailing\_address.state?”](#mailing_addressstate-1) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-61) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### payment\_instrument\_id [Section titled “payment\_instrument\_id”](#payment_instrument_id-1) > **payment\_instrument\_id**: `string` ###### Description [Section titled “Description”](#description-62) Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. ###### recipient\_name [Section titled “recipient\_name”](#recipient_name-1) > **recipient\_name**: `string` ###### type [Section titled “type”](#type-20) > **type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-21) ###### type [Section titled “type”](#type-21) > **type**: `"CHEQUE"` ###### Description [Section titled “Description”](#description-63) discriminator enum property added by openapi-typescript #### CounterParty [Section titled “CounterParty”](#counterparty) > **CounterParty**: `object` & `object` | `object` & `object` ##### Description [Section titled “Description”](#description-64) Counterparty Details for the transfer #### CounterPartyBankDetails [Section titled “CounterPartyBankDetails”](#counterpartybankdetails) > **CounterPartyBankDetails**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-22) ###### id [Section titled “id”](#id-3) > **id**: `string` ###### Description [Section titled “Description”](#description-65) The financial account id: Can be found from the [List linked accounts](/openapi/payments_api/#operation/listLinkedAccounts) endpoint ###### type [Section titled “type”](#type-22) > **type**: `"BANK"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-23) ###### type [Section titled “type”](#type-23) > **type**: `"BANK"` ###### Description [Section titled “Description”](#description-66) discriminator enum property added by openapi-typescript #### CounterPartyIncomingTransfer [Section titled “CounterPartyIncomingTransfer”](#counterpartyincomingtransfer) > **CounterPartyIncomingTransfer**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-24) ###### id [Section titled “id”](#id-4) > **id**: `string` ###### Description [Section titled “Description”](#description-67) The financial account id: Can be found from the [List linked accounts](/openapi/payments_api/#operation/listLinkedAccounts) endpoint ###### type [Section titled “type”](#type-24) > **type**: `"BANK"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-25) ###### type [Section titled “type”](#type-25) > **type**: `"BANK"` ###### Description [Section titled “Description”](#description-68) discriminator enum property added by openapi-typescript ##### Description [Section titled “Description”](#description-69) Counterparty Details for the transfer #### CounterPartyIncomingTransferType [Section titled “CounterPartyIncomingTransferType”](#counterpartyincomingtransfertype) > **CounterPartyIncomingTransferType**: `"BANK"` #### CounterPartyResponse [Section titled “CounterPartyResponse”](#counterpartyresponse) > **CounterPartyResponse**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-26) ###### account\_number? [Section titled “account\_number?”](#account_number-3) > `optional` **account\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-70) Account number of a bank account (or IBAN code for international transfer). ###### id [Section titled “id”](#id-5) > **id**: `string` ###### Description [Section titled “Description”](#description-71) Vendor ID returned from `/vendors` endpoint ###### payment\_instrument\_id [Section titled “payment\_instrument\_id”](#payment_instrument_id-2) > **payment\_instrument\_id**: `string` ###### routing\_number? [Section titled “routing\_number?”](#routing_number-3) > `optional` **routing\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-72) Routing number of a bank account (or SWIFT/BIC code for international transfer). ###### type [Section titled “type”](#type-26) > **type**: `"VENDOR"` | `"BOOK_TRANSFER"` | `"BANK_ACCOUNT"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-27) ###### type [Section titled “type”](#type-27) > **type**: `"VENDOR"` ###### Description [Section titled “Description”](#description-73) discriminator enum property added by openapi-typescript ##### Description [Section titled “Description”](#description-74) Counterparty Details for the transfer - Currently only supports vendors that are returned in the response from the /vendors endpoint BOOK\_TRANSFER is a limited feature. Please reach out if you are interested. #### CounterPartyResponseType [Section titled “CounterPartyResponseType”](#counterpartyresponsetype) > **CounterPartyResponseType**: `"VENDOR"` | `"BOOK_TRANSFER"` | `"BANK_ACCOUNT"` #### CounterPartyType [Section titled “CounterPartyType”](#counterpartytype) > **CounterPartyType**: `"VENDOR"` | `"BOOK_TRANSFER"` #### CreateIncomingTransferRequest [Section titled “CreateIncomingTransferRequest”](#createincomingtransferrequest) > **CreateIncomingTransferRequest**: `object` ##### CreateIncomingTransferRequest.amount [Section titled “CreateIncomingTransferRequest.amount”](#createincomingtransferrequestamount) > **amount**: `object` ##### CreateIncomingTransferRequest.amount.amount [Section titled “CreateIncomingTransferRequest.amount.amount”](#createincomingtransferrequestamountamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-75) 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 [Section titled “Example”](#example-6) ```ts 700 ``` ##### CreateIncomingTransferRequest.amount.currency [Section titled “CreateIncomingTransferRequest.amount.currency”](#createincomingtransferrequestamountcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-76) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-3) ```ts USD ``` ###### Example [Section titled “Example”](#example-7) ```ts USD ``` ##### CreateIncomingTransferRequest.counterparty [Section titled “CreateIncomingTransferRequest.counterparty”](#createincomingtransferrequestcounterparty) > **counterparty**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-28) ###### id [Section titled “id”](#id-6) > **id**: `string` ###### Description [Section titled “Description”](#description-77) The financial account id: Can be found from the [List linked accounts](/openapi/payments_api/#operation/listLinkedAccounts) endpoint ###### type [Section titled “type”](#type-28) > **type**: `"BANK"` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-29) ###### type [Section titled “type”](#type-29) > **type**: `"BANK"` ###### Description [Section titled “Description”](#description-78) discriminator enum property added by openapi-typescript ##### CreateIncomingTransferRequest.description [Section titled “CreateIncomingTransferRequest.description”](#createincomingtransferrequestdescription) > **description**: `string` ###### Description [Section titled “Description”](#description-79) Description of the transfer for internal use. Not exposed externally. ##### CreateIncomingTransferRequest.receiving\_account [Section titled “CreateIncomingTransferRequest.receiving\_account”](#createincomingtransferrequestreceiving_account) > **receiving\_account**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-30) ###### id [Section titled “id”](#id-7) > **id**: `string` ###### Description [Section titled “Description”](#description-80) ID of the Brex business account: Can be found from the [List business accounts](/openapi/transactions_api/#operation/listAccounts) endpoint ###### type [Section titled “type”](#type-30) > **type**: `"BREX_CASH"` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-31) ###### type [Section titled “type”](#type-31) > **type**: `"BREX_CASH"` ###### Description [Section titled “Description”](#description-81) discriminator enum property added by openapi-typescript #### CreateTransferRequest [Section titled “CreateTransferRequest”](#createtransferrequest) > **CreateTransferRequest**: `object` ##### CreateTransferRequest.amount [Section titled “CreateTransferRequest.amount”](#createtransferrequestamount) > **amount**: `object` ##### CreateTransferRequest.amount.amount [Section titled “CreateTransferRequest.amount.amount”](#createtransferrequestamountamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-82) 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 [Section titled “Example”](#example-8) ```ts 700 ``` ##### CreateTransferRequest.amount.currency [Section titled “CreateTransferRequest.amount.currency”](#createtransferrequestamountcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-83) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-4) ```ts USD ``` ###### Example [Section titled “Example”](#example-9) ```ts USD ``` ##### CreateTransferRequest.approval\_type? [Section titled “CreateTransferRequest.approval\_type?”](#createtransferrequestapproval_type) > `optional` **approval\_type?**: `"MANUAL"` | `null` ##### CreateTransferRequest.counterparty [Section titled “CreateTransferRequest.counterparty”](#createtransferrequestcounterparty) > **counterparty**: `object` & `object` | `object` & `object` ##### CreateTransferRequest.description [Section titled “CreateTransferRequest.description”](#createtransferrequestdescription) > **description**: `string` ###### Description [Section titled “Description”](#description-84) Description of the transfer for internal use. Not exposed externally. ##### CreateTransferRequest.external\_memo [Section titled “CreateTransferRequest.external\_memo”](#createtransferrequestexternal_memo) > **external\_memo**: `string` ###### Description [Section titled “Description”](#description-85) External memo for the transfer. `Payment Instructions` for Wires and the `Entry Description` for ACH payments. Must be at most 90 characters for `ACH` and `WIRE` transactions and at most 40 characters for `CHEQUES` ##### CreateTransferRequest.is\_ppro\_enabled? [Section titled “CreateTransferRequest.is\_ppro\_enabled?”](#createtransferrequestis_ppro_enabled) > `optional` **is\_ppro\_enabled?**: `boolean` ###### Description [Section titled “Description”](#description-86) When set to true, add Principal Protection (PPRO) to the transaction. PPRO means Brex will cover any fees charged by intemediary or receiving banks. PPRO charges will be billed separately in a monthly statement. PPRO is only available for international wire transactions. ##### CreateTransferRequest.originating\_account [Section titled “CreateTransferRequest.originating\_account”](#createtransferrequestoriginating_account) > **originating\_account**: `Omit`<`object` & `object`, `"type"`> #### CreateVendorRequest [Section titled “CreateVendorRequest”](#createvendorrequest) > **CreateVendorRequest**: `object` ##### CreateVendorRequest.company\_name [Section titled “CreateVendorRequest.company\_name”](#createvendorrequestcompany_name) > **company\_name**: `string` ###### Description [Section titled “Description”](#description-87) Name for vendor. The name must be unique. ##### CreateVendorRequest.email? [Section titled “CreateVendorRequest.email?”](#createvendorrequestemail) > `optional` **email?**: `string` | `null` Format: email ###### Description [Section titled “Description”](#description-88) Email for vendor. ##### CreateVendorRequest.payment\_accounts? [Section titled “CreateVendorRequest.payment\_accounts?”](#createvendorrequestpayment_accounts) > `optional` **payment\_accounts?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-89) Payment accounts associated with the vendor. ##### CreateVendorRequest.phone? [Section titled “CreateVendorRequest.phone?”](#createvendorrequestphone) > `optional` **phone?**: `string` | `null` ###### Description [Section titled “Description”](#description-90) Phone number for vendor. #### DomesticWireDetailsRequest [Section titled “DomesticWireDetailsRequest”](#domesticwiredetailsrequest) > **DomesticWireDetailsRequest**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-32) ###### account\_number [Section titled “account\_number”](#account_number-4) > **account\_number**: `string` ###### address [Section titled “address”](#address-1) > **address**: `object` ###### address.city? [Section titled “address.city?”](#addresscity-1) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-91) City, district, suburb, town, or village. ###### address.country? [Section titled “address.country?”](#addresscountry-1) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-92) Two-letter country code (ISO 3166-1 alpha-2). ###### address.line1? [Section titled “address.line1?”](#addressline1-1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-93) Address line 1, no PO Box. ###### address.line2? [Section titled “address.line2?”](#addressline2-1) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-94) Address line 2 (e.g., apartment, suite, unit, or building). ###### address.phone\_number? [Section titled “address.phone\_number?”](#addressphone_number-1) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-95) Phone number. ###### address.postal\_code? [Section titled “address.postal\_code?”](#addresspostal_code-1) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-96) ZIP or postal code. ###### address.state? [Section titled “address.state?”](#addressstate-1) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-97) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### beneficiary\_name? [Section titled “beneficiary\_name?”](#beneficiary_name-2) > `optional` **beneficiary\_name?**: `string` | `null` ###### routing\_number [Section titled “routing\_number”](#routing_number-4) > **routing\_number**: `string` ###### Description [Section titled “Description”](#description-98) The routing number must follow proper format. ###### type [Section titled “type”](#type-32) > **type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-33) ###### type [Section titled “type”](#type-33) > **type**: `"DOMESTIC_WIRE"` ###### Description [Section titled “Description”](#description-99) discriminator enum property added by openapi-typescript #### DomesticWireDetailsResponse [Section titled “DomesticWireDetailsResponse”](#domesticwiredetailsresponse) > **DomesticWireDetailsResponse**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-34) ###### account\_number [Section titled “account\_number”](#account_number-5) > **account\_number**: `string` ###### address [Section titled “address”](#address-2) > **address**: `object` ###### address.city? [Section titled “address.city?”](#addresscity-2) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-100) City, district, suburb, town, or village. ###### address.country? [Section titled “address.country?”](#addresscountry-2) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-101) Two-letter country code (ISO 3166-1 alpha-2). ###### address.line1? [Section titled “address.line1?”](#addressline1-2) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-102) Address line 1, no PO Box. ###### address.line2? [Section titled “address.line2?”](#addressline2-2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-103) Address line 2 (e.g., apartment, suite, unit, or building). ###### address.phone\_number? [Section titled “address.phone\_number?”](#addressphone_number-2) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-104) Phone number. ###### address.postal\_code? [Section titled “address.postal\_code?”](#addresspostal_code-2) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-105) ZIP or postal code. ###### address.state? [Section titled “address.state?”](#addressstate-2) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-106) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### payment\_instrument\_id [Section titled “payment\_instrument\_id”](#payment_instrument_id-3) > **payment\_instrument\_id**: `string` ###### Description [Section titled “Description”](#description-107) Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. ###### routing\_number [Section titled “routing\_number”](#routing_number-5) > **routing\_number**: `string` ###### type [Section titled “type”](#type-34) > **type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-35) ###### type [Section titled “type”](#type-35) > **type**: `"DOMESTIC_WIRE"` ###### Description [Section titled “Description”](#description-108) discriminator enum property added by openapi-typescript #### InternationalWireDetailsResponse [Section titled “InternationalWireDetailsResponse”](#internationalwiredetailsresponse) > **InternationalWireDetailsResponse**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-36) ###### address [Section titled “address”](#address-3) > **address**: `object` ###### address.city? [Section titled “address.city?”](#addresscity-3) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-109) City, district, suburb, town, or village. ###### address.country? [Section titled “address.country?”](#addresscountry-3) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-110) Two-letter country code (ISO 3166-1 alpha-2). ###### address.line1? [Section titled “address.line1?”](#addressline1-3) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-111) Address line 1, no PO Box. ###### address.line2? [Section titled “address.line2?”](#addressline2-3) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-112) Address line 2 (e.g., apartment, suite, unit, or building). ###### address.phone\_number? [Section titled “address.phone\_number?”](#addressphone_number-3) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-113) Phone number. ###### address.postal\_code? [Section titled “address.postal\_code?”](#addresspostal_code-3) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-114) ZIP or postal code. ###### address.state? [Section titled “address.state?”](#addressstate-3) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-115) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### beneficiary\_bank\_name? [Section titled “beneficiary\_bank\_name?”](#beneficiary_bank_name) > `optional` **beneficiary\_bank\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-116) Name of counterparty’s bank ###### iban [Section titled “iban”](#iban) > **iban**: `string` ###### Description [Section titled “Description”](#description-117) Counterparty’s international bank account number ###### payment\_instrument\_id [Section titled “payment\_instrument\_id”](#payment_instrument_id-4) > **payment\_instrument\_id**: `string` ###### Description [Section titled “Description”](#description-118) Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. ###### swift\_code [Section titled “swift\_code”](#swift_code) > **swift\_code**: `string` ###### Description [Section titled “Description”](#description-119) Counterparty’s `SWIFT` code ###### type [Section titled “type”](#type-36) > **type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-37) ###### type [Section titled “type”](#type-37) > **type**: `"INTERNATIONAL_WIRE"` ###### Description [Section titled “Description”](#description-120) discriminator enum property added by openapi-typescript #### Money [Section titled “Money”](#money) > **Money**: `object` ##### Description [Section titled “Description”](#description-121) Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700. ##### Money.amount [Section titled “Money.amount”](#moneyamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-122) 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 [Section titled “Example”](#example-10) ```ts 700 ``` ##### Money.currency [Section titled “Money.currency”](#moneycurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-123) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-5) ```ts USD ``` ###### Example [Section titled “Example”](#example-11) ```ts USD ``` #### OriginatingAccount [Section titled “OriginatingAccount”](#originatingaccount) > **OriginatingAccount**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-38) ###### id [Section titled “id”](#id-8) > **id**: `string` ###### Description [Section titled “Description”](#description-124) ID of the Brex Business account: Can be found from the `/accounts` endpoint where instrument type is `CASH`. ###### type [Section titled “type”](#type-38) > **type**: `"BREX_CASH"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-39) ###### type [Section titled “type”](#type-39) > **type**: `"BREX_CASH"` ###### Description [Section titled “Description”](#description-125) discriminator enum property added by openapi-typescript ##### Description [Section titled “Description”](#description-126) Originating account details for the transfer #### OriginatingAccountResponse [Section titled “OriginatingAccountResponse”](#originatingaccountresponse) > **OriginatingAccountResponse**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-40) ###### id [Section titled “id”](#id-9) > **id**: `string` ###### Description [Section titled “Description”](#description-127) ID of the Brex Business account. ###### type [Section titled “type”](#type-40) > **type**: `"BREX_CASH"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-41) ###### type [Section titled “type”](#type-41) > **type**: `"BREX_CASH"` ###### Description [Section titled “Description”](#description-128) discriminator enum property added by openapi-typescript ##### Description [Section titled “Description”](#description-129) Originating account details for the transfer #### OriginatingAccountResponseType [Section titled “OriginatingAccountResponseType”](#originatingaccountresponsetype) > **OriginatingAccountResponseType**: `"BREX_CASH"` #### OriginatingAccountType [Section titled “OriginatingAccountType”](#originatingaccounttype) > **OriginatingAccountType**: `"BREX_CASH"` #### Page\_BankConnection\_ [Section titled “Page\_BankConnection\_”](#page_bankconnection_) > **Page\_BankConnection\_**: `object` ##### Page\_BankConnection\_.items [Section titled “Page\_BankConnection\_.items”](#page_bankconnection_items) > **items**: `object`\[] ##### Page\_BankConnection\_.next\_cursor? [Section titled “Page\_BankConnection\_.next\_cursor?”](#page_bankconnection_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_Transfer\_ [Section titled “Page\_Transfer\_”](#page_transfer_) > **Page\_Transfer\_**: `object` ##### Page\_Transfer\_.items [Section titled “Page\_Transfer\_.items”](#page_transfer_items) > **items**: `object`\[] ##### Page\_Transfer\_.next\_cursor? [Section titled “Page\_Transfer\_.next\_cursor?”](#page_transfer_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_VendorResponse\_ [Section titled “Page\_VendorResponse\_”](#page_vendorresponse_) > **Page\_VendorResponse\_**: `object` ##### Page\_VendorResponse\_.items [Section titled “Page\_VendorResponse\_.items”](#page_vendorresponse_items) > **items**: `object`\[] ##### Page\_VendorResponse\_.next\_cursor? [Section titled “Page\_VendorResponse\_.next\_cursor?”](#page_vendorresponse_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### PaymentAccountDetails [Section titled “PaymentAccountDetails”](#paymentaccountdetails) > **PaymentAccountDetails**: `object` & `object` | `object` & `object` | `object` & `object` ##### Description [Section titled “Description”](#description-130) Payment Instruments associated with the vendor. Each vendor can only have one payment account per payment instrument type. For instance, a vendor may have associated details for each of ACH, DOMESTIC\_WIRE, and CHEQUE, but they cannot have 2 entries for ACH. If you modify a vendor’s existing payment instrument type with new details, it will overwrite any previous data. #### PaymentAccountDetailsResponse [Section titled “PaymentAccountDetailsResponse”](#paymentaccountdetailsresponse) > **PaymentAccountDetailsResponse**: `object` & `object` | `object` & `object` | `object` & `object` | `object` & `object` #### PaymentAccountRequest [Section titled “PaymentAccountRequest”](#paymentaccountrequest) > **PaymentAccountRequest**: `object` ##### PaymentAccountRequest.details [Section titled “PaymentAccountRequest.details”](#paymentaccountrequestdetails) > **details**: `object` & `object` | `object` & `object` | `object` & `object` #### PaymentAccountResponse [Section titled “PaymentAccountResponse”](#paymentaccountresponse) > **PaymentAccountResponse**: `object` ##### PaymentAccountResponse.details [Section titled “PaymentAccountResponse.details”](#paymentaccountresponsedetails) > **details**: `object` & `object` | `object` & `object` | `object` & `object` | `object` & `object` #### PaymentDetailsTypeRequest [Section titled “PaymentDetailsTypeRequest”](#paymentdetailstyperequest) > **PaymentDetailsTypeRequest**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` #### PaymentDetailsTypeResponse [Section titled “PaymentDetailsTypeResponse”](#paymentdetailstyperesponse) > **PaymentDetailsTypeResponse**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` #### PaymentType [Section titled “PaymentType”](#paymenttype) > **PaymentType**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"` #### ReceivingAccount [Section titled “ReceivingAccount”](#receivingaccount) > **ReceivingAccount**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-42) ###### id [Section titled “id”](#id-10) > **id**: `string` ###### Description [Section titled “Description”](#description-131) ID of the Brex business account: Can be found from the [List business accounts](/openapi/transactions_api/#operation/listAccounts) endpoint ###### type [Section titled “type”](#type-42) > **type**: `"BREX_CASH"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-43) ###### type [Section titled “type”](#type-43) > **type**: `"BREX_CASH"` ###### Description [Section titled “Description”](#description-132) discriminator enum property added by openapi-typescript ##### Description [Section titled “Description”](#description-133) Receiving account details for the transfer #### ReceivingAccountType [Section titled “ReceivingAccountType”](#receivingaccounttype) > **ReceivingAccountType**: `"BREX_CASH"` #### Recipient [Section titled “Recipient”](#recipient-1) > **Recipient**: `object` ##### Recipient.id [Section titled “Recipient.id”](#recipientid-1) > **id**: `string` ##### Recipient.type [Section titled “Recipient.type”](#recipienttype-1) > **type**: `"ACCOUNT_ID"` | `"PAYMENT_INSTRUMENT_ID"` #### RecipientType [Section titled “RecipientType”](#recipienttype-2) > **RecipientType**: `"ACCOUNT_ID"` | `"PAYMENT_INSTRUMENT_ID"` ##### Description [Section titled “Description”](#description-134) Specifies the type of the recipient. `ACCOUNT_ID` is the ID of a Brex Business account. `PAYMENT_INSTRUMENT_ID` is the ID of Payment Instrument of the receiving Brex account. #### Transfer [Section titled “Transfer”](#transfer) > **Transfer**: `object` ##### Transfer.amount [Section titled “Transfer.amount”](#transferamount) > **amount**: `object` ##### Transfer.amount.amount [Section titled “Transfer.amount.amount”](#transferamountamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-135) 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 [Section titled “Example”](#example-12) ```ts 700 ``` ##### Transfer.amount.currency [Section titled “Transfer.amount.currency”](#transferamountcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-136) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-6) ```ts USD ``` ###### Example [Section titled “Example”](#example-13) ```ts USD ``` ##### Transfer.cancellation\_reason? [Section titled “Transfer.cancellation\_reason?”](#transfercancellation_reason) > `optional` **cancellation\_reason?**: `"USER_CANCELLED"` | `"INSUFFICIENT_FUNDS"` | `"APPROVAL_DENIED"` | `"BLOCKED_BY_POSITIVE_PAY"` | `null` ##### Transfer.counterparty? [Section titled “Transfer.counterparty?”](#transfercounterparty) > `optional` **counterparty?**: `Omit`<`object` & `object`, `"type"`> | `null` ##### Transfer.created\_at? [Section titled “Transfer.created\_at?”](#transfercreated_at) > `optional` **created\_at?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-137) Date of transfer creation ##### Transfer.creator\_user\_id? [Section titled “Transfer.creator\_user\_id?”](#transfercreator_user_id) > `optional` **creator\_user\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-138) User ID of the transfer initiator ##### Transfer.description? [Section titled “Transfer.description?”](#transferdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-139) Description of the transfer ##### Transfer.display\_name? [Section titled “Transfer.display\_name?”](#transferdisplay_name) > `optional` **display\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-140) Human readable name for the transaction ##### Transfer.estimated\_delivery\_date? [Section titled “Transfer.estimated\_delivery\_date?”](#transferestimated_delivery_date) > `optional` **estimated\_delivery\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-141) Estimated delivery date for transfer ##### Transfer.external\_memo? [Section titled “Transfer.external\_memo?”](#transferexternal_memo) > `optional` **external\_memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-142) External memo for the transfer. `Payment Instructions` for Wires and the `Entry Description` for ACH payments. Must be at most 90 characters for `ACH` and `WIRE` transactions and at most 40 characters for `CHEQUES` ##### Transfer.id [Section titled “Transfer.id”](#transferid) > **id**: `string` ###### Description [Section titled “Description”](#description-143) Unique ID associated with the transfer ##### Transfer.is\_ppro\_enabled? [Section titled “Transfer.is\_ppro\_enabled?”](#transferis_ppro_enabled) > `optional` **is\_ppro\_enabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-144) If Principal Protection (PPRO) is enabled ##### Transfer.originating\_account [Section titled “Transfer.originating\_account”](#transferoriginating_account) > **originating\_account**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-44) ###### id [Section titled “id”](#id-11) > **id**: `string` ###### Description [Section titled “Description”](#description-145) ID of the Brex Business account. ###### type [Section titled “type”](#type-44) > **type**: `"BREX_CASH"` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-45) ###### type [Section titled “type”](#type-45) > **type**: `"BREX_CASH"` ###### Description [Section titled “Description”](#description-146) discriminator enum property added by openapi-typescript ##### Transfer.payment\_type [Section titled “Transfer.payment\_type”](#transferpayment_type) > **payment\_type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"` ##### Transfer.process\_date? [Section titled “Transfer.process\_date?”](#transferprocess_date) > `optional` **process\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-147) Transaction processing date ##### Transfer.status [Section titled “Transfer.status”](#transferstatus) > **status**: `"PROCESSING"` | `"SCHEDULED"` | `"PENDING_APPROVAL"` | `"FAILED"` | `"PROCESSED"` #### TransferCancellationReason [Section titled “TransferCancellationReason”](#transfercancellationreason) > **TransferCancellationReason**: `"USER_CANCELLED"` | `"INSUFFICIENT_FUNDS"` | `"APPROVAL_DENIED"` | `"BLOCKED_BY_POSITIVE_PAY"` ##### Description [Section titled “Description”](#description-148) `USER_CANCELLED`: The transfer was canceled. `INSUFFICIENT_FUNDS`: The transfer could not be sent due to insufficient funds. `APPROVAL_DENIED`: The transfer was not sent because it was denied. `BLOCKED_BY_POSITIVE_PAY`: The transfer was blocked because of the ACH debit settings. #### TransferStatus [Section titled “TransferStatus”](#transferstatus-1) > **TransferStatus**: `"PROCESSING"` | `"SCHEDULED"` | `"PENDING_APPROVAL"` | `"FAILED"` | `"PROCESSED"` ##### Description [Section titled “Description”](#description-149) `PROCESSING`: We have started to process the sending or receiving of this transaction. `SCHEDULED`: The transaction is scheduled to enter the `PROCESSING` status. `PENDING_APPROVAL`: The transaction requires approval before it can enter the `SCHEDULED` or `PROCESSING` status. `FAILED`: A grouping of multiple terminal states that prevented the transaction from completing. This includes a a user-cancellation, approval being denied, insufficient funds, failed verifications, etc. `PROCESSED`: The money movement has been fully completed, which could mean money sent has arrived. #### UpdateVendorRequest [Section titled “UpdateVendorRequest”](#updatevendorrequest) > **UpdateVendorRequest**: `object` ##### UpdateVendorRequest.beneficiary\_name? [Section titled “UpdateVendorRequest.beneficiary\_name?”](#updatevendorrequestbeneficiary_name) > `optional` **beneficiary\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-150) Name for the Beneficiary ##### UpdateVendorRequest.company\_name? [Section titled “UpdateVendorRequest.company\_name?”](#updatevendorrequestcompany_name) > `optional` **company\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-151) Name for vendor ##### UpdateVendorRequest.email? [Section titled “UpdateVendorRequest.email?”](#updatevendorrequestemail) > `optional` **email?**: `string` | `null` Format: email ###### Description [Section titled “Description”](#description-152) Email for vendor ##### UpdateVendorRequest.payment\_accounts? [Section titled “UpdateVendorRequest.payment\_accounts?”](#updatevendorrequestpayment_accounts) > `optional` **payment\_accounts?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-153) To update payment instruments, we require the entire payload for each payment instrument that is being updated. ##### UpdateVendorRequest.phone? [Section titled “UpdateVendorRequest.phone?”](#updatevendorrequestphone) > `optional` **phone?**: `string` | `null` ###### Description [Section titled “Description”](#description-154) Phone number for vendor #### VendorDetails [Section titled “VendorDetails”](#vendordetails) > **VendorDetails**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-46) ###### payment\_instrument\_id [Section titled “payment\_instrument\_id”](#payment_instrument_id-5) > **payment\_instrument\_id**: `string` ###### Description [Section titled “Description”](#description-155) ID of the vendor’s payment instrument: this will dictate the payment method and the counterparty of the transaction. The payment instrument ID is returned from the /vendors response and the type of the instrument will dictate the payment method. eg. Passing an instrument ID of type ACH will trigger an ACH payment to the associated vendor. Since a payment instrument can be updated while retaining the same payment\_instrument\_id, please make sure to double check the details. ###### type [Section titled “type”](#type-46) > **type**: `"VENDOR"` | `"BOOK_TRANSFER"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-47) ###### type [Section titled “type”](#type-47) > **type**: `"VENDOR"` ###### Description [Section titled “Description”](#description-156) discriminator enum property added by openapi-typescript #### VendorDetailsResponse [Section titled “VendorDetailsResponse”](#vendordetailsresponse) > **VendorDetailsResponse**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-48) ###### account\_number? [Section titled “account\_number?”](#account_number-6) > `optional` **account\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-157) Account number of a bank account (or IBAN code for international transfer). ###### id [Section titled “id”](#id-12) > **id**: `string` ###### Description [Section titled “Description”](#description-158) Vendor ID returned from `/vendors` endpoint ###### payment\_instrument\_id [Section titled “payment\_instrument\_id”](#payment_instrument_id-6) > **payment\_instrument\_id**: `string` ###### routing\_number? [Section titled “routing\_number?”](#routing_number-6) > `optional` **routing\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-159) Routing number of a bank account (or SWIFT/BIC code for international transfer). ###### type [Section titled “type”](#type-48) > **type**: `"VENDOR"` | `"BOOK_TRANSFER"` | `"BANK_ACCOUNT"` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-49) ###### type [Section titled “type”](#type-49) > **type**: `"VENDOR"` ###### Description [Section titled “Description”](#description-160) discriminator enum property added by openapi-typescript #### VendorResponse [Section titled “VendorResponse”](#vendorresponse) > **VendorResponse**: `object` ##### VendorResponse.company\_name? [Section titled “VendorResponse.company\_name?”](#vendorresponsecompany_name) > `optional` **company\_name?**: `string` | `null` ##### VendorResponse.email? [Section titled “VendorResponse.email?”](#vendorresponseemail) > `optional` **email?**: `string` | `null` ##### VendorResponse.id [Section titled “VendorResponse.id”](#vendorresponseid) > **id**: `string` ###### Description [Section titled “Description”](#description-161) Vendor ID: Can be passed to /transfers endpoint to specify counterparty. ##### VendorResponse.payment\_accounts? [Section titled “VendorResponse.payment\_accounts?”](#vendorresponsepayment_accounts) > `optional` **payment\_accounts?**: `object`\[] | `null` ##### VendorResponse.phone? [Section titled “VendorResponse.phone?”](#vendorresponsephone) > `optional` **phone?**: `string` | `null` # PaymentsPaths Defined in: [src/payments/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L2) ## Properties [Section titled “Properties”](#properties) ### /v1/incoming\_transfers [Section titled “/v1/incoming\_transfers”](#v1incoming_transfers) > **/v1/incoming\_transfers**: `object` Defined in: [src/payments/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L3) #### delete? [Section titled “delete?”](#delete) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post) > **post**: `object` Create incoming transfer ##### Description [Section titled “Description”](#description) This endpoint creates a new incoming transfer. You may use use any eligible bank account connection to fund (ACH Debit) any active Brex business account. ```plaintext **Reminder**: You may not use the Brex API for any activity that requires a license or registration from any governmental authority without Brex's prior review and approval. This includes but is not limited to any money services business or money transmission activity. Please review the Brex Access Agreement and contact us if you have any questions. ``` ##### post.parameters [Section titled “post.parameters”](#postparameters) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie) > `optional` **cookie?**: `undefined` ##### post.parameters.header [Section titled “post.parameters.header”](#postparametersheader) > **header**: `object` ##### post.parameters.header.Idempotency-Key [Section titled “post.parameters.header.Idempotency-Key”](#postparametersheaderidempotency-key) > **Idempotency-Key**: `string` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson) > **application/json**: `object` ##### post.requestBody.content.application/json.amount [Section titled “post.requestBody.content.application/json.amount”](#postrequestbodycontentapplicationjsonamount) > **amount**: `object` ##### post.requestBody.content.application/json.amount.amount [Section titled “post.requestBody.content.application/json.amount.amount”](#postrequestbodycontentapplicationjsonamountamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-1) 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 [Section titled “Example”](#example) ```ts 700 ``` ##### post.requestBody.content.application/json.amount.currency [Section titled “post.requestBody.content.application/json.amount.currency”](#postrequestbodycontentapplicationjsonamountcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-2) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default) ```ts USD ``` ###### Example [Section titled “Example”](#example-1) ```ts USD ``` ##### post.requestBody.content.application/json.counterparty [Section titled “post.requestBody.content.application/json.counterparty”](#postrequestbodycontentapplicationjsoncounterparty) > **counterparty**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration) ###### id [Section titled “id”](#id) > **id**: `string` ###### Description [Section titled “Description”](#description-3) The financial account id: Can be found from the [List linked accounts](/openapi/payments_api/#operation/listLinkedAccounts) endpoint ###### type [Section titled “type”](#type) > **type**: `"BANK"` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-1) ###### type [Section titled “type”](#type-1) > **type**: `"BANK"` ###### Description [Section titled “Description”](#description-4) discriminator enum property added by openapi-typescript ##### post.requestBody.content.application/json.description [Section titled “post.requestBody.content.application/json.description”](#postrequestbodycontentapplicationjsondescription) > **description**: `string` ###### Description [Section titled “Description”](#description-5) Description of the transfer for internal use. Not exposed externally. ##### post.requestBody.content.application/json.receiving\_account [Section titled “post.requestBody.content.application/json.receiving\_account”](#postrequestbodycontentapplicationjsonreceiving_account) > **receiving\_account**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-2) ###### id [Section titled “id”](#id-1) > **id**: `string` ###### Description [Section titled “Description”](#description-6) ID of the Brex business account: Can be found from the [List business accounts](/openapi/transactions_api/#operation/listAccounts) endpoint ###### type [Section titled “type”](#type-2) > **type**: `"BREX_CASH"` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-3) ###### type [Section titled “type”](#type-3) > **type**: `"BREX_CASH"` ###### Description [Section titled “Description”](#description-7) discriminator enum property added by openapi-typescript ##### post.responses [Section titled “post.responses”](#postresponses) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-8) createIncomingTransfer 200 response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson) > **application/json**: `object` ##### post.responses.200.content.application/json.amount [Section titled “post.responses.200.content.application/json.amount”](#postresponses200contentapplicationjsonamount) > **amount**: `object` ##### post.responses.200.content.application/json.amount.amount [Section titled “post.responses.200.content.application/json.amount.amount”](#postresponses200contentapplicationjsonamountamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-9) 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 [Section titled “Example”](#example-2) ```ts 700 ``` ##### post.responses.200.content.application/json.amount.currency [Section titled “post.responses.200.content.application/json.amount.currency”](#postresponses200contentapplicationjsonamountcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-10) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-1) ```ts USD ``` ###### Example [Section titled “Example”](#example-3) ```ts USD ``` ##### post.responses.200.content.application/json.cancellation\_reason? [Section titled “post.responses.200.content.application/json.cancellation\_reason?”](#postresponses200contentapplicationjsoncancellation_reason) > `optional` **cancellation\_reason?**: `"USER_CANCELLED"` | `"INSUFFICIENT_FUNDS"` | `"APPROVAL_DENIED"` | `"BLOCKED_BY_POSITIVE_PAY"` | `null` ##### post.responses.200.content.application/json.counterparty? [Section titled “post.responses.200.content.application/json.counterparty?”](#postresponses200contentapplicationjsoncounterparty) > `optional` **counterparty?**: `Omit`<`object` & `object`, `"type"`> | `null` ##### post.responses.200.content.application/json.created\_at? [Section titled “post.responses.200.content.application/json.created\_at?”](#postresponses200contentapplicationjsoncreated_at) > `optional` **created\_at?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-11) Date of transfer creation ##### post.responses.200.content.application/json.creator\_user\_id? [Section titled “post.responses.200.content.application/json.creator\_user\_id?”](#postresponses200contentapplicationjsoncreator_user_id) > `optional` **creator\_user\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-12) User ID of the transfer initiator ##### post.responses.200.content.application/json.description? [Section titled “post.responses.200.content.application/json.description?”](#postresponses200contentapplicationjsondescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-13) Description of the transfer ##### post.responses.200.content.application/json.display\_name? [Section titled “post.responses.200.content.application/json.display\_name?”](#postresponses200contentapplicationjsondisplay_name) > `optional` **display\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-14) Human readable name for the transaction ##### post.responses.200.content.application/json.estimated\_delivery\_date? [Section titled “post.responses.200.content.application/json.estimated\_delivery\_date?”](#postresponses200contentapplicationjsonestimated_delivery_date) > `optional` **estimated\_delivery\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-15) Estimated delivery date for transfer ##### post.responses.200.content.application/json.external\_memo? [Section titled “post.responses.200.content.application/json.external\_memo?”](#postresponses200contentapplicationjsonexternal_memo) > `optional` **external\_memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-16) External memo for the transfer. `Payment Instructions` for Wires and the `Entry Description` for ACH payments. Must be at most 90 characters for `ACH` and `WIRE` transactions and at most 40 characters for `CHEQUES` ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-17) Unique ID associated with the transfer ##### post.responses.200.content.application/json.is\_ppro\_enabled? [Section titled “post.responses.200.content.application/json.is\_ppro\_enabled?”](#postresponses200contentapplicationjsonis_ppro_enabled) > `optional` **is\_ppro\_enabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-18) If Principal Protection (PPRO) is enabled ##### post.responses.200.content.application/json.originating\_account [Section titled “post.responses.200.content.application/json.originating\_account”](#postresponses200contentapplicationjsonoriginating_account) > **originating\_account**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-4) ###### id [Section titled “id”](#id-2) > **id**: `string` ###### Description [Section titled “Description”](#description-19) ID of the Brex Business account. ###### type [Section titled “type”](#type-4) > **type**: `"BREX_CASH"` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-5) ###### type [Section titled “type”](#type-5) > **type**: `"BREX_CASH"` ###### Description [Section titled “Description”](#description-20) discriminator enum property added by openapi-typescript ##### post.responses.200.content.application/json.payment\_type [Section titled “post.responses.200.content.application/json.payment\_type”](#postresponses200contentapplicationjsonpayment_type) > **payment\_type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"` ##### post.responses.200.content.application/json.process\_date? [Section titled “post.responses.200.content.application/json.process\_date?”](#postresponses200contentapplicationjsonprocess_date) > `optional` **process\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-21) Transaction processing date ##### post.responses.200.content.application/json.status [Section titled “post.responses.200.content.application/json.status”](#postresponses200contentapplicationjsonstatus) > **status**: `"PROCESSING"` | `"SCHEDULED"` | `"PENDING_APPROVAL"` | `"FAILED"` | `"PROCESSED"` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace) > `optional` **trace?**: `undefined` *** ### /v1/linked\_accounts [Section titled “/v1/linked\_accounts”](#v1linked_accounts) > **/v1/linked\_accounts**: `object` Defined in: [src/payments/types.gen.ts:31](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L31) #### delete? [Section titled “delete?”](#delete-1) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-1) > **get**: `object` Lists linked accounts ##### Description [Section titled “Description”](#description-22) This endpoint lists all bank connections that are eligible to make ACH transfers to Brex business account ##### get.parameters [Section titled “get.parameters”](#getparameters) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit) > `optional` **limit?**: `number` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-23) Returns a list of bank connections ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-1) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-24) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-2) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-25) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-3) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-26) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-4) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-1) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-1) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-1) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-1) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-1) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-1) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-1) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-1) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-1) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-1) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-1) > `optional` **trace?**: `undefined` *** ### /v1/transfers [Section titled “/v1/transfers”](#v1transfers) > **/v1/transfers**: `object` Defined in: [src/payments/types.gen.ts:51](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L51) #### delete? [Section titled “delete?”](#delete-2) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-2) > **get**: `object` Lists transfers ##### Description [Section titled “Description”](#description-27) This endpoint lists existing transfers for an account. ```plaintext Currently, the API can only return transfers for the following payment rails: - ACH - DOMESTIC_WIRE - CHEQUE - INTERNATIONAL_WIRE ``` ##### get.parameters [Section titled “get.parameters”](#getparameters-1) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-1) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-1) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-1) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-1) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-1) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-1) > `optional` **limit?**: `number` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-1) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-1) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-28) Returns a list of transfers. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-1) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-1) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-1) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-1) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-5) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-29) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-1) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-6) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-30) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-1) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-7) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-31) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-1) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-8) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500) > **500**: `object` ###### Description [Section titled “Description”](#description-32) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-9) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-2) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-2) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-2) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-2) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-2) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-2) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-2) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-2) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-2) > **post**: `object` Create transfer ##### Description [Section titled “Description”](#description-33) This endpoint creates a new transfer. ```plaintext Currently, the API can only create transfers for the following payment rails: - ACH - DOMESTIC_WIRE - CHEQUE - INTERNATIONAL_WIRES **Transaction Descriptions** * For outgoing check payments, a successful transfer will return a response containing a description value with a format of `Check # to - `. * For book transfers (from one Brex Business account to another), the recipient value will have a format of ` - ` and the sender will have a format of ` - `. * For other payment rails, the format will be ` - `, where Counterparty name is `payment_instrument.beneficiary_name` or `contact.name` For vendors created from the Payments API, the `counterparty_name` will be the `company_name` [field](/openapi/payments_api/#operation/createVendor!path=company_name&t=request). **Reminder**: You may not use the Brex API for any activity that requires a license or registration from any governmental authority without Brex's prior review and approval. This includes but is not limited to any money services business or money transmission activity. Please review the Brex Access Agreement and contact us if you have any questions. ``` ##### post.parameters [Section titled “post.parameters”](#postparameters-1) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-1) > `optional` **cookie?**: `undefined` ##### post.parameters.header [Section titled “post.parameters.header”](#postparametersheader-1) > **header**: `object` ##### post.parameters.header.Idempotency-Key [Section titled “post.parameters.header.Idempotency-Key”](#postparametersheaderidempotency-key-1) > **Idempotency-Key**: `string` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath-1) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-1) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-1) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-1) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-1) > **application/json**: `object` ##### post.requestBody.content.application/json.amount [Section titled “post.requestBody.content.application/json.amount”](#postrequestbodycontentapplicationjsonamount-1) > **amount**: `object` ##### post.requestBody.content.application/json.amount.amount [Section titled “post.requestBody.content.application/json.amount.amount”](#postrequestbodycontentapplicationjsonamountamount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-34) 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 [Section titled “Example”](#example-4) ```ts 700 ``` ##### post.requestBody.content.application/json.amount.currency [Section titled “post.requestBody.content.application/json.amount.currency”](#postrequestbodycontentapplicationjsonamountcurrency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-35) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-2) ```ts USD ``` ###### Example [Section titled “Example”](#example-5) ```ts USD ``` ##### post.requestBody.content.application/json.approval\_type? [Section titled “post.requestBody.content.application/json.approval\_type?”](#postrequestbodycontentapplicationjsonapproval_type) > `optional` **approval\_type?**: `"MANUAL"` | `null` ##### post.requestBody.content.application/json.counterparty [Section titled “post.requestBody.content.application/json.counterparty”](#postrequestbodycontentapplicationjsoncounterparty-1) > **counterparty**: `object` & `object` | `object` & `object` ##### post.requestBody.content.application/json.description [Section titled “post.requestBody.content.application/json.description”](#postrequestbodycontentapplicationjsondescription-1) > **description**: `string` ###### Description [Section titled “Description”](#description-36) Description of the transfer for internal use. Not exposed externally. ##### post.requestBody.content.application/json.external\_memo [Section titled “post.requestBody.content.application/json.external\_memo”](#postrequestbodycontentapplicationjsonexternal_memo) > **external\_memo**: `string` ###### Description [Section titled “Description”](#description-37) External memo for the transfer. `Payment Instructions` for Wires and the `Entry Description` for ACH payments. Must be at most 90 characters for `ACH` and `WIRE` transactions and at most 40 characters for `CHEQUES` ##### post.requestBody.content.application/json.is\_ppro\_enabled? [Section titled “post.requestBody.content.application/json.is\_ppro\_enabled?”](#postrequestbodycontentapplicationjsonis_ppro_enabled) > `optional` **is\_ppro\_enabled?**: `boolean` ###### Description [Section titled “Description”](#description-38) When set to true, add Principal Protection (PPRO) to the transaction. PPRO means Brex will cover any fees charged by intemediary or receiving banks. PPRO charges will be billed separately in a monthly statement. PPRO is only available for international wire transactions. ##### post.requestBody.content.application/json.originating\_account [Section titled “post.requestBody.content.application/json.originating\_account”](#postrequestbodycontentapplicationjsonoriginating_account) > **originating\_account**: `Omit`<`object` & `object`, `"type"`> ##### post.responses [Section titled “post.responses”](#postresponses-1) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-39) createTransfer 200 response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-1) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-1) > **application/json**: `object` ##### post.responses.200.content.application/json.amount [Section titled “post.responses.200.content.application/json.amount”](#postresponses200contentapplicationjsonamount-1) > **amount**: `object` ##### post.responses.200.content.application/json.amount.amount [Section titled “post.responses.200.content.application/json.amount.amount”](#postresponses200contentapplicationjsonamountamount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-40) 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 [Section titled “Example”](#example-6) ```ts 700 ``` ##### post.responses.200.content.application/json.amount.currency [Section titled “post.responses.200.content.application/json.amount.currency”](#postresponses200contentapplicationjsonamountcurrency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-41) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-3) ```ts USD ``` ###### Example [Section titled “Example”](#example-7) ```ts USD ``` ##### post.responses.200.content.application/json.cancellation\_reason? [Section titled “post.responses.200.content.application/json.cancellation\_reason?”](#postresponses200contentapplicationjsoncancellation_reason-1) > `optional` **cancellation\_reason?**: `"USER_CANCELLED"` | `"INSUFFICIENT_FUNDS"` | `"APPROVAL_DENIED"` | `"BLOCKED_BY_POSITIVE_PAY"` | `null` ##### post.responses.200.content.application/json.counterparty? [Section titled “post.responses.200.content.application/json.counterparty?”](#postresponses200contentapplicationjsoncounterparty-1) > `optional` **counterparty?**: `Omit`<`object` & `object`, `"type"`> | `null` ##### post.responses.200.content.application/json.created\_at? [Section titled “post.responses.200.content.application/json.created\_at?”](#postresponses200contentapplicationjsoncreated_at-1) > `optional` **created\_at?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-42) Date of transfer creation ##### post.responses.200.content.application/json.creator\_user\_id? [Section titled “post.responses.200.content.application/json.creator\_user\_id?”](#postresponses200contentapplicationjsoncreator_user_id-1) > `optional` **creator\_user\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-43) User ID of the transfer initiator ##### post.responses.200.content.application/json.description? [Section titled “post.responses.200.content.application/json.description?”](#postresponses200contentapplicationjsondescription-1) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-44) Description of the transfer ##### post.responses.200.content.application/json.display\_name? [Section titled “post.responses.200.content.application/json.display\_name?”](#postresponses200contentapplicationjsondisplay_name-1) > `optional` **display\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-45) Human readable name for the transaction ##### post.responses.200.content.application/json.estimated\_delivery\_date? [Section titled “post.responses.200.content.application/json.estimated\_delivery\_date?”](#postresponses200contentapplicationjsonestimated_delivery_date-1) > `optional` **estimated\_delivery\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-46) Estimated delivery date for transfer ##### post.responses.200.content.application/json.external\_memo? [Section titled “post.responses.200.content.application/json.external\_memo?”](#postresponses200contentapplicationjsonexternal_memo-1) > `optional` **external\_memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-47) External memo for the transfer. `Payment Instructions` for Wires and the `Entry Description` for ACH payments. Must be at most 90 characters for `ACH` and `WIRE` transactions and at most 40 characters for `CHEQUES` ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-48) Unique ID associated with the transfer ##### post.responses.200.content.application/json.is\_ppro\_enabled? [Section titled “post.responses.200.content.application/json.is\_ppro\_enabled?”](#postresponses200contentapplicationjsonis_ppro_enabled-1) > `optional` **is\_ppro\_enabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-49) If Principal Protection (PPRO) is enabled ##### post.responses.200.content.application/json.originating\_account [Section titled “post.responses.200.content.application/json.originating\_account”](#postresponses200contentapplicationjsonoriginating_account-1) > **originating\_account**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-6) ###### id [Section titled “id”](#id-3) > **id**: `string` ###### Description [Section titled “Description”](#description-50) ID of the Brex Business account. ###### type [Section titled “type”](#type-6) > **type**: `"BREX_CASH"` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-7) ###### type [Section titled “type”](#type-7) > **type**: `"BREX_CASH"` ###### Description [Section titled “Description”](#description-51) discriminator enum property added by openapi-typescript ##### post.responses.200.content.application/json.payment\_type [Section titled “post.responses.200.content.application/json.payment\_type”](#postresponses200contentapplicationjsonpayment_type-1) > **payment\_type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"` ##### post.responses.200.content.application/json.process\_date? [Section titled “post.responses.200.content.application/json.process\_date?”](#postresponses200contentapplicationjsonprocess_date-1) > `optional` **process\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-52) Transaction processing date ##### post.responses.200.content.application/json.status [Section titled “post.responses.200.content.application/json.status”](#postresponses200contentapplicationjsonstatus-1) > **status**: `"PROCESSING"` | `"SCHEDULED"` | `"PENDING_APPROVAL"` | `"FAILED"` | `"PROCESSED"` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-10) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-2) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-2) > `optional` **trace?**: `undefined` *** ### /v1/transfers/{id} [Section titled “/v1/transfers/{id}”](#v1transfersid) > **/v1/transfers/{id}**: `object` Defined in: [src/payments/types.gen.ts:100](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L100) #### delete? [Section titled “delete?”](#delete-3) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-3) > **get**: `object` Get transfer ##### Description [Section titled “Description”](#description-53) This endpoint gets a transfer by ID. ```plaintext Currently, the API can only return transfers for the following payment rails: - ACH - DOMESTIC_WIRE - CHEQUE - INTERNATIONAL_WIRE ``` ##### get.parameters [Section titled “get.parameters”](#getparameters-2) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-2) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-2) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-2) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-2) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-2) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-2) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-54) Returns a transfer. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-2) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-2) > **application/json**: `object` ##### get.responses.200.content.application/json.amount [Section titled “get.responses.200.content.application/json.amount”](#getresponses200contentapplicationjsonamount) > **amount**: `object` ##### get.responses.200.content.application/json.amount.amount [Section titled “get.responses.200.content.application/json.amount.amount”](#getresponses200contentapplicationjsonamountamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-55) 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 [Section titled “Example”](#example-8) ```ts 700 ``` ##### get.responses.200.content.application/json.amount.currency [Section titled “get.responses.200.content.application/json.amount.currency”](#getresponses200contentapplicationjsonamountcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-56) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-4) ```ts USD ``` ###### Example [Section titled “Example”](#example-9) ```ts USD ``` ##### get.responses.200.content.application/json.cancellation\_reason? [Section titled “get.responses.200.content.application/json.cancellation\_reason?”](#getresponses200contentapplicationjsoncancellation_reason) > `optional` **cancellation\_reason?**: `"USER_CANCELLED"` | `"INSUFFICIENT_FUNDS"` | `"APPROVAL_DENIED"` | `"BLOCKED_BY_POSITIVE_PAY"` | `null` ##### get.responses.200.content.application/json.counterparty? [Section titled “get.responses.200.content.application/json.counterparty?”](#getresponses200contentapplicationjsoncounterparty) > `optional` **counterparty?**: `Omit`<`object` & `object`, `"type"`> | `null` ##### get.responses.200.content.application/json.created\_at? [Section titled “get.responses.200.content.application/json.created\_at?”](#getresponses200contentapplicationjsoncreated_at) > `optional` **created\_at?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-57) Date of transfer creation ##### get.responses.200.content.application/json.creator\_user\_id? [Section titled “get.responses.200.content.application/json.creator\_user\_id?”](#getresponses200contentapplicationjsoncreator_user_id) > `optional` **creator\_user\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-58) User ID of the transfer initiator ##### get.responses.200.content.application/json.description? [Section titled “get.responses.200.content.application/json.description?”](#getresponses200contentapplicationjsondescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-59) Description of the transfer ##### get.responses.200.content.application/json.display\_name? [Section titled “get.responses.200.content.application/json.display\_name?”](#getresponses200contentapplicationjsondisplay_name) > `optional` **display\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-60) Human readable name for the transaction ##### get.responses.200.content.application/json.estimated\_delivery\_date? [Section titled “get.responses.200.content.application/json.estimated\_delivery\_date?”](#getresponses200contentapplicationjsonestimated_delivery_date) > `optional` **estimated\_delivery\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-61) Estimated delivery date for transfer ##### get.responses.200.content.application/json.external\_memo? [Section titled “get.responses.200.content.application/json.external\_memo?”](#getresponses200contentapplicationjsonexternal_memo) > `optional` **external\_memo?**: `string` | `null` ###### Description [Section titled “Description”](#description-62) External memo for the transfer. `Payment Instructions` for Wires and the `Entry Description` for ACH payments. Must be at most 90 characters for `ACH` and `WIRE` transactions and at most 40 characters for `CHEQUES` ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-63) Unique ID associated with the transfer ##### get.responses.200.content.application/json.is\_ppro\_enabled? [Section titled “get.responses.200.content.application/json.is\_ppro\_enabled?”](#getresponses200contentapplicationjsonis_ppro_enabled) > `optional` **is\_ppro\_enabled?**: `boolean` | `null` ###### Description [Section titled “Description”](#description-64) If Principal Protection (PPRO) is enabled ##### get.responses.200.content.application/json.originating\_account [Section titled “get.responses.200.content.application/json.originating\_account”](#getresponses200contentapplicationjsonoriginating_account) > **originating\_account**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-8) ###### id [Section titled “id”](#id-4) > **id**: `string` ###### Description [Section titled “Description”](#description-65) ID of the Brex Business account. ###### type [Section titled “type”](#type-8) > **type**: `"BREX_CASH"` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-9) ###### type [Section titled “type”](#type-9) > **type**: `"BREX_CASH"` ###### Description [Section titled “Description”](#description-66) discriminator enum property added by openapi-typescript ##### get.responses.200.content.application/json.payment\_type [Section titled “get.responses.200.content.application/json.payment\_type”](#getresponses200contentapplicationjsonpayment_type) > **payment\_type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"` ##### get.responses.200.content.application/json.process\_date? [Section titled “get.responses.200.content.application/json.process\_date?”](#getresponses200contentapplicationjsonprocess_date) > `optional` **process\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-67) Transaction processing date ##### get.responses.200.content.application/json.status [Section titled “get.responses.200.content.application/json.status”](#getresponses200contentapplicationjsonstatus) > **status**: `"PROCESSING"` | `"SCHEDULED"` | `"PENDING_APPROVAL"` | `"FAILED"` | `"PROCESSED"` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-11) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-2) > **400**: `object` ###### Description [Section titled “Description”](#description-68) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-2) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-12) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-2) > **401**: `object` ###### Description [Section titled “Description”](#description-69) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-2) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-13) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-2) > **403**: `object` ###### Description [Section titled “Description”](#description-70) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-2) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-14) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-1) > **500**: `object` ###### Description [Section titled “Description”](#description-71) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-1) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-15) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-3) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-3) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-3) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-3) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-3) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-3) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-3) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-3) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-3) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-3) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-3) > `optional` **trace?**: `undefined` *** ### /v1/vendors [Section titled “/v1/vendors”](#v1vendors) > **/v1/vendors**: `object` Defined in: [src/payments/types.gen.ts:126](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L126) #### delete? [Section titled “delete?”](#delete-4) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-4) > **get**: `object` Lists vendors ##### Description [Section titled “Description”](#description-72) This endpoint lists all existing vendors for an account. Takes an optional parameter to match by vendor name. ##### get.parameters [Section titled “get.parameters”](#getparameters-3) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-3) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-3) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-3) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-3) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-2) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-2) > `optional` **limit?**: `number` | `null` ##### get.parameters.query.name? [Section titled “get.parameters.query.name?”](#getparametersqueryname) > `optional` **name?**: `string` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-3) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-3) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-3) > **200**: `object` ###### Description [Section titled “Description”](#description-73) Returns a list of vendor objects. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-3) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-3) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-2) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-2) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-16) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-3) > **400**: `object` ###### Description [Section titled “Description”](#description-74) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-3) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-17) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-3) > **401**: `object` ###### Description [Section titled “Description”](#description-75) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-3) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-18) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-3) > **403**: `object` ###### Description [Section titled “Description”](#description-76) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-3) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-19) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-4) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-4) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-4) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-4) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-4) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-4) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-4) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-4) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-4) > **post**: `object` Create vendor ##### Description [Section titled “Description”](#description-77) This endpoint creates a new vendor. ##### post.parameters [Section titled “post.parameters”](#postparameters-2) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-2) > `optional` **cookie?**: `undefined` ##### post.parameters.header [Section titled “post.parameters.header”](#postparametersheader-2) > **header**: `object` ##### post.parameters.header.Idempotency-Key [Section titled “post.parameters.header.Idempotency-Key”](#postparametersheaderidempotency-key-2) > **Idempotency-Key**: `string` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath-2) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-2) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-2) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-2) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-2) > **application/json**: `object` ##### post.requestBody.content.application/json.company\_name [Section titled “post.requestBody.content.application/json.company\_name”](#postrequestbodycontentapplicationjsoncompany_name) > **company\_name**: `string` ###### Description [Section titled “Description”](#description-78) Name for vendor. The name must be unique. ##### post.requestBody.content.application/json.email? [Section titled “post.requestBody.content.application/json.email?”](#postrequestbodycontentapplicationjsonemail) > `optional` **email?**: `string` | `null` Format: email ###### Description [Section titled “Description”](#description-79) Email for vendor. ##### post.requestBody.content.application/json.payment\_accounts? [Section titled “post.requestBody.content.application/json.payment\_accounts?”](#postrequestbodycontentapplicationjsonpayment_accounts) > `optional` **payment\_accounts?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-80) Payment accounts associated with the vendor. ##### post.requestBody.content.application/json.phone? [Section titled “post.requestBody.content.application/json.phone?”](#postrequestbodycontentapplicationjsonphone) > `optional` **phone?**: `string` | `null` ###### Description [Section titled “Description”](#description-81) Phone number for vendor. ##### post.responses [Section titled “post.responses”](#postresponses-2) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-82) createVendor 200 response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-2) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-2) > **application/json**: `object` ##### post.responses.200.content.application/json.company\_name? [Section titled “post.responses.200.content.application/json.company\_name?”](#postresponses200contentapplicationjsoncompany_name) > `optional` **company\_name?**: `string` | `null` ##### post.responses.200.content.application/json.email? [Section titled “post.responses.200.content.application/json.email?”](#postresponses200contentapplicationjsonemail) > `optional` **email?**: `string` | `null` ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid-2) > **id**: `string` ###### Description [Section titled “Description”](#description-83) Vendor ID: Can be passed to /transfers endpoint to specify counterparty. ##### post.responses.200.content.application/json.payment\_accounts? [Section titled “post.responses.200.content.application/json.payment\_accounts?”](#postresponses200contentapplicationjsonpayment_accounts) > `optional` **payment\_accounts?**: `object`\[] | `null` ##### post.responses.200.content.application/json.phone? [Section titled “post.responses.200.content.application/json.phone?”](#postresponses200contentapplicationjsonphone) > `optional` **phone?**: `string` | `null` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-20) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-4) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-4) > `optional` **trace?**: `undefined` *** ### /v1/vendors/{id} [Section titled “/v1/vendors/{id}”](#v1vendorsid) > **/v1/vendors/{id}**: `object` Defined in: [src/payments/types.gen.ts:151](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L151) #### delete [Section titled “delete”](#delete-5) > **delete**: `object` Delete vendor. ##### Description [Section titled “Description”](#description-84) This endpoint deletes a vendor by ID. ##### delete.parameters [Section titled “delete.parameters”](#deleteparameters) > **parameters**: `object` ##### delete.parameters.cookie? [Section titled “delete.parameters.cookie?”](#deleteparameterscookie) > `optional` **cookie?**: `undefined` ##### delete.parameters.header? [Section titled “delete.parameters.header?”](#deleteparametersheader) > `optional` **header?**: `undefined` ##### delete.parameters.path [Section titled “delete.parameters.path”](#deleteparameterspath) > **path**: `object` ##### delete.parameters.path.id [Section titled “delete.parameters.path.id”](#deleteparameterspathid) > **id**: `string` ##### delete.parameters.query? [Section titled “delete.parameters.query?”](#deleteparametersquery) > `optional` **query?**: `undefined` ##### delete.requestBody? [Section titled “delete.requestBody?”](#deleterequestbody) > `optional` **requestBody?**: `undefined` ##### delete.responses [Section titled “delete.responses”](#deleteresponses) > **responses**: `object` ##### delete.responses.200 [Section titled “delete.responses.200”](#deleteresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-85) deleteVendor 200 response ##### delete.responses.200.content? [Section titled “delete.responses.200.content?”](#deleteresponses200content) > `optional` **content?**: `undefined` ##### delete.responses.200.headers [Section titled “delete.responses.200.headers”](#deleteresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-21) \[`name`: `string`]: `unknown` #### get [Section titled “get”](#get-5) > **get**: `object` Get vendor ##### Description [Section titled “Description”](#description-86) This endpoint gets a vendor by ID. ##### get.parameters [Section titled “get.parameters”](#getparameters-4) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-4) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-4) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-4) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-1) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-4) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-4) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-4) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-4) > **200**: `object` ###### Description [Section titled “Description”](#description-87) Returns a vendor object. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-4) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-4) > **application/json**: `object` ##### get.responses.200.content.application/json.company\_name? [Section titled “get.responses.200.content.application/json.company\_name?”](#getresponses200contentapplicationjsoncompany_name) > `optional` **company\_name?**: `string` | `null` ##### get.responses.200.content.application/json.email? [Section titled “get.responses.200.content.application/json.email?”](#getresponses200contentapplicationjsonemail) > `optional` **email?**: `string` | `null` ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-88) Vendor ID: Can be passed to /transfers endpoint to specify counterparty. ##### get.responses.200.content.application/json.payment\_accounts? [Section titled “get.responses.200.content.application/json.payment\_accounts?”](#getresponses200contentapplicationjsonpayment_accounts) > `optional` **payment\_accounts?**: `object`\[] | `null` ##### get.responses.200.content.application/json.phone? [Section titled “get.responses.200.content.application/json.phone?”](#getresponses200contentapplicationjsonphone) > `optional` **phone?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-22) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-4) > **400**: `object` ###### Description [Section titled “Description”](#description-89) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-4) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-23) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-4) > **401**: `object` ###### Description [Section titled “Description”](#description-90) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-4) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-24) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-4) > **403**: `object` ###### Description [Section titled “Description”](#description-91) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-4) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-25) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-2) > **500**: `object` ###### Description [Section titled “Description”](#description-92) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-2) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-26) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-5) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-5) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-5) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-5) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-5) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-5) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-5) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-5) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-5) > `optional` **post?**: `undefined` #### put [Section titled “put”](#put-5) > **put**: `object` Update vendor ##### Description [Section titled “Description”](#description-93) Updates an existing vendor by ID. ##### put.parameters [Section titled “put.parameters”](#putparameters) > **parameters**: `object` ##### put.parameters.cookie? [Section titled “put.parameters.cookie?”](#putparameterscookie) > `optional` **cookie?**: `undefined` ##### put.parameters.header? [Section titled “put.parameters.header?”](#putparametersheader) > `optional` **header?**: `object` ##### put.parameters.header.Idempotency-Key? [Section titled “put.parameters.header.Idempotency-Key?”](#putparametersheaderidempotency-key) > `optional` **Idempotency-Key?**: `string` | `null` ##### put.parameters.path [Section titled “put.parameters.path”](#putparameterspath) > **path**: `object` ##### put.parameters.path.id [Section titled “put.parameters.path.id”](#putparameterspathid) > **id**: `string` ##### put.parameters.query? [Section titled “put.parameters.query?”](#putparametersquery) > `optional` **query?**: `undefined` ##### put.requestBody [Section titled “put.requestBody”](#putrequestbody) > **requestBody**: `object` ##### put.requestBody.content [Section titled “put.requestBody.content”](#putrequestbodycontent) > **content**: `object` ##### put.requestBody.content.application/json [Section titled “put.requestBody.content.application/json”](#putrequestbodycontentapplicationjson) > **application/json**: `object` ##### put.requestBody.content.application/json.beneficiary\_name? [Section titled “put.requestBody.content.application/json.beneficiary\_name?”](#putrequestbodycontentapplicationjsonbeneficiary_name) > `optional` **beneficiary\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-94) Name for the Beneficiary ##### put.requestBody.content.application/json.company\_name? [Section titled “put.requestBody.content.application/json.company\_name?”](#putrequestbodycontentapplicationjsoncompany_name) > `optional` **company\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-95) Name for vendor ##### put.requestBody.content.application/json.email? [Section titled “put.requestBody.content.application/json.email?”](#putrequestbodycontentapplicationjsonemail) > `optional` **email?**: `string` | `null` Format: email ###### Description [Section titled “Description”](#description-96) Email for vendor ##### put.requestBody.content.application/json.payment\_accounts? [Section titled “put.requestBody.content.application/json.payment\_accounts?”](#putrequestbodycontentapplicationjsonpayment_accounts) > `optional` **payment\_accounts?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-97) To update payment instruments, we require the entire payload for each payment instrument that is being updated. ##### put.requestBody.content.application/json.phone? [Section titled “put.requestBody.content.application/json.phone?”](#putrequestbodycontentapplicationjsonphone) > `optional` **phone?**: `string` | `null` ###### Description [Section titled “Description”](#description-98) Phone number for vendor ##### put.responses [Section titled “put.responses”](#putresponses) > **responses**: `object` ##### put.responses.200 [Section titled “put.responses.200”](#putresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-99) updateVendor 200 response ##### put.responses.200.content [Section titled “put.responses.200.content”](#putresponses200content) > **content**: `object` ##### put.responses.200.content.application/json [Section titled “put.responses.200.content.application/json”](#putresponses200contentapplicationjson) > **application/json**: `object` ##### put.responses.200.content.application/json.company\_name? [Section titled “put.responses.200.content.application/json.company\_name?”](#putresponses200contentapplicationjsoncompany_name) > `optional` **company\_name?**: `string` | `null` ##### put.responses.200.content.application/json.email? [Section titled “put.responses.200.content.application/json.email?”](#putresponses200contentapplicationjsonemail) > `optional` **email?**: `string` | `null` ##### put.responses.200.content.application/json.id [Section titled “put.responses.200.content.application/json.id”](#putresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-100) Vendor ID: Can be passed to /transfers endpoint to specify counterparty. ##### put.responses.200.content.application/json.payment\_accounts? [Section titled “put.responses.200.content.application/json.payment\_accounts?”](#putresponses200contentapplicationjsonpayment_accounts) > `optional` **payment\_accounts?**: `object`\[] | `null` ##### put.responses.200.content.application/json.phone? [Section titled “put.responses.200.content.application/json.phone?”](#putresponses200contentapplicationjsonphone) > `optional` **phone?**: `string` | `null` ##### put.responses.200.headers [Section titled “put.responses.200.headers”](#putresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-27) \[`name`: `string`]: `unknown` #### trace? [Section titled “trace?”](#trace-5) > `optional` **trace?**: `undefined` # AccountClass > **AccountClass** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"AccountClass"`] Defined in: [src/payments/schemas.gen.ts:7](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L7) # AccountType > **AccountType** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"AccountType"`] Defined in: [src/payments/schemas.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L8) # ACHDetailsRequest > **ACHDetailsRequest** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"ACHDetailsRequest"`] Defined in: [src/payments/schemas.gen.ts:5](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L5) # ACHDetailsResponse > **ACHDetailsResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"ACHDetailsResponse"`] Defined in: [src/payments/schemas.gen.ts:6](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L6) # Address > **Address** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"Address"`] Defined in: [src/payments/schemas.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L9) # ApprovalType > **ApprovalType** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"ApprovalType"`] Defined in: [src/payments/schemas.gen.ts:10](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L10) # Balance > **Balance** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"Balance"`] Defined in: [src/payments/schemas.gen.ts:11](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L11) # BankAccountDetailsResponse > **BankAccountDetailsResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"BankAccountDetailsResponse"`] Defined in: [src/payments/schemas.gen.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L12) # BankConnection > **BankConnection** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"BankConnection"`] Defined in: [src/payments/schemas.gen.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L13) # BankDetails > **BankDetails** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"BankDetails"`] Defined in: [src/payments/schemas.gen.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L14) # BankType > **BankType** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"BankType"`] Defined in: [src/payments/schemas.gen.ts:15](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L15) # BeneficiaryBank > **BeneficiaryBank** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"BeneficiaryBank"`] Defined in: [src/payments/schemas.gen.ts:16](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L16) # BookTransferDetails > **BookTransferDetails** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"BookTransferDetails"`] Defined in: [src/payments/schemas.gen.ts:17](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L17) # BookTransferDetailsResponse > **BookTransferDetailsResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"BookTransferDetailsResponse"`] Defined in: [src/payments/schemas.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L18) # BrexCashAccountDetails > **BrexCashAccountDetails** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"BrexCashAccountDetails"`] Defined in: [src/payments/schemas.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L19) # BrexCashAccountDetailsResponse > **BrexCashAccountDetailsResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"BrexCashAccountDetailsResponse"`] Defined in: [src/payments/schemas.gen.ts:20](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L20) # BrexCashDetails > **BrexCashDetails** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"BrexCashDetails"`] Defined in: [src/payments/schemas.gen.ts:22](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L22) # ChequeDetailsRequest > **ChequeDetailsRequest** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"ChequeDetailsRequest"`] Defined in: [src/payments/schemas.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L23) # ChequeDetailsResponse > **ChequeDetailsResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"ChequeDetailsResponse"`] Defined in: [src/payments/schemas.gen.ts:24](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L24) # CounterParty > **CounterParty** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"CounterParty"`] Defined in: [src/payments/schemas.gen.ts:25](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L25) # CounterPartyBankDetails > **CounterPartyBankDetails** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"CounterPartyBankDetails"`] Defined in: [src/payments/schemas.gen.ts:26](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L26) # CounterPartyIncomingTransfer > **CounterPartyIncomingTransfer** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"CounterPartyIncomingTransfer"`] Defined in: [src/payments/schemas.gen.ts:27](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L27) # CounterPartyIncomingTransferType > **CounterPartyIncomingTransferType** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"CounterPartyIncomingTransferType"`] Defined in: [src/payments/schemas.gen.ts:28](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L28) # CounterPartyResponse > **CounterPartyResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"CounterPartyResponse"`] Defined in: [src/payments/schemas.gen.ts:30](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L30) # CounterPartyResponseType > **CounterPartyResponseType** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"CounterPartyResponseType"`] Defined in: [src/payments/schemas.gen.ts:31](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L31) # CounterPartyType > **CounterPartyType** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"CounterPartyType"`] Defined in: [src/payments/schemas.gen.ts:32](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L32) # CreateIncomingTransferRequest > **CreateIncomingTransferRequest** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"CreateIncomingTransferRequest"`] Defined in: [src/payments/schemas.gen.ts:33](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L33) # CreateTransferRequest > **CreateTransferRequest** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"CreateTransferRequest"`] Defined in: [src/payments/schemas.gen.ts:34](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L34) # CreateVendorRequest > **CreateVendorRequest** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"CreateVendorRequest"`] Defined in: [src/payments/schemas.gen.ts:35](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L35) # DomesticWireDetailsRequest > **DomesticWireDetailsRequest** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"DomesticWireDetailsRequest"`] Defined in: [src/payments/schemas.gen.ts:36](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L36) # DomesticWireDetailsResponse > **DomesticWireDetailsResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"DomesticWireDetailsResponse"`] Defined in: [src/payments/schemas.gen.ts:37](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L37) # InternationalWireDetailsResponse > **InternationalWireDetailsResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"InternationalWireDetailsResponse"`] Defined in: [src/payments/schemas.gen.ts:38](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L38) # Money > **Money** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"Money"`] Defined in: [src/payments/schemas.gen.ts:40](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L40) # OriginatingAccount > **OriginatingAccount** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"OriginatingAccount"`] Defined in: [src/payments/schemas.gen.ts:41](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L41) # OriginatingAccountResponse > **OriginatingAccountResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"OriginatingAccountResponse"`] Defined in: [src/payments/schemas.gen.ts:42](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L42) # OriginatingAccountResponseType > **OriginatingAccountResponseType** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"OriginatingAccountResponseType"`] Defined in: [src/payments/schemas.gen.ts:43](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L43) # OriginatingAccountType > **OriginatingAccountType** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"OriginatingAccountType"`] Defined in: [src/payments/schemas.gen.ts:45](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L45) # Page_BankConnection_ > **Page\_BankConnection\_** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"Page_BankConnection_"`] Defined in: [src/payments/schemas.gen.ts:46](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L46) # Page_Transfer_ > **Page\_Transfer\_** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"Page_Transfer_"`] Defined in: [src/payments/schemas.gen.ts:47](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L47) # Page_VendorResponse_ > **Page\_VendorResponse\_** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"Page_VendorResponse_"`] Defined in: [src/payments/schemas.gen.ts:48](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L48) # PaymentAccountDetails > **PaymentAccountDetails** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"PaymentAccountDetails"`] Defined in: [src/payments/schemas.gen.ts:49](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L49) # PaymentAccountDetailsResponse > **PaymentAccountDetailsResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"PaymentAccountDetailsResponse"`] Defined in: [src/payments/schemas.gen.ts:50](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L50) # PaymentAccountRequest > **PaymentAccountRequest** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"PaymentAccountRequest"`] Defined in: [src/payments/schemas.gen.ts:51](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L51) # PaymentAccountResponse > **PaymentAccountResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"PaymentAccountResponse"`] Defined in: [src/payments/schemas.gen.ts:52](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L52) # PaymentDetailsTypeRequest > **PaymentDetailsTypeRequest** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"PaymentDetailsTypeRequest"`] Defined in: [src/payments/schemas.gen.ts:53](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L53) # PaymentDetailsTypeResponse > **PaymentDetailsTypeResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"PaymentDetailsTypeResponse"`] Defined in: [src/payments/schemas.gen.ts:54](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L54) # PaymentType > **PaymentType** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"PaymentType"`] Defined in: [src/payments/schemas.gen.ts:55](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L55) # ReceivingAccount > **ReceivingAccount** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"ReceivingAccount"`] Defined in: [src/payments/schemas.gen.ts:56](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L56) # ReceivingAccountType > **ReceivingAccountType** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"ReceivingAccountType"`] Defined in: [src/payments/schemas.gen.ts:57](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L57) # Recipient > **Recipient** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"Recipient"`] Defined in: [src/payments/schemas.gen.ts:58](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L58) # RecipientType > **RecipientType** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"RecipientType"`] Defined in: [src/payments/schemas.gen.ts:59](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L59) # Transfer > **Transfer** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"Transfer"`] Defined in: [src/payments/schemas.gen.ts:60](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L60) # TransferCancellationReason > **TransferCancellationReason** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"TransferCancellationReason"`] Defined in: [src/payments/schemas.gen.ts:61](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L61) # TransferStatus > **TransferStatus** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"TransferStatus"`] Defined in: [src/payments/schemas.gen.ts:62](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L62) # UpdateVendorRequest > **UpdateVendorRequest** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"UpdateVendorRequest"`] Defined in: [src/payments/schemas.gen.ts:63](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L63) # VendorDetails > **VendorDetails** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"VendorDetails"`] Defined in: [src/payments/schemas.gen.ts:64](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L64) # VendorDetailsResponse > **VendorDetailsResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"VendorDetailsResponse"`] Defined in: [src/payments/schemas.gen.ts:65](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L65) # VendorResponse > **VendorResponse** = [`PaymentsComponents`](/brex/api/payments/interfaces/paymentscomponents/)\[`"schemas"`]\[`"VendorResponse"`] Defined in: [src/payments/schemas.gen.ts:66](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/schemas.gen.ts#L66) # brex ## Modules [Section titled “Modules”](#modules) * [accounting](/brex/api/accounting/readme/) * [budgets](/brex/api/budgets/readme/) * [expenses](/brex/api/expenses/readme/) * [fields](/brex/api/fields/readme/) * [index](/brex/api/index/readme/) * [onboarding](/brex/api/onboarding/readme/) * [payments](/brex/api/payments/readme/) * [team](/brex/api/team/readme/) * [transactions](/brex/api/transactions/readme/) * [travel](/brex/api/travel/readme/) * [webhooks](/brex/api/webhooks/readme/) # BrexTeam Defined in: [src/team/client.gen.ts:579](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L579) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BrexTeam**(`core`): `BrexTeam` Defined in: [src/team/client.gen.ts:587](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L587) #### Parameters [Section titled “Parameters”](#parameters) ##### core [Section titled “core”](#core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `BrexTeam` ## Properties [Section titled “Properties”](#properties) ### cards [Section titled “cards”](#cards) > `readonly` **cards**: [`Cards`](/brex/api/team/classes/cards/) Defined in: [src/team/client.gen.ts:580](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L580) *** ### companies [Section titled “companies”](#companies) > `readonly` **companies**: [`Companies`](/brex/api/team/classes/companies/) Defined in: [src/team/client.gen.ts:581](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L581) *** ### departments [Section titled “departments”](#departments) > `readonly` **departments**: [`Departments`](/brex/api/team/classes/departments/) Defined in: [src/team/client.gen.ts:582](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L582) *** ### legalEntities [Section titled “legalEntities”](#legalentities) > `readonly` **legalEntities**: [`LegalEntities`](/brex/api/team/classes/legalentities/) Defined in: [src/team/client.gen.ts:583](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L583) *** ### locations [Section titled “locations”](#locations) > `readonly` **locations**: [`Locations`](/brex/api/team/classes/locations/) Defined in: [src/team/client.gen.ts:584](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L584) *** ### titles [Section titled “titles”](#titles) > `readonly` **titles**: [`Titles`](/brex/api/team/classes/titles/) Defined in: [src/team/client.gen.ts:585](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L585) *** ### users [Section titled “users”](#users) > `readonly` **users**: [`Users`](/brex/api/team/classes/users/) Defined in: [src/team/client.gen.ts:586](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L586) # Cards Defined in: [src/team/client.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L8) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Cards**(`_core`): `Cards` Defined in: [src/team/client.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L9) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Cards` ## Methods [Section titled “Methods”](#methods) ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `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`; }; `budget_id?`: `string` | `null`; `card_name`: `string`; `card_type?`: `"VIRTUAL"` | `"PHYSICAL"` | `null`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `has_been_transferred?`: `boolean`; `id`: `string`; `last_four`: `string`; `limit_type`: `"CARD"` | `"USER"`; `mailing_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `owner`: `object` & `object`; `spend_controls?`: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null`; `status?`: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null`; }> Defined in: [src/team/client.gen.ts:24](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L24) Create card Creates a new card. The `spend_controls` field is required when `limit_type` = `CARD`. The `mailing_address` field is required for physical cards and is the shipping address used to send the card; it is not the same as the billing and mailing address used for online purchases. The first 2 lines of this address must be under 60 characters long. Each user can only have up to 10 active physical cards. For Empower accounts, this endpoint requires budget management. If your account does not have access to budget management features, a 403 response status will be returned. If this is the case and you want to gain access to this endpoint, please contact Brex support. `POST /v2/cards` — requires OAuth scope: `cards` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-1) ##### body [Section titled “body”](#body) ###### card\_attribute\_preferences? [Section titled “card\_attribute\_preferences?”](#card_attribute_preferences) { `three_domain_secure_enabled_preference?`: `"THREE_DOMAIN_SECURE_ENABLED"` | `"THREE_DOMAIN_SECURE_DISABLED"` | `null`; } | `null` ###### card\_name [Section titled “card\_name”](#card_name) `string` ###### card\_type [Section titled “card\_type”](#card_type) `"VIRTUAL"` | `"PHYSICAL"` ###### limit\_type [Section titled “limit\_type”](#limit_type) `"CARD"` | `"USER"` ###### mailing\_address? [Section titled “mailing\_address?”](#mailing_address) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### metadata? [Section titled “metadata?”](#metadata) {\[`key`: `string`]: `string`; } | `null` **Description** Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ###### owner [Section titled “owner”](#owner) `object` & `object` ###### spend\_controls? [Section titled “spend\_controls?”](#spend_controls) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `parent_budget_id?`: `string` | `null`; `policy_id?`: `string` | `null`; `reason?`: `string` | `null`; `spend_duration`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; } | `null` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `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`; }; `budget_id?`: `string` | `null`; `card_name`: `string`; `card_type?`: `"VIRTUAL"` | `"PHYSICAL"` | `null`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `has_been_transferred?`: `boolean`; `id`: `string`; `last_four`: `string`; `limit_type`: `"CARD"` | `"USER"`; `mailing_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `owner`: `object` & `object`; `spend_controls?`: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null`; `status?`: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null`; }> *** ### emailNumber() [Section titled “emailNumber()”](#emailnumber) > **emailNumber**(`id`, `body`, `options?`): `Promise`<`void`> Defined in: [src/team/client.gen.ts:44](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L44) Create secure email to send card number Creates a secure email to send card number, CVV, and expiration date of a card by ID to the specified email. This endpoint is currently gated. If you would like to request access, please reach out to `POST /v2/cards/{id}/secure_email` — requires OAuth scope: `cards.pan` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-2) ##### id [Section titled “id”](#id) `string` ##### body [Section titled “body”](#body-1) ###### expiry\_days? [Section titled “expiry\_days?”](#expiry_days) `number` | `null` Format: int32 **Description** Link expiry in number of days. Defaults to 30 ###### message? [Section titled “message?”](#message) `string` | `null` **Description** Message to send with the card details ###### recipient\_email [Section titled “recipient\_email”](#recipient_email) `string` **Description** Email address to send card details to ###### sender\_name [Section titled “sender\_name”](#sender_name) `string` **Description** Sender name. Shows up in the subject of the email ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<`void`> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `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`; }; `budget_id?`: `string` | `null`; `card_name`: `string`; `card_type?`: `"VIRTUAL"` | `"PHYSICAL"` | `null`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `has_been_transferred?`: `boolean`; `id`: `string`; `last_four`: `string`; `limit_type`: `"CARD"` | `"USER"`; `mailing_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `owner`: `object` & `object`; `spend_controls?`: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null`; `status?`: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null`; }> Defined in: [src/team/client.gen.ts:65](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L65) Get card Retrieves a card by ID. Only cards with `limit_type = CARD` have `spend_controls` `GET /v2/cards/{id}` — requires OAuth scope: `cards`, `cards.readonly` #### Parameters [Section titled “Parameters”](#parameters-3) ##### id [Section titled “id”](#id-1) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `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`; }; `budget_id?`: `string` | `null`; `card_name`: `string`; `card_type?`: `"VIRTUAL"` | `"PHYSICAL"` | `null`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `has_been_transferred?`: `boolean`; `id`: `string`; `last_four`: `string`; `limit_type`: `"CARD"` | `"USER"`; `mailing_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `owner`: `object` & `object`; `spend_controls?`: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null`; `status?`: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null`; }> *** ### getNumber() [Section titled “getNumber()”](#getnumber) > **getNumber**(`id`, `options?`): `Promise`<{ `cvv`: `string`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `holder_name`: `string`; `id`: `string`; `number`: `string`; }> Defined in: [src/team/client.gen.ts:81](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L81) Get card number Retrieves card number, CVV, and expiration date of a card by ID. `GET /v2/cards/{id}/pan` — requires OAuth scope: `cards.pan` #### Parameters [Section titled “Parameters”](#parameters-4) ##### id [Section titled “id”](#id-2) `string` ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) `Promise`<{ `cvv`: `string`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `holder_name`: `string`; `id`: `string`; `number`: `string`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/team/client.gen.ts:101](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L101) List cards Lists all cards by a `user_id`. Only cards with `limit_type = CARD` have `spend_controls` `GET /v2/cards` — requires OAuth scope: `cards.readonly`, `cards` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-5) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ###### user\_id? [Section titled “user\_id?”](#user_id) `string` | `null` ##### options? [Section titled “options?”](#options-4) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-5) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### lock() [Section titled “lock()”](#lock) > **lock**(`id`, `body`, `options?`): `Promise`<{ `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`; }; `budget_id?`: `string` | `null`; `card_name`: `string`; `card_type?`: `"VIRTUAL"` | `"PHYSICAL"` | `null`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `has_been_transferred?`: `boolean`; `id`: `string`; `last_four`: `string`; `limit_type`: `"CARD"` | `"USER"`; `mailing_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `owner`: `object` & `object`; `spend_controls?`: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null`; `status?`: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null`; }> Defined in: [src/team/client.gen.ts:118](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L118) Lock card Locks an existing, unlocked card. And the card owner will receive a notification about it. `POST /v2/cards/{id}/lock` — requires OAuth scope: `cards` Supports an optional `Idempotency-Key` via `options.idempotencyKey`. #### Parameters [Section titled “Parameters”](#parameters-6) ##### id [Section titled “id”](#id-3) `string` ##### body [Section titled “body”](#body-2) ###### description? [Section titled “description?”](#description) `string` | `null` **Description** Description for locking a card ###### reason [Section titled “reason”](#reason) `"OTHER"` | `"CARD_DAMAGED"` | `"CARD_LOST"` | `"CARD_NOT_RECEIVED"` | `"DO_NOT_NEED_PHYSICAL_CARD"` | `"DO_NOT_NEED_VIRTUAL_CARD"` | `"FRAUD"` ##### options? [Section titled “options?”](#options-5) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-6) `Promise`<{ `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`; }; `budget_id?`: `string` | `null`; `card_name`: `string`; `card_type?`: `"VIRTUAL"` | `"PHYSICAL"` | `null`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `has_been_transferred?`: `boolean`; `id`: `string`; `last_four`: `string`; `limit_type`: `"CARD"` | `"USER"`; `mailing_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `owner`: `object` & `object`; `spend_controls?`: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null`; `status?`: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null`; }> *** ### terminate() [Section titled “terminate()”](#terminate) > **terminate**(`id`, `body`, `options?`): `Promise`<{ `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`; }; `budget_id?`: `string` | `null`; `card_name`: `string`; `card_type?`: `"VIRTUAL"` | `"PHYSICAL"` | `null`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `has_been_transferred?`: `boolean`; `id`: `string`; `last_four`: `string`; `limit_type`: `"CARD"` | `"USER"`; `mailing_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `owner`: `object` & `object`; `spend_controls?`: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null`; `status?`: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null`; }> Defined in: [src/team/client.gen.ts:144](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L144) Terminate card Terminates an existing card. The card owner will receive a notification about it. `POST /v2/cards/{id}/terminate` — requires OAuth scope: `cards` Supports an optional `Idempotency-Key` via `options.idempotencyKey`. #### Parameters [Section titled “Parameters”](#parameters-7) ##### id [Section titled “id”](#id-4) `string` ##### body [Section titled “body”](#body-3) ###### description? [Section titled “description?”](#description-1) `string` | `null` **Description** Description for terminating a card ###### reason [Section titled “reason”](#reason-1) `"OTHER"` | `"CARD_DAMAGED"` | `"CARD_LOST"` | `"CARD_NOT_RECEIVED"` | `"DO_NOT_NEED_PHYSICAL_CARD"` | `"DO_NOT_NEED_VIRTUAL_CARD"` | `"FRAUD"` ##### options? [Section titled “options?”](#options-6) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-7) `Promise`<{ `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`; }; `budget_id?`: `string` | `null`; `card_name`: `string`; `card_type?`: `"VIRTUAL"` | `"PHYSICAL"` | `null`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `has_been_transferred?`: `boolean`; `id`: `string`; `last_four`: `string`; `limit_type`: `"CARD"` | `"USER"`; `mailing_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `owner`: `object` & `object`; `spend_controls?`: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null`; `status?`: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null`; }> *** ### unlock() [Section titled “unlock()”](#unlock) > **unlock**(`id`, `options?`): `Promise`<{ `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`; }; `budget_id?`: `string` | `null`; `card_name`: `string`; `card_type?`: `"VIRTUAL"` | `"PHYSICAL"` | `null`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `has_been_transferred?`: `boolean`; `id`: `string`; `last_four`: `string`; `limit_type`: `"CARD"` | `"USER"`; `mailing_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `owner`: `object` & `object`; `spend_controls?`: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null`; `status?`: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null`; }> Defined in: [src/team/client.gen.ts:170](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L170) Unlock card Unlocks an existing card. `POST /v2/cards/{id}/unlock` — requires OAuth scope: `cards` Supports an optional `Idempotency-Key` via `options.idempotencyKey`. #### Parameters [Section titled “Parameters”](#parameters-8) ##### id [Section titled “id”](#id-5) `string` ##### options? [Section titled “options?”](#options-7) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-8) `Promise`<{ `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`; }; `budget_id?`: `string` | `null`; `card_name`: `string`; `card_type?`: `"VIRTUAL"` | `"PHYSICAL"` | `null`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `has_been_transferred?`: `boolean`; `id`: `string`; `last_four`: `string`; `limit_type`: `"CARD"` | `"USER"`; `mailing_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `owner`: `object` & `object`; `spend_controls?`: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null`; `status?`: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null`; }> *** ### update() [Section titled “update()”](#update) > **update**(`id`, `body`, `options?`): `Promise`<{ `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`; }; `budget_id?`: `string` | `null`; `card_name`: `string`; `card_type?`: `"VIRTUAL"` | `"PHYSICAL"` | `null`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `has_been_transferred?`: `boolean`; `id`: `string`; `last_four`: `string`; `limit_type`: `"CARD"` | `"USER"`; `mailing_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `owner`: `object` & `object`; `spend_controls?`: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null`; `status?`: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null`; }> Defined in: [src/team/client.gen.ts:192](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L192) Update card Update an existing vendor card `PUT /v2/cards/{id}` — requires OAuth scope: `cards` Supports an optional `Idempotency-Key` via `options.idempotencyKey`. #### Parameters [Section titled “Parameters”](#parameters-9) ##### id [Section titled “id”](#id-6) `string` ##### body [Section titled “body”](#body-4) ###### metadata? [Section titled “metadata?”](#metadata-1) {\[`key`: `string`]: `string`; } | `null` **Description** Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ###### spend\_controls? [Section titled “spend\_controls?”](#spend_controls-1) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null` ##### options? [Section titled “options?”](#options-8) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-9) `Promise`<{ `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`; }; `budget_id?`: `string` | `null`; `card_name`: `string`; `card_type?`: `"VIRTUAL"` | `"PHYSICAL"` | `null`; `expiration_date`: { `month`: `number`; `year`: `number`; }; `has_been_transferred?`: `boolean`; `id`: `string`; `last_four`: `string`; `limit_type`: `"CARD"` | `"USER"`; `mailing_address?`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `owner`: `object` & `object`; `spend_controls?`: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null`; `status?`: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null`; }> # Companies Defined in: [src/team/client.gen.ts:205](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L205) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Companies**(`_core`): `Companies` Defined in: [src/team/client.gen.ts:206](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L206) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Companies` ## Methods [Section titled “Methods”](#methods) ### get() [Section titled “get()”](#get) > **get**(`options?`): `Promise`<{ `accountType`: `"BREX_CLASSIC"` | `"BREX_EMPOWER"`; `id`: `string`; `legal_name`: `string`; `mailing_address`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; }; }> Defined in: [src/team/client.gen.ts:215](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L215) Get company This endpoint returns the company associated with the OAuth2 access token. `GET /v2/company` — requires OAuth scope: `companies.readonly` #### Parameters [Section titled “Parameters”](#parameters-1) ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `accountType`: `"BREX_CLASSIC"` | `"BREX_EMPOWER"`; `id`: `string`; `legal_name`: `string`; `mailing_address`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; }; }> # Departments Defined in: [src/team/client.gen.ts:224](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L224) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Departments**(`_core`): `Departments` Defined in: [src/team/client.gen.ts:225](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L225) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Departments` ## Methods [Section titled “Methods”](#methods) ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `description?`: `string` | `null`; `id`: `string`; `name`: `string`; }> Defined in: [src/team/client.gen.ts:235](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L235) Create department This endpoint creates a new department `POST /v2/departments` — requires OAuth scope: `departments` Supports an optional `Idempotency-Key` via `options.idempotencyKey`. #### Parameters [Section titled “Parameters”](#parameters-1) ##### body [Section titled “body”](#body) ###### description? [Section titled “description?”](#description) `string` | `null` **Description** Description of the department ###### name [Section titled “name”](#name) `string` **Description** Name of the department ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `description?`: `string` | `null`; `id`: `string`; `name`: `string`; }> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `description?`: `string` | `null`; `id`: `string`; `name`: `string`; }> Defined in: [src/team/client.gen.ts:255](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L255) Get department This endpoint gets a department by ID. `GET /v2/departments/{id}` — requires OAuth scope: `departments`, `departments.readonly` #### Parameters [Section titled “Parameters”](#parameters-2) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `description?`: `string` | `null`; `id`: `string`; `name`: `string`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/team/client.gen.ts:274](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L274) List departments This endpoint lists all departments. `GET /v2/departments` — requires OAuth scope: `departments`, `departments.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-3) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ###### name? [Section titled “name?”](#name-1) `string` | `null` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> # LegalEntities Defined in: [src/team/client.gen.ts:286](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L286) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new LegalEntities**(`_core`): `LegalEntities` Defined in: [src/team/client.gen.ts:287](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L287) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `LegalEntities` ## Methods [Section titled “Methods”](#methods) ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `billingAddress`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; }; `createdAt`: `string`; `displayName`: `string`; `id`: `string`; `isDefault?`: `boolean`; `status`: `"UNSUBMITTED"` | `"UNVERIFIED"` | `"IN_PROGRESS"` | `"VERIFIED"` | `"REJECTED"`; }> Defined in: [src/team/client.gen.ts:296](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L296) Get legal entity Get a legal entity by its ID. `GET /v2/legal_entities/{id}` — requires OAuth scope: `legal_entities`, `legal_entities.readonly` #### Parameters [Section titled “Parameters”](#parameters-1) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `billingAddress`: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; }; `createdAt`: `string`; `displayName`: `string`; `id`: `string`; `isDefault?`: `boolean`; `status`: `"UNSUBMITTED"` | `"UNVERIFIED"` | `"IN_PROGRESS"` | `"VERIFIED"` | `"REJECTED"`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/team/client.gen.ts:315](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L315) List legal entities List legal entities for the account. `GET /v2/legal_entities` — requires OAuth scope: `legal_entities`, `legal_entities.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-2) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> # Locations Defined in: [src/team/client.gen.ts:327](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L327) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Locations**(`_core`): `Locations` Defined in: [src/team/client.gen.ts:328](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L328) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Locations` ## Methods [Section titled “Methods”](#methods) ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `description?`: `string` | `null`; `id`: `string`; `name`: `string`; }> Defined in: [src/team/client.gen.ts:338](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L338) Create location This endpoint creates a new location. `POST /v2/locations` — requires OAuth scope: `locations` Supports an optional `Idempotency-Key` via `options.idempotencyKey`. #### Parameters [Section titled “Parameters”](#parameters-1) ##### body [Section titled “body”](#body) ###### description? [Section titled “description?”](#description) `string` | `null` **Description** Description of the location ###### name [Section titled “name”](#name) `string` **Description** Name of the location ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `description?`: `string` | `null`; `id`: `string`; `name`: `string`; }> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `description?`: `string` | `null`; `id`: `string`; `name`: `string`; }> Defined in: [src/team/client.gen.ts:356](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L356) Get location This endpoint gets a location by ID. `GET /v2/locations/{id}` — requires OAuth scope: `locations`, `locations.readonly` #### Parameters [Section titled “Parameters”](#parameters-2) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `description?`: `string` | `null`; `id`: `string`; `name`: `string`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/team/client.gen.ts:375](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L375) List locations This endpoint lists all locations. `GET /v2/locations` — requires OAuth scope: `locations`, `locations.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-3) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ###### name? [Section titled “name?”](#name-1) `string` | `null` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> # Titles Defined in: [src/team/client.gen.ts:387](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L387) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Titles**(`_core`): `Titles` Defined in: [src/team/client.gen.ts:388](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L388) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Titles` ## Methods [Section titled “Methods”](#methods) ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `id`: `string`; `name`: `string`; }> Defined in: [src/team/client.gen.ts:398](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L398) Create title This endpoint creates a new title `POST /v2/titles` — requires OAuth scope: `titles` Supports an optional `Idempotency-Key` via `options.idempotencyKey`. #### Parameters [Section titled “Parameters”](#parameters-1) ##### body [Section titled “body”](#body) ###### name [Section titled “name”](#name) `string` **Description** Name of the title ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `id`: `string`; `name`: `string`; }> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `id`: `string`; `name`: `string`; }> Defined in: [src/team/client.gen.ts:416](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L416) Get title This endpoint gets a title by ID. `GET /v2/titles/{id}` — requires OAuth scope: `titles`, `titles.readonly` #### Parameters [Section titled “Parameters”](#parameters-2) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `id`: `string`; `name`: `string`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/team/client.gen.ts:433](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L433) List titles This endpoint lists all titles. `GET /v2/titles` — requires OAuth scope: `titles`, `titles.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-3) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ###### name? [Section titled “name?”](#name-1) `string` | `null` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> # Users Defined in: [src/team/client.gen.ts:443](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L443) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Users**(`_core`): `Users` Defined in: [src/team/client.gen.ts:444](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L444) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Users` ## Methods [Section titled “Methods”](#methods) ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `department_id?`: `string` | `null`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; `manager_id?`: `string` | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `remote_display_id?`: `string` | `null`; `status?`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null`; `title_id?`: `string` | `null`; }> Defined in: [src/team/client.gen.ts:455](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L455) Invite user This endpoint invites a new user as an employee. To update user’s role, check out [this article](https://support.brex.com/how-do-i-change-another-user-s-role/). `POST /v2/users` — requires OAuth scope: `users` Supports an optional `Idempotency-Key` via `options.idempotencyKey`. #### Parameters [Section titled “Parameters”](#parameters-1) ##### body [Section titled “body”](#body) ###### department\_id? [Section titled “department\_id?”](#department_id) `string` | `null` ###### email [Section titled “email”](#email) `string` Format: email ###### first\_name [Section titled “first\_name”](#first_name) `string` ###### last\_name [Section titled “last\_name”](#last_name) `string` ###### location\_id? [Section titled “location\_id?”](#location_id) `string` | `null` ###### manager\_id? [Section titled “manager\_id?”](#manager_id) `string` | `null` ###### metadata? [Section titled “metadata?”](#metadata) {\[`key`: `string`]: `string`; } | `null` **Description** The metadata or customized attributes of the user. Maximum number of entries: 100 ###### title\_id? [Section titled “title\_id?”](#title_id) `string` | `null` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `department_id?`: `string` | `null`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; `manager_id?`: `string` | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `remote_display_id?`: `string` | `null`; `status?`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null`; `title_id?`: `string` | `null`; }> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `department_id?`: `string` | `null`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; `manager_id?`: `string` | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `remote_display_id?`: `string` | `null`; `status?`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null`; `title_id?`: `string` | `null`; }> Defined in: [src/team/client.gen.ts:471](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L471) Get user This endpoint gets a user by ID. `GET /v2/users/{id}` — requires OAuth scope: `users`, `users.readonly` #### Parameters [Section titled “Parameters”](#parameters-2) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `department_id?`: `string` | `null`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; `manager_id?`: `string` | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `remote_display_id?`: `string` | `null`; `status?`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null`; `title_id?`: `string` | `null`; }> *** ### getLimit() [Section titled “getLimit()”](#getlimit) > **getLimit**(`id`, `options?`): `Promise`<{ `monthly_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `monthly_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; }> Defined in: [src/team/client.gen.ts:487](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L487) Get limit for the user This endpoint gets the monthly limit for the user including the monthly available limit. `GET /v2/users/{id}/limit` — requires OAuth scope: `users`, `users.readonly` #### Parameters [Section titled “Parameters”](#parameters-3) ##### id [Section titled “id”](#id-1) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `monthly_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `monthly_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; }> *** ### getMe() [Section titled “getMe()”](#getme) > **getMe**(`options?`): `Promise`<{ `department_id?`: `string` | `null`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; `manager_id?`: `string` | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `remote_display_id?`: `string` | `null`; `status?`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null`; `title_id?`: `string` | `null`; }> Defined in: [src/team/client.gen.ts:505](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L505) Get current user This endpoint returns the user associated with the OAuth2 access token. `GET /v2/users/me` — requires OAuth scope: `users`, `users.readonly` #### Parameters [Section titled “Parameters”](#parameters-4) ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) `Promise`<{ `department_id?`: `string` | `null`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; `manager_id?`: `string` | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `remote_display_id?`: `string` | `null`; `status?`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null`; `title_id?`: `string` | `null`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/team/client.gen.ts:521](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L521) List users This endpoint lists all users. To find a user id by email, you can filter using the `email` query parameter. `GET /v2/users` — requires OAuth scope: `users`, `users.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-5) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### email? [Section titled “email?”](#email-1) `string` | `null` ###### expand\[]? [Section titled “expand\[\]?”](#expand) `string`\[] | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ###### remote\_display\_id? [Section titled “remote\_display\_id?”](#remote_display_id) `string` | `null` ##### options? [Section titled “options?”](#options-4) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-5) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### setLimit() [Section titled “setLimit()”](#setlimit) > **setLimit**(`id`, `body`, `options?`): `Promise`<{ `monthly_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `monthly_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; }> Defined in: [src/team/client.gen.ts:540](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L540) Set limit for the user This endpoint sets the monthly limit for a user. The limit amount must be non-negative. To unset the monthly limit of the user, just set `monthly_limit` to null. `POST /v2/users/{id}/limit` — requires OAuth scope: `users` Supports an optional `Idempotency-Key` via `options.idempotencyKey`. #### Parameters [Section titled “Parameters”](#parameters-6) ##### id [Section titled “id”](#id-2) `string` ##### body [Section titled “body”](#body-1) ###### monthly\_limit? [Section titled “monthly\_limit?”](#monthly_limit) { `amount`: `number`; `currency`: `string` | `null`; } | `null` ##### options? [Section titled “options?”](#options-5) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-6) `Promise`<{ `monthly_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `monthly_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; }> *** ### update() [Section titled “update()”](#update) > **update**(`id`, `body`, `options?`): `Promise`<{ `department_id?`: `string` | `null`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; `manager_id?`: `string` | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `remote_display_id?`: `string` | `null`; `status?`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null`; `title_id?`: `string` | `null`; }> Defined in: [src/team/client.gen.ts:566](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/client.gen.ts#L566) Update user This endpoint updates a user. Any parameters not provided will be left unchanged. `PUT /v2/users/{id}` — requires OAuth scope: `users` Supports an optional `Idempotency-Key` via `options.idempotencyKey`. #### Parameters [Section titled “Parameters”](#parameters-7) ##### id [Section titled “id”](#id-3) `string` ##### body [Section titled “body”](#body-2) ###### department\_id? [Section titled “department\_id?”](#department_id-1) `string` | `null` ###### location\_id? [Section titled “location\_id?”](#location_id-1) `string` | `null` ###### manager\_id? [Section titled “manager\_id?”](#manager_id-1) `string` | `null` **Description** The user id of the manager of this user ###### metadata? [Section titled “metadata?”](#metadata-1) {\[`key`: `string`]: `string`; } | `null` **Description** The metadata or customized attributes of the user. Maximum number of entries: 100 ###### status? [Section titled “status?”](#status) `"ACTIVE"` | `"DISABLED"` | `null` ###### title\_id? [Section titled “title\_id?”](#title_id-1) `string` | `null` ##### options? [Section titled “options?”](#options-6) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-7) `Promise`<{ `department_id?`: `string` | `null`; `email`: `string`; `first_name`: `string`; `id`: `string`; `last_name`: `string`; `location_id?`: `string` | `null`; `manager_id?`: `string` | `null`; `metadata?`: {\[`key`: `string`]: `string`; } | `null`; `remote_display_id?`: `string` | `null`; `status?`: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null`; `title_id?`: `string` | `null`; }> # createTeamClient > **createTeamClient**(`options`): [`BrexTeam`](/brex/api/team/classes/brexteam/) Defined in: [src/team/index.ts:22](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/index.ts#L22) Standalone client for the Brex Team API. ## Parameters [Section titled “Parameters”](#parameters) ### options [Section titled “options”](#options) [`BrexOptions`](/brex/api/index/interfaces/brexoptions/) ## Returns [Section titled “Returns”](#returns) [`BrexTeam`](/brex/api/team/classes/brexteam/) # TeamComponents Defined in: [src/team/types.gen.ts:449](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L449) ## Properties [Section titled “Properties”](#properties) ### headers [Section titled “headers”](#headers) > **headers**: `never` Defined in: [src/team/types.gen.ts:890](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L890) *** ### parameters [Section titled “parameters”](#parameters) > **parameters**: `never` Defined in: [src/team/types.gen.ts:888](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L888) *** ### pathItems [Section titled “pathItems”](#pathitems) > **pathItems**: `never` Defined in: [src/team/types.gen.ts:891](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L891) *** ### requestBodies [Section titled “requestBodies”](#requestbodies) > **requestBodies**: `never` Defined in: [src/team/types.gen.ts:889](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L889) *** ### responses [Section titled “responses”](#responses) > **responses**: `never` Defined in: [src/team/types.gen.ts:887](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L887) *** ### schemas [Section titled “schemas”](#schemas) > **schemas**: `object` Defined in: [src/team/types.gen.ts:450](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L450) #### AccountType [Section titled “AccountType”](#accounttype) > **AccountType**: `"BREX_CLASSIC"` | `"BREX_EMPOWER"` #### Address [Section titled “Address”](#address) > **Address**: `object` ##### Description [Section titled “Description”](#description) Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed). ##### Address.city? [Section titled “Address.city?”](#addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-1) City, district, suburb, town, or village. ##### Address.country? [Section titled “Address.country?”](#addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-2) Two-letter country code (ISO 3166-1 alpha-2). ##### Address.line1? [Section titled “Address.line1?”](#addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-3) Address line 1, no PO Box. ##### Address.line2? [Section titled “Address.line2?”](#addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-4) Address line 2 (e.g., apartment, suite, unit, or building). ##### Address.phone\_number? [Section titled “Address.phone\_number?”](#addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-5) Phone number. ##### Address.postal\_code? [Section titled “Address.postal\_code?”](#addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-6) ZIP or postal code. ##### Address.state? [Section titled “Address.state?”](#addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-7) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. #### Card [Section titled “Card”](#card) > **Card**: `object` ##### Description [Section titled “Description”](#description-8) Only cards with limit\_type = CARD have spend\_controls ##### Card.billing\_address [Section titled “Card.billing\_address”](#cardbilling_address) > **billing\_address**: `object` ##### Card.billing\_address.city? [Section titled “Card.billing\_address.city?”](#cardbilling_addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-9) City, district, suburb, town, or village. ##### Card.billing\_address.country? [Section titled “Card.billing\_address.country?”](#cardbilling_addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-10) Two-letter country code (ISO 3166-1 alpha-2). ##### Card.billing\_address.line1? [Section titled “Card.billing\_address.line1?”](#cardbilling_addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-11) Address line 1, no PO Box. ##### Card.billing\_address.line2? [Section titled “Card.billing\_address.line2?”](#cardbilling_addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-12) Address line 2 (e.g., apartment, suite, unit, or building). ##### Card.billing\_address.phone\_number? [Section titled “Card.billing\_address.phone\_number?”](#cardbilling_addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-13) Phone number. ##### Card.billing\_address.postal\_code? [Section titled “Card.billing\_address.postal\_code?”](#cardbilling_addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-14) ZIP or postal code. ##### Card.billing\_address.state? [Section titled “Card.billing\_address.state?”](#cardbilling_addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-15) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### Card.budget\_id? [Section titled “Card.budget\_id?”](#cardbudget_id) > `optional` **budget\_id?**: `string` | `null` ##### Card.card\_name [Section titled “Card.card\_name”](#cardcard_name) > **card\_name**: `string` ##### Card.card\_type? [Section titled “Card.card\_type?”](#cardcard_type) > `optional` **card\_type?**: `"VIRTUAL"` | `"PHYSICAL"` | `null` ##### Card.expiration\_date [Section titled “Card.expiration\_date”](#cardexpiration_date) > **expiration\_date**: `object` ##### Card.expiration\_date.month [Section titled “Card.expiration\_date.month”](#cardexpiration_datemonth) > **month**: `number` Format: int32 ##### Card.expiration\_date.year [Section titled “Card.expiration\_date.year”](#cardexpiration_dateyear) > **year**: `number` Format: int32 ##### Card.has\_been\_transferred? [Section titled “Card.has\_been\_transferred?”](#cardhas_been_transferred) > `optional` **has\_been\_transferred?**: `boolean` ###### Description [Section titled “Description”](#description-16) Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions\ at online vendors where this card was previously used before the transfer. ##### Card.id [Section titled “Card.id”](#cardid) > **id**: `string` ##### Card.last\_four [Section titled “Card.last\_four”](#cardlast_four) > **last\_four**: `string` ##### Card.limit\_type [Section titled “Card.limit\_type”](#cardlimit_type) > **limit\_type**: `"CARD"` | `"USER"` ##### Card.mailing\_address? [Section titled “Card.mailing\_address?”](#cardmailing_address) > `optional` **mailing\_address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-17) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-18) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-19) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-20) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-21) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-22) ZIP or postal code. ###### state? [Section titled “state?”](#state) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-23) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### Card.metadata? [Section titled “Card.metadata?”](#cardmetadata) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-24) Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ##### Card.owner [Section titled “Card.owner”](#cardowner) > **owner**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration) ###### type [Section titled “type”](#type) > **type**: `"USER"` ###### user\_id [Section titled “user\_id”](#user_id) > **user\_id**: `string` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-1) ###### type [Section titled “type”](#type-1) > **type**: `"USER"` ###### Description [Section titled “Description”](#description-25) discriminator enum property added by openapi-typescript ##### Card.spend\_controls? [Section titled “Card.spend\_controls?”](#cardspend_controls) > `optional` **spend\_controls?**: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } ###### allowed\_merchant\_details? [Section titled “allowed\_merchant\_details?”](#allowed_merchant_details) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-26) List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example [Section titled “Example”](#example) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? [Section titled “blocked\_merchant\_details?”](#blocked_merchant_details) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-27) List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example [Section titled “Example”](#example-1) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? [Section titled “lock\_after\_date?”](#lock_after_date) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-28) The `lock_after_date` is in UTC. ###### reason? [Section titled “reason?”](#reason) > `optional` **reason?**: `string` | `null` ###### spend\_available? [Section titled “spend\_available?”](#spend_available) > `optional` **spend\_available?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-29) 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 [Section titled “Example”](#example-2) ```ts 700 ``` ###### currency [Section titled “currency”](#currency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-30) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default) ```ts USD ``` ###### Example [Section titled “Example”](#example-3) ```ts USD ``` *** `null` ###### spend\_duration? [Section titled “spend\_duration?”](#spend_duration) > `optional` **spend\_duration?**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ###### spend\_limit? [Section titled “spend\_limit?”](#spend_limit) > `optional` **spend\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-3) ###### Type Literal [Section titled “Type Literal”](#type-literal-3) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-31) 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 [Section titled “Example”](#example-4) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-32) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-1) ```ts USD ``` ###### Example [Section titled “Example”](#example-5) ```ts USD ``` *** `null` *** `null` ##### Card.status? [Section titled “Card.status?”](#cardstatus) > `optional` **status?**: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null` #### CardAttributePreferences [Section titled “CardAttributePreferences”](#cardattributepreferences) > **CardAttributePreferences**: `object` ##### CardAttributePreferences.three\_domain\_secure\_enabled\_preference? [Section titled “CardAttributePreferences.three\_domain\_secure\_enabled\_preference?”](#cardattributepreferencesthree_domain_secure_enabled_preference) > `optional` **three\_domain\_secure\_enabled\_preference?**: `"THREE_DOMAIN_SECURE_ENABLED"` | `"THREE_DOMAIN_SECURE_DISABLED"` | `null` #### CardExpiration [Section titled “CardExpiration”](#cardexpiration) > **CardExpiration**: `object` ##### Description [Section titled “Description”](#description-33) Card expiration year and month. Cards expire on the last day of the expiration month. ```plaintext The expiration date is in UTC for cards starting with 555671, 428803 and 485932. And the expiration date is in PST for cards starting with 511572. ``` ##### CardExpiration.month [Section titled “CardExpiration.month”](#cardexpirationmonth) > **month**: `number` Format: int32 ##### CardExpiration.year [Section titled “CardExpiration.year”](#cardexpirationyear) > **year**: `number` Format: int32 #### CardNumberResponse [Section titled “CardNumberResponse”](#cardnumberresponse) > **CardNumberResponse**: `object` ##### Description [Section titled “Description”](#description-34) Card number, CVV, and expiration date of a card. ##### CardNumberResponse.cvv [Section titled “CardNumberResponse.cvv”](#cardnumberresponsecvv) > **cvv**: `string` ##### CardNumberResponse.expiration\_date [Section titled “CardNumberResponse.expiration\_date”](#cardnumberresponseexpiration_date) > **expiration\_date**: `object` ##### CardNumberResponse.expiration\_date.month [Section titled “CardNumberResponse.expiration\_date.month”](#cardnumberresponseexpiration_datemonth) > **month**: `number` Format: int32 ##### CardNumberResponse.expiration\_date.year [Section titled “CardNumberResponse.expiration\_date.year”](#cardnumberresponseexpiration_dateyear) > **year**: `number` Format: int32 ##### CardNumberResponse.holder\_name [Section titled “CardNumberResponse.holder\_name”](#cardnumberresponseholder_name) > **holder\_name**: `string` ##### CardNumberResponse.id [Section titled “CardNumberResponse.id”](#cardnumberresponseid) > **id**: `string` ##### CardNumberResponse.number [Section titled “CardNumberResponse.number”](#cardnumberresponsenumber) > **number**: `string` #### CardOwner [Section titled “CardOwner”](#cardowner-1) > **CardOwner**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-2) ###### type [Section titled “type”](#type-2) > **type**: `"USER"` ###### user\_id [Section titled “user\_id”](#user_id-1) > **user\_id**: `string` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-3) ###### type [Section titled “type”](#type-3) > **type**: `"USER"` ###### Description [Section titled “Description”](#description-35) discriminator enum property added by openapi-typescript #### CardStatus [Section titled “CardStatus”](#cardstatus-1) > **CardStatus**: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` #### CardType [Section titled “CardType”](#cardtype) > **CardType**: `"VIRTUAL"` | `"PHYSICAL"` #### ChangeCardReason [Section titled “ChangeCardReason”](#changecardreason) > **ChangeCardReason**: `"OTHER"` | `"CARD_DAMAGED"` | `"CARD_LOST"` | `"CARD_NOT_RECEIVED"` | `"DO_NOT_NEED_PHYSICAL_CARD"` | `"DO_NOT_NEED_VIRTUAL_CARD"` | `"FRAUD"` ##### Description [Section titled “Description”](#description-36) Reason for card termination. #### CompanyResponse [Section titled “CompanyResponse”](#companyresponse) > **CompanyResponse**: `object` ##### CompanyResponse.accountType [Section titled “CompanyResponse.accountType”](#companyresponseaccounttype) > **accountType**: `"BREX_CLASSIC"` | `"BREX_EMPOWER"` ##### CompanyResponse.id [Section titled “CompanyResponse.id”](#companyresponseid) > **id**: `string` ##### CompanyResponse.legal\_name [Section titled “CompanyResponse.legal\_name”](#companyresponselegal_name) > **legal\_name**: `string` ##### CompanyResponse.mailing\_address [Section titled “CompanyResponse.mailing\_address”](#companyresponsemailing_address) > **mailing\_address**: `object` ##### CompanyResponse.mailing\_address.city? [Section titled “CompanyResponse.mailing\_address.city?”](#companyresponsemailing_addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-37) City, district, suburb, town, or village. ##### CompanyResponse.mailing\_address.country? [Section titled “CompanyResponse.mailing\_address.country?”](#companyresponsemailing_addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-38) Two-letter country code (ISO 3166-1 alpha-2). ##### CompanyResponse.mailing\_address.line1? [Section titled “CompanyResponse.mailing\_address.line1?”](#companyresponsemailing_addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-39) Address line 1, no PO Box. ##### CompanyResponse.mailing\_address.line2? [Section titled “CompanyResponse.mailing\_address.line2?”](#companyresponsemailing_addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-40) Address line 2 (e.g., apartment, suite, unit, or building). ##### CompanyResponse.mailing\_address.phone\_number? [Section titled “CompanyResponse.mailing\_address.phone\_number?”](#companyresponsemailing_addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-41) Phone number. ##### CompanyResponse.mailing\_address.postal\_code? [Section titled “CompanyResponse.mailing\_address.postal\_code?”](#companyresponsemailing_addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-42) ZIP or postal code. ##### CompanyResponse.mailing\_address.state? [Section titled “CompanyResponse.mailing\_address.state?”](#companyresponsemailing_addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-43) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. #### CreateCardRequest [Section titled “CreateCardRequest”](#createcardrequest) > **CreateCardRequest**: `object` ##### Description [Section titled “Description”](#description-44) The `spend_controls` field is required when `limit_type` = `CARD`. The `shipping_address` field is required for physical cards, and the first 2 lines of the address must be under 60 characters long. ##### CreateCardRequest.card\_attribute\_preferences? [Section titled “CreateCardRequest.card\_attribute\_preferences?”](#createcardrequestcard_attribute_preferences) > `optional` **card\_attribute\_preferences?**: { `three_domain_secure_enabled_preference?`: `"THREE_DOMAIN_SECURE_ENABLED"` | `"THREE_DOMAIN_SECURE_DISABLED"` | `null`; } | `null` ##### CreateCardRequest.card\_name [Section titled “CreateCardRequest.card\_name”](#createcardrequestcard_name) > **card\_name**: `string` ##### CreateCardRequest.card\_type [Section titled “CreateCardRequest.card\_type”](#createcardrequestcard_type) > **card\_type**: `"VIRTUAL"` | `"PHYSICAL"` ##### CreateCardRequest.limit\_type [Section titled “CreateCardRequest.limit\_type”](#createcardrequestlimit_type) > **limit\_type**: `"CARD"` | `"USER"` ##### CreateCardRequest.mailing\_address? [Section titled “CreateCardRequest.mailing\_address?”](#createcardrequestmailing_address) > `optional` **mailing\_address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-4) ###### Type Literal [Section titled “Type Literal”](#type-literal-4) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city-1) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-45) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country-1) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-46) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1-1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-47) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2-1) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-48) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number-1) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-49) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code-1) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-50) ZIP or postal code. ###### state? [Section titled “state?”](#state-1) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-51) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### CreateCardRequest.metadata? [Section titled “CreateCardRequest.metadata?”](#createcardrequestmetadata) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-52) Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ##### CreateCardRequest.owner [Section titled “CreateCardRequest.owner”](#createcardrequestowner) > **owner**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-4) ###### type [Section titled “type”](#type-4) > **type**: `"USER"` ###### user\_id [Section titled “user\_id”](#user_id-2) > **user\_id**: `string` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-5) ###### type [Section titled “type”](#type-5) > **type**: `"USER"` ###### Description [Section titled “Description”](#description-53) discriminator enum property added by openapi-typescript ##### CreateCardRequest.spend\_controls? [Section titled “CreateCardRequest.spend\_controls?”](#createcardrequestspend_controls) > `optional` **spend\_controls?**: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `parent_budget_id?`: `string` | `null`; `policy_id?`: `string` | `null`; `reason?`: `string` | `null`; `spend_duration`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-5) ###### Type Literal [Section titled “Type Literal”](#type-literal-5) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `parent_budget_id?`: `string` | `null`; `policy_id?`: `string` | `null`; `reason?`: `string` | `null`; `spend_duration`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; } ###### allowed\_merchant\_details? [Section titled “allowed\_merchant\_details?”](#allowed_merchant_details-1) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-54) List of merchants where card transactions are allowed. Cannot be used together with blocked\_merchant\_details. Maximum 50 merchant details. ###### Example [Section titled “Example”](#example-6) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? [Section titled “blocked\_merchant\_details?”](#blocked_merchant_details-1) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-55) List of merchants where card transactions are blocked. Cannot be used together with allowed\_merchant\_details. Maximum 50 merchant details. ###### Example [Section titled “Example”](#example-7) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? [Section titled “lock\_after\_date?”](#lock_after_date-1) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ###### parent\_budget\_id? [Section titled “parent\_budget\_id?”](#parent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-56) If using the Empower platform, a new `budget` will be created for this card. You can specify a `parent_budget` that your new `budget` will be nested under. If `parent_budget_id` is null, we will nest the new budget under the top-level account `budget`. ###### policy\_id? [Section titled “policy\_id?”](#policy_id) > `optional` **policy\_id?**: `string` | `null` ###### reason? [Section titled “reason?”](#reason-1) > `optional` **reason?**: `string` | `null` ###### spend\_duration [Section titled “spend\_duration”](#spend_duration-1) > **spend\_duration**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ###### spend\_limit [Section titled “spend\_limit”](#spend_limit-1) > **spend\_limit**: `object` ###### spend\_limit.amount [Section titled “spend\_limit.amount”](#spend_limitamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-57) 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 [Section titled “Example”](#example-8) ```ts 700 ``` ###### spend\_limit.currency [Section titled “spend\_limit.currency”](#spend_limitcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-58) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-2) ```ts USD ``` ###### Example [Section titled “Example”](#example-9) ```ts USD ``` *** `null` #### CreateDepartmentRequest [Section titled “CreateDepartmentRequest”](#createdepartmentrequest) > **CreateDepartmentRequest**: `object` ##### CreateDepartmentRequest.description? [Section titled “CreateDepartmentRequest.description?”](#createdepartmentrequestdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-59) Description of the department ##### CreateDepartmentRequest.name [Section titled “CreateDepartmentRequest.name”](#createdepartmentrequestname) > **name**: `string` ###### Description [Section titled “Description”](#description-60) Name of the department #### CreateLocationRequest [Section titled “CreateLocationRequest”](#createlocationrequest) > **CreateLocationRequest**: `object` ##### CreateLocationRequest.description? [Section titled “CreateLocationRequest.description?”](#createlocationrequestdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-61) Description of the location ##### CreateLocationRequest.name [Section titled “CreateLocationRequest.name”](#createlocationrequestname) > **name**: `string` ###### Description [Section titled “Description”](#description-62) Name of the location #### CreateTitleRequest [Section titled “CreateTitleRequest”](#createtitlerequest) > **CreateTitleRequest**: `object` ##### CreateTitleRequest.name [Section titled “CreateTitleRequest.name”](#createtitlerequestname) > **name**: `string` ###### Description [Section titled “Description”](#description-63) Name of the title #### CreateUserRequest [Section titled “CreateUserRequest”](#createuserrequest) > **CreateUserRequest**: `object` ##### CreateUserRequest.department\_id? [Section titled “CreateUserRequest.department\_id?”](#createuserrequestdepartment_id) > `optional` **department\_id?**: `string` | `null` ##### CreateUserRequest.email [Section titled “CreateUserRequest.email”](#createuserrequestemail) > **email**: `string` Format: email ##### CreateUserRequest.first\_name [Section titled “CreateUserRequest.first\_name”](#createuserrequestfirst_name) > **first\_name**: `string` ##### CreateUserRequest.last\_name [Section titled “CreateUserRequest.last\_name”](#createuserrequestlast_name) > **last\_name**: `string` ##### CreateUserRequest.location\_id? [Section titled “CreateUserRequest.location\_id?”](#createuserrequestlocation_id) > `optional` **location\_id?**: `string` | `null` ##### CreateUserRequest.manager\_id? [Section titled “CreateUserRequest.manager\_id?”](#createuserrequestmanager_id) > `optional` **manager\_id?**: `string` | `null` ##### CreateUserRequest.metadata? [Section titled “CreateUserRequest.metadata?”](#createuserrequestmetadata) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-64) The metadata or customized attributes of the user. Maximum number of entries: 100 ##### CreateUserRequest.title\_id? [Section titled “CreateUserRequest.title\_id?”](#createuserrequesttitle_id) > `optional` **title\_id?**: `string` | `null` #### DepartmentResponse [Section titled “DepartmentResponse”](#departmentresponse) > **DepartmentResponse**: `object` ##### DepartmentResponse.description? [Section titled “DepartmentResponse.description?”](#departmentresponsedescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-65) Description of the department ##### DepartmentResponse.id [Section titled “DepartmentResponse.id”](#departmentresponseid) > **id**: `string` ##### DepartmentResponse.name [Section titled “DepartmentResponse.name”](#departmentresponsename) > **name**: `string` ###### Description [Section titled “Description”](#description-66) Name of the department #### LegalEntity [Section titled “LegalEntity”](#legalentity) > **LegalEntity**: `object` Legal Entity ##### Description [Section titled “Description”](#description-67) A Brex legal entity. ##### LegalEntity.billingAddress [Section titled “LegalEntity.billingAddress”](#legalentitybillingaddress) > **billingAddress**: `object` ##### LegalEntity.billingAddress.city? [Section titled “LegalEntity.billingAddress.city?”](#legalentitybillingaddresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-68) City, district, suburb, town, or village. ##### LegalEntity.billingAddress.country? [Section titled “LegalEntity.billingAddress.country?”](#legalentitybillingaddresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-69) Two-letter country code (ISO 3166-1 alpha-2). ##### LegalEntity.billingAddress.line1? [Section titled “LegalEntity.billingAddress.line1?”](#legalentitybillingaddressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-70) Address line 1, no PO Box. ##### LegalEntity.billingAddress.line2? [Section titled “LegalEntity.billingAddress.line2?”](#legalentitybillingaddressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-71) Address line 2 (e.g., apartment, suite, unit, or building). ##### LegalEntity.billingAddress.phone\_number? [Section titled “LegalEntity.billingAddress.phone\_number?”](#legalentitybillingaddressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-72) Phone number. ##### LegalEntity.billingAddress.postal\_code? [Section titled “LegalEntity.billingAddress.postal\_code?”](#legalentitybillingaddresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-73) ZIP or postal code. ##### LegalEntity.billingAddress.state? [Section titled “LegalEntity.billingAddress.state?”](#legalentitybillingaddressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-74) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### LegalEntity.createdAt [Section titled “LegalEntity.createdAt”](#legalentitycreatedat) > **createdAt**: `string` Format: date-time ###### Description [Section titled “Description”](#description-75) Timestamp, in UTC, when this legal entity was created. ##### LegalEntity.displayName [Section titled “LegalEntity.displayName”](#legalentitydisplayname) > **displayName**: `string` ###### Description [Section titled “Description”](#description-76) The display name of this legal entity. ##### LegalEntity.id [Section titled “LegalEntity.id”](#legalentityid) > **id**: `string` ###### Description [Section titled “Description”](#description-77) The ID of this legal entity. ##### LegalEntity.isDefault? [Section titled “LegalEntity.isDefault?”](#legalentityisdefault) > `optional` **isDefault?**: `boolean` ###### Description [Section titled “Description”](#description-78) Whether this is the default entity of the account. ##### LegalEntity.status [Section titled “LegalEntity.status”](#legalentitystatus) > **status**: `"UNSUBMITTED"` | `"UNVERIFIED"` | `"IN_PROGRESS"` | `"VERIFIED"` | `"REJECTED"` #### LegalEntityStatus [Section titled “LegalEntityStatus”](#legalentitystatus-1) > **LegalEntityStatus**: `"UNSUBMITTED"` | `"UNVERIFIED"` | `"IN_PROGRESS"` | `"VERIFIED"` | `"REJECTED"` ##### Description [Section titled “Description”](#description-79) The possible statuses for an entity’s verification in Brex. #### LimitType [Section titled “LimitType”](#limittype) > **LimitType**: `"CARD"` | `"USER"` ##### Description [Section titled “Description”](#description-80) `limit_type = CARD` for vendor cards. Vendor cards must have a `card_type` of `VIRTUAL` and do not rely on the user specific limit. ```plaintext For corporate cards, `limit_type = USER`. Learn more about different card types [here](https://support.brex.com/what-are-the-different-types-of-cards-i-can-get/). ``` #### LocationResponse [Section titled “LocationResponse”](#locationresponse) > **LocationResponse**: `object` ##### LocationResponse.description? [Section titled “LocationResponse.description?”](#locationresponsedescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-81) Description of the location ##### LocationResponse.id [Section titled “LocationResponse.id”](#locationresponseid) > **id**: `string` ##### LocationResponse.name [Section titled “LocationResponse.name”](#locationresponsename) > **name**: `string` ###### Description [Section titled “Description”](#description-82) Name of the location #### LockCardRequest [Section titled “LockCardRequest”](#lockcardrequest) > **LockCardRequest**: `object` ##### Description [Section titled “Description”](#description-83) Parameters for locking a card. ##### LockCardRequest.description? [Section titled “LockCardRequest.description?”](#lockcardrequestdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-84) Description for locking a card ##### LockCardRequest.reason [Section titled “LockCardRequest.reason”](#lockcardrequestreason) > **reason**: `"OTHER"` | `"CARD_DAMAGED"` | `"CARD_LOST"` | `"CARD_NOT_RECEIVED"` | `"DO_NOT_NEED_PHYSICAL_CARD"` | `"DO_NOT_NEED_VIRTUAL_CARD"` | `"FRAUD"` #### LockedMerchantDetails [Section titled “LockedMerchantDetails”](#lockedmerchantdetails) > **LockedMerchantDetails**: `object` ##### Description [Section titled “Description”](#description-85) Merchant details used for restricting or blocking transactions. ##### LockedMerchantDetails.name [Section titled “LockedMerchantDetails.name”](#lockedmerchantdetailsname) > **name**: `string` ###### Description [Section titled “Description”](#description-86) The name of the merchant. ###### Example [Section titled “Example”](#example-10) ```ts Github ``` #### Money [Section titled “Money”](#money) > **Money**: `object` ##### Description [Section titled “Description”](#description-87) Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700. ##### Money.amount [Section titled “Money.amount”](#moneyamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-88) 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 [Section titled “Example”](#example-11) ```ts 700 ``` ##### Money.currency [Section titled “Money.currency”](#moneycurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-89) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-3) ```ts USD ``` ###### Example [Section titled “Example”](#example-12) ```ts USD ``` #### OwnerType [Section titled “OwnerType”](#ownertype) > **OwnerType**: `"USER"` #### Page\_Card\_ [Section titled “Page\_Card\_”](#page_card_) > **Page\_Card\_**: `object` ##### Page\_Card\_.items [Section titled “Page\_Card\_.items”](#page_card_items) > **items**: `object`\[] ##### Page\_Card\_.next\_cursor? [Section titled “Page\_Card\_.next\_cursor?”](#page_card_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_DepartmentResponse\_ [Section titled “Page\_DepartmentResponse\_”](#page_departmentresponse_) > **Page\_DepartmentResponse\_**: `object` ##### Page\_DepartmentResponse\_.items [Section titled “Page\_DepartmentResponse\_.items”](#page_departmentresponse_items) > **items**: `object`\[] ##### Page\_DepartmentResponse\_.next\_cursor? [Section titled “Page\_DepartmentResponse\_.next\_cursor?”](#page_departmentresponse_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_LegalEntity\_ [Section titled “Page\_LegalEntity\_”](#page_legalentity_) > **Page\_LegalEntity\_**: `object` ##### Page\_LegalEntity\_.items [Section titled “Page\_LegalEntity\_.items”](#page_legalentity_items) > **items**: `object`\[] ##### Page\_LegalEntity\_.next\_cursor? [Section titled “Page\_LegalEntity\_.next\_cursor?”](#page_legalentity_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_LocationResponse\_ [Section titled “Page\_LocationResponse\_”](#page_locationresponse_) > **Page\_LocationResponse\_**: `object` ##### Page\_LocationResponse\_.items [Section titled “Page\_LocationResponse\_.items”](#page_locationresponse_items) > **items**: `object`\[] ##### Page\_LocationResponse\_.next\_cursor? [Section titled “Page\_LocationResponse\_.next\_cursor?”](#page_locationresponse_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_TitleResponse\_ [Section titled “Page\_TitleResponse\_”](#page_titleresponse_) > **Page\_TitleResponse\_**: `object` ##### Page\_TitleResponse\_.items [Section titled “Page\_TitleResponse\_.items”](#page_titleresponse_items) > **items**: `object`\[] ##### Page\_TitleResponse\_.next\_cursor? [Section titled “Page\_TitleResponse\_.next\_cursor?”](#page_titleresponse_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_UserResponse\_ [Section titled “Page\_UserResponse\_”](#page_userresponse_) > **Page\_UserResponse\_**: `object` ##### Page\_UserResponse\_.items [Section titled “Page\_UserResponse\_.items”](#page_userresponse_items) > **items**: `object`\[] ##### Page\_UserResponse\_.next\_cursor? [Section titled “Page\_UserResponse\_.next\_cursor?”](#page_userresponse_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### SecureEmailForCardDetailsRequest [Section titled “SecureEmailForCardDetailsRequest”](#secureemailforcarddetailsrequest) > **SecureEmailForCardDetailsRequest**: `object` ##### SecureEmailForCardDetailsRequest.expiry\_days? [Section titled “SecureEmailForCardDetailsRequest.expiry\_days?”](#secureemailforcarddetailsrequestexpiry_days) > `optional` **expiry\_days?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-90) Link expiry in number of days. Defaults to 30 ##### SecureEmailForCardDetailsRequest.message? [Section titled “SecureEmailForCardDetailsRequest.message?”](#secureemailforcarddetailsrequestmessage) > `optional` **message?**: `string` | `null` ###### Description [Section titled “Description”](#description-91) Message to send with the card details ##### SecureEmailForCardDetailsRequest.recipient\_email [Section titled “SecureEmailForCardDetailsRequest.recipient\_email”](#secureemailforcarddetailsrequestrecipient_email) > **recipient\_email**: `string` ###### Description [Section titled “Description”](#description-92) Email address to send card details to ##### SecureEmailForCardDetailsRequest.sender\_name [Section titled “SecureEmailForCardDetailsRequest.sender\_name”](#secureemailforcarddetailsrequestsender_name) > **sender\_name**: `string` ###### Description [Section titled “Description”](#description-93) Sender name. Shows up in the subject of the email #### SetUserLimitRequest [Section titled “SetUserLimitRequest”](#setuserlimitrequest) > **SetUserLimitRequest**: `object` ##### Description [Section titled “Description”](#description-94) Request that sets the monthly user limit. ##### SetUserLimitRequest.monthly\_limit? [Section titled “SetUserLimitRequest.monthly\_limit?”](#setuserlimitrequestmonthly_limit) > `optional` **monthly\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-6) ###### Type Literal [Section titled “Type Literal”](#type-literal-6) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-2) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-95) 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 [Section titled “Example”](#example-13) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-2) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-96) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-4) ```ts USD ``` ###### Example [Section titled “Example”](#example-14) ```ts USD ``` *** `null` #### SpendControl [Section titled “SpendControl”](#spendcontrol) > **SpendControl**: `object` ##### SpendControl.allowed\_merchant\_details? [Section titled “SpendControl.allowed\_merchant\_details?”](#spendcontrolallowed_merchant_details) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-97) List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example [Section titled “Example”](#example-15) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ##### SpendControl.blocked\_merchant\_details? [Section titled “SpendControl.blocked\_merchant\_details?”](#spendcontrolblocked_merchant_details) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-98) List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example [Section titled “Example”](#example-16) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ##### SpendControl.lock\_after\_date? [Section titled “SpendControl.lock\_after\_date?”](#spendcontrollock_after_date) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-99) The `lock_after_date` is in UTC. ##### SpendControl.reason? [Section titled “SpendControl.reason?”](#spendcontrolreason) > `optional` **reason?**: `string` | `null` ##### SpendControl.spend\_available? [Section titled “SpendControl.spend\_available?”](#spendcontrolspend_available) > `optional` **spend\_available?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-7) ###### Type Literal [Section titled “Type Literal”](#type-literal-7) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-3) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-100) 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 [Section titled “Example”](#example-17) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-3) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-101) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-5) ```ts USD ``` ###### Example [Section titled “Example”](#example-18) ```ts USD ``` *** `null` ##### SpendControl.spend\_duration? [Section titled “SpendControl.spend\_duration?”](#spendcontrolspend_duration) > `optional` **spend\_duration?**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ##### SpendControl.spend\_limit? [Section titled “SpendControl.spend\_limit?”](#spendcontrolspend_limit) > `optional` **spend\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-8) ###### Type Literal [Section titled “Type Literal”](#type-literal-8) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-4) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-102) 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 [Section titled “Example”](#example-19) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-4) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-103) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-6) ```ts USD ``` ###### Example [Section titled “Example”](#example-20) ```ts USD ``` *** `null` #### SpendControlRequest [Section titled “SpendControlRequest”](#spendcontrolrequest) > **SpendControlRequest**: `object` ##### Description [Section titled “Description”](#description-104) When `limit_type = CARD`, `spend_controls` must be set. When `limit type = USER`, `spend_controls` must be `null`. ##### SpendControlRequest.allowed\_merchant\_details? [Section titled “SpendControlRequest.allowed\_merchant\_details?”](#spendcontrolrequestallowed_merchant_details) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-105) List of merchants where card transactions are allowed. Cannot be used together with blocked\_merchant\_details. Maximum 50 merchant details. ###### Example [Section titled “Example”](#example-21) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ##### SpendControlRequest.blocked\_merchant\_details? [Section titled “SpendControlRequest.blocked\_merchant\_details?”](#spendcontrolrequestblocked_merchant_details) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-106) List of merchants where card transactions are blocked. Cannot be used together with allowed\_merchant\_details. Maximum 50 merchant details. ###### Example [Section titled “Example”](#example-22) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ##### SpendControlRequest.lock\_after\_date? [Section titled “SpendControlRequest.lock\_after\_date?”](#spendcontrolrequestlock_after_date) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ##### SpendControlRequest.parent\_budget\_id? [Section titled “SpendControlRequest.parent\_budget\_id?”](#spendcontrolrequestparent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-107) If using the Empower platform, a new `budget` will be created for this card. You can specify a `parent_budget` that your new `budget` will be nested under. If `parent_budget_id` is null, we will nest the new budget under the top-level account `budget`. ##### SpendControlRequest.policy\_id? [Section titled “SpendControlRequest.policy\_id?”](#spendcontrolrequestpolicy_id) > `optional` **policy\_id?**: `string` | `null` ##### SpendControlRequest.reason? [Section titled “SpendControlRequest.reason?”](#spendcontrolrequestreason) > `optional` **reason?**: `string` | `null` ##### SpendControlRequest.spend\_duration [Section titled “SpendControlRequest.spend\_duration”](#spendcontrolrequestspend_duration) > **spend\_duration**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### SpendControlRequest.spend\_limit [Section titled “SpendControlRequest.spend\_limit”](#spendcontrolrequestspend_limit) > **spend\_limit**: `object` ##### SpendControlRequest.spend\_limit.amount [Section titled “SpendControlRequest.spend\_limit.amount”](#spendcontrolrequestspend_limitamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-108) 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 [Section titled “Example”](#example-23) ```ts 700 ``` ##### SpendControlRequest.spend\_limit.currency [Section titled “SpendControlRequest.spend\_limit.currency”](#spendcontrolrequestspend_limitcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-109) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-7) ```ts USD ``` ###### Example [Section titled “Example”](#example-24) ```ts USD ``` #### SpendControlUpdateRequest [Section titled “SpendControlUpdateRequest”](#spendcontrolupdaterequest) > **SpendControlUpdateRequest**: `object` ##### SpendControlUpdateRequest.allowed\_merchant\_details? [Section titled “SpendControlUpdateRequest.allowed\_merchant\_details?”](#spendcontrolupdaterequestallowed_merchant_details) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-110) List of merchants where card transactions are allowed. Cannot be used together with blocked\_merchant\_details. Maximum 50 merchant details. ###### Example [Section titled “Example”](#example-25) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ##### SpendControlUpdateRequest.blocked\_merchant\_details? [Section titled “SpendControlUpdateRequest.blocked\_merchant\_details?”](#spendcontrolupdaterequestblocked_merchant_details) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-111) List of merchants where card transactions are blocked. Cannot be used together with allowed\_merchant\_details. Maximum 50 merchant details. ###### Example [Section titled “Example”](#example-26) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ##### SpendControlUpdateRequest.lock\_after\_date? [Section titled “SpendControlUpdateRequest.lock\_after\_date?”](#spendcontrolupdaterequestlock_after_date) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ##### SpendControlUpdateRequest.reason? [Section titled “SpendControlUpdateRequest.reason?”](#spendcontrolupdaterequestreason) > `optional` **reason?**: `string` | `null` ##### SpendControlUpdateRequest.spend\_duration? [Section titled “SpendControlUpdateRequest.spend\_duration?”](#spendcontrolupdaterequestspend_duration) > `optional` **spend\_duration?**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ##### SpendControlUpdateRequest.spend\_limit? [Section titled “SpendControlUpdateRequest.spend\_limit?”](#spendcontrolupdaterequestspend_limit) > `optional` **spend\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-9) ###### Type Literal [Section titled “Type Literal”](#type-literal-9) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-5) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-112) 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 [Section titled “Example”](#example-27) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-5) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-113) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-8) ```ts USD ``` ###### Example [Section titled “Example”](#example-28) ```ts USD ``` *** `null` #### SpendDuration [Section titled “SpendDuration”](#spendduration) > **SpendDuration**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ##### Description [Section titled “Description”](#description-114) Spend limit refresh frequency - MONTHLY: The spend limit refreshes every month - QUARTERLY: The spend limit refreshes every quarter - YEARLY: The spend limit refreshes every year - ONE\_TIME: The limit does not refresh #### TerminateCardRequest [Section titled “TerminateCardRequest”](#terminatecardrequest) > **TerminateCardRequest**: `object` ##### Description [Section titled “Description”](#description-115) Parameters for terminating a card. ##### TerminateCardRequest.description? [Section titled “TerminateCardRequest.description?”](#terminatecardrequestdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-116) Description for terminating a card ##### TerminateCardRequest.reason [Section titled “TerminateCardRequest.reason”](#terminatecardrequestreason) > **reason**: `"OTHER"` | `"CARD_DAMAGED"` | `"CARD_LOST"` | `"CARD_NOT_RECEIVED"` | `"DO_NOT_NEED_PHYSICAL_CARD"` | `"DO_NOT_NEED_VIRTUAL_CARD"` | `"FRAUD"` #### ThreeDomainSecureEnabledPreference [Section titled “ThreeDomainSecureEnabledPreference”](#threedomainsecureenabledpreference) > **ThreeDomainSecureEnabledPreference**: `"THREE_DOMAIN_SECURE_ENABLED"` | `"THREE_DOMAIN_SECURE_DISABLED"` ##### Description [Section titled “Description”](#description-117) Whether to enable 3-D secure protocol on this card. #### TitleResponse [Section titled “TitleResponse”](#titleresponse) > **TitleResponse**: `object` ##### TitleResponse.id [Section titled “TitleResponse.id”](#titleresponseid) > **id**: `string` ##### TitleResponse.name [Section titled “TitleResponse.name”](#titleresponsename) > **name**: `string` ###### Description [Section titled “Description”](#description-118) Name of the title #### UpdateCardRequest [Section titled “UpdateCardRequest”](#updatecardrequest) > **UpdateCardRequest**: `object` ##### UpdateCardRequest.metadata? [Section titled “UpdateCardRequest.metadata?”](#updatecardrequestmetadata) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-119) Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ##### UpdateCardRequest.spend\_controls? [Section titled “UpdateCardRequest.spend\_controls?”](#updatecardrequestspend_controls) > `optional` **spend\_controls?**: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-10) ###### Type Literal [Section titled “Type Literal”](#type-literal-10) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } ###### allowed\_merchant\_details? [Section titled “allowed\_merchant\_details?”](#allowed_merchant_details-2) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-120) List of merchants where card transactions are allowed. Cannot be used together with blocked\_merchant\_details. Maximum 50 merchant details. ###### Example [Section titled “Example”](#example-29) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? [Section titled “blocked\_merchant\_details?”](#blocked_merchant_details-2) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-121) List of merchants where card transactions are blocked. Cannot be used together with allowed\_merchant\_details. Maximum 50 merchant details. ###### Example [Section titled “Example”](#example-30) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? [Section titled “lock\_after\_date?”](#lock_after_date-2) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ###### reason? [Section titled “reason?”](#reason-2) > `optional` **reason?**: `string` | `null` ###### spend\_duration? [Section titled “spend\_duration?”](#spend_duration-2) > `optional` **spend\_duration?**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ###### spend\_limit? [Section titled “spend\_limit?”](#spend_limit-2) > `optional` **spend\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-11) ###### Type Literal [Section titled “Type Literal”](#type-literal-11) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-6) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-122) 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 [Section titled “Example”](#example-31) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-6) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-123) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-9) ```ts USD ``` ###### Example [Section titled “Example”](#example-32) ```ts USD ``` *** `null` *** `null` #### UpdateUserRequest [Section titled “UpdateUserRequest”](#updateuserrequest) > **UpdateUserRequest**: `object` ##### UpdateUserRequest.department\_id? [Section titled “UpdateUserRequest.department\_id?”](#updateuserrequestdepartment_id) > `optional` **department\_id?**: `string` | `null` ##### UpdateUserRequest.location\_id? [Section titled “UpdateUserRequest.location\_id?”](#updateuserrequestlocation_id) > `optional` **location\_id?**: `string` | `null` ##### UpdateUserRequest.manager\_id? [Section titled “UpdateUserRequest.manager\_id?”](#updateuserrequestmanager_id) > `optional` **manager\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-124) The user id of the manager of this user ##### UpdateUserRequest.metadata? [Section titled “UpdateUserRequest.metadata?”](#updateuserrequestmetadata) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-125) The metadata or customized attributes of the user. Maximum number of entries: 100 ##### UpdateUserRequest.status? [Section titled “UpdateUserRequest.status?”](#updateuserrequeststatus) > `optional` **status?**: `"ACTIVE"` | `"DISABLED"` | `null` ##### UpdateUserRequest.title\_id? [Section titled “UpdateUserRequest.title\_id?”](#updateuserrequesttitle_id) > `optional` **title\_id?**: `string` | `null` #### UpdateUserStatus [Section titled “UpdateUserStatus”](#updateuserstatus) > **UpdateUserStatus**: `"ACTIVE"` | `"DISABLED"` ##### Description [Section titled “Description”](#description-126) Acceptable user status for update. To suspend a user, set status to ‘disabled’. To unsuspend a user, set status to ‘active’. #### UserLimitResponse [Section titled “UserLimitResponse”](#userlimitresponse) > **UserLimitResponse**: `object` ##### UserLimitResponse.monthly\_available? [Section titled “UserLimitResponse.monthly\_available?”](#userlimitresponsemonthly_available) > `optional` **monthly\_available?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-12) ###### Type Literal [Section titled “Type Literal”](#type-literal-12) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-7) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-127) 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 [Section titled “Example”](#example-33) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-7) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-128) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-10) ```ts USD ``` ###### Example [Section titled “Example”](#example-34) ```ts USD ``` *** `null` ##### UserLimitResponse.monthly\_limit? [Section titled “UserLimitResponse.monthly\_limit?”](#userlimitresponsemonthly_limit) > `optional` **monthly\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-13) ###### Type Literal [Section titled “Type Literal”](#type-literal-13) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-8) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-129) 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 [Section titled “Example”](#example-35) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-8) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-130) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-11) ```ts USD ``` ###### Example [Section titled “Example”](#example-36) ```ts USD ``` *** `null` #### UserOwner [Section titled “UserOwner”](#userowner) > **UserOwner**: `object` & `object` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-6) ###### type [Section titled “type”](#type-6) > **type**: `"USER"` ###### user\_id [Section titled “user\_id”](#user_id-3) > **user\_id**: `string` ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-7) ###### type [Section titled “type”](#type-7) > **type**: `"USER"` ###### Description [Section titled “Description”](#description-131) discriminator enum property added by openapi-typescript #### UserResponse [Section titled “UserResponse”](#userresponse) > **UserResponse**: `object` ##### UserResponse.department\_id? [Section titled “UserResponse.department\_id?”](#userresponsedepartment_id) > `optional` **department\_id?**: `string` | `null` ##### UserResponse.email [Section titled “UserResponse.email”](#userresponseemail) > **email**: `string` ###### Description [Section titled “Description”](#description-132) Email address of the user ##### UserResponse.first\_name [Section titled “UserResponse.first\_name”](#userresponsefirst_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-133) First name of the user ##### UserResponse.id [Section titled “UserResponse.id”](#userresponseid) > **id**: `string` ##### UserResponse.last\_name [Section titled “UserResponse.last\_name”](#userresponselast_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-134) Last name of the user ##### UserResponse.location\_id? [Section titled “UserResponse.location\_id?”](#userresponselocation_id) > `optional` **location\_id?**: `string` | `null` ##### UserResponse.manager\_id? [Section titled “UserResponse.manager\_id?”](#userresponsemanager_id) > `optional` **manager\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-135) The user id of the manager of this user ##### UserResponse.metadata? [Section titled “UserResponse.metadata?”](#userresponsemetadata) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-136) The metadata or customized attributes of the user. Maximum number of entries: 100 ##### UserResponse.remote\_display\_id? [Section titled “UserResponse.remote\_display\_id?”](#userresponseremote_display_id) > `optional` **remote\_display\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-137) Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz ##### UserResponse.status? [Section titled “UserResponse.status?”](#userresponsestatus) > `optional` **status?**: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null` ##### UserResponse.title\_id? [Section titled “UserResponse.title\_id?”](#userresponsetitle_id) > `optional` **title\_id?**: `string` | `null` #### UserStatus [Section titled “UserStatus”](#userstatus) > **UserStatus**: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` ##### Description [Section titled “Description”](#description-138) Status of the user # TeamPaths Defined in: [src/team/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L2) ## Properties [Section titled “Properties”](#properties) ### /v2/cards [Section titled “/v2/cards”](#v2cards) > **/v2/cards**: `object` Defined in: [src/team/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L3) #### delete? [Section titled “delete?”](#delete) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get) > **get**: `object` List cards ##### Description [Section titled “Description”](#description) Lists all cards by a `user_id`. Only cards with `limit_type = CARD` have `spend_controls` ##### get.parameters [Section titled “get.parameters”](#getparameters) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit) > `optional` **limit?**: `number` | `null` ##### get.parameters.query.user\_id? [Section titled “get.parameters.query.user\_id?”](#getparametersqueryuser_id) > `optional` **user\_id?**: `string` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-1) listCardsByUserId 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post) > **post**: `object` Create card ##### Description [Section titled “Description”](#description-2) Creates a new card. The `spend_controls` field is required when `limit_type` = `CARD`. The `mailing_address` field is required for physical cards and is the shipping address used to send the card; it is not the same as the billing and mailing address used for online purchases. The first 2 lines of this address must be under 60 characters long. Each user can only have up to 10 active physical cards. For Empower accounts, this endpoint requires budget management. If your account does not have access to budget management features, a 403 response status will be returned. If this is the case and you want to gain access to this endpoint, please contact Brex support. ##### post.parameters [Section titled “post.parameters”](#postparameters) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie) > `optional` **cookie?**: `undefined` ##### post.parameters.header [Section titled “post.parameters.header”](#postparametersheader) > **header**: `object` ##### post.parameters.header.Idempotency-Key [Section titled “post.parameters.header.Idempotency-Key”](#postparametersheaderidempotency-key) > **Idempotency-Key**: `string` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson) > **application/json**: `object` ##### post.requestBody.content.application/json.card\_attribute\_preferences? [Section titled “post.requestBody.content.application/json.card\_attribute\_preferences?”](#postrequestbodycontentapplicationjsoncard_attribute_preferences) > `optional` **card\_attribute\_preferences?**: { `three_domain_secure_enabled_preference?`: `"THREE_DOMAIN_SECURE_ENABLED"` | `"THREE_DOMAIN_SECURE_DISABLED"` | `null`; } | `null` ##### post.requestBody.content.application/json.card\_name [Section titled “post.requestBody.content.application/json.card\_name”](#postrequestbodycontentapplicationjsoncard_name) > **card\_name**: `string` ##### post.requestBody.content.application/json.card\_type [Section titled “post.requestBody.content.application/json.card\_type”](#postrequestbodycontentapplicationjsoncard_type) > **card\_type**: `"VIRTUAL"` | `"PHYSICAL"` ##### post.requestBody.content.application/json.limit\_type [Section titled “post.requestBody.content.application/json.limit\_type”](#postrequestbodycontentapplicationjsonlimit_type) > **limit\_type**: `"CARD"` | `"USER"` ##### post.requestBody.content.application/json.mailing\_address? [Section titled “post.requestBody.content.application/json.mailing\_address?”](#postrequestbodycontentapplicationjsonmailing_address) > `optional` **mailing\_address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-3) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-4) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-5) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-6) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-7) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-8) ZIP or postal code. ###### state? [Section titled “state?”](#state) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-9) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### post.requestBody.content.application/json.metadata? [Section titled “post.requestBody.content.application/json.metadata?”](#postrequestbodycontentapplicationjsonmetadata) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-10) Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ##### post.requestBody.content.application/json.owner [Section titled “post.requestBody.content.application/json.owner”](#postrequestbodycontentapplicationjsonowner) > **owner**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration) ###### type [Section titled “type”](#type) > **type**: `"USER"` ###### user\_id [Section titled “user\_id”](#user_id) > **user\_id**: `string` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-1) ###### type [Section titled “type”](#type-1) > **type**: `"USER"` ###### Description [Section titled “Description”](#description-11) discriminator enum property added by openapi-typescript ##### post.requestBody.content.application/json.spend\_controls? [Section titled “post.requestBody.content.application/json.spend\_controls?”](#postrequestbodycontentapplicationjsonspend_controls) > `optional` **spend\_controls?**: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `parent_budget_id?`: `string` | `null`; `policy_id?`: `string` | `null`; `reason?`: `string` | `null`; `spend_duration`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `parent_budget_id?`: `string` | `null`; `policy_id?`: `string` | `null`; `reason?`: `string` | `null`; `spend_duration`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"`; `spend_limit`: { `amount`: `number`; `currency`: `string` | `null`; }; } ###### allowed\_merchant\_details? [Section titled “allowed\_merchant\_details?”](#allowed_merchant_details) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-12) List of merchants where card transactions are allowed. Cannot be used together with blocked\_merchant\_details. Maximum 50 merchant details. ###### Example [Section titled “Example”](#example) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? [Section titled “blocked\_merchant\_details?”](#blocked_merchant_details) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-13) List of merchants where card transactions are blocked. Cannot be used together with allowed\_merchant\_details. Maximum 50 merchant details. ###### Example [Section titled “Example”](#example-1) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? [Section titled “lock\_after\_date?”](#lock_after_date) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ###### parent\_budget\_id? [Section titled “parent\_budget\_id?”](#parent_budget_id) > `optional` **parent\_budget\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-14) If using the Empower platform, a new `budget` will be created for this card. You can specify a `parent_budget` that your new `budget` will be nested under. If `parent_budget_id` is null, we will nest the new budget under the top-level account `budget`. ###### policy\_id? [Section titled “policy\_id?”](#policy_id) > `optional` **policy\_id?**: `string` | `null` ###### reason? [Section titled “reason?”](#reason) > `optional` **reason?**: `string` | `null` ###### spend\_duration [Section titled “spend\_duration”](#spend_duration) > **spend\_duration**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` ###### spend\_limit [Section titled “spend\_limit”](#spend_limit) > **spend\_limit**: `object` ###### spend\_limit.amount [Section titled “spend\_limit.amount”](#spend_limitamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-15) 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 [Section titled “Example”](#example-2) ```ts 700 ``` ###### spend\_limit.currency [Section titled “spend\_limit.currency”](#spend_limitcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-16) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default) ```ts USD ``` ###### Example [Section titled “Example”](#example-3) ```ts USD ``` *** `null` ##### post.responses [Section titled “post.responses”](#postresponses) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-17) createCard 200 response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson) > **application/json**: `object` ##### post.responses.200.content.application/json.billing\_address [Section titled “post.responses.200.content.application/json.billing\_address”](#postresponses200contentapplicationjsonbilling_address) > **billing\_address**: `object` ##### post.responses.200.content.application/json.billing\_address.city? [Section titled “post.responses.200.content.application/json.billing\_address.city?”](#postresponses200contentapplicationjsonbilling_addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-18) City, district, suburb, town, or village. ##### post.responses.200.content.application/json.billing\_address.country? [Section titled “post.responses.200.content.application/json.billing\_address.country?”](#postresponses200contentapplicationjsonbilling_addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-19) Two-letter country code (ISO 3166-1 alpha-2). ##### post.responses.200.content.application/json.billing\_address.line1? [Section titled “post.responses.200.content.application/json.billing\_address.line1?”](#postresponses200contentapplicationjsonbilling_addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-20) Address line 1, no PO Box. ##### post.responses.200.content.application/json.billing\_address.line2? [Section titled “post.responses.200.content.application/json.billing\_address.line2?”](#postresponses200contentapplicationjsonbilling_addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-21) Address line 2 (e.g., apartment, suite, unit, or building). ##### post.responses.200.content.application/json.billing\_address.phone\_number? [Section titled “post.responses.200.content.application/json.billing\_address.phone\_number?”](#postresponses200contentapplicationjsonbilling_addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-22) Phone number. ##### post.responses.200.content.application/json.billing\_address.postal\_code? [Section titled “post.responses.200.content.application/json.billing\_address.postal\_code?”](#postresponses200contentapplicationjsonbilling_addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-23) ZIP or postal code. ##### post.responses.200.content.application/json.billing\_address.state? [Section titled “post.responses.200.content.application/json.billing\_address.state?”](#postresponses200contentapplicationjsonbilling_addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-24) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### post.responses.200.content.application/json.budget\_id? [Section titled “post.responses.200.content.application/json.budget\_id?”](#postresponses200contentapplicationjsonbudget_id) > `optional` **budget\_id?**: `string` | `null` ##### post.responses.200.content.application/json.card\_name [Section titled “post.responses.200.content.application/json.card\_name”](#postresponses200contentapplicationjsoncard_name) > **card\_name**: `string` ##### post.responses.200.content.application/json.card\_type? [Section titled “post.responses.200.content.application/json.card\_type?”](#postresponses200contentapplicationjsoncard_type) > `optional` **card\_type?**: `"VIRTUAL"` | `"PHYSICAL"` | `null` ##### post.responses.200.content.application/json.expiration\_date [Section titled “post.responses.200.content.application/json.expiration\_date”](#postresponses200contentapplicationjsonexpiration_date) > **expiration\_date**: `object` ##### post.responses.200.content.application/json.expiration\_date.month [Section titled “post.responses.200.content.application/json.expiration\_date.month”](#postresponses200contentapplicationjsonexpiration_datemonth) > **month**: `number` Format: int32 ##### post.responses.200.content.application/json.expiration\_date.year [Section titled “post.responses.200.content.application/json.expiration\_date.year”](#postresponses200contentapplicationjsonexpiration_dateyear) > **year**: `number` Format: int32 ##### post.responses.200.content.application/json.has\_been\_transferred? [Section titled “post.responses.200.content.application/json.has\_been\_transferred?”](#postresponses200contentapplicationjsonhas_been_transferred) > `optional` **has\_been\_transferred?**: `boolean` ###### Description [Section titled “Description”](#description-25) Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions\ at online vendors where this card was previously used before the transfer. ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid) > **id**: `string` ##### post.responses.200.content.application/json.last\_four [Section titled “post.responses.200.content.application/json.last\_four”](#postresponses200contentapplicationjsonlast_four) > **last\_four**: `string` ##### post.responses.200.content.application/json.limit\_type [Section titled “post.responses.200.content.application/json.limit\_type”](#postresponses200contentapplicationjsonlimit_type) > **limit\_type**: `"CARD"` | `"USER"` ##### post.responses.200.content.application/json.mailing\_address? [Section titled “post.responses.200.content.application/json.mailing\_address?”](#postresponses200contentapplicationjsonmailing_address) > `optional` **mailing\_address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city-1) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-26) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country-1) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-27) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1-1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-28) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2-1) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-29) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number-1) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-30) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code-1) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-31) ZIP or postal code. ###### state? [Section titled “state?”](#state-1) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-32) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### post.responses.200.content.application/json.metadata? [Section titled “post.responses.200.content.application/json.metadata?”](#postresponses200contentapplicationjsonmetadata) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-33) Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ##### post.responses.200.content.application/json.owner [Section titled “post.responses.200.content.application/json.owner”](#postresponses200contentapplicationjsonowner) > **owner**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-2) ###### type [Section titled “type”](#type-2) > **type**: `"USER"` ###### user\_id [Section titled “user\_id”](#user_id-1) > **user\_id**: `string` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-3) ###### type [Section titled “type”](#type-3) > **type**: `"USER"` ###### Description [Section titled “Description”](#description-34) discriminator enum property added by openapi-typescript ##### post.responses.200.content.application/json.spend\_controls? [Section titled “post.responses.200.content.application/json.spend\_controls?”](#postresponses200contentapplicationjsonspend_controls) > `optional` **spend\_controls?**: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: … | …; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: … | …; } | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-3) ###### Type Literal [Section titled “Type Literal”](#type-literal-3) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: … | …; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: … | …; } | `null`; } ###### allowed\_merchant\_details? [Section titled “allowed\_merchant\_details?”](#allowed_merchant_details-1) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-35) List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example [Section titled “Example”](#example-4) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? [Section titled “blocked\_merchant\_details?”](#blocked_merchant_details-1) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-36) List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example [Section titled “Example”](#example-5) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? [Section titled “lock\_after\_date?”](#lock_after_date-1) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-37) The `lock_after_date` is in UTC. ###### reason? [Section titled “reason?”](#reason-1) > `optional` **reason?**: `string` | `null` ###### spend\_available? [Section titled “spend\_available?”](#spend_available) > `optional` **spend\_available?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-4) ###### Type Literal [Section titled “Type Literal”](#type-literal-4) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-38) 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 [Section titled “Example”](#example-6) ```ts 700 ``` ###### currency [Section titled “currency”](#currency) > **currency**: … | … ###### Description [Section titled “Description”](#description-39) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-1) ```ts USD ``` ###### Example [Section titled “Example”](#example-7) ```ts USD ``` *** `null` ###### spend\_duration? [Section titled “spend\_duration?”](#spend_duration-1) > `optional` **spend\_duration?**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ###### spend\_limit? [Section titled “spend\_limit?”](#spend_limit-1) > `optional` **spend\_limit?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-5) ###### Type Literal [Section titled “Type Literal”](#type-literal-5) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-40) 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 [Section titled “Example”](#example-8) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-1) > **currency**: … | … ###### Description [Section titled “Description”](#description-41) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-2) ```ts USD ``` ###### Example [Section titled “Example”](#example-9) ```ts USD ``` *** `null` *** `null` ##### post.responses.200.content.application/json.status? [Section titled “post.responses.200.content.application/json.status?”](#postresponses200contentapplicationjsonstatus) > `optional` **status?**: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-1) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace) > `optional` **trace?**: `undefined` *** ### /v2/cards/{id} [Section titled “/v2/cards/{id}”](#v2cardsid) > **/v2/cards/{id}**: `object` Defined in: [src/team/types.gen.ts:33](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L33) #### delete? [Section titled “delete?”](#delete-1) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-1) > **get**: `object` Get card ##### Description [Section titled “Description”](#description-42) Retrieves a card by ID. Only cards with `limit_type = CARD` have `spend_controls` ##### get.parameters [Section titled “get.parameters”](#getparameters-1) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-1) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-1) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-1) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-1) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-1) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-1) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-43) getCardById 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-1) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-1) > **application/json**: `object` ##### get.responses.200.content.application/json.billing\_address [Section titled “get.responses.200.content.application/json.billing\_address”](#getresponses200contentapplicationjsonbilling_address) > **billing\_address**: `object` ##### get.responses.200.content.application/json.billing\_address.city? [Section titled “get.responses.200.content.application/json.billing\_address.city?”](#getresponses200contentapplicationjsonbilling_addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-44) City, district, suburb, town, or village. ##### get.responses.200.content.application/json.billing\_address.country? [Section titled “get.responses.200.content.application/json.billing\_address.country?”](#getresponses200contentapplicationjsonbilling_addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-45) Two-letter country code (ISO 3166-1 alpha-2). ##### get.responses.200.content.application/json.billing\_address.line1? [Section titled “get.responses.200.content.application/json.billing\_address.line1?”](#getresponses200contentapplicationjsonbilling_addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-46) Address line 1, no PO Box. ##### get.responses.200.content.application/json.billing\_address.line2? [Section titled “get.responses.200.content.application/json.billing\_address.line2?”](#getresponses200contentapplicationjsonbilling_addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-47) Address line 2 (e.g., apartment, suite, unit, or building). ##### get.responses.200.content.application/json.billing\_address.phone\_number? [Section titled “get.responses.200.content.application/json.billing\_address.phone\_number?”](#getresponses200contentapplicationjsonbilling_addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-48) Phone number. ##### get.responses.200.content.application/json.billing\_address.postal\_code? [Section titled “get.responses.200.content.application/json.billing\_address.postal\_code?”](#getresponses200contentapplicationjsonbilling_addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-49) ZIP or postal code. ##### get.responses.200.content.application/json.billing\_address.state? [Section titled “get.responses.200.content.application/json.billing\_address.state?”](#getresponses200contentapplicationjsonbilling_addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-50) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### get.responses.200.content.application/json.budget\_id? [Section titled “get.responses.200.content.application/json.budget\_id?”](#getresponses200contentapplicationjsonbudget_id) > `optional` **budget\_id?**: `string` | `null` ##### get.responses.200.content.application/json.card\_name [Section titled “get.responses.200.content.application/json.card\_name”](#getresponses200contentapplicationjsoncard_name) > **card\_name**: `string` ##### get.responses.200.content.application/json.card\_type? [Section titled “get.responses.200.content.application/json.card\_type?”](#getresponses200contentapplicationjsoncard_type) > `optional` **card\_type?**: `"VIRTUAL"` | `"PHYSICAL"` | `null` ##### get.responses.200.content.application/json.expiration\_date [Section titled “get.responses.200.content.application/json.expiration\_date”](#getresponses200contentapplicationjsonexpiration_date) > **expiration\_date**: `object` ##### get.responses.200.content.application/json.expiration\_date.month [Section titled “get.responses.200.content.application/json.expiration\_date.month”](#getresponses200contentapplicationjsonexpiration_datemonth) > **month**: `number` Format: int32 ##### get.responses.200.content.application/json.expiration\_date.year [Section titled “get.responses.200.content.application/json.expiration\_date.year”](#getresponses200contentapplicationjsonexpiration_dateyear) > **year**: `number` Format: int32 ##### get.responses.200.content.application/json.has\_been\_transferred? [Section titled “get.responses.200.content.application/json.has\_been\_transferred?”](#getresponses200contentapplicationjsonhas_been_transferred) > `optional` **has\_been\_transferred?**: `boolean` ###### Description [Section titled “Description”](#description-51) Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions\ at online vendors where this card was previously used before the transfer. ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid) > **id**: `string` ##### get.responses.200.content.application/json.last\_four [Section titled “get.responses.200.content.application/json.last\_four”](#getresponses200contentapplicationjsonlast_four) > **last\_four**: `string` ##### get.responses.200.content.application/json.limit\_type [Section titled “get.responses.200.content.application/json.limit\_type”](#getresponses200contentapplicationjsonlimit_type) > **limit\_type**: `"CARD"` | `"USER"` ##### get.responses.200.content.application/json.mailing\_address? [Section titled “get.responses.200.content.application/json.mailing\_address?”](#getresponses200contentapplicationjsonmailing_address) > `optional` **mailing\_address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-6) ###### Type Literal [Section titled “Type Literal”](#type-literal-6) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city-2) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-52) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country-2) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-53) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1-2) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-54) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2-2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-55) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number-2) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-56) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code-2) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-57) ZIP or postal code. ###### state? [Section titled “state?”](#state-2) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-58) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### get.responses.200.content.application/json.metadata? [Section titled “get.responses.200.content.application/json.metadata?”](#getresponses200contentapplicationjsonmetadata) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-59) Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ##### get.responses.200.content.application/json.owner [Section titled “get.responses.200.content.application/json.owner”](#getresponses200contentapplicationjsonowner) > **owner**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-4) ###### type [Section titled “type”](#type-4) > **type**: `"USER"` ###### user\_id [Section titled “user\_id”](#user_id-2) > **user\_id**: `string` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-5) ###### type [Section titled “type”](#type-5) > **type**: `"USER"` ###### Description [Section titled “Description”](#description-60) discriminator enum property added by openapi-typescript ##### get.responses.200.content.application/json.spend\_controls? [Section titled “get.responses.200.content.application/json.spend\_controls?”](#getresponses200contentapplicationjsonspend_controls) > `optional` **spend\_controls?**: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: … | …; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: … | …; } | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-7) ###### Type Literal [Section titled “Type Literal”](#type-literal-7) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: … | …; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: … | …; } | `null`; } ###### allowed\_merchant\_details? [Section titled “allowed\_merchant\_details?”](#allowed_merchant_details-2) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-61) List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example [Section titled “Example”](#example-10) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? [Section titled “blocked\_merchant\_details?”](#blocked_merchant_details-2) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-62) List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example [Section titled “Example”](#example-11) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? [Section titled “lock\_after\_date?”](#lock_after_date-2) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-63) The `lock_after_date` is in UTC. ###### reason? [Section titled “reason?”](#reason-2) > `optional` **reason?**: `string` | `null` ###### spend\_available? [Section titled “spend\_available?”](#spend_available-1) > `optional` **spend\_available?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-8) ###### Type Literal [Section titled “Type Literal”](#type-literal-8) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-2) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-64) 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 [Section titled “Example”](#example-12) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-2) > **currency**: … | … ###### Description [Section titled “Description”](#description-65) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-3) ```ts USD ``` ###### Example [Section titled “Example”](#example-13) ```ts USD ``` *** `null` ###### spend\_duration? [Section titled “spend\_duration?”](#spend_duration-2) > `optional` **spend\_duration?**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ###### spend\_limit? [Section titled “spend\_limit?”](#spend_limit-2) > `optional` **spend\_limit?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-9) ###### Type Literal [Section titled “Type Literal”](#type-literal-9) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-3) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-66) 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 [Section titled “Example”](#example-14) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-3) > **currency**: … | … ###### Description [Section titled “Description”](#description-67) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-4) ```ts USD ``` ###### Example [Section titled “Example”](#example-15) ```ts USD ``` *** `null` *** `null` ##### get.responses.200.content.application/json.status? [Section titled “get.responses.200.content.application/json.status?”](#getresponses200contentapplicationjsonstatus) > `optional` **status?**: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-2) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-1) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-1) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-1) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-1) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-1) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-1) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-1) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-1) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-1) > `optional` **post?**: `undefined` #### put [Section titled “put”](#put-1) > **put**: `object` Update card ##### Description [Section titled “Description”](#description-68) Update an existing vendor card ##### put.parameters [Section titled “put.parameters”](#putparameters) > **parameters**: `object` ##### put.parameters.cookie? [Section titled “put.parameters.cookie?”](#putparameterscookie) > `optional` **cookie?**: `undefined` ##### put.parameters.header? [Section titled “put.parameters.header?”](#putparametersheader) > `optional` **header?**: `object` ##### put.parameters.header.Idempotency-Key? [Section titled “put.parameters.header.Idempotency-Key?”](#putparametersheaderidempotency-key) > `optional` **Idempotency-Key?**: `string` | `null` ##### put.parameters.path [Section titled “put.parameters.path”](#putparameterspath) > **path**: `object` ##### put.parameters.path.id [Section titled “put.parameters.path.id”](#putparameterspathid) > **id**: `string` ##### put.parameters.query? [Section titled “put.parameters.query?”](#putparametersquery) > `optional` **query?**: `undefined` ##### put.requestBody [Section titled “put.requestBody”](#putrequestbody) > **requestBody**: `object` ##### put.requestBody.content [Section titled “put.requestBody.content”](#putrequestbodycontent) > **content**: `object` ##### put.requestBody.content.application/json [Section titled “put.requestBody.content.application/json”](#putrequestbodycontentapplicationjson) > **application/json**: `object` ##### put.requestBody.content.application/json.metadata? [Section titled “put.requestBody.content.application/json.metadata?”](#putrequestbodycontentapplicationjsonmetadata) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-69) Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ##### put.requestBody.content.application/json.spend\_controls? [Section titled “put.requestBody.content.application/json.spend\_controls?”](#putrequestbodycontentapplicationjsonspend_controls) > `optional` **spend\_controls?**: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-10) ###### Type Literal [Section titled “Type Literal”](#type-literal-10) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: `string` | `null`; } | `null`; } ###### allowed\_merchant\_details? [Section titled “allowed\_merchant\_details?”](#allowed_merchant_details-3) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-70) List of merchants where card transactions are allowed. Cannot be used together with blocked\_merchant\_details. Maximum 50 merchant details. ###### Example [Section titled “Example”](#example-16) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? [Section titled “blocked\_merchant\_details?”](#blocked_merchant_details-3) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-71) List of merchants where card transactions are blocked. Cannot be used together with allowed\_merchant\_details. Maximum 50 merchant details. ###### Example [Section titled “Example”](#example-17) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? [Section titled “lock\_after\_date?”](#lock_after_date-3) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ###### reason? [Section titled “reason?”](#reason-3) > `optional` **reason?**: `string` | `null` ###### spend\_duration? [Section titled “spend\_duration?”](#spend_duration-3) > `optional` **spend\_duration?**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ###### spend\_limit? [Section titled “spend\_limit?”](#spend_limit-3) > `optional` **spend\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-11) ###### Type Literal [Section titled “Type Literal”](#type-literal-11) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-4) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-72) 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 [Section titled “Example”](#example-18) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-4) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-73) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-5) ```ts USD ``` ###### Example [Section titled “Example”](#example-19) ```ts USD ``` *** `null` *** `null` ##### put.responses [Section titled “put.responses”](#putresponses) > **responses**: `object` ##### put.responses.200 [Section titled “put.responses.200”](#putresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-74) updateCard 200 response ##### put.responses.200.content [Section titled “put.responses.200.content”](#putresponses200content) > **content**: `object` ##### put.responses.200.content.application/json [Section titled “put.responses.200.content.application/json”](#putresponses200contentapplicationjson) > **application/json**: `object` ##### put.responses.200.content.application/json.billing\_address [Section titled “put.responses.200.content.application/json.billing\_address”](#putresponses200contentapplicationjsonbilling_address) > **billing\_address**: `object` ##### put.responses.200.content.application/json.billing\_address.city? [Section titled “put.responses.200.content.application/json.billing\_address.city?”](#putresponses200contentapplicationjsonbilling_addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-75) City, district, suburb, town, or village. ##### put.responses.200.content.application/json.billing\_address.country? [Section titled “put.responses.200.content.application/json.billing\_address.country?”](#putresponses200contentapplicationjsonbilling_addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-76) Two-letter country code (ISO 3166-1 alpha-2). ##### put.responses.200.content.application/json.billing\_address.line1? [Section titled “put.responses.200.content.application/json.billing\_address.line1?”](#putresponses200contentapplicationjsonbilling_addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-77) Address line 1, no PO Box. ##### put.responses.200.content.application/json.billing\_address.line2? [Section titled “put.responses.200.content.application/json.billing\_address.line2?”](#putresponses200contentapplicationjsonbilling_addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-78) Address line 2 (e.g., apartment, suite, unit, or building). ##### put.responses.200.content.application/json.billing\_address.phone\_number? [Section titled “put.responses.200.content.application/json.billing\_address.phone\_number?”](#putresponses200contentapplicationjsonbilling_addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-79) Phone number. ##### put.responses.200.content.application/json.billing\_address.postal\_code? [Section titled “put.responses.200.content.application/json.billing\_address.postal\_code?”](#putresponses200contentapplicationjsonbilling_addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-80) ZIP or postal code. ##### put.responses.200.content.application/json.billing\_address.state? [Section titled “put.responses.200.content.application/json.billing\_address.state?”](#putresponses200contentapplicationjsonbilling_addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-81) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### put.responses.200.content.application/json.budget\_id? [Section titled “put.responses.200.content.application/json.budget\_id?”](#putresponses200contentapplicationjsonbudget_id) > `optional` **budget\_id?**: `string` | `null` ##### put.responses.200.content.application/json.card\_name [Section titled “put.responses.200.content.application/json.card\_name”](#putresponses200contentapplicationjsoncard_name) > **card\_name**: `string` ##### put.responses.200.content.application/json.card\_type? [Section titled “put.responses.200.content.application/json.card\_type?”](#putresponses200contentapplicationjsoncard_type) > `optional` **card\_type?**: `"VIRTUAL"` | `"PHYSICAL"` | `null` ##### put.responses.200.content.application/json.expiration\_date [Section titled “put.responses.200.content.application/json.expiration\_date”](#putresponses200contentapplicationjsonexpiration_date) > **expiration\_date**: `object` ##### put.responses.200.content.application/json.expiration\_date.month [Section titled “put.responses.200.content.application/json.expiration\_date.month”](#putresponses200contentapplicationjsonexpiration_datemonth) > **month**: `number` Format: int32 ##### put.responses.200.content.application/json.expiration\_date.year [Section titled “put.responses.200.content.application/json.expiration\_date.year”](#putresponses200contentapplicationjsonexpiration_dateyear) > **year**: `number` Format: int32 ##### put.responses.200.content.application/json.has\_been\_transferred? [Section titled “put.responses.200.content.application/json.has\_been\_transferred?”](#putresponses200contentapplicationjsonhas_been_transferred) > `optional` **has\_been\_transferred?**: `boolean` ###### Description [Section titled “Description”](#description-82) Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions\ at online vendors where this card was previously used before the transfer. ##### put.responses.200.content.application/json.id [Section titled “put.responses.200.content.application/json.id”](#putresponses200contentapplicationjsonid) > **id**: `string` ##### put.responses.200.content.application/json.last\_four [Section titled “put.responses.200.content.application/json.last\_four”](#putresponses200contentapplicationjsonlast_four) > **last\_four**: `string` ##### put.responses.200.content.application/json.limit\_type [Section titled “put.responses.200.content.application/json.limit\_type”](#putresponses200contentapplicationjsonlimit_type) > **limit\_type**: `"CARD"` | `"USER"` ##### put.responses.200.content.application/json.mailing\_address? [Section titled “put.responses.200.content.application/json.mailing\_address?”](#putresponses200contentapplicationjsonmailing_address) > `optional` **mailing\_address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-12) ###### Type Literal [Section titled “Type Literal”](#type-literal-12) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city-3) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-83) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country-3) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-84) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1-3) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-85) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2-3) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-86) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number-3) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-87) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code-3) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-88) ZIP or postal code. ###### state? [Section titled “state?”](#state-3) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-89) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### put.responses.200.content.application/json.metadata? [Section titled “put.responses.200.content.application/json.metadata?”](#putresponses200contentapplicationjsonmetadata) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-90) Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ##### put.responses.200.content.application/json.owner [Section titled “put.responses.200.content.application/json.owner”](#putresponses200contentapplicationjsonowner) > **owner**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-6) ###### type [Section titled “type”](#type-6) > **type**: `"USER"` ###### user\_id [Section titled “user\_id”](#user_id-3) > **user\_id**: `string` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-7) ###### type [Section titled “type”](#type-7) > **type**: `"USER"` ###### Description [Section titled “Description”](#description-91) discriminator enum property added by openapi-typescript ##### put.responses.200.content.application/json.spend\_controls? [Section titled “put.responses.200.content.application/json.spend\_controls?”](#putresponses200contentapplicationjsonspend_controls) > `optional` **spend\_controls?**: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: … | …; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: … | …; } | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-13) ###### Type Literal [Section titled “Type Literal”](#type-literal-13) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: … | …; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: … | …; } | `null`; } ###### allowed\_merchant\_details? [Section titled “allowed\_merchant\_details?”](#allowed_merchant_details-4) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-92) List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example [Section titled “Example”](#example-20) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? [Section titled “blocked\_merchant\_details?”](#blocked_merchant_details-4) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-93) List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example [Section titled “Example”](#example-21) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? [Section titled “lock\_after\_date?”](#lock_after_date-4) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-94) The `lock_after_date` is in UTC. ###### reason? [Section titled “reason?”](#reason-4) > `optional` **reason?**: `string` | `null` ###### spend\_available? [Section titled “spend\_available?”](#spend_available-2) > `optional` **spend\_available?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-14) ###### Type Literal [Section titled “Type Literal”](#type-literal-14) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-5) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-95) 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 [Section titled “Example”](#example-22) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-5) > **currency**: … | … ###### Description [Section titled “Description”](#description-96) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-6) ```ts USD ``` ###### Example [Section titled “Example”](#example-23) ```ts USD ``` *** `null` ###### spend\_duration? [Section titled “spend\_duration?”](#spend_duration-4) > `optional` **spend\_duration?**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ###### spend\_limit? [Section titled “spend\_limit?”](#spend_limit-4) > `optional` **spend\_limit?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-15) ###### Type Literal [Section titled “Type Literal”](#type-literal-15) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-6) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-97) 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 [Section titled “Example”](#example-24) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-6) > **currency**: … | … ###### Description [Section titled “Description”](#description-98) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-7) ```ts USD ``` ###### Example [Section titled “Example”](#example-25) ```ts USD ``` *** `null` *** `null` ##### put.responses.200.content.application/json.status? [Section titled “put.responses.200.content.application/json.status?”](#putresponses200contentapplicationjsonstatus) > `optional` **status?**: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null` ##### put.responses.200.headers [Section titled “put.responses.200.headers”](#putresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-3) \[`name`: `string`]: `unknown` #### trace? [Section titled “trace?”](#trace-1) > `optional` **trace?**: `undefined` *** ### /v2/cards/{id}/lock [Section titled “/v2/cards/{id}/lock”](#v2cardsidlock) > **/v2/cards/{id}/lock**: `object` Defined in: [src/team/types.gen.ts:57](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L57) #### delete? [Section titled “delete?”](#delete-2) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-2) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-2) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-2) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-2) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-2) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-2) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-2) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-2) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-2) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-2) > **post**: `object` Lock card ##### Description [Section titled “Description”](#description-99) Locks an existing, unlocked card. And the card owner will receive a notification about it. ##### post.parameters [Section titled “post.parameters”](#postparameters-1) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-1) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-1) > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? [Section titled “post.parameters.header.Idempotency-Key?”](#postparametersheaderidempotency-key-1) > `optional` **Idempotency-Key?**: `string` | `null` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-1) > **path**: `object` ##### post.parameters.path.id [Section titled “post.parameters.path.id”](#postparameterspathid) > **id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-1) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-1) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-1) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-1) > **application/json**: `object` ##### post.requestBody.content.application/json.description? [Section titled “post.requestBody.content.application/json.description?”](#postrequestbodycontentapplicationjsondescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-100) Description for locking a card ##### post.requestBody.content.application/json.reason [Section titled “post.requestBody.content.application/json.reason”](#postrequestbodycontentapplicationjsonreason) > **reason**: `"OTHER"` | `"CARD_DAMAGED"` | `"CARD_LOST"` | `"CARD_NOT_RECEIVED"` | `"DO_NOT_NEED_PHYSICAL_CARD"` | `"DO_NOT_NEED_VIRTUAL_CARD"` | `"FRAUD"` ##### post.responses [Section titled “post.responses”](#postresponses-1) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-101) lockCard 200 response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-1) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-1) > **application/json**: `object` ##### post.responses.200.content.application/json.billing\_address [Section titled “post.responses.200.content.application/json.billing\_address”](#postresponses200contentapplicationjsonbilling_address-1) > **billing\_address**: `object` ##### post.responses.200.content.application/json.billing\_address.city? [Section titled “post.responses.200.content.application/json.billing\_address.city?”](#postresponses200contentapplicationjsonbilling_addresscity-1) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-102) City, district, suburb, town, or village. ##### post.responses.200.content.application/json.billing\_address.country? [Section titled “post.responses.200.content.application/json.billing\_address.country?”](#postresponses200contentapplicationjsonbilling_addresscountry-1) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-103) Two-letter country code (ISO 3166-1 alpha-2). ##### post.responses.200.content.application/json.billing\_address.line1? [Section titled “post.responses.200.content.application/json.billing\_address.line1?”](#postresponses200contentapplicationjsonbilling_addressline1-1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-104) Address line 1, no PO Box. ##### post.responses.200.content.application/json.billing\_address.line2? [Section titled “post.responses.200.content.application/json.billing\_address.line2?”](#postresponses200contentapplicationjsonbilling_addressline2-1) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-105) Address line 2 (e.g., apartment, suite, unit, or building). ##### post.responses.200.content.application/json.billing\_address.phone\_number? [Section titled “post.responses.200.content.application/json.billing\_address.phone\_number?”](#postresponses200contentapplicationjsonbilling_addressphone_number-1) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-106) Phone number. ##### post.responses.200.content.application/json.billing\_address.postal\_code? [Section titled “post.responses.200.content.application/json.billing\_address.postal\_code?”](#postresponses200contentapplicationjsonbilling_addresspostal_code-1) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-107) ZIP or postal code. ##### post.responses.200.content.application/json.billing\_address.state? [Section titled “post.responses.200.content.application/json.billing\_address.state?”](#postresponses200contentapplicationjsonbilling_addressstate-1) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-108) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### post.responses.200.content.application/json.budget\_id? [Section titled “post.responses.200.content.application/json.budget\_id?”](#postresponses200contentapplicationjsonbudget_id-1) > `optional` **budget\_id?**: `string` | `null` ##### post.responses.200.content.application/json.card\_name [Section titled “post.responses.200.content.application/json.card\_name”](#postresponses200contentapplicationjsoncard_name-1) > **card\_name**: `string` ##### post.responses.200.content.application/json.card\_type? [Section titled “post.responses.200.content.application/json.card\_type?”](#postresponses200contentapplicationjsoncard_type-1) > `optional` **card\_type?**: `"VIRTUAL"` | `"PHYSICAL"` | `null` ##### post.responses.200.content.application/json.expiration\_date [Section titled “post.responses.200.content.application/json.expiration\_date”](#postresponses200contentapplicationjsonexpiration_date-1) > **expiration\_date**: `object` ##### post.responses.200.content.application/json.expiration\_date.month [Section titled “post.responses.200.content.application/json.expiration\_date.month”](#postresponses200contentapplicationjsonexpiration_datemonth-1) > **month**: `number` Format: int32 ##### post.responses.200.content.application/json.expiration\_date.year [Section titled “post.responses.200.content.application/json.expiration\_date.year”](#postresponses200contentapplicationjsonexpiration_dateyear-1) > **year**: `number` Format: int32 ##### post.responses.200.content.application/json.has\_been\_transferred? [Section titled “post.responses.200.content.application/json.has\_been\_transferred?”](#postresponses200contentapplicationjsonhas_been_transferred-1) > `optional` **has\_been\_transferred?**: `boolean` ###### Description [Section titled “Description”](#description-109) Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions\ at online vendors where this card was previously used before the transfer. ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid-1) > **id**: `string` ##### post.responses.200.content.application/json.last\_four [Section titled “post.responses.200.content.application/json.last\_four”](#postresponses200contentapplicationjsonlast_four-1) > **last\_four**: `string` ##### post.responses.200.content.application/json.limit\_type [Section titled “post.responses.200.content.application/json.limit\_type”](#postresponses200contentapplicationjsonlimit_type-1) > **limit\_type**: `"CARD"` | `"USER"` ##### post.responses.200.content.application/json.mailing\_address? [Section titled “post.responses.200.content.application/json.mailing\_address?”](#postresponses200contentapplicationjsonmailing_address-1) > `optional` **mailing\_address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-16) ###### Type Literal [Section titled “Type Literal”](#type-literal-16) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city-4) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-110) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country-4) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-111) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1-4) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-112) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2-4) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-113) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number-4) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-114) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code-4) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-115) ZIP or postal code. ###### state? [Section titled “state?”](#state-4) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-116) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### post.responses.200.content.application/json.metadata? [Section titled “post.responses.200.content.application/json.metadata?”](#postresponses200contentapplicationjsonmetadata-1) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-117) Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ##### post.responses.200.content.application/json.owner [Section titled “post.responses.200.content.application/json.owner”](#postresponses200contentapplicationjsonowner-1) > **owner**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-8) ###### type [Section titled “type”](#type-8) > **type**: `"USER"` ###### user\_id [Section titled “user\_id”](#user_id-4) > **user\_id**: `string` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-9) ###### type [Section titled “type”](#type-9) > **type**: `"USER"` ###### Description [Section titled “Description”](#description-118) discriminator enum property added by openapi-typescript ##### post.responses.200.content.application/json.spend\_controls? [Section titled “post.responses.200.content.application/json.spend\_controls?”](#postresponses200contentapplicationjsonspend_controls-1) > `optional` **spend\_controls?**: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: … | …; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: … | …; } | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-17) ###### Type Literal [Section titled “Type Literal”](#type-literal-17) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: … | …; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: … | …; } | `null`; } ###### allowed\_merchant\_details? [Section titled “allowed\_merchant\_details?”](#allowed_merchant_details-5) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-119) List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example [Section titled “Example”](#example-26) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? [Section titled “blocked\_merchant\_details?”](#blocked_merchant_details-5) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-120) List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example [Section titled “Example”](#example-27) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? [Section titled “lock\_after\_date?”](#lock_after_date-5) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-121) The `lock_after_date` is in UTC. ###### reason? [Section titled “reason?”](#reason-5) > `optional` **reason?**: `string` | `null` ###### spend\_available? [Section titled “spend\_available?”](#spend_available-3) > `optional` **spend\_available?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-18) ###### Type Literal [Section titled “Type Literal”](#type-literal-18) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-7) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-122) 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 [Section titled “Example”](#example-28) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-7) > **currency**: … | … ###### Description [Section titled “Description”](#description-123) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-8) ```ts USD ``` ###### Example [Section titled “Example”](#example-29) ```ts USD ``` *** `null` ###### spend\_duration? [Section titled “spend\_duration?”](#spend_duration-5) > `optional` **spend\_duration?**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ###### spend\_limit? [Section titled “spend\_limit?”](#spend_limit-5) > `optional` **spend\_limit?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-19) ###### Type Literal [Section titled “Type Literal”](#type-literal-19) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-8) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-124) 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 [Section titled “Example”](#example-30) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-8) > **currency**: … | … ###### Description [Section titled “Description”](#description-125) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-9) ```ts USD ``` ###### Example [Section titled “Example”](#example-31) ```ts USD ``` *** `null` *** `null` ##### post.responses.200.content.application/json.status? [Section titled “post.responses.200.content.application/json.status?”](#postresponses200contentapplicationjsonstatus-1) > `optional` **status?**: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-4) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-2) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-2) > `optional` **trace?**: `undefined` *** ### /v2/cards/{id}/pan [Section titled “/v2/cards/{id}/pan”](#v2cardsidpan) > **/v2/cards/{id}/pan**: `object` Defined in: [src/team/types.gen.ts:77](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L77) #### delete? [Section titled “delete?”](#delete-3) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-3) > **get**: `object` Get card number ##### Description [Section titled “Description”](#description-126) Retrieves card number, CVV, and expiration date of a card by ID. ##### get.parameters [Section titled “get.parameters”](#getparameters-2) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-2) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-2) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-2) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-1) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-2) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-2) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-2) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-127) getCardNumber 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-2) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-2) > **application/json**: `object` ##### get.responses.200.content.application/json.cvv [Section titled “get.responses.200.content.application/json.cvv”](#getresponses200contentapplicationjsoncvv) > **cvv**: `string` ##### get.responses.200.content.application/json.expiration\_date [Section titled “get.responses.200.content.application/json.expiration\_date”](#getresponses200contentapplicationjsonexpiration_date-1) > **expiration\_date**: `object` ##### get.responses.200.content.application/json.expiration\_date.month [Section titled “get.responses.200.content.application/json.expiration\_date.month”](#getresponses200contentapplicationjsonexpiration_datemonth-1) > **month**: `number` Format: int32 ##### get.responses.200.content.application/json.expiration\_date.year [Section titled “get.responses.200.content.application/json.expiration\_date.year”](#getresponses200contentapplicationjsonexpiration_dateyear-1) > **year**: `number` Format: int32 ##### get.responses.200.content.application/json.holder\_name [Section titled “get.responses.200.content.application/json.holder\_name”](#getresponses200contentapplicationjsonholder_name) > **holder\_name**: `string` ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-1) > **id**: `string` ##### get.responses.200.content.application/json.number [Section titled “get.responses.200.content.application/json.number”](#getresponses200contentapplicationjsonnumber) > **number**: `string` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-5) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-3) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-3) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-3) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-3) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-3) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-3) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-3) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-3) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-3) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-3) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-3) > `optional` **trace?**: `undefined` *** ### /v2/cards/{id}/secure\_email [Section titled “/v2/cards/{id}/secure\_email”](#v2cardsidsecure_email) > **/v2/cards/{id}/secure\_email**: `object` Defined in: [src/team/types.gen.ts:97](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L97) #### delete? [Section titled “delete?”](#delete-4) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-4) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-4) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-4) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-4) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-4) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-4) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-4) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-4) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-4) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-4) > **post**: `object` Create secure email to send card number ##### Description [Section titled “Description”](#description-128) Creates a secure email to send card number, CVV, and expiration date of a card by ID to the specified email. ```plaintext This endpoint is currently gated. If you would like to request access, please reach out to developer-support@brex.com ``` ##### post.parameters [Section titled “post.parameters”](#postparameters-2) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-2) > `optional` **cookie?**: `undefined` ##### post.parameters.header [Section titled “post.parameters.header”](#postparametersheader-2) > **header**: `object` ##### post.parameters.header.Idempotency-Key [Section titled “post.parameters.header.Idempotency-Key”](#postparametersheaderidempotency-key-2) > **Idempotency-Key**: `string` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-2) > **path**: `object` ##### post.parameters.path.id [Section titled “post.parameters.path.id”](#postparameterspathid-1) > **id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-2) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-2) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-2) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-2) > **application/json**: `object` ##### post.requestBody.content.application/json.expiry\_days? [Section titled “post.requestBody.content.application/json.expiry\_days?”](#postrequestbodycontentapplicationjsonexpiry_days) > `optional` **expiry\_days?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-129) Link expiry in number of days. Defaults to 30 ##### post.requestBody.content.application/json.message? [Section titled “post.requestBody.content.application/json.message?”](#postrequestbodycontentapplicationjsonmessage) > `optional` **message?**: `string` | `null` ###### Description [Section titled “Description”](#description-130) Message to send with the card details ##### post.requestBody.content.application/json.recipient\_email [Section titled “post.requestBody.content.application/json.recipient\_email”](#postrequestbodycontentapplicationjsonrecipient_email) > **recipient\_email**: `string` ###### Description [Section titled “Description”](#description-131) Email address to send card details to ##### post.requestBody.content.application/json.sender\_name [Section titled “post.requestBody.content.application/json.sender\_name”](#postrequestbodycontentapplicationjsonsender_name) > **sender\_name**: `string` ###### Description [Section titled “Description”](#description-132) Sender name. Shows up in the subject of the email ##### post.responses [Section titled “post.responses”](#postresponses-2) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-133) emailCardNumber 200 response ##### post.responses.200.content? [Section titled “post.responses.200.content?”](#postresponses200content-2) > `optional` **content?**: `undefined` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-6) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-4) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-4) > `optional` **trace?**: `undefined` *** ### /v2/cards/{id}/terminate [Section titled “/v2/cards/{id}/terminate”](#v2cardsidterminate) > **/v2/cards/{id}/terminate**: `object` Defined in: [src/team/types.gen.ts:120](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L120) #### delete? [Section titled “delete?”](#delete-5) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-5) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-5) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-5) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-5) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-5) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-5) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-5) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-5) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-5) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-5) > **post**: `object` Terminate card ##### Description [Section titled “Description”](#description-134) Terminates an existing card. The card owner will receive a notification about it. ##### post.parameters [Section titled “post.parameters”](#postparameters-3) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-3) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-3) > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? [Section titled “post.parameters.header.Idempotency-Key?”](#postparametersheaderidempotency-key-3) > `optional` **Idempotency-Key?**: `string` | `null` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-3) > **path**: `object` ##### post.parameters.path.id [Section titled “post.parameters.path.id”](#postparameterspathid-2) > **id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-3) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-3) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-3) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-3) > **application/json**: `object` ##### post.requestBody.content.application/json.description? [Section titled “post.requestBody.content.application/json.description?”](#postrequestbodycontentapplicationjsondescription-1) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-135) Description for terminating a card ##### post.requestBody.content.application/json.reason [Section titled “post.requestBody.content.application/json.reason”](#postrequestbodycontentapplicationjsonreason-1) > **reason**: `"OTHER"` | `"CARD_DAMAGED"` | `"CARD_LOST"` | `"CARD_NOT_RECEIVED"` | `"DO_NOT_NEED_PHYSICAL_CARD"` | `"DO_NOT_NEED_VIRTUAL_CARD"` | `"FRAUD"` ##### post.responses [Section titled “post.responses”](#postresponses-3) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-3) > **200**: `object` ###### Description [Section titled “Description”](#description-136) terminateCard 200 response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-3) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-2) > **application/json**: `object` ##### post.responses.200.content.application/json.billing\_address [Section titled “post.responses.200.content.application/json.billing\_address”](#postresponses200contentapplicationjsonbilling_address-2) > **billing\_address**: `object` ##### post.responses.200.content.application/json.billing\_address.city? [Section titled “post.responses.200.content.application/json.billing\_address.city?”](#postresponses200contentapplicationjsonbilling_addresscity-2) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-137) City, district, suburb, town, or village. ##### post.responses.200.content.application/json.billing\_address.country? [Section titled “post.responses.200.content.application/json.billing\_address.country?”](#postresponses200contentapplicationjsonbilling_addresscountry-2) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-138) Two-letter country code (ISO 3166-1 alpha-2). ##### post.responses.200.content.application/json.billing\_address.line1? [Section titled “post.responses.200.content.application/json.billing\_address.line1?”](#postresponses200contentapplicationjsonbilling_addressline1-2) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-139) Address line 1, no PO Box. ##### post.responses.200.content.application/json.billing\_address.line2? [Section titled “post.responses.200.content.application/json.billing\_address.line2?”](#postresponses200contentapplicationjsonbilling_addressline2-2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-140) Address line 2 (e.g., apartment, suite, unit, or building). ##### post.responses.200.content.application/json.billing\_address.phone\_number? [Section titled “post.responses.200.content.application/json.billing\_address.phone\_number?”](#postresponses200contentapplicationjsonbilling_addressphone_number-2) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-141) Phone number. ##### post.responses.200.content.application/json.billing\_address.postal\_code? [Section titled “post.responses.200.content.application/json.billing\_address.postal\_code?”](#postresponses200contentapplicationjsonbilling_addresspostal_code-2) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-142) ZIP or postal code. ##### post.responses.200.content.application/json.billing\_address.state? [Section titled “post.responses.200.content.application/json.billing\_address.state?”](#postresponses200contentapplicationjsonbilling_addressstate-2) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-143) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### post.responses.200.content.application/json.budget\_id? [Section titled “post.responses.200.content.application/json.budget\_id?”](#postresponses200contentapplicationjsonbudget_id-2) > `optional` **budget\_id?**: `string` | `null` ##### post.responses.200.content.application/json.card\_name [Section titled “post.responses.200.content.application/json.card\_name”](#postresponses200contentapplicationjsoncard_name-2) > **card\_name**: `string` ##### post.responses.200.content.application/json.card\_type? [Section titled “post.responses.200.content.application/json.card\_type?”](#postresponses200contentapplicationjsoncard_type-2) > `optional` **card\_type?**: `"VIRTUAL"` | `"PHYSICAL"` | `null` ##### post.responses.200.content.application/json.expiration\_date [Section titled “post.responses.200.content.application/json.expiration\_date”](#postresponses200contentapplicationjsonexpiration_date-2) > **expiration\_date**: `object` ##### post.responses.200.content.application/json.expiration\_date.month [Section titled “post.responses.200.content.application/json.expiration\_date.month”](#postresponses200contentapplicationjsonexpiration_datemonth-2) > **month**: `number` Format: int32 ##### post.responses.200.content.application/json.expiration\_date.year [Section titled “post.responses.200.content.application/json.expiration\_date.year”](#postresponses200contentapplicationjsonexpiration_dateyear-2) > **year**: `number` Format: int32 ##### post.responses.200.content.application/json.has\_been\_transferred? [Section titled “post.responses.200.content.application/json.has\_been\_transferred?”](#postresponses200contentapplicationjsonhas_been_transferred-2) > `optional` **has\_been\_transferred?**: `boolean` ###### Description [Section titled “Description”](#description-144) Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions\ at online vendors where this card was previously used before the transfer. ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid-2) > **id**: `string` ##### post.responses.200.content.application/json.last\_four [Section titled “post.responses.200.content.application/json.last\_four”](#postresponses200contentapplicationjsonlast_four-2) > **last\_four**: `string` ##### post.responses.200.content.application/json.limit\_type [Section titled “post.responses.200.content.application/json.limit\_type”](#postresponses200contentapplicationjsonlimit_type-2) > **limit\_type**: `"CARD"` | `"USER"` ##### post.responses.200.content.application/json.mailing\_address? [Section titled “post.responses.200.content.application/json.mailing\_address?”](#postresponses200contentapplicationjsonmailing_address-2) > `optional` **mailing\_address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-20) ###### Type Literal [Section titled “Type Literal”](#type-literal-20) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city-5) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-145) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country-5) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-146) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1-5) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-147) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2-5) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-148) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number-5) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-149) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code-5) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-150) ZIP or postal code. ###### state? [Section titled “state?”](#state-5) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-151) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### post.responses.200.content.application/json.metadata? [Section titled “post.responses.200.content.application/json.metadata?”](#postresponses200contentapplicationjsonmetadata-2) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-152) Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ##### post.responses.200.content.application/json.owner [Section titled “post.responses.200.content.application/json.owner”](#postresponses200contentapplicationjsonowner-2) > **owner**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-10) ###### type [Section titled “type”](#type-10) > **type**: `"USER"` ###### user\_id [Section titled “user\_id”](#user_id-5) > **user\_id**: `string` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-11) ###### type [Section titled “type”](#type-11) > **type**: `"USER"` ###### Description [Section titled “Description”](#description-153) discriminator enum property added by openapi-typescript ##### post.responses.200.content.application/json.spend\_controls? [Section titled “post.responses.200.content.application/json.spend\_controls?”](#postresponses200contentapplicationjsonspend_controls-2) > `optional` **spend\_controls?**: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: … | …; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: … | …; } | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-21) ###### Type Literal [Section titled “Type Literal”](#type-literal-21) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: … | …; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: … | …; } | `null`; } ###### allowed\_merchant\_details? [Section titled “allowed\_merchant\_details?”](#allowed_merchant_details-6) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-154) List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example [Section titled “Example”](#example-32) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? [Section titled “blocked\_merchant\_details?”](#blocked_merchant_details-6) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-155) List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example [Section titled “Example”](#example-33) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? [Section titled “lock\_after\_date?”](#lock_after_date-6) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-156) The `lock_after_date` is in UTC. ###### reason? [Section titled “reason?”](#reason-6) > `optional` **reason?**: `string` | `null` ###### spend\_available? [Section titled “spend\_available?”](#spend_available-4) > `optional` **spend\_available?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-22) ###### Type Literal [Section titled “Type Literal”](#type-literal-22) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-9) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-157) 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 [Section titled “Example”](#example-34) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-9) > **currency**: … | … ###### Description [Section titled “Description”](#description-158) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-10) ```ts USD ``` ###### Example [Section titled “Example”](#example-35) ```ts USD ``` *** `null` ###### spend\_duration? [Section titled “spend\_duration?”](#spend_duration-6) > `optional` **spend\_duration?**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ###### spend\_limit? [Section titled “spend\_limit?”](#spend_limit-6) > `optional` **spend\_limit?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-23) ###### Type Literal [Section titled “Type Literal”](#type-literal-23) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-10) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-159) 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 [Section titled “Example”](#example-36) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-10) > **currency**: … | … ###### Description [Section titled “Description”](#description-160) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-11) ```ts USD ``` ###### Example [Section titled “Example”](#example-37) ```ts USD ``` *** `null` *** `null` ##### post.responses.200.content.application/json.status? [Section titled “post.responses.200.content.application/json.status?”](#postresponses200contentapplicationjsonstatus-2) > `optional` **status?**: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-7) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-5) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-5) > `optional` **trace?**: `undefined` *** ### /v2/cards/{id}/unlock [Section titled “/v2/cards/{id}/unlock”](#v2cardsidunlock) > **/v2/cards/{id}/unlock**: `object` Defined in: [src/team/types.gen.ts:140](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L140) #### delete? [Section titled “delete?”](#delete-6) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-6) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-6) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-6) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-6) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-6) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-6) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-6) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-6) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-6) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-6) > **post**: `object` Unlock card ##### Description [Section titled “Description”](#description-161) Unlocks an existing card. ##### post.parameters [Section titled “post.parameters”](#postparameters-4) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-4) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-4) > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? [Section titled “post.parameters.header.Idempotency-Key?”](#postparametersheaderidempotency-key-4) > `optional` **Idempotency-Key?**: `string` | `null` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-4) > **path**: `object` ##### post.parameters.path.id [Section titled “post.parameters.path.id”](#postparameterspathid-3) > **id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-4) > `optional` **query?**: `undefined` ##### post.requestBody? [Section titled “post.requestBody?”](#postrequestbody-4) > `optional` **requestBody?**: `undefined` ##### post.responses [Section titled “post.responses”](#postresponses-4) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-4) > **200**: `object` ###### Description [Section titled “Description”](#description-162) unlockCard 200 response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-4) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-3) > **application/json**: `object` ##### post.responses.200.content.application/json.billing\_address [Section titled “post.responses.200.content.application/json.billing\_address”](#postresponses200contentapplicationjsonbilling_address-3) > **billing\_address**: `object` ##### post.responses.200.content.application/json.billing\_address.city? [Section titled “post.responses.200.content.application/json.billing\_address.city?”](#postresponses200contentapplicationjsonbilling_addresscity-3) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-163) City, district, suburb, town, or village. ##### post.responses.200.content.application/json.billing\_address.country? [Section titled “post.responses.200.content.application/json.billing\_address.country?”](#postresponses200contentapplicationjsonbilling_addresscountry-3) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-164) Two-letter country code (ISO 3166-1 alpha-2). ##### post.responses.200.content.application/json.billing\_address.line1? [Section titled “post.responses.200.content.application/json.billing\_address.line1?”](#postresponses200contentapplicationjsonbilling_addressline1-3) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-165) Address line 1, no PO Box. ##### post.responses.200.content.application/json.billing\_address.line2? [Section titled “post.responses.200.content.application/json.billing\_address.line2?”](#postresponses200contentapplicationjsonbilling_addressline2-3) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-166) Address line 2 (e.g., apartment, suite, unit, or building). ##### post.responses.200.content.application/json.billing\_address.phone\_number? [Section titled “post.responses.200.content.application/json.billing\_address.phone\_number?”](#postresponses200contentapplicationjsonbilling_addressphone_number-3) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-167) Phone number. ##### post.responses.200.content.application/json.billing\_address.postal\_code? [Section titled “post.responses.200.content.application/json.billing\_address.postal\_code?”](#postresponses200contentapplicationjsonbilling_addresspostal_code-3) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-168) ZIP or postal code. ##### post.responses.200.content.application/json.billing\_address.state? [Section titled “post.responses.200.content.application/json.billing\_address.state?”](#postresponses200contentapplicationjsonbilling_addressstate-3) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-169) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### post.responses.200.content.application/json.budget\_id? [Section titled “post.responses.200.content.application/json.budget\_id?”](#postresponses200contentapplicationjsonbudget_id-3) > `optional` **budget\_id?**: `string` | `null` ##### post.responses.200.content.application/json.card\_name [Section titled “post.responses.200.content.application/json.card\_name”](#postresponses200contentapplicationjsoncard_name-3) > **card\_name**: `string` ##### post.responses.200.content.application/json.card\_type? [Section titled “post.responses.200.content.application/json.card\_type?”](#postresponses200contentapplicationjsoncard_type-3) > `optional` **card\_type?**: `"VIRTUAL"` | `"PHYSICAL"` | `null` ##### post.responses.200.content.application/json.expiration\_date [Section titled “post.responses.200.content.application/json.expiration\_date”](#postresponses200contentapplicationjsonexpiration_date-3) > **expiration\_date**: `object` ##### post.responses.200.content.application/json.expiration\_date.month [Section titled “post.responses.200.content.application/json.expiration\_date.month”](#postresponses200contentapplicationjsonexpiration_datemonth-3) > **month**: `number` Format: int32 ##### post.responses.200.content.application/json.expiration\_date.year [Section titled “post.responses.200.content.application/json.expiration\_date.year”](#postresponses200contentapplicationjsonexpiration_dateyear-3) > **year**: `number` Format: int32 ##### post.responses.200.content.application/json.has\_been\_transferred? [Section titled “post.responses.200.content.application/json.has\_been\_transferred?”](#postresponses200contentapplicationjsonhas_been_transferred-3) > `optional` **has\_been\_transferred?**: `boolean` ###### Description [Section titled “Description”](#description-170) Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions\ at online vendors where this card was previously used before the transfer. ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid-3) > **id**: `string` ##### post.responses.200.content.application/json.last\_four [Section titled “post.responses.200.content.application/json.last\_four”](#postresponses200contentapplicationjsonlast_four-3) > **last\_four**: `string` ##### post.responses.200.content.application/json.limit\_type [Section titled “post.responses.200.content.application/json.limit\_type”](#postresponses200contentapplicationjsonlimit_type-3) > **limit\_type**: `"CARD"` | `"USER"` ##### post.responses.200.content.application/json.mailing\_address? [Section titled “post.responses.200.content.application/json.mailing\_address?”](#postresponses200contentapplicationjsonmailing_address-3) > `optional` **mailing\_address?**: { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-24) ###### Type Literal [Section titled “Type Literal”](#type-literal-24) { `city?`: `string` | `null`; `country?`: `string` | `null`; `line1?`: `string` | `null`; `line2?`: `string` | `null`; `phone_number?`: `string` | `null`; `postal_code?`: `string` | `null`; `state?`: `string` | `null`; } ###### city? [Section titled “city?”](#city-6) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-171) City, district, suburb, town, or village. ###### country? [Section titled “country?”](#country-6) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-172) Two-letter country code (ISO 3166-1 alpha-2). ###### line1? [Section titled “line1?”](#line1-6) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-173) Address line 1, no PO Box. ###### line2? [Section titled “line2?”](#line2-6) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-174) Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? [Section titled “phone\_number?”](#phone_number-6) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-175) Phone number. ###### postal\_code? [Section titled “postal\_code?”](#postal_code-6) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-176) ZIP or postal code. ###### state? [Section titled “state?”](#state-6) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-177) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### post.responses.200.content.application/json.metadata? [Section titled “post.responses.200.content.application/json.metadata?”](#postresponses200contentapplicationjsonmetadata-3) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-178) Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ##### post.responses.200.content.application/json.owner [Section titled “post.responses.200.content.application/json.owner”](#postresponses200contentapplicationjsonowner-3) > **owner**: `object` & `object` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-12) ###### type [Section titled “type”](#type-12) > **type**: `"USER"` ###### user\_id [Section titled “user\_id”](#user_id-6) > **user\_id**: `string` ###### Type Declaration [Section titled “Type Declaration”](#type-declaration-13) ###### type [Section titled “type”](#type-13) > **type**: `"USER"` ###### Description [Section titled “Description”](#description-179) discriminator enum property added by openapi-typescript ##### post.responses.200.content.application/json.spend\_controls? [Section titled “post.responses.200.content.application/json.spend\_controls?”](#postresponses200contentapplicationjsonspend_controls-3) > `optional` **spend\_controls?**: { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: … | …; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: … | …; } | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-25) ###### Type Literal [Section titled “Type Literal”](#type-literal-25) { `allowed_merchant_details?`: `object`\[] | `null`; `blocked_merchant_details?`: `object`\[] | `null`; `lock_after_date?`: `string` | `null`; `reason?`: `string` | `null`; `spend_available?`: { `amount`: `number`; `currency`: … | …; } | `null`; `spend_duration?`: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null`; `spend_limit?`: { `amount`: `number`; `currency`: … | …; } | `null`; } ###### allowed\_merchant\_details? [Section titled “allowed\_merchant\_details?”](#allowed_merchant_details-7) > `optional` **allowed\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-180) List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. ###### Example [Section titled “Example”](#example-38) ```ts [{"name": "Github"}, {"name": "AWS"}] ``` ###### blocked\_merchant\_details? [Section titled “blocked\_merchant\_details?”](#blocked_merchant_details-7) > `optional` **blocked\_merchant\_details?**: `object`\[] | `null` ###### Description [Section titled “Description”](#description-181) List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. ###### Example [Section titled “Example”](#example-39) ```ts [{"name": "Apple"}, {"name": "Amazon"}] ``` ###### lock\_after\_date? [Section titled “lock\_after\_date?”](#lock_after_date-7) > `optional` **lock\_after\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-182) The `lock_after_date` is in UTC. ###### reason? [Section titled “reason?”](#reason-7) > `optional` **reason?**: `string` | `null` ###### spend\_available? [Section titled “spend\_available?”](#spend_available-5) > `optional` **spend\_available?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-26) ###### Type Literal [Section titled “Type Literal”](#type-literal-26) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-11) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-183) 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 [Section titled “Example”](#example-40) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-11) > **currency**: … | … ###### Description [Section titled “Description”](#description-184) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-12) ```ts USD ``` ###### Example [Section titled “Example”](#example-41) ```ts USD ``` *** `null` ###### spend\_duration? [Section titled “spend\_duration?”](#spend_duration-7) > `optional` **spend\_duration?**: `"MONTHLY"` | `"QUARTERLY"` | `"YEARLY"` | `"ONE_TIME"` | `null` ###### spend\_limit? [Section titled “spend\_limit?”](#spend_limit-7) > `optional` **spend\_limit?**: { `amount`: `number`; `currency`: … | …; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-27) ###### Type Literal [Section titled “Type Literal”](#type-literal-27) { `amount`: `number`; `currency`: … | …; } ###### amount [Section titled “amount”](#amount-12) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-185) 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 [Section titled “Example”](#example-42) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-12) > **currency**: … | … ###### Description [Section titled “Description”](#description-186) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-13) ```ts USD ``` ###### Example [Section titled “Example”](#example-43) ```ts USD ``` *** `null` *** `null` ##### post.responses.200.content.application/json.status? [Section titled “post.responses.200.content.application/json.status?”](#postresponses200contentapplicationjsonstatus-3) > `optional` **status?**: `"ACTIVE"` | `"TERMINATED"` | `"SHIPPED"` | `"LOCKED"` | `null` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-8) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-6) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-6) > `optional` **trace?**: `undefined` *** ### /v2/company [Section titled “/v2/company”](#v2company) > **/v2/company**: `object` Defined in: [src/team/types.gen.ts:160](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L160) #### delete? [Section titled “delete?”](#delete-7) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-7) > **get**: `object` Get company ##### Description [Section titled “Description”](#description-187) This endpoint returns the company associated with the OAuth2 access token. ##### get.parameters [Section titled “get.parameters”](#getparameters-3) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-3) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-3) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-3) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-3) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-3) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-3) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-3) > **200**: `object` ###### Description [Section titled “Description”](#description-188) getCompany 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-3) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-3) > **application/json**: `object` ##### get.responses.200.content.application/json.accountType [Section titled “get.responses.200.content.application/json.accountType”](#getresponses200contentapplicationjsonaccounttype) > **accountType**: `"BREX_CLASSIC"` | `"BREX_EMPOWER"` ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-2) > **id**: `string` ##### get.responses.200.content.application/json.legal\_name [Section titled “get.responses.200.content.application/json.legal\_name”](#getresponses200contentapplicationjsonlegal_name) > **legal\_name**: `string` ##### get.responses.200.content.application/json.mailing\_address [Section titled “get.responses.200.content.application/json.mailing\_address”](#getresponses200contentapplicationjsonmailing_address-1) > **mailing\_address**: `object` ##### get.responses.200.content.application/json.mailing\_address.city? [Section titled “get.responses.200.content.application/json.mailing\_address.city?”](#getresponses200contentapplicationjsonmailing_addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-189) City, district, suburb, town, or village. ##### get.responses.200.content.application/json.mailing\_address.country? [Section titled “get.responses.200.content.application/json.mailing\_address.country?”](#getresponses200contentapplicationjsonmailing_addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-190) Two-letter country code (ISO 3166-1 alpha-2). ##### get.responses.200.content.application/json.mailing\_address.line1? [Section titled “get.responses.200.content.application/json.mailing\_address.line1?”](#getresponses200contentapplicationjsonmailing_addressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-191) Address line 1, no PO Box. ##### get.responses.200.content.application/json.mailing\_address.line2? [Section titled “get.responses.200.content.application/json.mailing\_address.line2?”](#getresponses200contentapplicationjsonmailing_addressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-192) Address line 2 (e.g., apartment, suite, unit, or building). ##### get.responses.200.content.application/json.mailing\_address.phone\_number? [Section titled “get.responses.200.content.application/json.mailing\_address.phone\_number?”](#getresponses200contentapplicationjsonmailing_addressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-193) Phone number. ##### get.responses.200.content.application/json.mailing\_address.postal\_code? [Section titled “get.responses.200.content.application/json.mailing\_address.postal\_code?”](#getresponses200contentapplicationjsonmailing_addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-194) ZIP or postal code. ##### get.responses.200.content.application/json.mailing\_address.state? [Section titled “get.responses.200.content.application/json.mailing\_address.state?”](#getresponses200contentapplicationjsonmailing_addressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-195) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-9) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-7) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-7) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-7) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-7) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-7) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-7) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-7) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-7) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-7) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-7) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-7) > `optional` **trace?**: `undefined` *** ### /v2/departments [Section titled “/v2/departments”](#v2departments) > **/v2/departments**: `object` Defined in: [src/team/types.gen.ts:180](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L180) #### delete? [Section titled “delete?”](#delete-8) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-8) > **get**: `object` List departments ##### Description [Section titled “Description”](#description-196) This endpoint lists all departments. ##### get.parameters [Section titled “get.parameters”](#getparameters-4) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-4) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-4) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-4) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-4) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-1) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-1) > `optional` **limit?**: `number` | `null` ##### get.parameters.query.name? [Section titled “get.parameters.query.name?”](#getparametersqueryname) > `optional` **name?**: `string` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-4) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-4) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-4) > **200**: `object` ###### Description [Section titled “Description”](#description-197) listDepartments 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-4) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-4) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-1) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-1) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-10) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-8) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-8) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-8) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-8) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-8) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-8) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-8) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-8) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-8) > **post**: `object` Create department ##### Description [Section titled “Description”](#description-198) This endpoint creates a new department ##### post.parameters [Section titled “post.parameters”](#postparameters-5) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-5) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-5) > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? [Section titled “post.parameters.header.Idempotency-Key?”](#postparametersheaderidempotency-key-5) > `optional` **Idempotency-Key?**: `string` | `null` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath-5) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-5) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-5) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-4) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-4) > **application/json**: `object` ##### post.requestBody.content.application/json.description? [Section titled “post.requestBody.content.application/json.description?”](#postrequestbodycontentapplicationjsondescription-2) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-199) Description of the department ##### post.requestBody.content.application/json.name [Section titled “post.requestBody.content.application/json.name”](#postrequestbodycontentapplicationjsonname) > **name**: `string` ###### Description [Section titled “Description”](#description-200) Name of the department ##### post.responses [Section titled “post.responses”](#postresponses-5) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-5) > **200**: `object` ###### Description [Section titled “Description”](#description-201) createDepartment 200 response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-5) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-4) > **application/json**: `object` ##### post.responses.200.content.application/json.description? [Section titled “post.responses.200.content.application/json.description?”](#postresponses200contentapplicationjsondescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-202) Description of the department ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid-4) > **id**: `string` ##### post.responses.200.content.application/json.name [Section titled “post.responses.200.content.application/json.name”](#postresponses200contentapplicationjsonname) > **name**: `string` ###### Description [Section titled “Description”](#description-203) Name of the department ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-11) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-8) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-8) > `optional` **trace?**: `undefined` *** ### /v2/departments/{id} [Section titled “/v2/departments/{id}”](#v2departmentsid) > **/v2/departments/{id}**: `object` Defined in: [src/team/types.gen.ts:204](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L204) #### delete? [Section titled “delete?”](#delete-9) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-9) > **get**: `object` Get department ##### Description [Section titled “Description”](#description-204) This endpoint gets a department by ID. ##### get.parameters [Section titled “get.parameters”](#getparameters-5) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-5) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-5) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-5) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-2) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-5) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-5) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-5) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-5) > **200**: `object` ###### Description [Section titled “Description”](#description-205) getDepartmentById 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-5) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-5) > **application/json**: `object` ##### get.responses.200.content.application/json.description? [Section titled “get.responses.200.content.application/json.description?”](#getresponses200contentapplicationjsondescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-206) Description of the department ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-3) > **id**: `string` ##### get.responses.200.content.application/json.name [Section titled “get.responses.200.content.application/json.name”](#getresponses200contentapplicationjsonname) > **name**: `string` ###### Description [Section titled “Description”](#description-207) Name of the department ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-12) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-9) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-9) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-9) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-9) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-9) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-9) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-9) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-9) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-9) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-9) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-9) > `optional` **trace?**: `undefined` *** ### /v2/legal\_entities [Section titled “/v2/legal\_entities”](#v2legal_entities) > **/v2/legal\_entities**: `object` Defined in: [src/team/types.gen.ts:224](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L224) #### delete? [Section titled “delete?”](#delete-10) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-10) > **get**: `object` List legal entities ##### Description [Section titled “Description”](#description-208) List legal entities for the account. ##### get.parameters [Section titled “get.parameters”](#getparameters-6) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-6) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-6) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-6) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-6) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-2) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-2) > `optional` **limit?**: `number` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-6) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-6) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-6) > **200**: `object` ###### Description [Section titled “Description”](#description-209) listLegalEntities 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-6) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-6) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-2) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-2) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-6) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-13) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-10) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-10) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-10) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-10) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-10) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-10) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-10) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-10) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-10) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-10) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-10) > `optional` **trace?**: `undefined` *** ### /v2/legal\_entities/{id} [Section titled “/v2/legal\_entities/{id}”](#v2legal_entitiesid) > **/v2/legal\_entities/{id}**: `object` Defined in: [src/team/types.gen.ts:244](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L244) #### delete? [Section titled “delete?”](#delete-11) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-11) > **get**: `object` Get legal entity ##### Description [Section titled “Description”](#description-210) Get a legal entity by its ID. ##### get.parameters [Section titled “get.parameters”](#getparameters-7) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-7) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-7) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-7) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-3) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-7) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-7) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-7) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-7) > **200**: `object` ###### Description [Section titled “Description”](#description-211) getLegalEntity 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-7) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-7) > **application/json**: `object` ##### get.responses.200.content.application/json.billingAddress [Section titled “get.responses.200.content.application/json.billingAddress”](#getresponses200contentapplicationjsonbillingaddress) > **billingAddress**: `object` ##### get.responses.200.content.application/json.billingAddress.city? [Section titled “get.responses.200.content.application/json.billingAddress.city?”](#getresponses200contentapplicationjsonbillingaddresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-212) City, district, suburb, town, or village. ##### get.responses.200.content.application/json.billingAddress.country? [Section titled “get.responses.200.content.application/json.billingAddress.country?”](#getresponses200contentapplicationjsonbillingaddresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-213) Two-letter country code (ISO 3166-1 alpha-2). ##### get.responses.200.content.application/json.billingAddress.line1? [Section titled “get.responses.200.content.application/json.billingAddress.line1?”](#getresponses200contentapplicationjsonbillingaddressline1) > `optional` **line1?**: `string` | `null` ###### Description [Section titled “Description”](#description-214) Address line 1, no PO Box. ##### get.responses.200.content.application/json.billingAddress.line2? [Section titled “get.responses.200.content.application/json.billingAddress.line2?”](#getresponses200contentapplicationjsonbillingaddressline2) > `optional` **line2?**: `string` | `null` ###### Description [Section titled “Description”](#description-215) Address line 2 (e.g., apartment, suite, unit, or building). ##### get.responses.200.content.application/json.billingAddress.phone\_number? [Section titled “get.responses.200.content.application/json.billingAddress.phone\_number?”](#getresponses200contentapplicationjsonbillingaddressphone_number) > `optional` **phone\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-216) Phone number. ##### get.responses.200.content.application/json.billingAddress.postal\_code? [Section titled “get.responses.200.content.application/json.billingAddress.postal\_code?”](#getresponses200contentapplicationjsonbillingaddresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-217) ZIP or postal code. ##### get.responses.200.content.application/json.billingAddress.state? [Section titled “get.responses.200.content.application/json.billingAddress.state?”](#getresponses200contentapplicationjsonbillingaddressstate) > `optional` **state?**: `string` | `null` ###### Description [Section titled “Description”](#description-218) For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ##### get.responses.200.content.application/json.createdAt [Section titled “get.responses.200.content.application/json.createdAt”](#getresponses200contentapplicationjsoncreatedat) > **createdAt**: `string` Format: date-time ###### Description [Section titled “Description”](#description-219) Timestamp, in UTC, when this legal entity was created. ##### get.responses.200.content.application/json.displayName [Section titled “get.responses.200.content.application/json.displayName”](#getresponses200contentapplicationjsondisplayname) > **displayName**: `string` ###### Description [Section titled “Description”](#description-220) The display name of this legal entity. ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-4) > **id**: `string` ###### Description [Section titled “Description”](#description-221) The ID of this legal entity. ##### get.responses.200.content.application/json.isDefault? [Section titled “get.responses.200.content.application/json.isDefault?”](#getresponses200contentapplicationjsonisdefault) > `optional` **isDefault?**: `boolean` ###### Description [Section titled “Description”](#description-222) Whether this is the default entity of the account. ##### get.responses.200.content.application/json.status [Section titled “get.responses.200.content.application/json.status”](#getresponses200contentapplicationjsonstatus-1) > **status**: `"UNSUBMITTED"` | `"UNVERIFIED"` | `"IN_PROGRESS"` | `"VERIFIED"` | `"REJECTED"` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-7) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-14) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-11) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-11) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-11) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-11) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-11) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-11) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-11) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-11) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-11) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-11) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-11) > `optional` **trace?**: `undefined` *** ### /v2/locations [Section titled “/v2/locations”](#v2locations) > **/v2/locations**: `object` Defined in: [src/team/types.gen.ts:264](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L264) #### delete? [Section titled “delete?”](#delete-12) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-12) > **get**: `object` List locations ##### Description [Section titled “Description”](#description-223) This endpoint lists all locations. ##### get.parameters [Section titled “get.parameters”](#getparameters-8) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-8) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-8) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-8) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-8) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-3) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-3) > `optional` **limit?**: `number` | `null` ##### get.parameters.query.name? [Section titled “get.parameters.query.name?”](#getparametersqueryname-1) > `optional` **name?**: `string` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-8) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-8) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-8) > **200**: `object` ###### Description [Section titled “Description”](#description-224) listLocations 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-8) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-8) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-3) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-3) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-8) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-15) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-12) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-12) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-12) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-12) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-12) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-12) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-12) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-12) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-12) > **post**: `object` Create location ##### Description [Section titled “Description”](#description-225) This endpoint creates a new location. ##### post.parameters [Section titled “post.parameters”](#postparameters-6) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-6) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-6) > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? [Section titled “post.parameters.header.Idempotency-Key?”](#postparametersheaderidempotency-key-6) > `optional` **Idempotency-Key?**: `string` | `null` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath-6) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-6) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-6) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-5) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-5) > **application/json**: `object` ##### post.requestBody.content.application/json.description? [Section titled “post.requestBody.content.application/json.description?”](#postrequestbodycontentapplicationjsondescription-3) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-226) Description of the location ##### post.requestBody.content.application/json.name [Section titled “post.requestBody.content.application/json.name”](#postrequestbodycontentapplicationjsonname-1) > **name**: `string` ###### Description [Section titled “Description”](#description-227) Name of the location ##### post.responses [Section titled “post.responses”](#postresponses-6) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-6) > **200**: `object` ###### Description [Section titled “Description”](#description-228) createLocation 200 response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-6) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-5) > **application/json**: `object` ##### post.responses.200.content.application/json.description? [Section titled “post.responses.200.content.application/json.description?”](#postresponses200contentapplicationjsondescription-1) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-229) Description of the location ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid-5) > **id**: `string` ##### post.responses.200.content.application/json.name [Section titled “post.responses.200.content.application/json.name”](#postresponses200contentapplicationjsonname-1) > **name**: `string` ###### Description [Section titled “Description”](#description-230) Name of the location ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-6) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-16) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-12) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-12) > `optional` **trace?**: `undefined` *** ### /v2/locations/{id} [Section titled “/v2/locations/{id}”](#v2locationsid) > **/v2/locations/{id}**: `object` Defined in: [src/team/types.gen.ts:288](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L288) #### delete? [Section titled “delete?”](#delete-13) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-13) > **get**: `object` Get location ##### Description [Section titled “Description”](#description-231) This endpoint gets a location by ID. ##### get.parameters [Section titled “get.parameters”](#getparameters-9) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-9) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-9) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-9) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-4) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-9) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-9) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-9) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-9) > **200**: `object` ###### Description [Section titled “Description”](#description-232) getLocationById 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-9) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-9) > **application/json**: `object` ##### get.responses.200.content.application/json.description? [Section titled “get.responses.200.content.application/json.description?”](#getresponses200contentapplicationjsondescription-1) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-233) Description of the location ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-5) > **id**: `string` ##### get.responses.200.content.application/json.name [Section titled “get.responses.200.content.application/json.name”](#getresponses200contentapplicationjsonname-1) > **name**: `string` ###### Description [Section titled “Description”](#description-234) Name of the location ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-9) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-17) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-13) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-13) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-13) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-13) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-13) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-13) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-13) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-13) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-13) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-13) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-13) > `optional` **trace?**: `undefined` *** ### /v2/titles [Section titled “/v2/titles”](#v2titles) > **/v2/titles**: `object` Defined in: [src/team/types.gen.ts:308](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L308) #### delete? [Section titled “delete?”](#delete-14) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-14) > **get**: `object` List titles ##### Description [Section titled “Description”](#description-235) This endpoint lists all titles. ##### get.parameters [Section titled “get.parameters”](#getparameters-10) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-10) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-10) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-10) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-10) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-4) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-4) > `optional` **limit?**: `number` | `null` ##### get.parameters.query.name? [Section titled “get.parameters.query.name?”](#getparametersqueryname-2) > `optional` **name?**: `string` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-10) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-10) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-10) > **200**: `object` ###### Description [Section titled “Description”](#description-236) listTitles 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-10) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-10) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-4) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-4) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-10) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-18) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-14) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-14) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-14) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-14) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-14) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-14) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-14) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-14) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-14) > **post**: `object` Create title ##### Description [Section titled “Description”](#description-237) This endpoint creates a new title ##### post.parameters [Section titled “post.parameters”](#postparameters-7) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-7) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-7) > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? [Section titled “post.parameters.header.Idempotency-Key?”](#postparametersheaderidempotency-key-7) > `optional` **Idempotency-Key?**: `string` | `null` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath-7) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-7) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-7) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-6) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-6) > **application/json**: `object` ##### post.requestBody.content.application/json.name [Section titled “post.requestBody.content.application/json.name”](#postrequestbodycontentapplicationjsonname-2) > **name**: `string` ###### Description [Section titled “Description”](#description-238) Name of the title ##### post.responses [Section titled “post.responses”](#postresponses-7) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-7) > **200**: `object` ###### Description [Section titled “Description”](#description-239) createTitle 200 response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-7) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-6) > **application/json**: `object` ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid-6) > **id**: `string` ##### post.responses.200.content.application/json.name [Section titled “post.responses.200.content.application/json.name”](#postresponses200contentapplicationjsonname-2) > **name**: `string` ###### Description [Section titled “Description”](#description-240) Name of the title ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-7) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-19) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-14) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-14) > `optional` **trace?**: `undefined` *** ### /v2/titles/{id} [Section titled “/v2/titles/{id}”](#v2titlesid) > **/v2/titles/{id}**: `object` Defined in: [src/team/types.gen.ts:332](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L332) #### delete? [Section titled “delete?”](#delete-15) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-15) > **get**: `object` Get title ##### Description [Section titled “Description”](#description-241) This endpoint gets a title by ID. ##### get.parameters [Section titled “get.parameters”](#getparameters-11) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-11) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-11) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-11) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-5) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-11) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-11) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-11) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-11) > **200**: `object` ###### Description [Section titled “Description”](#description-242) getTitleById 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-11) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-11) > **application/json**: `object` ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-6) > **id**: `string` ##### get.responses.200.content.application/json.name [Section titled “get.responses.200.content.application/json.name”](#getresponses200contentapplicationjsonname-2) > **name**: `string` ###### Description [Section titled “Description”](#description-243) Name of the title ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-11) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-20) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-15) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-15) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-15) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-15) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-15) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-15) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-15) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-15) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-15) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-15) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-15) > `optional` **trace?**: `undefined` *** ### /v2/users [Section titled “/v2/users”](#v2users) > **/v2/users**: `object` Defined in: [src/team/types.gen.ts:352](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L352) #### delete? [Section titled “delete?”](#delete-16) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-16) > **get**: `object` List users ##### Description [Section titled “Description”](#description-244) This endpoint lists all users. To find a user id by email, you can filter using the `email` query parameter. ##### get.parameters [Section titled “get.parameters”](#getparameters-12) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-12) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-12) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-12) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-12) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-5) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.email? [Section titled “get.parameters.query.email?”](#getparametersqueryemail) > `optional` **email?**: `string` | `null` ##### get.parameters.query.expand\[]? [Section titled “get.parameters.query.expand\[\]?”](#getparametersqueryexpand) > `optional` **expand\[]?**: `string`\[] | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-5) > `optional` **limit?**: `number` | `null` ##### get.parameters.query.remote\_display\_id? [Section titled “get.parameters.query.remote\_display\_id?”](#getparametersqueryremote_display_id) > `optional` **remote\_display\_id?**: `string` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-12) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-12) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-12) > **200**: `object` ###### Description [Section titled “Description”](#description-245) listUsers 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-12) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-12) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-5) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-5) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-12) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-21) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-16) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-16) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-16) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-16) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-16) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-16) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-16) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-16) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-16) > **post**: `object` Invite user ##### Description [Section titled “Description”](#description-246) This endpoint invites a new user as an employee. To update user’s role, check out [this article](https://support.brex.com/how-do-i-change-another-user-s-role/). ##### post.parameters [Section titled “post.parameters”](#postparameters-8) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-8) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-8) > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? [Section titled “post.parameters.header.Idempotency-Key?”](#postparametersheaderidempotency-key-8) > `optional` **Idempotency-Key?**: `string` | `null` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath-8) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-8) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-8) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-7) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-7) > **application/json**: `object` ##### post.requestBody.content.application/json.department\_id? [Section titled “post.requestBody.content.application/json.department\_id?”](#postrequestbodycontentapplicationjsondepartment_id) > `optional` **department\_id?**: `string` | `null` ##### post.requestBody.content.application/json.email [Section titled “post.requestBody.content.application/json.email”](#postrequestbodycontentapplicationjsonemail) > **email**: `string` Format: email ##### post.requestBody.content.application/json.first\_name [Section titled “post.requestBody.content.application/json.first\_name”](#postrequestbodycontentapplicationjsonfirst_name) > **first\_name**: `string` ##### post.requestBody.content.application/json.last\_name [Section titled “post.requestBody.content.application/json.last\_name”](#postrequestbodycontentapplicationjsonlast_name) > **last\_name**: `string` ##### post.requestBody.content.application/json.location\_id? [Section titled “post.requestBody.content.application/json.location\_id?”](#postrequestbodycontentapplicationjsonlocation_id) > `optional` **location\_id?**: `string` | `null` ##### post.requestBody.content.application/json.manager\_id? [Section titled “post.requestBody.content.application/json.manager\_id?”](#postrequestbodycontentapplicationjsonmanager_id) > `optional` **manager\_id?**: `string` | `null` ##### post.requestBody.content.application/json.metadata? [Section titled “post.requestBody.content.application/json.metadata?”](#postrequestbodycontentapplicationjsonmetadata-1) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-247) The metadata or customized attributes of the user. Maximum number of entries: 100 ##### post.requestBody.content.application/json.title\_id? [Section titled “post.requestBody.content.application/json.title\_id?”](#postrequestbodycontentapplicationjsontitle_id) > `optional` **title\_id?**: `string` | `null` ##### post.responses [Section titled “post.responses”](#postresponses-8) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-8) > **200**: `object` ###### Description [Section titled “Description”](#description-248) createUser 200 response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-8) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-7) > **application/json**: `object` ##### post.responses.200.content.application/json.department\_id? [Section titled “post.responses.200.content.application/json.department\_id?”](#postresponses200contentapplicationjsondepartment_id) > `optional` **department\_id?**: `string` | `null` ##### post.responses.200.content.application/json.email [Section titled “post.responses.200.content.application/json.email”](#postresponses200contentapplicationjsonemail) > **email**: `string` ###### Description [Section titled “Description”](#description-249) Email address of the user ##### post.responses.200.content.application/json.first\_name [Section titled “post.responses.200.content.application/json.first\_name”](#postresponses200contentapplicationjsonfirst_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-250) First name of the user ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid-7) > **id**: `string` ##### post.responses.200.content.application/json.last\_name [Section titled “post.responses.200.content.application/json.last\_name”](#postresponses200contentapplicationjsonlast_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-251) Last name of the user ##### post.responses.200.content.application/json.location\_id? [Section titled “post.responses.200.content.application/json.location\_id?”](#postresponses200contentapplicationjsonlocation_id) > `optional` **location\_id?**: `string` | `null` ##### post.responses.200.content.application/json.manager\_id? [Section titled “post.responses.200.content.application/json.manager\_id?”](#postresponses200contentapplicationjsonmanager_id) > `optional` **manager\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-252) The user id of the manager of this user ##### post.responses.200.content.application/json.metadata? [Section titled “post.responses.200.content.application/json.metadata?”](#postresponses200contentapplicationjsonmetadata-4) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-253) The metadata or customized attributes of the user. Maximum number of entries: 100 ##### post.responses.200.content.application/json.remote\_display\_id? [Section titled “post.responses.200.content.application/json.remote\_display\_id?”](#postresponses200contentapplicationjsonremote_display_id) > `optional` **remote\_display\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-254) Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz ##### post.responses.200.content.application/json.status? [Section titled “post.responses.200.content.application/json.status?”](#postresponses200contentapplicationjsonstatus-4) > `optional` **status?**: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null` ##### post.responses.200.content.application/json.title\_id? [Section titled “post.responses.200.content.application/json.title\_id?”](#postresponses200contentapplicationjsontitle_id) > `optional` **title\_id?**: `string` | `null` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-8) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-22) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-16) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-16) > `optional` **trace?**: `undefined` *** ### /v2/users/{id} [Section titled “/v2/users/{id}”](#v2usersid) > **/v2/users/{id}**: `object` Defined in: [src/team/types.gen.ts:377](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L377) #### delete? [Section titled “delete?”](#delete-17) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-17) > **get**: `object` Get user ##### Description [Section titled “Description”](#description-255) This endpoint gets a user by ID. ##### get.parameters [Section titled “get.parameters”](#getparameters-13) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-13) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-13) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-13) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-6) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-13) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-13) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-13) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-13) > **200**: `object` ###### Description [Section titled “Description”](#description-256) getUserById 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-13) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-13) > **application/json**: `object` ##### get.responses.200.content.application/json.department\_id? [Section titled “get.responses.200.content.application/json.department\_id?”](#getresponses200contentapplicationjsondepartment_id) > `optional` **department\_id?**: `string` | `null` ##### get.responses.200.content.application/json.email [Section titled “get.responses.200.content.application/json.email”](#getresponses200contentapplicationjsonemail) > **email**: `string` ###### Description [Section titled “Description”](#description-257) Email address of the user ##### get.responses.200.content.application/json.first\_name [Section titled “get.responses.200.content.application/json.first\_name”](#getresponses200contentapplicationjsonfirst_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-258) First name of the user ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-7) > **id**: `string` ##### get.responses.200.content.application/json.last\_name [Section titled “get.responses.200.content.application/json.last\_name”](#getresponses200contentapplicationjsonlast_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-259) Last name of the user ##### get.responses.200.content.application/json.location\_id? [Section titled “get.responses.200.content.application/json.location\_id?”](#getresponses200contentapplicationjsonlocation_id) > `optional` **location\_id?**: `string` | `null` ##### get.responses.200.content.application/json.manager\_id? [Section titled “get.responses.200.content.application/json.manager\_id?”](#getresponses200contentapplicationjsonmanager_id) > `optional` **manager\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-260) The user id of the manager of this user ##### get.responses.200.content.application/json.metadata? [Section titled “get.responses.200.content.application/json.metadata?”](#getresponses200contentapplicationjsonmetadata-1) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-261) The metadata or customized attributes of the user. Maximum number of entries: 100 ##### get.responses.200.content.application/json.remote\_display\_id? [Section titled “get.responses.200.content.application/json.remote\_display\_id?”](#getresponses200contentapplicationjsonremote_display_id) > `optional` **remote\_display\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-262) Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz ##### get.responses.200.content.application/json.status? [Section titled “get.responses.200.content.application/json.status?”](#getresponses200contentapplicationjsonstatus-2) > `optional` **status?**: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null` ##### get.responses.200.content.application/json.title\_id? [Section titled “get.responses.200.content.application/json.title\_id?”](#getresponses200contentapplicationjsontitle_id) > `optional` **title\_id?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-13) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-23) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-17) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-17) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-17) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-17) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-17) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-17) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-17) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-17) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-17) > `optional` **post?**: `undefined` #### put [Section titled “put”](#put-17) > **put**: `object` Update user ##### Description [Section titled “Description”](#description-263) This endpoint updates a user. Any parameters not provided will be left unchanged. ##### put.parameters [Section titled “put.parameters”](#putparameters-1) > **parameters**: `object` ##### put.parameters.cookie? [Section titled “put.parameters.cookie?”](#putparameterscookie-1) > `optional` **cookie?**: `undefined` ##### put.parameters.header? [Section titled “put.parameters.header?”](#putparametersheader-1) > `optional` **header?**: `object` ##### put.parameters.header.Idempotency-Key? [Section titled “put.parameters.header.Idempotency-Key?”](#putparametersheaderidempotency-key-1) > `optional` **Idempotency-Key?**: `string` | `null` ##### put.parameters.path [Section titled “put.parameters.path”](#putparameterspath-1) > **path**: `object` ##### put.parameters.path.id [Section titled “put.parameters.path.id”](#putparameterspathid-1) > **id**: `string` ##### put.parameters.query? [Section titled “put.parameters.query?”](#putparametersquery-1) > `optional` **query?**: `undefined` ##### put.requestBody [Section titled “put.requestBody”](#putrequestbody-1) > **requestBody**: `object` ##### put.requestBody.content [Section titled “put.requestBody.content”](#putrequestbodycontent-1) > **content**: `object` ##### put.requestBody.content.application/json [Section titled “put.requestBody.content.application/json”](#putrequestbodycontentapplicationjson-1) > **application/json**: `object` ##### put.requestBody.content.application/json.department\_id? [Section titled “put.requestBody.content.application/json.department\_id?”](#putrequestbodycontentapplicationjsondepartment_id) > `optional` **department\_id?**: `string` | `null` ##### put.requestBody.content.application/json.location\_id? [Section titled “put.requestBody.content.application/json.location\_id?”](#putrequestbodycontentapplicationjsonlocation_id) > `optional` **location\_id?**: `string` | `null` ##### put.requestBody.content.application/json.manager\_id? [Section titled “put.requestBody.content.application/json.manager\_id?”](#putrequestbodycontentapplicationjsonmanager_id) > `optional` **manager\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-264) The user id of the manager of this user ##### put.requestBody.content.application/json.metadata? [Section titled “put.requestBody.content.application/json.metadata?”](#putrequestbodycontentapplicationjsonmetadata-1) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-265) The metadata or customized attributes of the user. Maximum number of entries: 100 ##### put.requestBody.content.application/json.status? [Section titled “put.requestBody.content.application/json.status?”](#putrequestbodycontentapplicationjsonstatus) > `optional` **status?**: `"ACTIVE"` | `"DISABLED"` | `null` ##### put.requestBody.content.application/json.title\_id? [Section titled “put.requestBody.content.application/json.title\_id?”](#putrequestbodycontentapplicationjsontitle_id) > `optional` **title\_id?**: `string` | `null` ##### put.responses [Section titled “put.responses”](#putresponses-1) > **responses**: `object` ##### put.responses.200 [Section titled “put.responses.200”](#putresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-266) updateUser 200 response ##### put.responses.200.content [Section titled “put.responses.200.content”](#putresponses200content-1) > **content**: `object` ##### put.responses.200.content.application/json [Section titled “put.responses.200.content.application/json”](#putresponses200contentapplicationjson-1) > **application/json**: `object` ##### put.responses.200.content.application/json.department\_id? [Section titled “put.responses.200.content.application/json.department\_id?”](#putresponses200contentapplicationjsondepartment_id) > `optional` **department\_id?**: `string` | `null` ##### put.responses.200.content.application/json.email [Section titled “put.responses.200.content.application/json.email”](#putresponses200contentapplicationjsonemail) > **email**: `string` ###### Description [Section titled “Description”](#description-267) Email address of the user ##### put.responses.200.content.application/json.first\_name [Section titled “put.responses.200.content.application/json.first\_name”](#putresponses200contentapplicationjsonfirst_name) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-268) First name of the user ##### put.responses.200.content.application/json.id [Section titled “put.responses.200.content.application/json.id”](#putresponses200contentapplicationjsonid-1) > **id**: `string` ##### put.responses.200.content.application/json.last\_name [Section titled “put.responses.200.content.application/json.last\_name”](#putresponses200contentapplicationjsonlast_name) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-269) Last name of the user ##### put.responses.200.content.application/json.location\_id? [Section titled “put.responses.200.content.application/json.location\_id?”](#putresponses200contentapplicationjsonlocation_id) > `optional` **location\_id?**: `string` | `null` ##### put.responses.200.content.application/json.manager\_id? [Section titled “put.responses.200.content.application/json.manager\_id?”](#putresponses200contentapplicationjsonmanager_id) > `optional` **manager\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-270) The user id of the manager of this user ##### put.responses.200.content.application/json.metadata? [Section titled “put.responses.200.content.application/json.metadata?”](#putresponses200contentapplicationjsonmetadata-1) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-271) The metadata or customized attributes of the user. Maximum number of entries: 100 ##### put.responses.200.content.application/json.remote\_display\_id? [Section titled “put.responses.200.content.application/json.remote\_display\_id?”](#putresponses200contentapplicationjsonremote_display_id) > `optional` **remote\_display\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-272) Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz ##### put.responses.200.content.application/json.status? [Section titled “put.responses.200.content.application/json.status?”](#putresponses200contentapplicationjsonstatus-1) > `optional` **status?**: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null` ##### put.responses.200.content.application/json.title\_id? [Section titled “put.responses.200.content.application/json.title\_id?”](#putresponses200contentapplicationjsontitle_id) > `optional` **title\_id?**: `string` | `null` ##### put.responses.200.headers [Section titled “put.responses.200.headers”](#putresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-24) \[`name`: `string`]: `unknown` #### trace? [Section titled “trace?”](#trace-17) > `optional` **trace?**: `undefined` *** ### /v2/users/{id}/limit [Section titled “/v2/users/{id}/limit”](#v2usersidlimit) > **/v2/users/{id}/limit**: `object` Defined in: [src/team/types.gen.ts:401](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L401) #### delete? [Section titled “delete?”](#delete-18) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-18) > **get**: `object` Get limit for the user ##### Description [Section titled “Description”](#description-273) This endpoint gets the monthly limit for the user including the monthly available limit. ##### get.parameters [Section titled “get.parameters”](#getparameters-14) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-14) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-14) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-14) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-7) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-14) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-14) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-14) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-14) > **200**: `object` ###### Description [Section titled “Description”](#description-274) getUserLimit 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-14) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-14) > **application/json**: `object` ##### get.responses.200.content.application/json.monthly\_available? [Section titled “get.responses.200.content.application/json.monthly\_available?”](#getresponses200contentapplicationjsonmonthly_available) > `optional` **monthly\_available?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-28) ###### Type Literal [Section titled “Type Literal”](#type-literal-28) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-13) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-275) 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 [Section titled “Example”](#example-44) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-13) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-276) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-14) ```ts USD ``` ###### Example [Section titled “Example”](#example-45) ```ts USD ``` *** `null` ##### get.responses.200.content.application/json.monthly\_limit? [Section titled “get.responses.200.content.application/json.monthly\_limit?”](#getresponses200contentapplicationjsonmonthly_limit) > `optional` **monthly\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-29) ###### Type Literal [Section titled “Type Literal”](#type-literal-29) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-14) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-277) 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 [Section titled “Example”](#example-46) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-14) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-278) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-15) ```ts USD ``` ###### Example [Section titled “Example”](#example-47) ```ts USD ``` *** `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-14) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-25) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-18) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-18) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-18) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-18) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-18) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-18) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-18) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-18) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-18) > **post**: `object` Set limit for the user ##### Description [Section titled “Description”](#description-279) This endpoint sets the monthly limit for a user. The limit amount must be non-negative. To unset the monthly limit of the user, just set `monthly_limit` to null. ##### post.parameters [Section titled “post.parameters”](#postparameters-9) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-9) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-9) > `optional` **header?**: `object` ##### post.parameters.header.Idempotency-Key? [Section titled “post.parameters.header.Idempotency-Key?”](#postparametersheaderidempotency-key-9) > `optional` **Idempotency-Key?**: `string` | `null` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-9) > **path**: `object` ##### post.parameters.path.id [Section titled “post.parameters.path.id”](#postparameterspathid-4) > **id**: `string` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-9) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-9) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-8) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-8) > **application/json**: `object` ##### post.requestBody.content.application/json.monthly\_limit? [Section titled “post.requestBody.content.application/json.monthly\_limit?”](#postrequestbodycontentapplicationjsonmonthly_limit) > `optional` **monthly\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-30) ###### Type Literal [Section titled “Type Literal”](#type-literal-30) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-15) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-280) 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 [Section titled “Example”](#example-48) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-15) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-281) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-16) ```ts USD ``` ###### Example [Section titled “Example”](#example-49) ```ts USD ``` *** `null` ##### post.responses [Section titled “post.responses”](#postresponses-9) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-9) > **200**: `object` ###### Description [Section titled “Description”](#description-282) setUserLimit 200 response ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-9) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-8) > **application/json**: `object` ##### post.responses.200.content.application/json.monthly\_available? [Section titled “post.responses.200.content.application/json.monthly\_available?”](#postresponses200contentapplicationjsonmonthly_available) > `optional` **monthly\_available?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-31) ###### Type Literal [Section titled “Type Literal”](#type-literal-31) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-16) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-283) 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 [Section titled “Example”](#example-50) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-16) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-284) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-17) ```ts USD ``` ###### Example [Section titled “Example”](#example-51) ```ts USD ``` *** `null` ##### post.responses.200.content.application/json.monthly\_limit? [Section titled “post.responses.200.content.application/json.monthly\_limit?”](#postresponses200contentapplicationjsonmonthly_limit) > `optional` **monthly\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-32) ###### Type Literal [Section titled “Type Literal”](#type-literal-32) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-17) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-285) 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 [Section titled “Example”](#example-52) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-17) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-286) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-18) ```ts USD ``` ###### Example [Section titled “Example”](#example-53) ```ts USD ``` *** `null` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-9) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-26) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-18) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-18) > `optional` **trace?**: `undefined` *** ### /v2/users/me [Section titled “/v2/users/me”](#v2usersme) > **/v2/users/me**: `object` Defined in: [src/team/types.gen.ts:427](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/types.gen.ts#L427) #### delete? [Section titled “delete?”](#delete-19) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-19) > **get**: `object` Get current user ##### Description [Section titled “Description”](#description-287) This endpoint returns the user associated with the OAuth2 access token. ##### get.parameters [Section titled “get.parameters”](#getparameters-15) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-15) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-15) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-15) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-15) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-15) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-15) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-15) > **200**: `object` ###### Description [Section titled “Description”](#description-288) getMe 200 response ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-15) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-15) > **application/json**: `object` ##### get.responses.200.content.application/json.department\_id? [Section titled “get.responses.200.content.application/json.department\_id?”](#getresponses200contentapplicationjsondepartment_id-1) > `optional` **department\_id?**: `string` | `null` ##### get.responses.200.content.application/json.email [Section titled “get.responses.200.content.application/json.email”](#getresponses200contentapplicationjsonemail-1) > **email**: `string` ###### Description [Section titled “Description”](#description-289) Email address of the user ##### get.responses.200.content.application/json.first\_name [Section titled “get.responses.200.content.application/json.first\_name”](#getresponses200contentapplicationjsonfirst_name-1) > **first\_name**: `string` ###### Description [Section titled “Description”](#description-290) First name of the user ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-8) > **id**: `string` ##### get.responses.200.content.application/json.last\_name [Section titled “get.responses.200.content.application/json.last\_name”](#getresponses200contentapplicationjsonlast_name-1) > **last\_name**: `string` ###### Description [Section titled “Description”](#description-291) Last name of the user ##### get.responses.200.content.application/json.location\_id? [Section titled “get.responses.200.content.application/json.location\_id?”](#getresponses200contentapplicationjsonlocation_id-1) > `optional` **location\_id?**: `string` | `null` ##### get.responses.200.content.application/json.manager\_id? [Section titled “get.responses.200.content.application/json.manager\_id?”](#getresponses200contentapplicationjsonmanager_id-1) > `optional` **manager\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-292) The user id of the manager of this user ##### get.responses.200.content.application/json.metadata? [Section titled “get.responses.200.content.application/json.metadata?”](#getresponses200contentapplicationjsonmetadata-2) > `optional` **metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-293) The metadata or customized attributes of the user. Maximum number of entries: 100 ##### get.responses.200.content.application/json.remote\_display\_id? [Section titled “get.responses.200.content.application/json.remote\_display\_id?”](#getresponses200contentapplicationjsonremote_display_id-1) > `optional` **remote\_display\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-294) Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz ##### get.responses.200.content.application/json.status? [Section titled “get.responses.200.content.application/json.status?”](#getresponses200contentapplicationjsonstatus-3) > `optional` **status?**: `"ACTIVE"` | `"DISABLED"` | `"ARCHIVED"` | `"DELETED"` | `"INACTIVE"` | `"INVITED"` | `"PENDING_ACTIVATION"` | `"CLOSED"` | `null` ##### get.responses.200.content.application/json.title\_id? [Section titled “get.responses.200.content.application/json.title\_id?”](#getresponses200contentapplicationjsontitle_id-1) > `optional` **title\_id?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-15) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-27) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-19) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-19) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-19) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-19) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-19) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-19) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-19) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-19) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-19) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-19) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-19) > `optional` **trace?**: `undefined` # AccountType > **AccountType** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"AccountType"`] Defined in: [src/team/schemas.gen.ts:5](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L5) # Address > **Address** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"Address"`] Defined in: [src/team/schemas.gen.ts:6](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L6) # Card > **Card** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"Card"`] Defined in: [src/team/schemas.gen.ts:7](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L7) # CardAttributePreferences > **CardAttributePreferences** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"CardAttributePreferences"`] Defined in: [src/team/schemas.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L8) # CardExpiration > **CardExpiration** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"CardExpiration"`] Defined in: [src/team/schemas.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L9) # CardNumberResponse > **CardNumberResponse** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"CardNumberResponse"`] Defined in: [src/team/schemas.gen.ts:10](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L10) # CardOwner > **CardOwner** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"CardOwner"`] Defined in: [src/team/schemas.gen.ts:11](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L11) # CardStatus > **CardStatus** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"CardStatus"`] Defined in: [src/team/schemas.gen.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L12) # CardType > **CardType** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"CardType"`] Defined in: [src/team/schemas.gen.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L13) # ChangeCardReason > **ChangeCardReason** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"ChangeCardReason"`] Defined in: [src/team/schemas.gen.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L14) # CompanyResponse > **CompanyResponse** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"CompanyResponse"`] Defined in: [src/team/schemas.gen.ts:15](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L15) # CreateCardRequest > **CreateCardRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"CreateCardRequest"`] Defined in: [src/team/schemas.gen.ts:16](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L16) # CreateDepartmentRequest > **CreateDepartmentRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"CreateDepartmentRequest"`] Defined in: [src/team/schemas.gen.ts:17](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L17) # CreateLocationRequest > **CreateLocationRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"CreateLocationRequest"`] Defined in: [src/team/schemas.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L18) # CreateTitleRequest > **CreateTitleRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"CreateTitleRequest"`] Defined in: [src/team/schemas.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L19) # CreateUserRequest > **CreateUserRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"CreateUserRequest"`] Defined in: [src/team/schemas.gen.ts:20](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L20) # DepartmentResponse > **DepartmentResponse** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"DepartmentResponse"`] Defined in: [src/team/schemas.gen.ts:21](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L21) # LegalEntity > **LegalEntity** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"LegalEntity"`] Defined in: [src/team/schemas.gen.ts:22](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L22) # LegalEntityStatus > **LegalEntityStatus** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"LegalEntityStatus"`] Defined in: [src/team/schemas.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L23) # LimitType > **LimitType** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"LimitType"`] Defined in: [src/team/schemas.gen.ts:24](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L24) # LocationResponse > **LocationResponse** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"LocationResponse"`] Defined in: [src/team/schemas.gen.ts:25](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L25) # LockCardRequest > **LockCardRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"LockCardRequest"`] Defined in: [src/team/schemas.gen.ts:26](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L26) # LockedMerchantDetails > **LockedMerchantDetails** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"LockedMerchantDetails"`] Defined in: [src/team/schemas.gen.ts:27](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L27) # Money > **Money** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"Money"`] Defined in: [src/team/schemas.gen.ts:28](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L28) # OwnerType > **OwnerType** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"OwnerType"`] Defined in: [src/team/schemas.gen.ts:29](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L29) # Page_Card_ > **Page\_Card\_** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"Page_Card_"`] Defined in: [src/team/schemas.gen.ts:30](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L30) # Page_DepartmentResponse_ > **Page\_DepartmentResponse\_** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"Page_DepartmentResponse_"`] Defined in: [src/team/schemas.gen.ts:31](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L31) # Page_LegalEntity_ > **Page\_LegalEntity\_** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"Page_LegalEntity_"`] Defined in: [src/team/schemas.gen.ts:32](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L32) # Page_LocationResponse_ > **Page\_LocationResponse\_** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"Page_LocationResponse_"`] Defined in: [src/team/schemas.gen.ts:33](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L33) # Page_TitleResponse_ > **Page\_TitleResponse\_** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"Page_TitleResponse_"`] Defined in: [src/team/schemas.gen.ts:34](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L34) # Page_UserResponse_ > **Page\_UserResponse\_** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"Page_UserResponse_"`] Defined in: [src/team/schemas.gen.ts:35](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L35) # SecureEmailForCardDetailsRequest > **SecureEmailForCardDetailsRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"SecureEmailForCardDetailsRequest"`] Defined in: [src/team/schemas.gen.ts:36](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L36) # SetUserLimitRequest > **SetUserLimitRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"SetUserLimitRequest"`] Defined in: [src/team/schemas.gen.ts:38](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L38) # SpendControl > **SpendControl** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"SpendControl"`] Defined in: [src/team/schemas.gen.ts:39](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L39) # SpendControlRequest > **SpendControlRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"SpendControlRequest"`] Defined in: [src/team/schemas.gen.ts:40](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L40) # SpendControlUpdateRequest > **SpendControlUpdateRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"SpendControlUpdateRequest"`] Defined in: [src/team/schemas.gen.ts:41](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L41) # SpendDuration > **SpendDuration** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"SpendDuration"`] Defined in: [src/team/schemas.gen.ts:42](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L42) # TerminateCardRequest > **TerminateCardRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"TerminateCardRequest"`] Defined in: [src/team/schemas.gen.ts:43](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L43) # ThreeDomainSecureEnabledPreference > **ThreeDomainSecureEnabledPreference** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"ThreeDomainSecureEnabledPreference"`] Defined in: [src/team/schemas.gen.ts:44](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L44) # TitleResponse > **TitleResponse** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"TitleResponse"`] Defined in: [src/team/schemas.gen.ts:46](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L46) # UpdateCardRequest > **UpdateCardRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"UpdateCardRequest"`] Defined in: [src/team/schemas.gen.ts:47](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L47) # UpdateUserRequest > **UpdateUserRequest** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"UpdateUserRequest"`] Defined in: [src/team/schemas.gen.ts:48](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L48) # UpdateUserStatus > **UpdateUserStatus** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"UpdateUserStatus"`] Defined in: [src/team/schemas.gen.ts:49](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L49) # UserLimitResponse > **UserLimitResponse** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"UserLimitResponse"`] Defined in: [src/team/schemas.gen.ts:50](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L50) # UserOwner > **UserOwner** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"UserOwner"`] Defined in: [src/team/schemas.gen.ts:51](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L51) # UserResponse > **UserResponse** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"UserResponse"`] Defined in: [src/team/schemas.gen.ts:52](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L52) # UserStatus > **UserStatus** = [`TeamComponents`](/brex/api/team/interfaces/teamcomponents/)\[`"schemas"`]\[`"UserStatus"`] Defined in: [src/team/schemas.gen.ts:53](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/team/schemas.gen.ts#L53) # Accounts Defined in: [src/transactions/client.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L8) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Accounts**(`_core`): `Accounts` Defined in: [src/transactions/client.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L9) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Accounts` ## Methods [Section titled “Methods”](#methods) ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `account_number`: `string`; `available_balance`: { `amount`: `number`; `currency`: `string` | `null`; }; `current_balance`: { `amount`: `number`; `currency`: `string` | `null`; }; `id`: `string`; `name`: `string`; `primary`: `boolean`; `routing_number`: `string`; `status?`: `"ACTIVE"` | `null`; }> Defined in: [src/transactions/client.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L18) Get cash account by ID This endpoint returns the cash account associated with the provided ID with its status. `GET /v2/accounts/cash/{id}` — requires OAuth scope: `accounts.cash.readonly` #### Parameters [Section titled “Parameters”](#parameters-1) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `account_number`: `string`; `available_balance`: { `amount`: `number`; `currency`: `string` | `null`; }; `current_balance`: { `amount`: `number`; `currency`: `string` | `null`; }; `id`: `string`; `name`: `string`; `primary`: `boolean`; `routing_number`: `string`; `status?`: `"ACTIVE"` | `null`; }> *** ### getPrimary() [Section titled “getPrimary()”](#getprimary) > **getPrimary**(`options?`): `Promise`<{ `account_number`: `string`; `available_balance`: { `amount`: `number`; `currency`: `string` | `null`; }; `current_balance`: { `amount`: `number`; `currency`: `string` | `null`; }; `id`: `string`; `name`: `string`; `primary`: `boolean`; `routing_number`: `string`; `status?`: `"ACTIVE"` | `null`; }> Defined in: [src/transactions/client.gen.ts:36](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L36) Get primary cash account This endpoint returns the primary cash account with its status. There will always be only one primary account. `GET /v2/accounts/cash/primary` — requires OAuth scope: `accounts.cash.readonly` #### Parameters [Section titled “Parameters”](#parameters-2) ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `account_number`: `string`; `available_balance`: { `amount`: `number`; `currency`: `string` | `null`; }; `current_balance`: { `amount`: `number`; `currency`: `string` | `null`; }; `id`: `string`; `name`: `string`; `primary`: `boolean`; `routing_number`: `string`; `status?`: `"ACTIVE"` | `null`; }> *** ### list() [Section titled “list()”](#list) > **list**(`options?`): `Promise`<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/transactions/client.gen.ts:53](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L53) List cash accounts This endpoint lists all the existing cash accounts with their status. `GET /v2/accounts/cash` — requires OAuth scope: `accounts.cash.readonly` #### Parameters [Section titled “Parameters”](#parameters-3) ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### listCard() [Section titled “listCard()”](#listcard) > **listCard**(`options?`): `Promise`<`object`\[]> Defined in: [src/transactions/client.gen.ts:70](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L70) List card accounts This endpoint lists all accounts of card type. `GET /v2/accounts/card` — requires OAuth scope: `accounts.card.readonly` #### Parameters [Section titled “Parameters”](#parameters-4) ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) `Promise`<`object`\[]> *** ### listCashStatements() [Section titled “listCashStatements()”](#listcashstatements) > **listCashStatements**(`id`, `query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/transactions/client.gen.ts:88](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L88) List cash account statements. This endpoint lists all finalized statements for the cash account by ID. `GET /v2/accounts/cash/{id}/statements` — requires OAuth scope: `statements.cash.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-5) ##### id [Section titled “id”](#id-1) `string` ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ##### options? [Section titled “options?”](#options-4) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-5) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### listPrimaryCardStatements() [Section titled “listPrimaryCardStatements()”](#listprimarycardstatements) > **listPrimaryCardStatements**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/transactions/client.gen.ts:108](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L108) List primary card account statements. This endpoint lists all finalized statements for the primary card account. `GET /v2/accounts/card/primary/statements` — requires OAuth scope: `statements.card.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-6) ##### query? [Section titled “query?”](#query-1) ###### cursor? [Section titled “cursor?”](#cursor-1) `string` | `null` ###### limit? [Section titled “limit?”](#limit-1) `number` | `null` ##### options? [Section titled “options?”](#options-5) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-6) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> # BrexTransactions Defined in: [src/transactions/client.gen.ts:164](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L164) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BrexTransactions**(`core`): `BrexTransactions` Defined in: [src/transactions/client.gen.ts:167](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L167) #### Parameters [Section titled “Parameters”](#parameters) ##### core [Section titled “core”](#core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `BrexTransactions` ## Properties [Section titled “Properties”](#properties) ### accounts [Section titled “accounts”](#accounts) > `readonly` **accounts**: [`Accounts`](/brex/api/transactions/classes/accounts/) Defined in: [src/transactions/client.gen.ts:165](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L165) *** ### transactions [Section titled “transactions”](#transactions) > `readonly` **transactions**: [`Transactions`](/brex/api/transactions/classes/transactions/) Defined in: [src/transactions/client.gen.ts:166](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L166) # Transactions Defined in: [src/transactions/client.gen.ts:120](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L120) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Transactions**(`_core`): `Transactions` Defined in: [src/transactions/client.gen.ts:121](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L121) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Transactions` ## Methods [Section titled “Methods”](#methods) ### listCash() [Section titled “listCash()”](#listcash) > **listCash**(`id`, `query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/transactions/client.gen.ts:131](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L131) List transactions for the selected cash account. This endpoint lists all transactions for the cash account with the selected ID. `GET /v2/transactions/cash/{id}` — requires OAuth scope: `transactions.cash.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-1) ##### id [Section titled “id”](#id) `string` ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ###### posted\_at\_start? [Section titled “posted\_at\_start?”](#posted_at_start) `string` | `null` **Description** Shows only transactions with a `posted_at_date` 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) **Example** ```ts 2022-12-12T23:59:59.999 ``` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### listPrimaryCard() [Section titled “listPrimaryCard()”](#listprimarycard) > **listPrimaryCard**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/transactions/client.gen.ts:152](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/client.gen.ts#L152) List transactions for all card accounts. This endpoint lists all settled transactions for all card accounts. Regular users may only fetch their own “PURCHASE”,“REFUND” and “CHARGEBACK” settled transactions. `GET /v2/transactions/card/primary` — requires OAuth scope: `transactions.card.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-2) ##### query? [Section titled “query?”](#query-1) ###### cursor? [Section titled “cursor?”](#cursor-1) `string` | `null` ###### expand\[]? [Section titled “expand\[\]?”](#expand) `string`\[] | `null` ###### limit? [Section titled “limit?”](#limit-1) `number` | `null` ###### posted\_at\_start? [Section titled “posted\_at\_start?”](#posted_at_start-1) `string` | `null` **Description** Shows only transactions with a `posted_at_date` 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) **Example** ```ts 2022-12-12T23:59:59.999 ``` ###### user\_ids? [Section titled “user\_ids?”](#user_ids) `string`\[] | `null` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> # createTransactionsClient > **createTransactionsClient**(`options`): [`BrexTransactions`](/brex/api/transactions/classes/brextransactions/) Defined in: [src/transactions/index.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/index.ts#L13) Standalone client for the Brex Transactions API. ## Parameters [Section titled “Parameters”](#parameters) ### options [Section titled “options”](#options) [`BrexOptions`](/brex/api/index/interfaces/brexoptions/) ## Returns [Section titled “Returns”](#returns) [`BrexTransactions`](/brex/api/transactions/classes/brextransactions/) # TransactionsComponents Defined in: [src/transactions/types.gen.ts:166](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L166) ## Properties [Section titled “Properties”](#properties) ### headers [Section titled “headers”](#headers) > **headers**: `never` Defined in: [src/transactions/types.gen.ts:333](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L333) *** ### parameters [Section titled “parameters”](#parameters) > **parameters**: `never` Defined in: [src/transactions/types.gen.ts:331](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L331) *** ### pathItems [Section titled “pathItems”](#pathitems) > **pathItems**: `never` Defined in: [src/transactions/types.gen.ts:334](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L334) *** ### requestBodies [Section titled “requestBodies”](#requestbodies) > **requestBodies**: `never` Defined in: [src/transactions/types.gen.ts:332](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L332) *** ### responses [Section titled “responses”](#responses) > **responses**: `never` Defined in: [src/transactions/types.gen.ts:330](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L330) *** ### schemas [Section titled “schemas”](#schemas) > **schemas**: `object` Defined in: [src/transactions/types.gen.ts:167](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L167) #### CardAccount [Section titled “CardAccount”](#cardaccount) > **CardAccount**: `object` ##### CardAccount.account\_limit? [Section titled “CardAccount.account\_limit?”](#cardaccountaccount_limit) > `optional` **account\_limit?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#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 [Section titled “Example”](#example) ```ts 700 ``` ###### currency [Section titled “currency”](#currency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-1) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default) ```ts USD ``` ###### Example [Section titled “Example”](#example-1) ```ts USD ``` *** `null` ##### CardAccount.available\_balance? [Section titled “CardAccount.available\_balance?”](#cardaccountavailable_balance) > `optional` **available\_balance?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-2) 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 [Section titled “Example”](#example-2) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-3) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-1) ```ts USD ``` ###### Example [Section titled “Example”](#example-3) ```ts USD ``` *** `null` ##### CardAccount.current\_balance? [Section titled “CardAccount.current\_balance?”](#cardaccountcurrent_balance) > `optional` **current\_balance?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-2) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-4) 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 [Section titled “Example”](#example-4) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-2) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-5) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-2) ```ts USD ``` ###### Example [Section titled “Example”](#example-5) ```ts USD ``` *** `null` ##### CardAccount.current\_statement\_period [Section titled “CardAccount.current\_statement\_period”](#cardaccountcurrent_statement_period) > **current\_statement\_period**: `object` ##### CardAccount.current\_statement\_period.end\_date [Section titled “CardAccount.current\_statement\_period.end\_date”](#cardaccountcurrent_statement_periodend_date) > **end\_date**: `string` Format: date ###### Description [Section titled “Description”](#description-6) End date of the statement period at UTC 00:00:00 (exclusive) ##### CardAccount.current\_statement\_period.start\_date [Section titled “CardAccount.current\_statement\_period.start\_date”](#cardaccountcurrent_statement_periodstart_date) > **start\_date**: `string` Format: date ###### Description [Section titled “Description”](#description-7) Start date of the statement period at UTC 00:00:00 (inclusive) ##### CardAccount.id [Section titled “CardAccount.id”](#cardaccountid) > **id**: `string` ###### Description [Section titled “Description”](#description-8) ID of the card account ##### CardAccount.status? [Section titled “CardAccount.status?”](#cardaccountstatus) > `optional` **status?**: `"ACTIVE"` | `null` #### CardTransaction [Section titled “CardTransaction”](#cardtransaction) > **CardTransaction**: `object` ##### CardTransaction.amount [Section titled “CardTransaction.amount”](#cardtransactionamount) > **amount**: `object` ##### CardTransaction.amount.amount [Section titled “CardTransaction.amount.amount”](#cardtransactionamountamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-9) 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 [Section titled “Example”](#example-6) ```ts 700 ``` ##### CardTransaction.amount.currency [Section titled “CardTransaction.amount.currency”](#cardtransactionamountcurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-10) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-3) ```ts USD ``` ###### Example [Section titled “Example”](#example-7) ```ts USD ``` ##### CardTransaction.card\_id? [Section titled “CardTransaction.card\_id?”](#cardtransactioncard_id) > `optional` **card\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-11) ID of the card used for the transaction. Null when type is REWARDS\_CREDIT or COLLECTION. ##### CardTransaction.card\_metadata? [Section titled “CardTransaction.card\_metadata?”](#cardtransactioncard_metadata) > `optional` **card\_metadata?**: {\[`key`: `string`]: `string`; } | `null` ###### Description [Section titled “Description”](#description-12) Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. ##### CardTransaction.card\_transaction\_operation\_reference\_id? [Section titled “CardTransaction.card\_transaction\_operation\_reference\_id?”](#cardtransactioncard_transaction_operation_reference_id) > `optional` **card\_transaction\_operation\_reference\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-13) The card transaction operation reference ID. Null when type is REWARDS\_CREDIT, COLLECTION, or BNPL\_FEE. ##### CardTransaction.description [Section titled “CardTransaction.description”](#cardtransactiondescription) > **description**: `string` ###### Description [Section titled “Description”](#description-14) Description of the transaction ##### CardTransaction.expense\_id? [Section titled “CardTransaction.expense\_id?”](#cardtransactionexpense_id) > `optional` **expense\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-15) The expense ID related to the card transaction. ##### CardTransaction.id [Section titled “CardTransaction.id”](#cardtransactionid) > **id**: `string` ##### CardTransaction.initiated\_at\_date [Section titled “CardTransaction.initiated\_at\_date”](#cardtransactioninitiated_at_date) > **initiated\_at\_date**: `string` Format: date ###### Description [Section titled “Description”](#description-16) ISO 8601 date string ##### CardTransaction.merchant? [Section titled “CardTransaction.merchant?”](#cardtransactionmerchant) > `optional` **merchant?**: { `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-3) ###### Type Literal [Section titled “Type Literal”](#type-literal-3) { `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; } ###### country [Section titled “country”](#country) > **country**: `string` ###### Description [Section titled “Description”](#description-17) Merchant’s country, in ISO 3166-1 alpha-3 format. ###### mcc [Section titled “mcc”](#mcc) > **mcc**: `string` ###### Description [Section titled “Description”](#description-18) A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to for more details. ###### raw\_descriptor [Section titled “raw\_descriptor”](#raw_descriptor) > **raw\_descriptor**: `string` ###### Description [Section titled “Description”](#description-19) Merchant descriptor, it can be the merchant name. *** `null` ##### CardTransaction.posted\_at\_date [Section titled “CardTransaction.posted\_at\_date”](#cardtransactionposted_at_date) > **posted\_at\_date**: `string` Format: date ###### Description [Section titled “Description”](#description-20) ISO 8601 date string ##### CardTransaction.type? [Section titled “CardTransaction.type?”](#cardtransactiontype) > `optional` **type?**: `"PURCHASE"` | `"REFUND"` | `"CHARGEBACK"` | `"REWARDS_CREDIT"` | `"COLLECTION"` | `"BNPL_FEE"` | `null` #### CardTransactionType [Section titled “CardTransactionType”](#cardtransactiontype-1) > **CardTransactionType**: `"PURCHASE"` | `"REFUND"` | `"CHARGEBACK"` | `"REWARDS_CREDIT"` | `"COLLECTION"` | `"BNPL_FEE"` #### CashAccount [Section titled “CashAccount”](#cashaccount) > **CashAccount**: `object` ##### CashAccount.account\_number [Section titled “CashAccount.account\_number”](#cashaccountaccount_number) > **account\_number**: `string` ##### CashAccount.available\_balance [Section titled “CashAccount.available\_balance”](#cashaccountavailable_balance) > **available\_balance**: `object` ##### CashAccount.available\_balance.amount [Section titled “CashAccount.available\_balance.amount”](#cashaccountavailable_balanceamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-21) 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 [Section titled “Example”](#example-8) ```ts 700 ``` ##### CashAccount.available\_balance.currency [Section titled “CashAccount.available\_balance.currency”](#cashaccountavailable_balancecurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-22) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-4) ```ts USD ``` ###### Example [Section titled “Example”](#example-9) ```ts USD ``` ##### CashAccount.current\_balance [Section titled “CashAccount.current\_balance”](#cashaccountcurrent_balance) > **current\_balance**: `object` ##### CashAccount.current\_balance.amount [Section titled “CashAccount.current\_balance.amount”](#cashaccountcurrent_balanceamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-23) 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 [Section titled “Example”](#example-10) ```ts 700 ``` ##### CashAccount.current\_balance.currency [Section titled “CashAccount.current\_balance.currency”](#cashaccountcurrent_balancecurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-24) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-5) ```ts USD ``` ###### Example [Section titled “Example”](#example-11) ```ts USD ``` ##### CashAccount.id [Section titled “CashAccount.id”](#cashaccountid) > **id**: `string` ###### Description [Section titled “Description”](#description-25) ID of the cash account ##### CashAccount.name [Section titled “CashAccount.name”](#cashaccountname) > **name**: `string` ##### CashAccount.primary [Section titled “CashAccount.primary”](#cashaccountprimary) > **primary**: `boolean` ###### Description [Section titled “Description”](#description-26) Whether or not this account is the primary account. There will always be only one primary account. ##### CashAccount.routing\_number [Section titled “CashAccount.routing\_number”](#cashaccountrouting_number) > **routing\_number**: `string` ##### CashAccount.status? [Section titled “CashAccount.status?”](#cashaccountstatus) > `optional` **status?**: `"ACTIVE"` | `null` #### CashTransaction [Section titled “CashTransaction”](#cashtransaction) > **CashTransaction**: `object` ##### CashTransaction.amount? [Section titled “CashTransaction.amount?”](#cashtransactionamount) > `optional` **amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-4) ###### Type Literal [Section titled “Type Literal”](#type-literal-4) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-3) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-27) 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 [Section titled “Example”](#example-12) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-3) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-28) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-6) ```ts USD ``` ###### Example [Section titled “Example”](#example-13) ```ts USD ``` *** `null` ##### CashTransaction.description [Section titled “CashTransaction.description”](#cashtransactiondescription) > **description**: `string` ###### Description [Section titled “Description”](#description-29) Description of the transaction ##### CashTransaction.id [Section titled “CashTransaction.id”](#cashtransactionid) > **id**: `string` ##### CashTransaction.initiated\_at\_date [Section titled “CashTransaction.initiated\_at\_date”](#cashtransactioninitiated_at_date) > **initiated\_at\_date**: `string` Format: date ###### Description [Section titled “Description”](#description-30) ISO 8601 date of when the payment is initiated ##### CashTransaction.posted\_at\_date [Section titled “CashTransaction.posted\_at\_date”](#cashtransactionposted_at_date) > **posted\_at\_date**: `string` Format: date ###### Description [Section titled “Description”](#description-31) ISO 8601 date of when the payment is posted ##### CashTransaction.transfer\_id? [Section titled “CashTransaction.transfer\_id?”](#cashtransactiontransfer_id) > `optional` **transfer\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-32) Transfer ID to fetch additional metadata about the transaction using `https://developer.brex.com/openapi/payments_api/#operation/getTransfersById` ##### CashTransaction.type? [Section titled “CashTransaction.type?”](#cashtransactiontype) > `optional` **type?**: `"BOOK_TRANSFER"` | `"STABLECOIN"` | `"PAYMENT"` | `"DIVIDEND"` | `"FEE"` | `"ADJUSTMENT"` | `"INTEREST"` | `"CARD_COLLECTION"` | `"REWARDS_REDEMPTION"` | `"RECEIVABLES_OFFERS_ADVANCE"` | `"FBO_TRANSFER"` | `"RECEIVABLES_OFFERS_REPAYMENT"` | `"RECEIVABLES_OFFERS_COLLECTION"` | `"BREX_OPERATIONAL_TRANSFER"` | `"INTRA_CUSTOMER_ACCOUNT_BOOK_TRANSFER"` | `"CRYPTO_BRIDGE"` | `"TRANSACTION_FEES_COLLECTION"` | `"PAYBACK"` | `null` #### CashTransactionType [Section titled “CashTransactionType”](#cashtransactiontype-1) > **CashTransactionType**: `"BOOK_TRANSFER"` | `"STABLECOIN"` | `"PAYMENT"` | `"DIVIDEND"` | `"FEE"` | `"ADJUSTMENT"` | `"INTEREST"` | `"CARD_COLLECTION"` | `"REWARDS_REDEMPTION"` | `"RECEIVABLES_OFFERS_ADVANCE"` | `"FBO_TRANSFER"` | `"RECEIVABLES_OFFERS_REPAYMENT"` | `"RECEIVABLES_OFFERS_COLLECTION"` | `"BREX_OPERATIONAL_TRANSFER"` | `"INTRA_CUSTOMER_ACCOUNT_BOOK_TRANSFER"` | `"CRYPTO_BRIDGE"` | `"TRANSACTION_FEES_COLLECTION"` | `"PAYBACK"` #### Merchant [Section titled “Merchant”](#merchant) > **Merchant**: `object` ##### Merchant.country [Section titled “Merchant.country”](#merchantcountry) > **country**: `string` ###### Description [Section titled “Description”](#description-33) Merchant’s country, in ISO 3166-1 alpha-3 format. ##### Merchant.mcc [Section titled “Merchant.mcc”](#merchantmcc) > **mcc**: `string` ###### Description [Section titled “Description”](#description-34) A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to for more details. ##### Merchant.raw\_descriptor [Section titled “Merchant.raw\_descriptor”](#merchantraw_descriptor) > **raw\_descriptor**: `string` ###### Description [Section titled “Description”](#description-35) Merchant descriptor, it can be the merchant name. #### Money [Section titled “Money”](#money) > **Money**: `object` ##### Description [Section titled “Description”](#description-36) Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700. ##### Money.amount [Section titled “Money.amount”](#moneyamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-37) 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 [Section titled “Example”](#example-14) ```ts 700 ``` ##### Money.currency [Section titled “Money.currency”](#moneycurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-38) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-7) ```ts USD ``` ###### Example [Section titled “Example”](#example-15) ```ts USD ``` #### Page\_CardTransaction\_ [Section titled “Page\_CardTransaction\_”](#page_cardtransaction_) > **Page\_CardTransaction\_**: `object` ##### Page\_CardTransaction\_.items [Section titled “Page\_CardTransaction\_.items”](#page_cardtransaction_items) > **items**: `object`\[] ##### Page\_CardTransaction\_.next\_cursor? [Section titled “Page\_CardTransaction\_.next\_cursor?”](#page_cardtransaction_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_CashAccount\_ [Section titled “Page\_CashAccount\_”](#page_cashaccount_) > **Page\_CashAccount\_**: `object` ##### Page\_CashAccount\_.items [Section titled “Page\_CashAccount\_.items”](#page_cashaccount_items) > **items**: `object`\[] ##### Page\_CashAccount\_.next\_cursor? [Section titled “Page\_CashAccount\_.next\_cursor?”](#page_cashaccount_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_CashTransaction\_ [Section titled “Page\_CashTransaction\_”](#page_cashtransaction_) > **Page\_CashTransaction\_**: `object` ##### Page\_CashTransaction\_.items [Section titled “Page\_CashTransaction\_.items”](#page_cashtransaction_items) > **items**: `object`\[] ##### Page\_CashTransaction\_.next\_cursor? [Section titled “Page\_CashTransaction\_.next\_cursor?”](#page_cashtransaction_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_Statement\_ [Section titled “Page\_Statement\_”](#page_statement_) > **Page\_Statement\_**: `object` ##### Page\_Statement\_.items [Section titled “Page\_Statement\_.items”](#page_statement_items) > **items**: `object`\[] ##### Page\_Statement\_.next\_cursor? [Section titled “Page\_Statement\_.next\_cursor?”](#page_statement_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Statement [Section titled “Statement”](#statement) > **Statement**: `object` ##### Statement.end\_balance? [Section titled “Statement.end\_balance?”](#statementend_balance) > `optional` **end\_balance?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-5) ###### Type Literal [Section titled “Type Literal”](#type-literal-5) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-4) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-39) 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 [Section titled “Example”](#example-16) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-4) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-40) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-8) ```ts USD ``` ###### Example [Section titled “Example”](#example-17) ```ts USD ``` *** `null` ##### Statement.id [Section titled “Statement.id”](#statementid) > **id**: `string` ##### Statement.period [Section titled “Statement.period”](#statementperiod) > **period**: `object` ##### Statement.period.end\_date [Section titled “Statement.period.end\_date”](#statementperiodend_date) > **end\_date**: `string` Format: date ###### Description [Section titled “Description”](#description-41) End date of the statement period at UTC 00:00:00 (exclusive) ##### Statement.period.start\_date [Section titled “Statement.period.start\_date”](#statementperiodstart_date) > **start\_date**: `string` Format: date ###### Description [Section titled “Description”](#description-42) Start date of the statement period at UTC 00:00:00 (inclusive) ##### Statement.start\_balance? [Section titled “Statement.start\_balance?”](#statementstart_balance) > `optional` **start\_balance?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-6) ###### Type Literal [Section titled “Type Literal”](#type-literal-6) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-5) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-43) 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 [Section titled “Example”](#example-18) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-5) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-44) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-9) ```ts USD ``` ###### Example [Section titled “Example”](#example-19) ```ts USD ``` *** `null` #### StatementPeriod [Section titled “StatementPeriod”](#statementperiod-1) > **StatementPeriod**: `object` ##### StatementPeriod.end\_date [Section titled “StatementPeriod.end\_date”](#statementperiodend_date-1) > **end\_date**: `string` Format: date ###### Description [Section titled “Description”](#description-45) End date of the statement period at UTC 00:00:00 (exclusive) ##### StatementPeriod.start\_date [Section titled “StatementPeriod.start\_date”](#statementperiodstart_date-1) > **start\_date**: `string` Format: date ###### Description [Section titled “Description”](#description-46) Start date of the statement period at UTC 00:00:00 (inclusive) #### Status [Section titled “Status”](#status) > **Status**: `"ACTIVE"` # TransactionsPaths Defined in: [src/transactions/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L2) ## Properties [Section titled “Properties”](#properties) ### /v2/accounts/card [Section titled “/v2/accounts/card”](#v2accountscard) > **/v2/accounts/card**: `object` Defined in: [src/transactions/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L3) #### delete? [Section titled “delete?”](#delete) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get) > **get**: `object` List card accounts ##### Description [Section titled “Description”](#description) This endpoint lists all accounts of card type. ##### get.parameters [Section titled “get.parameters”](#getparameters) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-1) Returns a list of card accounts. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson) > **application/json**: `object`\[] ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-2) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-1) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-3) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-2) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-4) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-3) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace) > `optional` **trace?**: `undefined` *** ### /v2/accounts/card/primary/statements [Section titled “/v2/accounts/card/primary/statements”](#v2accountscardprimarystatements) > **/v2/accounts/card/primary/statements**: `object` Defined in: [src/transactions/types.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L23) #### delete? [Section titled “delete?”](#delete-1) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-1) > **get**: `object` List primary card account statements. ##### Description [Section titled “Description”](#description-5) This endpoint lists all finalized statements for the primary card account. ##### get.parameters [Section titled “get.parameters”](#getparameters-1) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-1) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-1) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-1) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-1) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit) > `optional` **limit?**: `number` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-1) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-1) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-6) Returns a list of primary card account statements. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-1) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-1) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-4) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-7) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-1) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-5) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-8) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-1) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-6) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-9) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-1) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-7) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-1) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-1) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-1) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-1) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-1) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-1) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-1) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-1) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-1) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-1) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-1) > `optional` **trace?**: `undefined` *** ### /v2/accounts/cash [Section titled “/v2/accounts/cash”](#v2accountscash) > **/v2/accounts/cash**: `object` Defined in: [src/transactions/types.gen.ts:43](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L43) #### delete? [Section titled “delete?”](#delete-2) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-2) > **get**: `object` List cash accounts ##### Description [Section titled “Description”](#description-10) This endpoint lists all the existing cash accounts with their status. ##### get.parameters [Section titled “get.parameters”](#getparameters-2) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-2) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-2) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-2) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-2) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-2) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-2) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-11) Returns a list of cash accounts. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-2) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-2) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-1) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-1) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-8) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-2) > **400**: `object` ###### Description [Section titled “Description”](#description-12) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-2) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-9) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-2) > **401**: `object` ###### Description [Section titled “Description”](#description-13) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-2) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-10) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-2) > **403**: `object` ###### Description [Section titled “Description”](#description-14) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-2) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-11) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-2) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-2) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-2) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-2) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-2) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-2) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-2) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-2) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-2) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-2) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-2) > `optional` **trace?**: `undefined` *** ### /v2/accounts/cash/{id} [Section titled “/v2/accounts/cash/{id}”](#v2accountscashid) > **/v2/accounts/cash/{id}**: `object` Defined in: [src/transactions/types.gen.ts:63](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L63) #### delete? [Section titled “delete?”](#delete-3) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-3) > **get**: `object` Get cash account by ID ##### Description [Section titled “Description”](#description-15) This endpoint returns the cash account associated with the provided ID with its status. ##### get.parameters [Section titled “get.parameters”](#getparameters-3) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-3) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-3) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-3) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-3) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-3) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-3) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-3) > **200**: `object` ###### Description [Section titled “Description”](#description-16) Returns the cash account. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-3) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-3) > **application/json**: `object` ##### get.responses.200.content.application/json.account\_number [Section titled “get.responses.200.content.application/json.account\_number”](#getresponses200contentapplicationjsonaccount_number) > **account\_number**: `string` ##### get.responses.200.content.application/json.available\_balance [Section titled “get.responses.200.content.application/json.available\_balance”](#getresponses200contentapplicationjsonavailable_balance) > **available\_balance**: `object` ##### get.responses.200.content.application/json.available\_balance.amount [Section titled “get.responses.200.content.application/json.available\_balance.amount”](#getresponses200contentapplicationjsonavailable_balanceamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-17) 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 [Section titled “Example”](#example) ```ts 700 ``` ##### get.responses.200.content.application/json.available\_balance.currency [Section titled “get.responses.200.content.application/json.available\_balance.currency”](#getresponses200contentapplicationjsonavailable_balancecurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-18) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default) ```ts USD ``` ###### Example [Section titled “Example”](#example-1) ```ts USD ``` ##### get.responses.200.content.application/json.current\_balance [Section titled “get.responses.200.content.application/json.current\_balance”](#getresponses200contentapplicationjsoncurrent_balance) > **current\_balance**: `object` ##### get.responses.200.content.application/json.current\_balance.amount [Section titled “get.responses.200.content.application/json.current\_balance.amount”](#getresponses200contentapplicationjsoncurrent_balanceamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-19) 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 [Section titled “Example”](#example-2) ```ts 700 ``` ##### get.responses.200.content.application/json.current\_balance.currency [Section titled “get.responses.200.content.application/json.current\_balance.currency”](#getresponses200contentapplicationjsoncurrent_balancecurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-20) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-1) ```ts USD ``` ###### Example [Section titled “Example”](#example-3) ```ts USD ``` ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-21) ID of the cash account ##### get.responses.200.content.application/json.name [Section titled “get.responses.200.content.application/json.name”](#getresponses200contentapplicationjsonname) > **name**: `string` ##### get.responses.200.content.application/json.primary [Section titled “get.responses.200.content.application/json.primary”](#getresponses200contentapplicationjsonprimary) > **primary**: `boolean` ###### Description [Section titled “Description”](#description-22) Whether or not this account is the primary account. There will always be only one primary account. ##### get.responses.200.content.application/json.routing\_number [Section titled “get.responses.200.content.application/json.routing\_number”](#getresponses200contentapplicationjsonrouting_number) > **routing\_number**: `string` ##### get.responses.200.content.application/json.status? [Section titled “get.responses.200.content.application/json.status?”](#getresponses200contentapplicationjsonstatus) > `optional` **status?**: `"ACTIVE"` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-12) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-3) > **400**: `object` ###### Description [Section titled “Description”](#description-23) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-3) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-13) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-3) > **401**: `object` ###### Description [Section titled “Description”](#description-24) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-3) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-14) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-3) > **403**: `object` ###### Description [Section titled “Description”](#description-25) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-3) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-15) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-3) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-3) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-3) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-3) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-3) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-3) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-3) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-3) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-3) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-3) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-3) > `optional` **trace?**: `undefined` *** ### /v2/accounts/cash/{id}/statements [Section titled “/v2/accounts/cash/{id}/statements”](#v2accountscashidstatements) > **/v2/accounts/cash/{id}/statements**: `object` Defined in: [src/transactions/types.gen.ts:83](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L83) #### delete? [Section titled “delete?”](#delete-4) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-4) > **get**: `object` List cash account statements. ##### Description [Section titled “Description”](#description-26) This endpoint lists all finalized statements for the cash account by ID. ##### get.parameters [Section titled “get.parameters”](#getparameters-4) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-4) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-4) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-4) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-1) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-4) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-1) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-1) > `optional` **limit?**: `number` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-4) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-4) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-4) > **200**: `object` ###### Description [Section titled “Description”](#description-27) Returns a list of cash account statements. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-4) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-4) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-2) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-2) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-16) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-4) > **400**: `object` ###### Description [Section titled “Description”](#description-28) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-4) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-17) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-4) > **401**: `object` ###### Description [Section titled “Description”](#description-29) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-4) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-18) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-4) > **403**: `object` ###### Description [Section titled “Description”](#description-30) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-4) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-19) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-4) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-4) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-4) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-4) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-4) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-4) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-4) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-4) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-4) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-4) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-4) > `optional` **trace?**: `undefined` *** ### /v2/accounts/cash/primary [Section titled “/v2/accounts/cash/primary”](#v2accountscashprimary) > **/v2/accounts/cash/primary**: `object` Defined in: [src/transactions/types.gen.ts:103](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L103) #### delete? [Section titled “delete?”](#delete-5) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-5) > **get**: `object` Get primary cash account ##### Description [Section titled “Description”](#description-31) This endpoint returns the primary cash account with its status. There will always be only one primary account. ##### get.parameters [Section titled “get.parameters”](#getparameters-5) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-5) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-5) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-5) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-5) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-5) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-5) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-5) > **200**: `object` ###### Description [Section titled “Description”](#description-32) Returns the primary cash account. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-5) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-5) > **application/json**: `object` ##### get.responses.200.content.application/json.account\_number [Section titled “get.responses.200.content.application/json.account\_number”](#getresponses200contentapplicationjsonaccount_number-1) > **account\_number**: `string` ##### get.responses.200.content.application/json.available\_balance [Section titled “get.responses.200.content.application/json.available\_balance”](#getresponses200contentapplicationjsonavailable_balance-1) > **available\_balance**: `object` ##### get.responses.200.content.application/json.available\_balance.amount [Section titled “get.responses.200.content.application/json.available\_balance.amount”](#getresponses200contentapplicationjsonavailable_balanceamount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-33) 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 [Section titled “Example”](#example-4) ```ts 700 ``` ##### get.responses.200.content.application/json.available\_balance.currency [Section titled “get.responses.200.content.application/json.available\_balance.currency”](#getresponses200contentapplicationjsonavailable_balancecurrency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-34) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-2) ```ts USD ``` ###### Example [Section titled “Example”](#example-5) ```ts USD ``` ##### get.responses.200.content.application/json.current\_balance [Section titled “get.responses.200.content.application/json.current\_balance”](#getresponses200contentapplicationjsoncurrent_balance-1) > **current\_balance**: `object` ##### get.responses.200.content.application/json.current\_balance.amount [Section titled “get.responses.200.content.application/json.current\_balance.amount”](#getresponses200contentapplicationjsoncurrent_balanceamount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-35) 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 [Section titled “Example”](#example-6) ```ts 700 ``` ##### get.responses.200.content.application/json.current\_balance.currency [Section titled “get.responses.200.content.application/json.current\_balance.currency”](#getresponses200contentapplicationjsoncurrent_balancecurrency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-36) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-3) ```ts USD ``` ###### Example [Section titled “Example”](#example-7) ```ts USD ``` ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-37) ID of the cash account ##### get.responses.200.content.application/json.name [Section titled “get.responses.200.content.application/json.name”](#getresponses200contentapplicationjsonname-1) > **name**: `string` ##### get.responses.200.content.application/json.primary [Section titled “get.responses.200.content.application/json.primary”](#getresponses200contentapplicationjsonprimary-1) > **primary**: `boolean` ###### Description [Section titled “Description”](#description-38) Whether or not this account is the primary account. There will always be only one primary account. ##### get.responses.200.content.application/json.routing\_number [Section titled “get.responses.200.content.application/json.routing\_number”](#getresponses200contentapplicationjsonrouting_number-1) > **routing\_number**: `string` ##### get.responses.200.content.application/json.status? [Section titled “get.responses.200.content.application/json.status?”](#getresponses200contentapplicationjsonstatus-1) > `optional` **status?**: `"ACTIVE"` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-20) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-5) > **400**: `object` ###### Description [Section titled “Description”](#description-39) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-5) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-21) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-5) > **401**: `object` ###### Description [Section titled “Description”](#description-40) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-5) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-22) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-5) > **403**: `object` ###### Description [Section titled “Description”](#description-41) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-5) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-23) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-5) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-5) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-5) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-5) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-5) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-5) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-5) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-5) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-5) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-5) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-5) > `optional` **trace?**: `undefined` *** ### /v2/transactions/card/primary [Section titled “/v2/transactions/card/primary”](#v2transactionscardprimary) > **/v2/transactions/card/primary**: `object` Defined in: [src/transactions/types.gen.ts:123](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L123) #### delete? [Section titled “delete?”](#delete-6) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-6) > **get**: `object` List transactions for all card accounts. ##### Description [Section titled “Description”](#description-42) This endpoint lists all settled transactions for all card accounts. Regular users may only fetch their own “PURCHASE”,“REFUND” and “CHARGEBACK” settled transactions. ##### get.parameters [Section titled “get.parameters”](#getparameters-6) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-6) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-6) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-6) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-6) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-2) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.expand\[]? [Section titled “get.parameters.query.expand\[\]?”](#getparametersqueryexpand) > `optional` **expand\[]?**: `string`\[] | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-2) > `optional` **limit?**: `number` | `null` ##### get.parameters.query.posted\_at\_start? [Section titled “get.parameters.query.posted\_at\_start?”](#getparametersqueryposted_at_start) > `optional` **posted\_at\_start?**: `string` | `null` ###### Description [Section titled “Description”](#description-43) Shows only transactions with a `posted_at_date` 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) ###### Example [Section titled “Example”](#example-8) ```ts 2022-12-12T23:59:59.999 ``` ##### get.parameters.query.user\_ids? [Section titled “get.parameters.query.user\_ids?”](#getparametersqueryuser_ids) > `optional` **user\_ids?**: `string`\[] | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-6) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-6) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-6) > **200**: `object` ###### Description [Section titled “Description”](#description-44) Returns a list of card transactions. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-6) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-6) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-3) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-3) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-6) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-24) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-6) > **400**: `object` ###### Description [Section titled “Description”](#description-45) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-6) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-6) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-25) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-6) > **401**: `object` ###### Description [Section titled “Description”](#description-46) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-6) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-6) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-26) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-6) > **403**: `object` ###### Description [Section titled “Description”](#description-47) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-6) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-6) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-27) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-6) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-6) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-6) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-6) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-6) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-6) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-6) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-6) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-6) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-6) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-6) > `optional` **trace?**: `undefined` *** ### /v2/transactions/cash/{id} [Section titled “/v2/transactions/cash/{id}”](#v2transactionscashid) > **/v2/transactions/cash/{id}**: `object` Defined in: [src/transactions/types.gen.ts:144](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L144) #### delete? [Section titled “delete?”](#delete-7) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-7) > **get**: `object` List transactions for the selected cash account. ##### Description [Section titled “Description”](#description-48) This endpoint lists all transactions for the cash account with the selected ID. ##### get.parameters [Section titled “get.parameters”](#getparameters-7) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-7) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-7) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-7) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-2) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-7) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-3) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-3) > `optional` **limit?**: `number` | `null` ##### get.parameters.query.posted\_at\_start? [Section titled “get.parameters.query.posted\_at\_start?”](#getparametersqueryposted_at_start-1) > `optional` **posted\_at\_start?**: `string` | `null` ###### Description [Section titled “Description”](#description-49) Shows only transactions with a `posted_at_date` 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) ###### Example [Section titled “Example”](#example-9) ```ts 2022-12-12T23:59:59.999 ``` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-7) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-7) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-7) > **200**: `object` ###### Description [Section titled “Description”](#description-50) Returns a list of cash transactions. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-7) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-7) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-4) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-4) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-7) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-28) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-7) > **400**: `object` ###### Description [Section titled “Description”](#description-51) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-7) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-7) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-29) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-7) > **401**: `object` ###### Description [Section titled “Description”](#description-52) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-7) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-7) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-30) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-7) > **403**: `object` ###### Description [Section titled “Description”](#description-53) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-7) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-7) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-31) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-7) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-7) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-7) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-7) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-7) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-7) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-7) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-7) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-7) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-7) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-7) > `optional` **trace?**: `undefined` # CardAccount > **CardAccount** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"CardAccount"`] Defined in: [src/transactions/schemas.gen.ts:5](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L5) # CardTransaction > **CardTransaction** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"CardTransaction"`] Defined in: [src/transactions/schemas.gen.ts:6](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L6) # CardTransactionType > **CardTransactionType** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"CardTransactionType"`] Defined in: [src/transactions/schemas.gen.ts:7](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L7) # CashAccount > **CashAccount** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"CashAccount"`] Defined in: [src/transactions/schemas.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L8) # CashTransaction > **CashTransaction** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"CashTransaction"`] Defined in: [src/transactions/schemas.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L9) # CashTransactionType > **CashTransactionType** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"CashTransactionType"`] Defined in: [src/transactions/schemas.gen.ts:10](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L10) # Merchant > **Merchant** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"Merchant"`] Defined in: [src/transactions/schemas.gen.ts:11](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L11) # Money > **Money** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"Money"`] Defined in: [src/transactions/schemas.gen.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L12) # Page_CardTransaction_ > **Page\_CardTransaction\_** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"Page_CardTransaction_"`] Defined in: [src/transactions/schemas.gen.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L13) # Page_CashAccount_ > **Page\_CashAccount\_** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"Page_CashAccount_"`] Defined in: [src/transactions/schemas.gen.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L14) # Page_CashTransaction_ > **Page\_CashTransaction\_** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"Page_CashTransaction_"`] Defined in: [src/transactions/schemas.gen.ts:15](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L15) # Page_Statement_ > **Page\_Statement\_** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"Page_Statement_"`] Defined in: [src/transactions/schemas.gen.ts:16](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L16) # Statement > **Statement** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"Statement"`] Defined in: [src/transactions/schemas.gen.ts:17](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L17) # StatementPeriod > **StatementPeriod** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"StatementPeriod"`] Defined in: [src/transactions/schemas.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L18) # Status > **Status** = [`TransactionsComponents`](/brex/api/transactions/interfaces/transactionscomponents/)\[`"schemas"`]\[`"Status"`] Defined in: [src/transactions/schemas.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/schemas.gen.ts#L19) # BrexTravel Defined in: [src/travel/client.gen.ts:90](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/client.gen.ts#L90) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BrexTravel**(`core`): `BrexTravel` Defined in: [src/travel/client.gen.ts:92](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/client.gen.ts#L92) #### Parameters [Section titled “Parameters”](#parameters) ##### core [Section titled “core”](#core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `BrexTravel` ## Properties [Section titled “Properties”](#properties) ### trips [Section titled “trips”](#trips) > `readonly` **trips**: [`Trips`](/brex/api/travel/classes/trips/) Defined in: [src/travel/client.gen.ts:91](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/client.gen.ts#L91) # Trips Defined in: [src/travel/client.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/client.gen.ts#L8) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Trips**(`_core`): `Trips` Defined in: [src/travel/client.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/client.gen.ts#L9) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Trips` ## Methods [Section titled “Methods”](#methods) ### get() [Section titled “get()”](#get) > **get**(`tripId`, `options?`): `Promise`<{ `billable_at?`: `string` | `null`; `booker_user_id`: `string`; `created_at`: `string`; `ends_at?`: `string` | `null`; `id`: `string`; `name?`: `string` | `null`; `starts_at?`: `string` | `null`; `status`: `"DELETED"` | `"INVITED"` | `"PROCESSING"` | `"CANCELED"` | `"REFUNDED"` | `"DRAFT"` | `"IN_PROGRESS"` | `"APPROVAL_DENIED"` | `"PENDING"` | `"HOLD"` | `"COMPLETED"` | `"VOIDED"` | `"UNCONFIRMED"` | `"AIRLINE_CONTROL"` | `"PAYMENT_DECLINED"` | `"SCHEDULE_CHANGE"` | `"APPROVAL_REQUESTED"` | `"CANCELLATION_IN_PROGRESS"` | `"UPCOMING"`; `traveler?`: { `guest_email?`: `string` | `null`; `name?`: { `first_name?`: `string`; `last_name?`: `string`; `middle_name?`: `string` | `null`; `suffix?`: `string` | `null`; }; `type`: `"EMPLOYEE"` | `"GUEST"`; `user_id?`: `string` | `null`; }; `updated_at`: `string`; `version`: `number`; }> Defined in: [src/travel/client.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/client.gen.ts#L18) Get trip Retrieves a trip by ID. `GET /v1/trips/{trip_id}` — requires OAuth scope: `travel.trips`, `travel.trips.readonly` #### Parameters [Section titled “Parameters”](#parameters-1) ##### tripId [Section titled “tripId”](#tripid) `string` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `billable_at?`: `string` | `null`; `booker_user_id`: `string`; `created_at`: `string`; `ends_at?`: `string` | `null`; `id`: `string`; `name?`: `string` | `null`; `starts_at?`: `string` | `null`; `status`: `"DELETED"` | `"INVITED"` | `"PROCESSING"` | `"CANCELED"` | `"REFUNDED"` | `"DRAFT"` | `"IN_PROGRESS"` | `"APPROVAL_DENIED"` | `"PENDING"` | `"HOLD"` | `"COMPLETED"` | `"VOIDED"` | `"UNCONFIRMED"` | `"AIRLINE_CONTROL"` | `"PAYMENT_DECLINED"` | `"SCHEDULE_CHANGE"` | `"APPROVAL_REQUESTED"` | `"CANCELLATION_IN_PROGRESS"` | `"UPCOMING"`; `traveler?`: { `guest_email?`: `string` | `null`; `name?`: { `first_name?`: `string`; `last_name?`: `string`; `middle_name?`: `string` | `null`; `suffix?`: `string` | `null`; }; `type`: `"EMPLOYEE"` | `"GUEST"`; `user_id?`: `string` | `null`; }; `updated_at`: `string`; `version`: `number`; }> *** ### getBooking() [Section titled “getBooking()”](#getbooking) > **getBooking**(`tripId`, `bookingId`, `options?`): `Promise`<{ `booking_data`: { `journeys`: `object`\[]; `known_traveler_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `redress_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `tickets`: `object`\[]; `type`: `"AIR"`; } | { `car_details`: { `car_class?`: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"`; `display_name`: `string`; }; `reservation_details`: { `confirmation_code?`: `string` | `null`; `drop_off`: { `location`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; }; `pickup`: { `location`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; }; `rental_company?`: `string` | `null`; }; `type`: `"CAR_RENTAL"`; } | { `lodging_details`: { `brand_name?`: `string` | `null`; `chain_name?`: `string` | `null`; `contact_information?`: { `email?`: `string` | `null`; `fax?`: `string` | `null`; `phone?`: `string` | `null`; }; `display_name`: `string`; `location?`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `star_rating?`: `number` | `null`; }; `reservation_details`: { `check_in_time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; `checkout_time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; `confirmation_code?`: `string` | `null`; `room?`: { `bed_count?`: `number` | `null`; `bed_type?`: `string` | `null`; `description?`: `string` | `null`; `display_name?`: `string` | `null`; }; }; `type`: `"LODGING"`; } | { `journeys`: `object`\[]; `type`: `"RAIL"`; }; `created_at`: `string`; `id`: `string`; `source`: `"BREX_TRAVEL"` | `"EXTERNAL"`; `status`: `"PROCESSING"` | `"CANCELED"` | `"REFUNDED"` | `"IN_PROGRESS"` | `"APPROVAL_DENIED"` | `"PENDING"` | `"CONFIRMED"` | `"HOLD"` | `"COMPLETED"` | `"VOIDED"` | `"UNCONFIRMED"` | `"AIRLINE_CONTROL"` | `"PAYMENT_DECLINED"` | `"SCHEDULE_CHANGE"` | `"APPROVAL_REQUESTED"` | `"CANCELLATION_IN_PROGRESS"`; `trip_id`: `string`; `type`: `"CAR_RENTAL"` | `"LODGING"` | `"AIR"` | `"RAIL"`; `updated_at`: `string`; `version`: `number`; }> Defined in: [src/travel/client.gen.ts:36](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/client.gen.ts#L36) Get booking Retrieves a booking by trip and booking ID. `GET /v1/trips/{trip_id}/bookings/{booking_id}` — requires OAuth scope: `travel.trips`, `travel.trips.readonly` #### Parameters [Section titled “Parameters”](#parameters-2) ##### tripId [Section titled “tripId”](#tripid-1) `string` ##### bookingId [Section titled “bookingId”](#bookingid) `string` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `booking_data`: { `journeys`: `object`\[]; `known_traveler_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `redress_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `tickets`: `object`\[]; `type`: `"AIR"`; } | { `car_details`: { `car_class?`: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"`; `display_name`: `string`; }; `reservation_details`: { `confirmation_code?`: `string` | `null`; `drop_off`: { `location`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; }; `pickup`: { `location`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; }; `rental_company?`: `string` | `null`; }; `type`: `"CAR_RENTAL"`; } | { `lodging_details`: { `brand_name?`: `string` | `null`; `chain_name?`: `string` | `null`; `contact_information?`: { `email?`: `string` | `null`; `fax?`: `string` | `null`; `phone?`: `string` | `null`; }; `display_name`: `string`; `location?`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `star_rating?`: `number` | `null`; }; `reservation_details`: { `check_in_time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; `checkout_time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; `confirmation_code?`: `string` | `null`; `room?`: { `bed_count?`: `number` | `null`; `bed_type?`: `string` | `null`; `description?`: `string` | `null`; `display_name?`: `string` | `null`; }; }; `type`: `"LODGING"`; } | { `journeys`: `object`\[]; `type`: `"RAIL"`; }; `created_at`: `string`; `id`: `string`; `source`: `"BREX_TRAVEL"` | `"EXTERNAL"`; `status`: `"PROCESSING"` | `"CANCELED"` | `"REFUNDED"` | `"IN_PROGRESS"` | `"APPROVAL_DENIED"` | `"PENDING"` | `"CONFIRMED"` | `"HOLD"` | `"COMPLETED"` | `"VOIDED"` | `"UNCONFIRMED"` | `"AIRLINE_CONTROL"` | `"PAYMENT_DECLINED"` | `"SCHEDULE_CHANGE"` | `"APPROVAL_REQUESTED"` | `"CANCELLATION_IN_PROGRESS"`; `trip_id`: `string`; `type`: `"CAR_RENTAL"` | `"LODGING"` | `"AIR"` | `"RAIL"`; `updated_at`: `string`; `version`: `number`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/travel/client.gen.ts:60](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/client.gen.ts#L60) List trips Lists trips according to the filters passed in the query string. `GET /v1/trips` — requires OAuth scope: `travel.trips`, `travel.trips.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-3) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### last\_updated\_after? [Section titled “last\_updated\_after?”](#last_updated_after) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### listBookings() [Section titled “listBookings()”](#listbookings) > **listBookings**(`tripId`, `query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/travel/client.gen.ts:77](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/client.gen.ts#L77) List trip bookings Lists the bookings within a trip. `GET /v1/trips/{trip_id}/bookings` — requires OAuth scope: `travel.trips`, `travel.trips.readonly` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-4) ##### tripId [Section titled “tripId”](#tripid-2) `string` ##### query? [Section titled “query?”](#query-1) ###### cursor? [Section titled “cursor?”](#cursor-1) `string` | `null` ###### limit? [Section titled “limit?”](#limit-1) `number` | `null` ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> # createTravelClient > **createTravelClient**(`options`): [`BrexTravel`](/brex/api/travel/classes/brextravel/) Defined in: [src/travel/index.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/index.ts#L13) Standalone client for the Brex Travel API. ## Parameters [Section titled “Parameters”](#parameters) ### options [Section titled “options”](#options) [`BrexOptions`](/brex/api/index/interfaces/brexoptions/) ## Returns [Section titled “Returns”](#returns) [`BrexTravel`](/brex/api/travel/classes/brextravel/) # TravelComponents Defined in: [src/travel/types.gen.ts:85](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L85) ## Properties [Section titled “Properties”](#properties) ### headers [Section titled “headers”](#headers) > **headers**: `never` Defined in: [src/travel/types.gen.ts:792](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L792) *** ### parameters [Section titled “parameters”](#parameters) > **parameters**: `never` Defined in: [src/travel/types.gen.ts:790](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L790) *** ### pathItems [Section titled “pathItems”](#pathitems) > **pathItems**: `never` Defined in: [src/travel/types.gen.ts:793](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L793) *** ### requestBodies [Section titled “requestBodies”](#requestbodies) > **requestBodies**: `never` Defined in: [src/travel/types.gen.ts:791](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L791) *** ### responses [Section titled “responses”](#responses) > **responses**: `never` Defined in: [src/travel/types.gen.ts:789](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L789) *** ### schemas [Section titled “schemas”](#schemas) > **schemas**: `object` Defined in: [src/travel/types.gen.ts:86](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L86) #### Address [Section titled “Address”](#address) > **Address**: `object` ##### Description [Section titled “Description”](#description) A location. All fields are optional, but the object will hold as much information as possible. ##### Address.address\_line\_1? [Section titled “Address.address\_line\_1?”](#addressaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-1) The first line of the address. ###### Example [Section titled “Example”](#example) ```ts Av. Vinte de Janeiro, S/N ``` ##### Address.address\_line\_2? [Section titled “Address.address\_line\_2?”](#addressaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-2) The second line of the address. ###### Example [Section titled “Example”](#example-1) ```ts Ilha do Governador ``` ##### Address.administrative\_area? [Section titled “Address.administrative\_area?”](#addressadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-3) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-2) ```ts RJ ``` ##### Address.city? [Section titled “Address.city?”](#addresscity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-4) The city where the address is located. ###### Example [Section titled “Example”](#example-3) ```ts Rio de Janeiro ``` ##### Address.coordinates? [Section titled “Address.coordinates?”](#addresscoordinates) > `optional` **coordinates?**: `object` ##### Address.coordinates.latitude [Section titled “Address.coordinates.latitude”](#addresscoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-4) ```ts -22.8145373 ``` ##### Address.coordinates.longitude [Section titled “Address.coordinates.longitude”](#addresscoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-5) ```ts -43.2465548 ``` ##### Address.country? [Section titled “Address.country?”](#addresscountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-5) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-6) ```ts Brazil ``` ##### Address.postal\_code? [Section titled “Address.postal\_code?”](#addresspostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-6) The postal code of the given address. ###### Example [Section titled “Example”](#example-7) ```ts 21941-900 ``` ##### Address.timezone? [Section titled “Address.timezone?”](#addresstimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-7) The timezone in the given address. ###### Example [Section titled “Example”](#example-8) ```ts America/Sao_Paulo ``` ##### Address.GeoCoordinates [Section titled “Address.GeoCoordinates”](#addressgeocoordinates) > **Address.GeoCoordinates**: `object` ###### Description [Section titled “Description”](#description-8) The coordinates of an address. ##### Address.GeoCoordinates.latitude [Section titled “Address.GeoCoordinates.latitude”](#addressgeocoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-9) ```ts -22.8145373 ``` ##### Address.GeoCoordinates.longitude [Section titled “Address.GeoCoordinates.longitude”](#addressgeocoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-10) ```ts -43.2465548 ``` #### AirBookingData [Section titled “AirBookingData”](#airbookingdata) > **AirBookingData**: `object` ##### Description [Section titled “Description”](#description-9) Air-specific booking information. ##### AirBookingData.journeys [Section titled “AirBookingData.journeys”](#airbookingdatajourneys) > **journeys**: `object`\[] ###### Description [Section titled “Description”](#description-10) The journeys that make up this booking. ##### AirBookingData.known\_traveler\_number? [Section titled “AirBookingData.known\_traveler\_number?”](#airbookingdataknown_traveler_number) > `optional` **known\_traveler\_number?**: `object` ##### AirBookingData.known\_traveler\_number.document\_number [Section titled “AirBookingData.known\_traveler\_number.document\_number”](#airbookingdataknown_traveler_numberdocument_number) > **document\_number**: `string` ###### Description [Section titled “Description”](#description-11) The actual document number. ###### Example [Section titled “Example”](#example-11) ```ts 1231231 ``` ##### AirBookingData.known\_traveler\_number.issuing\_country [Section titled “AirBookingData.known\_traveler\_number.issuing\_country”](#airbookingdataknown_traveler_numberissuing_country) > **issuing\_country**: `string` ###### Description [Section titled “Description”](#description-12) The country that issued this document. ###### Example [Section titled “Example”](#example-12) ```ts BR ``` ##### AirBookingData.redress\_number? [Section titled “AirBookingData.redress\_number?”](#airbookingdataredress_number) > `optional` **redress\_number?**: `object` ##### AirBookingData.redress\_number.document\_number [Section titled “AirBookingData.redress\_number.document\_number”](#airbookingdataredress_numberdocument_number) > **document\_number**: `string` ###### Description [Section titled “Description”](#description-13) The actual document number. ###### Example [Section titled “Example”](#example-13) ```ts 1231231 ``` ##### AirBookingData.redress\_number.issuing\_country [Section titled “AirBookingData.redress\_number.issuing\_country”](#airbookingdataredress_numberissuing_country) > **issuing\_country**: `string` ###### Description [Section titled “Description”](#description-14) The country that issued this document. ###### Example [Section titled “Example”](#example-14) ```ts BR ``` ##### AirBookingData.tickets [Section titled “AirBookingData.tickets”](#airbookingdatatickets) > **tickets**: `object`\[] ###### Description [Section titled “Description”](#description-15) The flight tickets in this booking. ##### AirBookingData.type [Section titled “AirBookingData.type”](#airbookingdatatype) > **type**: `"AIR"` ###### Description [Section titled “Description”](#description-16) discriminator enum property added by openapi-typescript ##### AirBookingData.CabinClass [Section titled “AirBookingData.CabinClass”](#airbookingdatacabinclass) > **AirBookingData.CabinClass**: `"BUSINESS"` | `"ECONOMY"` | `"PREMIUM_ECONOMY"` | `"FIRST"` ###### Description [Section titled “Description”](#description-17) The cabin class of a flight. ###### Example [Section titled “Example”](#example-15) ```ts ECONOMY @enum {string} ``` ##### AirBookingData.DocumentNumber [Section titled “AirBookingData.DocumentNumber”](#airbookingdatadocumentnumber) > **AirBookingData.DocumentNumber**: `object` ###### Description [Section titled “Description”](#description-18) A document number such as a redress number or a known traveler number. ##### AirBookingData.DocumentNumber.document\_number [Section titled “AirBookingData.DocumentNumber.document\_number”](#airbookingdatadocumentnumberdocument_number) > **document\_number**: `string` ###### Description [Section titled “Description”](#description-19) The actual document number. ###### Example [Section titled “Example”](#example-16) ```ts 1231231 ``` ##### AirBookingData.DocumentNumber.issuing\_country [Section titled “AirBookingData.DocumentNumber.issuing\_country”](#airbookingdatadocumentnumberissuing_country) > **issuing\_country**: `string` ###### Description [Section titled “Description”](#description-20) The country that issued this document. ###### Example [Section titled “Example”](#example-17) ```ts BR ``` ##### AirBookingData.Flight [Section titled “AirBookingData.Flight”](#airbookingdataflight) > **AirBookingData.Flight**: `object` ###### Description [Section titled “Description”](#description-21) A flight taken by the traveler. ##### AirBookingData.Flight.arrival\_time [Section titled “AirBookingData.Flight.arrival\_time”](#airbookingdataflightarrival_time) > **arrival\_time**: `object` ##### AirBookingData.Flight.arrival\_time.local\_time [Section titled “AirBookingData.Flight.arrival\_time.local\_time”](#airbookingdataflightarrival_timelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-22) The local time in the relevant location in the ISO 8601 format. ##### AirBookingData.Flight.arrival\_time.timestamp? [Section titled “AirBookingData.Flight.arrival\_time.timestamp?”](#airbookingdataflightarrival_timetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-23) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-18) ```ts 2017-12-27T15:42:30Z ``` ##### AirBookingData.Flight.cabin\_class? [Section titled “AirBookingData.Flight.cabin\_class?”](#airbookingdataflightcabin_class) > `optional` **cabin\_class?**: `"BUSINESS"` | `"ECONOMY"` | `"PREMIUM_ECONOMY"` | `"FIRST"` ##### AirBookingData.Flight.confirmation\_code? [Section titled “AirBookingData.Flight.confirmation\_code?”](#airbookingdataflightconfirmation_code) > `optional` **confirmation\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-24) The airline confirmation code. ###### Example [Section titled “Example”](#example-19) ```ts PWZRTQ ``` ##### AirBookingData.Flight.departure\_time [Section titled “AirBookingData.Flight.departure\_time”](#airbookingdataflightdeparture_time) > **departure\_time**: `object` ##### AirBookingData.Flight.departure\_time.local\_time [Section titled “AirBookingData.Flight.departure\_time.local\_time”](#airbookingdataflightdeparture_timelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-25) The local time in the relevant location in the ISO 8601 format. ##### AirBookingData.Flight.departure\_time.timestamp? [Section titled “AirBookingData.Flight.departure\_time.timestamp?”](#airbookingdataflightdeparture_timetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-26) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-20) ```ts 2017-12-27T15:42:30Z ``` ##### AirBookingData.Flight.destination [Section titled “AirBookingData.Flight.destination”](#airbookingdataflightdestination) > **destination**: `object` ##### AirBookingData.Flight.destination.airport\_code [Section titled “AirBookingData.Flight.destination.airport\_code”](#airbookingdataflightdestinationairport_code) > **airport\_code**: `string` ###### Description [Section titled “Description”](#description-27) The 3-letter IATA code of the airport. ###### Example [Section titled “Example”](#example-21) ```ts GIG ``` ##### AirBookingData.Flight.destination.airport\_location? [Section titled “AirBookingData.Flight.destination.airport\_location?”](#airbookingdataflightdestinationairport_location) > `optional` **airport\_location?**: `object` ##### AirBookingData.Flight.destination.airport\_location.address\_line\_1? [Section titled “AirBookingData.Flight.destination.airport\_location.address\_line\_1?”](#airbookingdataflightdestinationairport_locationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-28) The first line of the address. ###### Example [Section titled “Example”](#example-22) ```ts Av. Vinte de Janeiro, S/N ``` ##### AirBookingData.Flight.destination.airport\_location.address\_line\_2? [Section titled “AirBookingData.Flight.destination.airport\_location.address\_line\_2?”](#airbookingdataflightdestinationairport_locationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-29) The second line of the address. ###### Example [Section titled “Example”](#example-23) ```ts Ilha do Governador ``` ##### AirBookingData.Flight.destination.airport\_location.administrative\_area? [Section titled “AirBookingData.Flight.destination.airport\_location.administrative\_area?”](#airbookingdataflightdestinationairport_locationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-30) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-24) ```ts RJ ``` ##### AirBookingData.Flight.destination.airport\_location.city? [Section titled “AirBookingData.Flight.destination.airport\_location.city?”](#airbookingdataflightdestinationairport_locationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-31) The city where the address is located. ###### Example [Section titled “Example”](#example-25) ```ts Rio de Janeiro ``` ##### AirBookingData.Flight.destination.airport\_location.coordinates? [Section titled “AirBookingData.Flight.destination.airport\_location.coordinates?”](#airbookingdataflightdestinationairport_locationcoordinates) > `optional` **coordinates?**: `object` ##### AirBookingData.Flight.destination.airport\_location.coordinates.latitude [Section titled “AirBookingData.Flight.destination.airport\_location.coordinates.latitude”](#airbookingdataflightdestinationairport_locationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-26) ```ts -22.8145373 ``` ##### AirBookingData.Flight.destination.airport\_location.coordinates.longitude [Section titled “AirBookingData.Flight.destination.airport\_location.coordinates.longitude”](#airbookingdataflightdestinationairport_locationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-27) ```ts -43.2465548 ``` ##### AirBookingData.Flight.destination.airport\_location.country? [Section titled “AirBookingData.Flight.destination.airport\_location.country?”](#airbookingdataflightdestinationairport_locationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-32) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-28) ```ts Brazil ``` ##### AirBookingData.Flight.destination.airport\_location.postal\_code? [Section titled “AirBookingData.Flight.destination.airport\_location.postal\_code?”](#airbookingdataflightdestinationairport_locationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-33) The postal code of the given address. ###### Example [Section titled “Example”](#example-29) ```ts 21941-900 ``` ##### AirBookingData.Flight.destination.airport\_location.timezone? [Section titled “AirBookingData.Flight.destination.airport\_location.timezone?”](#airbookingdataflightdestinationairport_locationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-34) The timezone in the given address. ###### Example [Section titled “Example”](#example-30) ```ts America/Sao_Paulo ``` ##### AirBookingData.Flight.destination.gate? [Section titled “AirBookingData.Flight.destination.gate?”](#airbookingdataflightdestinationgate) > `optional` **gate?**: `string` | `null` ###### Description [Section titled “Description”](#description-35) The gate for boarding or leaving the plane. ###### Example [Section titled “Example”](#example-31) ```ts B13 ``` ##### AirBookingData.Flight.destination.terminal? [Section titled “AirBookingData.Flight.destination.terminal?”](#airbookingdataflightdestinationterminal) > `optional` **terminal?**: `string` | `null` ###### Description [Section titled “Description”](#description-36) The terminal name and/or number. ###### Example [Section titled “Example”](#example-32) ```ts T2 ``` ##### AirBookingData.Flight.duration? [Section titled “AirBookingData.Flight.duration?”](#airbookingdataflightduration) > `optional` **duration?**: `string` | `null` ###### Description [Section titled “Description”](#description-37) The duration of the flight in the ISO 8601 PnYnMnDTnHnMnS format. ###### Example [Section titled “Example”](#example-33) ```ts PT4h20M ``` ##### AirBookingData.Flight.marketing\_flight? [Section titled “AirBookingData.Flight.marketing\_flight?”](#airbookingdataflightmarketing_flight) > `optional` **marketing\_flight?**: `object` ##### AirBookingData.Flight.marketing\_flight.airline\_code [Section titled “AirBookingData.Flight.marketing\_flight.airline\_code”](#airbookingdataflightmarketing_flightairline_code) > **airline\_code**: `string` ###### Description [Section titled “Description”](#description-38) The IATA code for the airline. ###### Example [Section titled “Example”](#example-34) ```ts G3 ``` ##### AirBookingData.Flight.marketing\_flight.airline\_name? [Section titled “AirBookingData.Flight.marketing\_flight.airline\_name?”](#airbookingdataflightmarketing_flightairline_name) > `optional` **airline\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-39) The name of the airline. ###### Example [Section titled “Example”](#example-35) ```ts GOL Linhas Aereas S.A. ``` ##### AirBookingData.Flight.marketing\_flight.number [Section titled “AirBookingData.Flight.marketing\_flight.number”](#airbookingdataflightmarketing_flightnumber) > **number**: `string` ###### Description [Section titled “Description”](#description-40) The number of the flight. ###### Example [Section titled “Example”](#example-36) ```ts 1234 ``` ##### AirBookingData.Flight.operating\_flight? [Section titled “AirBookingData.Flight.operating\_flight?”](#airbookingdataflightoperating_flight) > `optional` **operating\_flight?**: `object` ##### AirBookingData.Flight.operating\_flight.airline\_code [Section titled “AirBookingData.Flight.operating\_flight.airline\_code”](#airbookingdataflightoperating_flightairline_code) > **airline\_code**: `string` ###### Description [Section titled “Description”](#description-41) The IATA code for the airline. ###### Example [Section titled “Example”](#example-37) ```ts G3 ``` ##### AirBookingData.Flight.operating\_flight.airline\_name? [Section titled “AirBookingData.Flight.operating\_flight.airline\_name?”](#airbookingdataflightoperating_flightairline_name) > `optional` **airline\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-42) The name of the airline. ###### Example [Section titled “Example”](#example-38) ```ts GOL Linhas Aereas S.A. ``` ##### AirBookingData.Flight.operating\_flight.number [Section titled “AirBookingData.Flight.operating\_flight.number”](#airbookingdataflightoperating_flightnumber) > **number**: `string` ###### Description [Section titled “Description”](#description-43) The number of the flight. ###### Example [Section titled “Example”](#example-39) ```ts 1234 ``` ##### AirBookingData.Flight.origin [Section titled “AirBookingData.Flight.origin”](#airbookingdataflightorigin) > **origin**: `object` ##### AirBookingData.Flight.origin.airport\_code [Section titled “AirBookingData.Flight.origin.airport\_code”](#airbookingdataflightoriginairport_code) > **airport\_code**: `string` ###### Description [Section titled “Description”](#description-44) The 3-letter IATA code of the airport. ###### Example [Section titled “Example”](#example-40) ```ts GIG ``` ##### AirBookingData.Flight.origin.airport\_location? [Section titled “AirBookingData.Flight.origin.airport\_location?”](#airbookingdataflightoriginairport_location) > `optional` **airport\_location?**: `object` ##### AirBookingData.Flight.origin.airport\_location.address\_line\_1? [Section titled “AirBookingData.Flight.origin.airport\_location.address\_line\_1?”](#airbookingdataflightoriginairport_locationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-45) The first line of the address. ###### Example [Section titled “Example”](#example-41) ```ts Av. Vinte de Janeiro, S/N ``` ##### AirBookingData.Flight.origin.airport\_location.address\_line\_2? [Section titled “AirBookingData.Flight.origin.airport\_location.address\_line\_2?”](#airbookingdataflightoriginairport_locationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-46) The second line of the address. ###### Example [Section titled “Example”](#example-42) ```ts Ilha do Governador ``` ##### AirBookingData.Flight.origin.airport\_location.administrative\_area? [Section titled “AirBookingData.Flight.origin.airport\_location.administrative\_area?”](#airbookingdataflightoriginairport_locationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-47) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-43) ```ts RJ ``` ##### AirBookingData.Flight.origin.airport\_location.city? [Section titled “AirBookingData.Flight.origin.airport\_location.city?”](#airbookingdataflightoriginairport_locationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-48) The city where the address is located. ###### Example [Section titled “Example”](#example-44) ```ts Rio de Janeiro ``` ##### AirBookingData.Flight.origin.airport\_location.coordinates? [Section titled “AirBookingData.Flight.origin.airport\_location.coordinates?”](#airbookingdataflightoriginairport_locationcoordinates) > `optional` **coordinates?**: `object` ##### AirBookingData.Flight.origin.airport\_location.coordinates.latitude [Section titled “AirBookingData.Flight.origin.airport\_location.coordinates.latitude”](#airbookingdataflightoriginairport_locationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-45) ```ts -22.8145373 ``` ##### AirBookingData.Flight.origin.airport\_location.coordinates.longitude [Section titled “AirBookingData.Flight.origin.airport\_location.coordinates.longitude”](#airbookingdataflightoriginairport_locationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-46) ```ts -43.2465548 ``` ##### AirBookingData.Flight.origin.airport\_location.country? [Section titled “AirBookingData.Flight.origin.airport\_location.country?”](#airbookingdataflightoriginairport_locationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-49) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-47) ```ts Brazil ``` ##### AirBookingData.Flight.origin.airport\_location.postal\_code? [Section titled “AirBookingData.Flight.origin.airport\_location.postal\_code?”](#airbookingdataflightoriginairport_locationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-50) The postal code of the given address. ###### Example [Section titled “Example”](#example-48) ```ts 21941-900 ``` ##### AirBookingData.Flight.origin.airport\_location.timezone? [Section titled “AirBookingData.Flight.origin.airport\_location.timezone?”](#airbookingdataflightoriginairport_locationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-51) The timezone in the given address. ###### Example [Section titled “Example”](#example-49) ```ts America/Sao_Paulo ``` ##### AirBookingData.Flight.origin.gate? [Section titled “AirBookingData.Flight.origin.gate?”](#airbookingdataflightorigingate) > `optional` **gate?**: `string` | `null` ###### Description [Section titled “Description”](#description-52) The gate for boarding or leaving the plane. ###### Example [Section titled “Example”](#example-50) ```ts B13 ``` ##### AirBookingData.Flight.origin.terminal? [Section titled “AirBookingData.Flight.origin.terminal?”](#airbookingdataflightoriginterminal) > `optional` **terminal?**: `string` | `null` ###### Description [Section titled “Description”](#description-53) The terminal name and/or number. ###### Example [Section titled “Example”](#example-51) ```ts T2 ``` ##### AirBookingData.Flight.seat? [Section titled “AirBookingData.Flight.seat?”](#airbookingdataflightseat) > `optional` **seat?**: `object` ##### AirBookingData.Flight.seat.number [Section titled “AirBookingData.Flight.seat.number”](#airbookingdataflightseatnumber) > **number**: `string` ###### Description [Section titled “Description”](#description-54) The seat number. ###### Example [Section titled “Example”](#example-52) ```ts 31D ``` ##### AirBookingData.Flight.seat.status? [Section titled “AirBookingData.Flight.seat.status?”](#airbookingdataflightseatstatus) > `optional` **status?**: `"CANCELED"` | `"PENDING"` | `"CONFIRMED"` ##### AirBookingData.FlightEndpoint [Section titled “AirBookingData.FlightEndpoint”](#airbookingdataflightendpoint) > **AirBookingData.FlightEndpoint**: `object` ###### Description [Section titled “Description”](#description-55) The place where a flight departs from or arrives at. ##### AirBookingData.FlightEndpoint.airport\_code [Section titled “AirBookingData.FlightEndpoint.airport\_code”](#airbookingdataflightendpointairport_code) > **airport\_code**: `string` ###### Description [Section titled “Description”](#description-56) The 3-letter IATA code of the airport. ###### Example [Section titled “Example”](#example-53) ```ts GIG ``` ##### AirBookingData.FlightEndpoint.airport\_location? [Section titled “AirBookingData.FlightEndpoint.airport\_location?”](#airbookingdataflightendpointairport_location) > `optional` **airport\_location?**: `object` ##### AirBookingData.FlightEndpoint.airport\_location.address\_line\_1? [Section titled “AirBookingData.FlightEndpoint.airport\_location.address\_line\_1?”](#airbookingdataflightendpointairport_locationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-57) The first line of the address. ###### Example [Section titled “Example”](#example-54) ```ts Av. Vinte de Janeiro, S/N ``` ##### AirBookingData.FlightEndpoint.airport\_location.address\_line\_2? [Section titled “AirBookingData.FlightEndpoint.airport\_location.address\_line\_2?”](#airbookingdataflightendpointairport_locationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-58) The second line of the address. ###### Example [Section titled “Example”](#example-55) ```ts Ilha do Governador ``` ##### AirBookingData.FlightEndpoint.airport\_location.administrative\_area? [Section titled “AirBookingData.FlightEndpoint.airport\_location.administrative\_area?”](#airbookingdataflightendpointairport_locationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-59) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-56) ```ts RJ ``` ##### AirBookingData.FlightEndpoint.airport\_location.city? [Section titled “AirBookingData.FlightEndpoint.airport\_location.city?”](#airbookingdataflightendpointairport_locationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-60) The city where the address is located. ###### Example [Section titled “Example”](#example-57) ```ts Rio de Janeiro ``` ##### AirBookingData.FlightEndpoint.airport\_location.coordinates? [Section titled “AirBookingData.FlightEndpoint.airport\_location.coordinates?”](#airbookingdataflightendpointairport_locationcoordinates) > `optional` **coordinates?**: `object` ##### AirBookingData.FlightEndpoint.airport\_location.coordinates.latitude [Section titled “AirBookingData.FlightEndpoint.airport\_location.coordinates.latitude”](#airbookingdataflightendpointairport_locationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-58) ```ts -22.8145373 ``` ##### AirBookingData.FlightEndpoint.airport\_location.coordinates.longitude [Section titled “AirBookingData.FlightEndpoint.airport\_location.coordinates.longitude”](#airbookingdataflightendpointairport_locationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-59) ```ts -43.2465548 ``` ##### AirBookingData.FlightEndpoint.airport\_location.country? [Section titled “AirBookingData.FlightEndpoint.airport\_location.country?”](#airbookingdataflightendpointairport_locationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-61) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-60) ```ts Brazil ``` ##### AirBookingData.FlightEndpoint.airport\_location.postal\_code? [Section titled “AirBookingData.FlightEndpoint.airport\_location.postal\_code?”](#airbookingdataflightendpointairport_locationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-62) The postal code of the given address. ###### Example [Section titled “Example”](#example-61) ```ts 21941-900 ``` ##### AirBookingData.FlightEndpoint.airport\_location.timezone? [Section titled “AirBookingData.FlightEndpoint.airport\_location.timezone?”](#airbookingdataflightendpointairport_locationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-63) The timezone in the given address. ###### Example [Section titled “Example”](#example-62) ```ts America/Sao_Paulo ``` ##### AirBookingData.FlightEndpoint.gate? [Section titled “AirBookingData.FlightEndpoint.gate?”](#airbookingdataflightendpointgate) > `optional` **gate?**: `string` | `null` ###### Description [Section titled “Description”](#description-64) The gate for boarding or leaving the plane. ###### Example [Section titled “Example”](#example-63) ```ts B13 ``` ##### AirBookingData.FlightEndpoint.terminal? [Section titled “AirBookingData.FlightEndpoint.terminal?”](#airbookingdataflightendpointterminal) > `optional` **terminal?**: `string` | `null` ###### Description [Section titled “Description”](#description-65) The terminal name and/or number. ###### Example [Section titled “Example”](#example-64) ```ts T2 ``` ##### AirBookingData.FlightNumber [Section titled “AirBookingData.FlightNumber”](#airbookingdataflightnumber) > **AirBookingData.FlightNumber**: `object` ###### Description [Section titled “Description”](#description-66) The flight number, including carrier information. ##### AirBookingData.FlightNumber.airline\_code [Section titled “AirBookingData.FlightNumber.airline\_code”](#airbookingdataflightnumberairline_code) > **airline\_code**: `string` ###### Description [Section titled “Description”](#description-67) The IATA code for the airline. ###### Example [Section titled “Example”](#example-65) ```ts G3 ``` ##### AirBookingData.FlightNumber.airline\_name? [Section titled “AirBookingData.FlightNumber.airline\_name?”](#airbookingdataflightnumberairline_name) > `optional` **airline\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-68) The name of the airline. ###### Example [Section titled “Example”](#example-66) ```ts GOL Linhas Aereas S.A. ``` ##### AirBookingData.FlightNumber.number [Section titled “AirBookingData.FlightNumber.number”](#airbookingdataflightnumbernumber) > **number**: `string` ###### Description [Section titled “Description”](#description-69) The number of the flight. ###### Example [Section titled “Example”](#example-67) ```ts 1234 ``` ##### AirBookingData.FlightSeat [Section titled “AirBookingData.FlightSeat”](#airbookingdataflightseat-1) > **AirBookingData.FlightSeat**: `object` ###### Description [Section titled “Description”](#description-70) Seat information in a flight. ##### AirBookingData.FlightSeat.number [Section titled “AirBookingData.FlightSeat.number”](#airbookingdataflightseatnumber-1) > **number**: `string` ###### Description [Section titled “Description”](#description-71) The seat number. ###### Example [Section titled “Example”](#example-68) ```ts 31D ``` ##### AirBookingData.FlightSeat.status? [Section titled “AirBookingData.FlightSeat.status?”](#airbookingdataflightseatstatus-1) > `optional` **status?**: `"CANCELED"` | `"PENDING"` | `"CONFIRMED"` ##### AirBookingData.FlightSeatStatus [Section titled “AirBookingData.FlightSeatStatus”](#airbookingdataflightseatstatus-2) > **AirBookingData.FlightSeatStatus**: `"CANCELED"` | `"PENDING"` | `"CONFIRMED"` ###### Description [Section titled “Description”](#description-72) The status of a flight seat. ###### Example [Section titled “Example”](#example-69) ```ts CONFIRMED @enum {string} ``` ##### AirBookingData.FlightTicket [Section titled “AirBookingData.FlightTicket”](#airbookingdataflightticket) > **AirBookingData.FlightTicket**: `object` ###### Description [Section titled “Description”](#description-73) A flight ticket. ##### AirBookingData.FlightTicket.issue\_date? [Section titled “AirBookingData.FlightTicket.issue\_date?”](#airbookingdataflightticketissue_date) > `optional` **issue\_date?**: `string` | `null` Format: date ###### Description [Section titled “Description”](#description-74) The date when the ticket was issued. ###### Example [Section titled “Example”](#example-70) ```ts 2017-12-27 ``` ##### AirBookingData.FlightTicket.number [Section titled “AirBookingData.FlightTicket.number”](#airbookingdataflightticketnumber) > **number**: `string` ###### Description [Section titled “Description”](#description-75) The ticket number provided by the airline. ###### Example [Section titled “Example”](#example-71) ```ts 0017959463925 ``` ##### AirBookingData.Journey [Section titled “AirBookingData.Journey”](#airbookingdatajourney) > **AirBookingData.Journey**: `object` ###### Description [Section titled “Description”](#description-76) A journey is composed of one or more flight segments that take a passenger from an origin to a final destination. E.g. if a traveler is doing a round trip from GIG to SFO, but they need to make a connection in IAH in each direction, the booking will contain 2 journeys. The first will contain 2 segments: GIG > IAH, and IAH > SFO. The second journey will also contain 2 segments: SFO > IAH, and IAH > GIG. ##### AirBookingData.Journey.cabin\_display\_name? [Section titled “AirBookingData.Journey.cabin\_display\_name?”](#airbookingdatajourneycabin_display_name) > `optional` **cabin\_display\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-77) The cabin name as shown by the airline. ###### Example [Section titled “Example”](#example-72) ```ts Flexible Economy ``` ##### AirBookingData.Journey.flights [Section titled “AirBookingData.Journey.flights”](#airbookingdatajourneyflights) > **flights**: `object`\[] ###### Description [Section titled “Description”](#description-78) The flights that make up this journey. ##### AirBookingData.Journey.status [Section titled “AirBookingData.Journey.status”](#airbookingdatajourneystatus) > **status**: `"PROCESSING"` | `"CANCELED"` | `"REFUNDED"` | `"IN_PROGRESS"` | `"APPROVAL_DENIED"` | `"PENDING"` | `"CONFIRMED"` | `"HOLD"` | `"COMPLETED"` | `"VOIDED"` | `"UNCONFIRMED"` | `"AIRLINE_CONTROL"` | `"PAYMENT_DECLINED"` | `"SCHEDULE_CHANGE"` | `"APPROVAL_REQUESTED"` | `"CANCELLATION_IN_PROGRESS"` #### Booking [Section titled “Booking”](#booking) > **Booking**: `object` ##### Description [Section titled “Description”](#description-79) A booking representation. ##### Booking.booking\_data [Section titled “Booking.booking\_data”](#bookingbooking_data) > **booking\_data**: { `journeys`: `object`\[]; `known_traveler_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `redress_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `tickets`: `object`\[]; `type`: `"AIR"`; } | { `car_details`: { `car_class?`: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"`; `display_name`: `string`; }; `reservation_details`: { `confirmation_code?`: `string` | `null`; `drop_off`: { `location`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; }; `pickup`: { `location`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; }; `rental_company?`: `string` | `null`; }; `type`: `"CAR_RENTAL"`; } | { `lodging_details`: { `brand_name?`: `string` | `null`; `chain_name?`: `string` | `null`; `contact_information?`: { `email?`: `string` | `null`; `fax?`: `string` | `null`; `phone?`: `string` | `null`; }; `display_name`: `string`; `location?`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `star_rating?`: `number` | `null`; }; `reservation_details`: { `check_in_time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; `checkout_time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; `confirmation_code?`: `string` | `null`; `room?`: { `bed_count?`: `number` | `null`; `bed_type?`: `string` | `null`; `description?`: `string` | `null`; `display_name?`: `string` | `null`; }; }; `type`: `"LODGING"`; } | { `journeys`: `object`\[]; `type`: `"RAIL"`; } ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `journeys`: `object`\[]; `known_traveler_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `redress_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `tickets`: `object`\[]; `type`: `"AIR"`; } ###### journeys [Section titled “journeys”](#journeys) > **journeys**: `object`\[] ###### Description [Section titled “Description”](#description-80) The journeys that make up this booking. ###### known\_traveler\_number? [Section titled “known\_traveler\_number?”](#known_traveler_number) > `optional` **known\_traveler\_number?**: `object` ###### known\_traveler\_number.document\_number [Section titled “known\_traveler\_number.document\_number”](#known_traveler_numberdocument_number) > **document\_number**: `string` ###### Description [Section titled “Description”](#description-81) The actual document number. ###### Example [Section titled “Example”](#example-73) ```ts 1231231 ``` ###### known\_traveler\_number.issuing\_country [Section titled “known\_traveler\_number.issuing\_country”](#known_traveler_numberissuing_country) > **issuing\_country**: `string` ###### Description [Section titled “Description”](#description-82) The country that issued this document. ###### Example [Section titled “Example”](#example-74) ```ts BR ``` ###### redress\_number? [Section titled “redress\_number?”](#redress_number) > `optional` **redress\_number?**: `object` ###### redress\_number.document\_number [Section titled “redress\_number.document\_number”](#redress_numberdocument_number) > **document\_number**: `string` ###### Description [Section titled “Description”](#description-83) The actual document number. ###### Example [Section titled “Example”](#example-75) ```ts 1231231 ``` ###### redress\_number.issuing\_country [Section titled “redress\_number.issuing\_country”](#redress_numberissuing_country) > **issuing\_country**: `string` ###### Description [Section titled “Description”](#description-84) The country that issued this document. ###### Example [Section titled “Example”](#example-76) ```ts BR ``` ###### tickets [Section titled “tickets”](#tickets) > **tickets**: `object`\[] ###### Description [Section titled “Description”](#description-85) The flight tickets in this booking. ###### type [Section titled “type”](#type) > **type**: `"AIR"` ###### Description [Section titled “Description”](#description-86) discriminator enum property added by openapi-typescript *** ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `car_details`: { `car_class?`: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"`; `display_name`: `string`; }; `reservation_details`: { `confirmation_code?`: `string` | `null`; `drop_off`: { `location`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; }; `pickup`: { `location`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; }; `rental_company?`: `string` | `null`; }; `type`: `"CAR_RENTAL"`; } ###### car\_details [Section titled “car\_details”](#car_details) > **car\_details**: `object` ###### car\_details.car\_class? [Section titled “car\_details.car\_class?”](#car_detailscar_class) > `optional` **car\_class?**: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"` ###### car\_details.display\_name [Section titled “car\_details.display\_name”](#car_detailsdisplay_name) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-87) The name of the car as displayed to the user. ###### Example [Section titled “Example”](#example-77) ```ts Intermediate car ``` ###### reservation\_details [Section titled “reservation\_details”](#reservation_details) > **reservation\_details**: `object` ###### reservation\_details.confirmation\_code? [Section titled “reservation\_details.confirmation\_code?”](#reservation_detailsconfirmation_code) > `optional` **confirmation\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-88) The confirmation code given by the vendor. ###### Example [Section titled “Example”](#example-78) ```ts 7003XBQ504 ``` ###### reservation\_details.drop\_off [Section titled “reservation\_details.drop\_off”](#reservation_detailsdrop_off) > **drop\_off**: `object` ###### reservation\_details.drop\_off.location [Section titled “reservation\_details.drop\_off.location”](#reservation_detailsdrop_offlocation) > **location**: `object` ###### reservation\_details.drop\_off.location.address\_line\_1? [Section titled “reservation\_details.drop\_off.location.address\_line\_1?”](#reservation_detailsdrop_offlocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-89) The first line of the address. ###### Example [Section titled “Example”](#example-79) ```ts Av. Vinte de Janeiro, S/N ``` ###### reservation\_details.drop\_off.location.address\_line\_2? [Section titled “reservation\_details.drop\_off.location.address\_line\_2?”](#reservation_detailsdrop_offlocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-90) The second line of the address. ###### Example [Section titled “Example”](#example-80) ```ts Ilha do Governador ``` ###### reservation\_details.drop\_off.location.administrative\_area? [Section titled “reservation\_details.drop\_off.location.administrative\_area?”](#reservation_detailsdrop_offlocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-91) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-81) ```ts RJ ``` ###### reservation\_details.drop\_off.location.city? [Section titled “reservation\_details.drop\_off.location.city?”](#reservation_detailsdrop_offlocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-92) The city where the address is located. ###### Example [Section titled “Example”](#example-82) ```ts Rio de Janeiro ``` ###### reservation\_details.drop\_off.location.coordinates? [Section titled “reservation\_details.drop\_off.location.coordinates?”](#reservation_detailsdrop_offlocationcoordinates) > `optional` **coordinates?**: `object` ###### reservation\_details.drop\_off.location.coordinates.latitude [Section titled “reservation\_details.drop\_off.location.coordinates.latitude”](#reservation_detailsdrop_offlocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-83) ```ts -22.8145373 ``` ###### reservation\_details.drop\_off.location.coordinates.longitude [Section titled “reservation\_details.drop\_off.location.coordinates.longitude”](#reservation_detailsdrop_offlocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-84) ```ts -43.2465548 ``` ###### reservation\_details.drop\_off.location.country? [Section titled “reservation\_details.drop\_off.location.country?”](#reservation_detailsdrop_offlocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-93) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-85) ```ts Brazil ``` ###### reservation\_details.drop\_off.location.postal\_code? [Section titled “reservation\_details.drop\_off.location.postal\_code?”](#reservation_detailsdrop_offlocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-94) The postal code of the given address. ###### Example [Section titled “Example”](#example-86) ```ts 21941-900 ``` ###### reservation\_details.drop\_off.location.timezone? [Section titled “reservation\_details.drop\_off.location.timezone?”](#reservation_detailsdrop_offlocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-95) The timezone in the given address. ###### Example [Section titled “Example”](#example-87) ```ts America/Sao_Paulo ``` ###### reservation\_details.drop\_off.time [Section titled “reservation\_details.drop\_off.time”](#reservation_detailsdrop_offtime) > **time**: `object` ###### reservation\_details.drop\_off.time.local\_time [Section titled “reservation\_details.drop\_off.time.local\_time”](#reservation_detailsdrop_offtimelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-96) The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.drop\_off.time.timestamp? [Section titled “reservation\_details.drop\_off.time.timestamp?”](#reservation_detailsdrop_offtimetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-97) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-88) ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.pickup [Section titled “reservation\_details.pickup”](#reservation_detailspickup) > **pickup**: `object` ###### reservation\_details.pickup.location [Section titled “reservation\_details.pickup.location”](#reservation_detailspickuplocation) > **location**: `object` ###### reservation\_details.pickup.location.address\_line\_1? [Section titled “reservation\_details.pickup.location.address\_line\_1?”](#reservation_detailspickuplocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-98) The first line of the address. ###### Example [Section titled “Example”](#example-89) ```ts Av. Vinte de Janeiro, S/N ``` ###### reservation\_details.pickup.location.address\_line\_2? [Section titled “reservation\_details.pickup.location.address\_line\_2?”](#reservation_detailspickuplocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-99) The second line of the address. ###### Example [Section titled “Example”](#example-90) ```ts Ilha do Governador ``` ###### reservation\_details.pickup.location.administrative\_area? [Section titled “reservation\_details.pickup.location.administrative\_area?”](#reservation_detailspickuplocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-100) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-91) ```ts RJ ``` ###### reservation\_details.pickup.location.city? [Section titled “reservation\_details.pickup.location.city?”](#reservation_detailspickuplocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-101) The city where the address is located. ###### Example [Section titled “Example”](#example-92) ```ts Rio de Janeiro ``` ###### reservation\_details.pickup.location.coordinates? [Section titled “reservation\_details.pickup.location.coordinates?”](#reservation_detailspickuplocationcoordinates) > `optional` **coordinates?**: `object` ###### reservation\_details.pickup.location.coordinates.latitude [Section titled “reservation\_details.pickup.location.coordinates.latitude”](#reservation_detailspickuplocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-93) ```ts -22.8145373 ``` ###### reservation\_details.pickup.location.coordinates.longitude [Section titled “reservation\_details.pickup.location.coordinates.longitude”](#reservation_detailspickuplocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-94) ```ts -43.2465548 ``` ###### reservation\_details.pickup.location.country? [Section titled “reservation\_details.pickup.location.country?”](#reservation_detailspickuplocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-102) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-95) ```ts Brazil ``` ###### reservation\_details.pickup.location.postal\_code? [Section titled “reservation\_details.pickup.location.postal\_code?”](#reservation_detailspickuplocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-103) The postal code of the given address. ###### Example [Section titled “Example”](#example-96) ```ts 21941-900 ``` ###### reservation\_details.pickup.location.timezone? [Section titled “reservation\_details.pickup.location.timezone?”](#reservation_detailspickuplocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-104) The timezone in the given address. ###### Example [Section titled “Example”](#example-97) ```ts America/Sao_Paulo ``` ###### reservation\_details.pickup.time [Section titled “reservation\_details.pickup.time”](#reservation_detailspickuptime) > **time**: `object` ###### reservation\_details.pickup.time.local\_time [Section titled “reservation\_details.pickup.time.local\_time”](#reservation_detailspickuptimelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-105) The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.pickup.time.timestamp? [Section titled “reservation\_details.pickup.time.timestamp?”](#reservation_detailspickuptimetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-106) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-98) ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.rental\_company? [Section titled “reservation\_details.rental\_company?”](#reservation_detailsrental_company) > `optional` **rental\_company?**: `string` | `null` ###### Description [Section titled “Description”](#description-107) Name of car rental company. ###### Example [Section titled “Example”](#example-99) ```ts Catch-A-Ride ``` ###### type [Section titled “type”](#type-1) > **type**: `"CAR_RENTAL"` ###### Description [Section titled “Description”](#description-108) discriminator enum property added by openapi-typescript *** ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `lodging_details`: { `brand_name?`: `string` | `null`; `chain_name?`: `string` | `null`; `contact_information?`: { `email?`: `string` | `null`; `fax?`: `string` | `null`; `phone?`: `string` | `null`; }; `display_name`: `string`; `location?`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `star_rating?`: `number` | `null`; }; `reservation_details`: { `check_in_time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; `checkout_time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; `confirmation_code?`: `string` | `null`; `room?`: { `bed_count?`: `number` | `null`; `bed_type?`: `string` | `null`; `description?`: `string` | `null`; `display_name?`: `string` | `null`; }; }; `type`: `"LODGING"`; } ###### lodging\_details [Section titled “lodging\_details”](#lodging_details) > **lodging\_details**: `object` ###### lodging\_details.brand\_name? [Section titled “lodging\_details.brand\_name?”](#lodging_detailsbrand_name) > `optional` **brand\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-109) The brand name of the hotel. ###### Example [Section titled “Example”](#example-100) ```ts Marriott Hotels ``` ###### lodging\_details.chain\_name? [Section titled “lodging\_details.chain\_name?”](#lodging_detailschain_name) > `optional` **chain\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-110) The name of the hotel chain. ###### Example [Section titled “Example”](#example-101) ```ts Accor Hotels ``` ###### lodging\_details.contact\_information? [Section titled “lodging\_details.contact\_information?”](#lodging_detailscontact_information) > `optional` **contact\_information?**: `object` ###### lodging\_details.contact\_information.email? [Section titled “lodging\_details.contact\_information.email?”](#lodging_detailscontact_informationemail) > `optional` **email?**: `string` | `null` ###### Description [Section titled “Description”](#description-111) The email address of the venue. ###### Example [Section titled “Example”](#example-102) ```ts city@hotelchain.com ``` ###### lodging\_details.contact\_information.fax? [Section titled “lodging\_details.contact\_information.fax?”](#lodging_detailscontact_informationfax) > `optional` **fax?**: `string` | `null` ###### Description [Section titled “Description”](#description-112) The fax number of the venue. ###### Example [Section titled “Example”](#example-103) ```ts 12345554321 ``` ###### lodging\_details.contact\_information.phone? [Section titled “lodging\_details.contact\_information.phone?”](#lodging_detailscontact_informationphone) > `optional` **phone?**: `string` | `null` ###### Description [Section titled “Description”](#description-113) The phone number of the venue. ###### Example [Section titled “Example”](#example-104) ```ts 12345554321 ``` ###### lodging\_details.display\_name [Section titled “lodging\_details.display\_name”](#lodging_detailsdisplay_name) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-114) The name of the venue as displayed to the user. ###### Example [Section titled “Example”](#example-105) ```ts Fancy Hotel ``` ###### lodging\_details.location? [Section titled “lodging\_details.location?”](#lodging_detailslocation) > `optional` **location?**: `object` ###### lodging\_details.location.address\_line\_1? [Section titled “lodging\_details.location.address\_line\_1?”](#lodging_detailslocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-115) The first line of the address. ###### Example [Section titled “Example”](#example-106) ```ts Av. Vinte de Janeiro, S/N ``` ###### lodging\_details.location.address\_line\_2? [Section titled “lodging\_details.location.address\_line\_2?”](#lodging_detailslocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-116) The second line of the address. ###### Example [Section titled “Example”](#example-107) ```ts Ilha do Governador ``` ###### lodging\_details.location.administrative\_area? [Section titled “lodging\_details.location.administrative\_area?”](#lodging_detailslocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-117) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-108) ```ts RJ ``` ###### lodging\_details.location.city? [Section titled “lodging\_details.location.city?”](#lodging_detailslocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-118) The city where the address is located. ###### Example [Section titled “Example”](#example-109) ```ts Rio de Janeiro ``` ###### lodging\_details.location.coordinates? [Section titled “lodging\_details.location.coordinates?”](#lodging_detailslocationcoordinates) > `optional` **coordinates?**: `object` ###### lodging\_details.location.coordinates.latitude [Section titled “lodging\_details.location.coordinates.latitude”](#lodging_detailslocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-110) ```ts -22.8145373 ``` ###### lodging\_details.location.coordinates.longitude [Section titled “lodging\_details.location.coordinates.longitude”](#lodging_detailslocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-111) ```ts -43.2465548 ``` ###### lodging\_details.location.country? [Section titled “lodging\_details.location.country?”](#lodging_detailslocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-119) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-112) ```ts Brazil ``` ###### lodging\_details.location.postal\_code? [Section titled “lodging\_details.location.postal\_code?”](#lodging_detailslocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-120) The postal code of the given address. ###### Example [Section titled “Example”](#example-113) ```ts 21941-900 ``` ###### lodging\_details.location.timezone? [Section titled “lodging\_details.location.timezone?”](#lodging_detailslocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-121) The timezone in the given address. ###### Example [Section titled “Example”](#example-114) ```ts America/Sao_Paulo ``` ###### lodging\_details.star\_rating? [Section titled “lodging\_details.star\_rating?”](#lodging_detailsstar_rating) > `optional` **star\_rating?**: `number` | `null` Format: float ###### Description [Section titled “Description”](#description-122) The star rating of the hotel. Some hotels have half stars. ###### Example [Section titled “Example”](#example-115) ```ts 3.5 ``` ###### reservation\_details [Section titled “reservation\_details”](#reservation_details-1) > **reservation\_details**: `object` ###### reservation\_details.check\_in\_time [Section titled “reservation\_details.check\_in\_time”](#reservation_detailscheck_in_time) > **check\_in\_time**: `object` ###### reservation\_details.check\_in\_time.local\_time [Section titled “reservation\_details.check\_in\_time.local\_time”](#reservation_detailscheck_in_timelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-123) The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.check\_in\_time.timestamp? [Section titled “reservation\_details.check\_in\_time.timestamp?”](#reservation_detailscheck_in_timetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-124) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-116) ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.checkout\_time [Section titled “reservation\_details.checkout\_time”](#reservation_detailscheckout_time) > **checkout\_time**: `object` ###### reservation\_details.checkout\_time.local\_time [Section titled “reservation\_details.checkout\_time.local\_time”](#reservation_detailscheckout_timelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-125) The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.checkout\_time.timestamp? [Section titled “reservation\_details.checkout\_time.timestamp?”](#reservation_detailscheckout_timetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-126) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-117) ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.confirmation\_code? [Section titled “reservation\_details.confirmation\_code?”](#reservation_detailsconfirmation_code-1) > `optional` **confirmation\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-127) Confirmation code provided by the vendor. ###### Example [Section titled “Example”](#example-118) ```ts 7003XBQ504 ``` ###### reservation\_details.room? [Section titled “reservation\_details.room?”](#reservation_detailsroom) > `optional` **room?**: `object` ###### reservation\_details.room.bed\_count? [Section titled “reservation\_details.room.bed\_count?”](#reservation_detailsroombed_count) > `optional` **bed\_count?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-128) The number of beds. ###### Example [Section titled “Example”](#example-119) ```ts 1 ``` ###### reservation\_details.room.bed\_type? [Section titled “reservation\_details.room.bed\_type?”](#reservation_detailsroombed_type) > `optional` **bed\_type?**: `string` | `null` ###### Description [Section titled “Description”](#description-129) The kind of bed. ###### Example [Section titled “Example”](#example-120) ```ts DOUBLE ``` ###### reservation\_details.room.description? [Section titled “reservation\_details.room.description?”](#reservation_detailsroomdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-130) A description of the room. ###### Example [Section titled “Example”](#example-121) ```ts Superior room ``` ###### reservation\_details.room.display\_name? [Section titled “reservation\_details.room.display\_name?”](#reservation_detailsroomdisplay_name) > `optional` **display\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-131) The name of the room as displayed to the user. ###### Example [Section titled “Example”](#example-122) ```ts Standard room ``` ###### type [Section titled “type”](#type-2) > **type**: `"LODGING"` ###### Description [Section titled “Description”](#description-132) discriminator enum property added by openapi-typescript *** ###### Type Literal [Section titled “Type Literal”](#type-literal-3) { `journeys`: `object`\[]; `type`: `"RAIL"`; } ###### journeys [Section titled “journeys”](#journeys-1) > **journeys**: `object`\[] ###### Description [Section titled “Description”](#description-133) The journeys that make up this booking. ###### type [Section titled “type”](#type-3) > **type**: `"RAIL"` ###### Description [Section titled “Description”](#description-134) discriminator enum property added by openapi-typescript ##### Booking.created\_at [Section titled “Booking.created\_at”](#bookingcreated_at) > **created\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-135) The time when the booking was created. ###### Example [Section titled “Example”](#example-123) ```ts 2017-12-27T15:42:30Z ``` ##### Booking.id [Section titled “Booking.id”](#bookingid) > **id**: `string` ###### Description [Section titled “Description”](#description-136) The ID of the booking. ###### Example [Section titled “Example”](#example-124) ```ts booking_cl9t5dnu800040m3071dandeq ``` ##### Booking.source [Section titled “Booking.source”](#bookingsource) > **source**: `"BREX_TRAVEL"` | `"EXTERNAL"` ##### Booking.status [Section titled “Booking.status”](#bookingstatus) > **status**: `"PROCESSING"` | `"CANCELED"` | `"REFUNDED"` | `"IN_PROGRESS"` | `"APPROVAL_DENIED"` | `"PENDING"` | `"CONFIRMED"` | `"HOLD"` | `"COMPLETED"` | `"VOIDED"` | `"UNCONFIRMED"` | `"AIRLINE_CONTROL"` | `"PAYMENT_DECLINED"` | `"SCHEDULE_CHANGE"` | `"APPROVAL_REQUESTED"` | `"CANCELLATION_IN_PROGRESS"` ##### Booking.trip\_id [Section titled “Booking.trip\_id”](#bookingtrip_id) > **trip\_id**: `string` ###### Description [Section titled “Description”](#description-137) The ID of the trip to which this booking belongs. ###### Example [Section titled “Example”](#example-125) ```ts trip_cl9rh1n8g001e0j84w6fb4fd1 ``` ##### Booking.type [Section titled “Booking.type”](#bookingtype) > **type**: `"CAR_RENTAL"` | `"LODGING"` | `"AIR"` | `"RAIL"` ##### Booking.updated\_at [Section titled “Booking.updated\_at”](#bookingupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-138) The time when the booking was last updated. ###### Example [Section titled “Example”](#example-126) ```ts 2017-12-27T15:42:30Z ``` ##### Booking.version [Section titled “Booking.version”](#bookingversion) > **version**: `number` Format: int32 ###### Description [Section titled “Description”](#description-139) The current version of the booking. ###### Example [Section titled “Example”](#example-127) ```ts 2 ``` ##### Booking.Data [Section titled “Booking.Data”](#bookingdata) > **Booking.Data**: { `journeys`: `object`\[]; `known_traveler_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `redress_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `tickets`: `object`\[]; `type`: `"AIR"`; } | { `car_details`: { `car_class?`: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"`; `display_name`: `string`; }; `reservation_details`: { `confirmation_code?`: `string` | `null`; `drop_off`: { `location`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; }; `pickup`: { `location`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; }; `rental_company?`: `string` | `null`; }; `type`: `"CAR_RENTAL"`; } | { `lodging_details`: { `brand_name?`: `string` | `null`; `chain_name?`: `string` | `null`; `contact_information?`: { `email?`: `string` | `null`; `fax?`: `string` | `null`; `phone?`: `string` | `null`; }; `display_name`: `string`; `location?`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `star_rating?`: `number` | `null`; }; `reservation_details`: { `check_in_time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; `checkout_time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; `confirmation_code?`: `string` | `null`; `room?`: { `bed_count?`: `number` | `null`; `bed_type?`: `string` | `null`; `description?`: `string` | `null`; `display_name?`: `string` | `null`; }; }; `type`: `"LODGING"`; } | { `journeys`: `object`\[]; `type`: `"RAIL"`; } ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-4) { `journeys`: `object`\[]; `known_traveler_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `redress_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `tickets`: `object`\[]; `type`: `"AIR"`; } ###### journeys [Section titled “journeys”](#journeys-2) > **journeys**: `object`\[] ###### Description [Section titled “Description”](#description-140) The journeys that make up this booking. ###### known\_traveler\_number? [Section titled “known\_traveler\_number?”](#known_traveler_number-1) > `optional` **known\_traveler\_number?**: `object` ###### known\_traveler\_number.document\_number [Section titled “known\_traveler\_number.document\_number”](#known_traveler_numberdocument_number-1) > **document\_number**: `string` ###### Description [Section titled “Description”](#description-141) The actual document number. ###### Example [Section titled “Example”](#example-128) ```ts 1231231 ``` ###### known\_traveler\_number.issuing\_country [Section titled “known\_traveler\_number.issuing\_country”](#known_traveler_numberissuing_country-1) > **issuing\_country**: `string` ###### Description [Section titled “Description”](#description-142) The country that issued this document. ###### Example [Section titled “Example”](#example-129) ```ts BR ``` ###### redress\_number? [Section titled “redress\_number?”](#redress_number-1) > `optional` **redress\_number?**: `object` ###### redress\_number.document\_number [Section titled “redress\_number.document\_number”](#redress_numberdocument_number-1) > **document\_number**: `string` ###### Description [Section titled “Description”](#description-143) The actual document number. ###### Example [Section titled “Example”](#example-130) ```ts 1231231 ``` ###### redress\_number.issuing\_country [Section titled “redress\_number.issuing\_country”](#redress_numberissuing_country-1) > **issuing\_country**: `string` ###### Description [Section titled “Description”](#description-144) The country that issued this document. ###### Example [Section titled “Example”](#example-131) ```ts BR ``` ###### tickets [Section titled “tickets”](#tickets-1) > **tickets**: `object`\[] ###### Description [Section titled “Description”](#description-145) The flight tickets in this booking. ###### type [Section titled “type”](#type-4) > **type**: `"AIR"` ###### Description [Section titled “Description”](#description-146) discriminator enum property added by openapi-typescript *** ###### Type Literal [Section titled “Type Literal”](#type-literal-5) { `car_details`: { `car_class?`: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"`; `display_name`: `string`; }; `reservation_details`: { `confirmation_code?`: `string` | `null`; `drop_off`: { `location`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; }; `pickup`: { `location`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; }; `rental_company?`: `string` | `null`; }; `type`: `"CAR_RENTAL"`; } ###### car\_details [Section titled “car\_details”](#car_details-1) > **car\_details**: `object` ###### car\_details.car\_class? [Section titled “car\_details.car\_class?”](#car_detailscar_class-1) > `optional` **car\_class?**: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"` ###### car\_details.display\_name [Section titled “car\_details.display\_name”](#car_detailsdisplay_name-1) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-147) The name of the car as displayed to the user. ###### Example [Section titled “Example”](#example-132) ```ts Intermediate car ``` ###### reservation\_details [Section titled “reservation\_details”](#reservation_details-2) > **reservation\_details**: `object` ###### reservation\_details.confirmation\_code? [Section titled “reservation\_details.confirmation\_code?”](#reservation_detailsconfirmation_code-2) > `optional` **confirmation\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-148) The confirmation code given by the vendor. ###### Example [Section titled “Example”](#example-133) ```ts 7003XBQ504 ``` ###### reservation\_details.drop\_off [Section titled “reservation\_details.drop\_off”](#reservation_detailsdrop_off-1) > **drop\_off**: `object` ###### reservation\_details.drop\_off.location [Section titled “reservation\_details.drop\_off.location”](#reservation_detailsdrop_offlocation-1) > **location**: `object` ###### reservation\_details.drop\_off.location.address\_line\_1? [Section titled “reservation\_details.drop\_off.location.address\_line\_1?”](#reservation_detailsdrop_offlocationaddress_line_1-1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-149) The first line of the address. ###### Example [Section titled “Example”](#example-134) ```ts Av. Vinte de Janeiro, S/N ``` ###### reservation\_details.drop\_off.location.address\_line\_2? [Section titled “reservation\_details.drop\_off.location.address\_line\_2?”](#reservation_detailsdrop_offlocationaddress_line_2-1) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-150) The second line of the address. ###### Example [Section titled “Example”](#example-135) ```ts Ilha do Governador ``` ###### reservation\_details.drop\_off.location.administrative\_area? [Section titled “reservation\_details.drop\_off.location.administrative\_area?”](#reservation_detailsdrop_offlocationadministrative_area-1) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-151) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-136) ```ts RJ ``` ###### reservation\_details.drop\_off.location.city? [Section titled “reservation\_details.drop\_off.location.city?”](#reservation_detailsdrop_offlocationcity-1) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-152) The city where the address is located. ###### Example [Section titled “Example”](#example-137) ```ts Rio de Janeiro ``` ###### reservation\_details.drop\_off.location.coordinates? [Section titled “reservation\_details.drop\_off.location.coordinates?”](#reservation_detailsdrop_offlocationcoordinates-1) > `optional` **coordinates?**: `object` ###### reservation\_details.drop\_off.location.coordinates.latitude [Section titled “reservation\_details.drop\_off.location.coordinates.latitude”](#reservation_detailsdrop_offlocationcoordinateslatitude-1) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-138) ```ts -22.8145373 ``` ###### reservation\_details.drop\_off.location.coordinates.longitude [Section titled “reservation\_details.drop\_off.location.coordinates.longitude”](#reservation_detailsdrop_offlocationcoordinateslongitude-1) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-139) ```ts -43.2465548 ``` ###### reservation\_details.drop\_off.location.country? [Section titled “reservation\_details.drop\_off.location.country?”](#reservation_detailsdrop_offlocationcountry-1) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-153) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-140) ```ts Brazil ``` ###### reservation\_details.drop\_off.location.postal\_code? [Section titled “reservation\_details.drop\_off.location.postal\_code?”](#reservation_detailsdrop_offlocationpostal_code-1) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-154) The postal code of the given address. ###### Example [Section titled “Example”](#example-141) ```ts 21941-900 ``` ###### reservation\_details.drop\_off.location.timezone? [Section titled “reservation\_details.drop\_off.location.timezone?”](#reservation_detailsdrop_offlocationtimezone-1) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-155) The timezone in the given address. ###### Example [Section titled “Example”](#example-142) ```ts America/Sao_Paulo ``` ###### reservation\_details.drop\_off.time [Section titled “reservation\_details.drop\_off.time”](#reservation_detailsdrop_offtime-1) > **time**: `object` ###### reservation\_details.drop\_off.time.local\_time [Section titled “reservation\_details.drop\_off.time.local\_time”](#reservation_detailsdrop_offtimelocal_time-1) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-156) The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.drop\_off.time.timestamp? [Section titled “reservation\_details.drop\_off.time.timestamp?”](#reservation_detailsdrop_offtimetimestamp-1) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-157) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-143) ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.pickup [Section titled “reservation\_details.pickup”](#reservation_detailspickup-1) > **pickup**: `object` ###### reservation\_details.pickup.location [Section titled “reservation\_details.pickup.location”](#reservation_detailspickuplocation-1) > **location**: `object` ###### reservation\_details.pickup.location.address\_line\_1? [Section titled “reservation\_details.pickup.location.address\_line\_1?”](#reservation_detailspickuplocationaddress_line_1-1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-158) The first line of the address. ###### Example [Section titled “Example”](#example-144) ```ts Av. Vinte de Janeiro, S/N ``` ###### reservation\_details.pickup.location.address\_line\_2? [Section titled “reservation\_details.pickup.location.address\_line\_2?”](#reservation_detailspickuplocationaddress_line_2-1) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-159) The second line of the address. ###### Example [Section titled “Example”](#example-145) ```ts Ilha do Governador ``` ###### reservation\_details.pickup.location.administrative\_area? [Section titled “reservation\_details.pickup.location.administrative\_area?”](#reservation_detailspickuplocationadministrative_area-1) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-160) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-146) ```ts RJ ``` ###### reservation\_details.pickup.location.city? [Section titled “reservation\_details.pickup.location.city?”](#reservation_detailspickuplocationcity-1) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-161) The city where the address is located. ###### Example [Section titled “Example”](#example-147) ```ts Rio de Janeiro ``` ###### reservation\_details.pickup.location.coordinates? [Section titled “reservation\_details.pickup.location.coordinates?”](#reservation_detailspickuplocationcoordinates-1) > `optional` **coordinates?**: `object` ###### reservation\_details.pickup.location.coordinates.latitude [Section titled “reservation\_details.pickup.location.coordinates.latitude”](#reservation_detailspickuplocationcoordinateslatitude-1) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-148) ```ts -22.8145373 ``` ###### reservation\_details.pickup.location.coordinates.longitude [Section titled “reservation\_details.pickup.location.coordinates.longitude”](#reservation_detailspickuplocationcoordinateslongitude-1) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-149) ```ts -43.2465548 ``` ###### reservation\_details.pickup.location.country? [Section titled “reservation\_details.pickup.location.country?”](#reservation_detailspickuplocationcountry-1) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-162) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-150) ```ts Brazil ``` ###### reservation\_details.pickup.location.postal\_code? [Section titled “reservation\_details.pickup.location.postal\_code?”](#reservation_detailspickuplocationpostal_code-1) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-163) The postal code of the given address. ###### Example [Section titled “Example”](#example-151) ```ts 21941-900 ``` ###### reservation\_details.pickup.location.timezone? [Section titled “reservation\_details.pickup.location.timezone?”](#reservation_detailspickuplocationtimezone-1) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-164) The timezone in the given address. ###### Example [Section titled “Example”](#example-152) ```ts America/Sao_Paulo ``` ###### reservation\_details.pickup.time [Section titled “reservation\_details.pickup.time”](#reservation_detailspickuptime-1) > **time**: `object` ###### reservation\_details.pickup.time.local\_time [Section titled “reservation\_details.pickup.time.local\_time”](#reservation_detailspickuptimelocal_time-1) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-165) The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.pickup.time.timestamp? [Section titled “reservation\_details.pickup.time.timestamp?”](#reservation_detailspickuptimetimestamp-1) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-166) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-153) ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.rental\_company? [Section titled “reservation\_details.rental\_company?”](#reservation_detailsrental_company-1) > `optional` **rental\_company?**: `string` | `null` ###### Description [Section titled “Description”](#description-167) Name of car rental company. ###### Example [Section titled “Example”](#example-154) ```ts Catch-A-Ride ``` ###### type [Section titled “type”](#type-5) > **type**: `"CAR_RENTAL"` ###### Description [Section titled “Description”](#description-168) discriminator enum property added by openapi-typescript *** ###### Type Literal [Section titled “Type Literal”](#type-literal-6) { `lodging_details`: { `brand_name?`: `string` | `null`; `chain_name?`: `string` | `null`; `contact_information?`: { `email?`: `string` | `null`; `fax?`: `string` | `null`; `phone?`: `string` | `null`; }; `display_name`: `string`; `location?`: { `address_line_1?`: `string` | `null`; `address_line_2?`: `string` | `null`; `administrative_area?`: `string` | `null`; `city?`: `string` | `null`; `coordinates?`: { `latitude`: `number`; `longitude`: `number`; }; `country?`: `string` | `null`; `postal_code?`: `string` | `null`; `timezone?`: `string` | `null`; }; `star_rating?`: `number` | `null`; }; `reservation_details`: { `check_in_time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; `checkout_time`: { `local_time`: `string`; `timestamp?`: `string` | `null`; }; `confirmation_code?`: `string` | `null`; `room?`: { `bed_count?`: `number` | `null`; `bed_type?`: `string` | `null`; `description?`: `string` | `null`; `display_name?`: `string` | `null`; }; }; `type`: `"LODGING"`; } ###### lodging\_details [Section titled “lodging\_details”](#lodging_details-1) > **lodging\_details**: `object` ###### lodging\_details.brand\_name? [Section titled “lodging\_details.brand\_name?”](#lodging_detailsbrand_name-1) > `optional` **brand\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-169) The brand name of the hotel. ###### Example [Section titled “Example”](#example-155) ```ts Marriott Hotels ``` ###### lodging\_details.chain\_name? [Section titled “lodging\_details.chain\_name?”](#lodging_detailschain_name-1) > `optional` **chain\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-170) The name of the hotel chain. ###### Example [Section titled “Example”](#example-156) ```ts Accor Hotels ``` ###### lodging\_details.contact\_information? [Section titled “lodging\_details.contact\_information?”](#lodging_detailscontact_information-1) > `optional` **contact\_information?**: `object` ###### lodging\_details.contact\_information.email? [Section titled “lodging\_details.contact\_information.email?”](#lodging_detailscontact_informationemail-1) > `optional` **email?**: `string` | `null` ###### Description [Section titled “Description”](#description-171) The email address of the venue. ###### Example [Section titled “Example”](#example-157) ```ts city@hotelchain.com ``` ###### lodging\_details.contact\_information.fax? [Section titled “lodging\_details.contact\_information.fax?”](#lodging_detailscontact_informationfax-1) > `optional` **fax?**: `string` | `null` ###### Description [Section titled “Description”](#description-172) The fax number of the venue. ###### Example [Section titled “Example”](#example-158) ```ts 12345554321 ``` ###### lodging\_details.contact\_information.phone? [Section titled “lodging\_details.contact\_information.phone?”](#lodging_detailscontact_informationphone-1) > `optional` **phone?**: `string` | `null` ###### Description [Section titled “Description”](#description-173) The phone number of the venue. ###### Example [Section titled “Example”](#example-159) ```ts 12345554321 ``` ###### lodging\_details.display\_name [Section titled “lodging\_details.display\_name”](#lodging_detailsdisplay_name-1) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-174) The name of the venue as displayed to the user. ###### Example [Section titled “Example”](#example-160) ```ts Fancy Hotel ``` ###### lodging\_details.location? [Section titled “lodging\_details.location?”](#lodging_detailslocation-1) > `optional` **location?**: `object` ###### lodging\_details.location.address\_line\_1? [Section titled “lodging\_details.location.address\_line\_1?”](#lodging_detailslocationaddress_line_1-1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-175) The first line of the address. ###### Example [Section titled “Example”](#example-161) ```ts Av. Vinte de Janeiro, S/N ``` ###### lodging\_details.location.address\_line\_2? [Section titled “lodging\_details.location.address\_line\_2?”](#lodging_detailslocationaddress_line_2-1) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-176) The second line of the address. ###### Example [Section titled “Example”](#example-162) ```ts Ilha do Governador ``` ###### lodging\_details.location.administrative\_area? [Section titled “lodging\_details.location.administrative\_area?”](#lodging_detailslocationadministrative_area-1) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-177) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-163) ```ts RJ ``` ###### lodging\_details.location.city? [Section titled “lodging\_details.location.city?”](#lodging_detailslocationcity-1) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-178) The city where the address is located. ###### Example [Section titled “Example”](#example-164) ```ts Rio de Janeiro ``` ###### lodging\_details.location.coordinates? [Section titled “lodging\_details.location.coordinates?”](#lodging_detailslocationcoordinates-1) > `optional` **coordinates?**: `object` ###### lodging\_details.location.coordinates.latitude [Section titled “lodging\_details.location.coordinates.latitude”](#lodging_detailslocationcoordinateslatitude-1) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-165) ```ts -22.8145373 ``` ###### lodging\_details.location.coordinates.longitude [Section titled “lodging\_details.location.coordinates.longitude”](#lodging_detailslocationcoordinateslongitude-1) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-166) ```ts -43.2465548 ``` ###### lodging\_details.location.country? [Section titled “lodging\_details.location.country?”](#lodging_detailslocationcountry-1) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-179) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-167) ```ts Brazil ``` ###### lodging\_details.location.postal\_code? [Section titled “lodging\_details.location.postal\_code?”](#lodging_detailslocationpostal_code-1) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-180) The postal code of the given address. ###### Example [Section titled “Example”](#example-168) ```ts 21941-900 ``` ###### lodging\_details.location.timezone? [Section titled “lodging\_details.location.timezone?”](#lodging_detailslocationtimezone-1) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-181) The timezone in the given address. ###### Example [Section titled “Example”](#example-169) ```ts America/Sao_Paulo ``` ###### lodging\_details.star\_rating? [Section titled “lodging\_details.star\_rating?”](#lodging_detailsstar_rating-1) > `optional` **star\_rating?**: `number` | `null` Format: float ###### Description [Section titled “Description”](#description-182) The star rating of the hotel. Some hotels have half stars. ###### Example [Section titled “Example”](#example-170) ```ts 3.5 ``` ###### reservation\_details [Section titled “reservation\_details”](#reservation_details-3) > **reservation\_details**: `object` ###### reservation\_details.check\_in\_time [Section titled “reservation\_details.check\_in\_time”](#reservation_detailscheck_in_time-1) > **check\_in\_time**: `object` ###### reservation\_details.check\_in\_time.local\_time [Section titled “reservation\_details.check\_in\_time.local\_time”](#reservation_detailscheck_in_timelocal_time-1) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-183) The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.check\_in\_time.timestamp? [Section titled “reservation\_details.check\_in\_time.timestamp?”](#reservation_detailscheck_in_timetimestamp-1) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-184) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-171) ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.checkout\_time [Section titled “reservation\_details.checkout\_time”](#reservation_detailscheckout_time-1) > **checkout\_time**: `object` ###### reservation\_details.checkout\_time.local\_time [Section titled “reservation\_details.checkout\_time.local\_time”](#reservation_detailscheckout_timelocal_time-1) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-185) The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.checkout\_time.timestamp? [Section titled “reservation\_details.checkout\_time.timestamp?”](#reservation_detailscheckout_timetimestamp-1) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-186) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-172) ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.confirmation\_code? [Section titled “reservation\_details.confirmation\_code?”](#reservation_detailsconfirmation_code-3) > `optional` **confirmation\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-187) Confirmation code provided by the vendor. ###### Example [Section titled “Example”](#example-173) ```ts 7003XBQ504 ``` ###### reservation\_details.room? [Section titled “reservation\_details.room?”](#reservation_detailsroom-1) > `optional` **room?**: `object` ###### reservation\_details.room.bed\_count? [Section titled “reservation\_details.room.bed\_count?”](#reservation_detailsroombed_count-1) > `optional` **bed\_count?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-188) The number of beds. ###### Example [Section titled “Example”](#example-174) ```ts 1 ``` ###### reservation\_details.room.bed\_type? [Section titled “reservation\_details.room.bed\_type?”](#reservation_detailsroombed_type-1) > `optional` **bed\_type?**: `string` | `null` ###### Description [Section titled “Description”](#description-189) The kind of bed. ###### Example [Section titled “Example”](#example-175) ```ts DOUBLE ``` ###### reservation\_details.room.description? [Section titled “reservation\_details.room.description?”](#reservation_detailsroomdescription-1) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-190) A description of the room. ###### Example [Section titled “Example”](#example-176) ```ts Superior room ``` ###### reservation\_details.room.display\_name? [Section titled “reservation\_details.room.display\_name?”](#reservation_detailsroomdisplay_name-1) > `optional` **display\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-191) The name of the room as displayed to the user. ###### Example [Section titled “Example”](#example-177) ```ts Standard room ``` ###### type [Section titled “type”](#type-6) > **type**: `"LODGING"` ###### Description [Section titled “Description”](#description-192) discriminator enum property added by openapi-typescript *** ###### Type Literal [Section titled “Type Literal”](#type-literal-7) { `journeys`: `object`\[]; `type`: `"RAIL"`; } ###### journeys [Section titled “journeys”](#journeys-3) > **journeys**: `object`\[] ###### Description [Section titled “Description”](#description-193) The journeys that make up this booking. ###### type [Section titled “type”](#type-7) > **type**: `"RAIL"` ###### Description [Section titled “Description”](#description-194) discriminator enum property added by openapi-typescript ###### Description [Section titled “Description”](#description-195) Type-specific booking data. ##### Booking.Source [Section titled “Booking.Source”](#bookingsource-1) > **Booking.Source**: `"BREX_TRAVEL"` | `"EXTERNAL"` ###### Description [Section titled “Description”](#description-196) The original source of a booking: \* `BREX_TRAVEL` - The booking was created via Brex Travel. \* `EXTERNAL` - The booking was manually inserted, e.g. a hotel room block for a group event. ###### Example [Section titled “Example”](#example-178) ```ts BREX_TRAVEL @enum {string} ``` ##### Booking.Time [Section titled “Booking.Time”](#bookingtime) > **Booking.Time**: `object` ###### Description [Section titled “Description”](#description-197) A time within a booking, including local time in the relevant location, and a timestamp when possible. ##### Booking.Time.local\_time [Section titled “Booking.Time.local\_time”](#bookingtimelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-198) The local time in the relevant location in the ISO 8601 format. ##### Booking.Time.timestamp? [Section titled “Booking.Time.timestamp?”](#bookingtimetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-199) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-179) ```ts 2017-12-27T15:42:30Z ``` ##### Booking.Type [Section titled “Booking.Type”](#bookingtype-1) > **Booking.Type**: `"CAR_RENTAL"` | `"LODGING"` | `"AIR"` | `"RAIL"` ###### Description [Section titled “Description”](#description-200) The type of a booking. ###### Example [Section titled “Example”](#example-180) ```ts AIR @enum {string} ``` #### BookingStatus [Section titled “BookingStatus”](#bookingstatus-1) > **BookingStatus**: `"PROCESSING"` | `"CANCELED"` | `"REFUNDED"` | `"IN_PROGRESS"` | `"APPROVAL_DENIED"` | `"PENDING"` | `"CONFIRMED"` | `"HOLD"` | `"COMPLETED"` | `"VOIDED"` | `"UNCONFIRMED"` | `"AIRLINE_CONTROL"` | `"PAYMENT_DECLINED"` | `"SCHEDULE_CHANGE"` | `"APPROVAL_REQUESTED"` | `"CANCELLATION_IN_PROGRESS"` ##### Description [Section titled “Description”](#description-201) The status of the booking: \* `HOLD` - The booking is a hold, and may be canceled without being charged. \* `PENDING` - Some action needs to be completed before the booking is confirmed. Usually the action is the payment being confirmed. \* `CONFIRMED` - The booking is confirmed. \* `COMPLETED` - The booking has already happened. \* `CANCELED` - The booking has been canceled. \* `IN_PROGRESS` - The booking is currently in progress. \* `REFUNDED` - A refund has been issued. It may or may not be a full refund. \* `VOIDED` - Voided is similar to (and can be treated the same as) canceled. \* `PROCESSING` - The booking has been created or changed, but confirmation from the vendor has not been received yet. \* `UNCONFIRMED` - The booking was in the `PROCESSING` state for too long and some action is probably required to get this booking confirmed. \* `AIRLINE_CONTROL` - The airline has taken control of the booking and further updates may not be visible. \* `PAYMENT_DECLINED` - The payment for the booking has failed. \* `SCHEDULE_CHANGE` - Some change has happened to the booking schedule, e.g. the flight getting canceled and the passenger reallocated to another flight. Travel support should reach out to confirm the traveler accepts the new schedule. \* `APPROVAL_REQUESTED` - The booking is subject to approval, and it is waiting for a review. \* `APPROVAL_DENIED` - A reviewer has denied the booking, or the deadline to approve the booking has passed and it got canceled. \* `CANCELLATION_IN_PROGRESS` - The booking is currently being canceled. ##### Example [Section titled “Example”](#example-181) ```ts CONFIRMED @enum {string} ``` #### CarRentalBookingData [Section titled “CarRentalBookingData”](#carrentalbookingdata) > **CarRentalBookingData**: `object` ##### Description [Section titled “Description”](#description-202) Car rental-specific booking information. ##### CarRentalBookingData.car\_details [Section titled “CarRentalBookingData.car\_details”](#carrentalbookingdatacar_details) > **car\_details**: `object` ##### CarRentalBookingData.car\_details.car\_class? [Section titled “CarRentalBookingData.car\_details.car\_class?”](#carrentalbookingdatacar_detailscar_class) > `optional` **car\_class?**: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"` ##### CarRentalBookingData.car\_details.display\_name [Section titled “CarRentalBookingData.car\_details.display\_name”](#carrentalbookingdatacar_detailsdisplay_name) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-203) The name of the car as displayed to the user. ###### Example [Section titled “Example”](#example-182) ```ts Intermediate car ``` ##### CarRentalBookingData.reservation\_details [Section titled “CarRentalBookingData.reservation\_details”](#carrentalbookingdatareservation_details) > **reservation\_details**: `object` ##### CarRentalBookingData.reservation\_details.confirmation\_code? [Section titled “CarRentalBookingData.reservation\_details.confirmation\_code?”](#carrentalbookingdatareservation_detailsconfirmation_code) > `optional` **confirmation\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-204) The confirmation code given by the vendor. ###### Example [Section titled “Example”](#example-183) ```ts 7003XBQ504 ``` ##### CarRentalBookingData.reservation\_details.drop\_off [Section titled “CarRentalBookingData.reservation\_details.drop\_off”](#carrentalbookingdatareservation_detailsdrop_off) > **drop\_off**: `object` ##### CarRentalBookingData.reservation\_details.drop\_off.location [Section titled “CarRentalBookingData.reservation\_details.drop\_off.location”](#carrentalbookingdatareservation_detailsdrop_offlocation) > **location**: `object` ##### CarRentalBookingData.reservation\_details.drop\_off.location.address\_line\_1? [Section titled “CarRentalBookingData.reservation\_details.drop\_off.location.address\_line\_1?”](#carrentalbookingdatareservation_detailsdrop_offlocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-205) The first line of the address. ###### Example [Section titled “Example”](#example-184) ```ts Av. Vinte de Janeiro, S/N ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.address\_line\_2? [Section titled “CarRentalBookingData.reservation\_details.drop\_off.location.address\_line\_2?”](#carrentalbookingdatareservation_detailsdrop_offlocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-206) The second line of the address. ###### Example [Section titled “Example”](#example-185) ```ts Ilha do Governador ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.administrative\_area? [Section titled “CarRentalBookingData.reservation\_details.drop\_off.location.administrative\_area?”](#carrentalbookingdatareservation_detailsdrop_offlocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-207) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-186) ```ts RJ ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.city? [Section titled “CarRentalBookingData.reservation\_details.drop\_off.location.city?”](#carrentalbookingdatareservation_detailsdrop_offlocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-208) The city where the address is located. ###### Example [Section titled “Example”](#example-187) ```ts Rio de Janeiro ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.coordinates? [Section titled “CarRentalBookingData.reservation\_details.drop\_off.location.coordinates?”](#carrentalbookingdatareservation_detailsdrop_offlocationcoordinates) > `optional` **coordinates?**: `object` ##### CarRentalBookingData.reservation\_details.drop\_off.location.coordinates.latitude [Section titled “CarRentalBookingData.reservation\_details.drop\_off.location.coordinates.latitude”](#carrentalbookingdatareservation_detailsdrop_offlocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-188) ```ts -22.8145373 ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.coordinates.longitude [Section titled “CarRentalBookingData.reservation\_details.drop\_off.location.coordinates.longitude”](#carrentalbookingdatareservation_detailsdrop_offlocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-189) ```ts -43.2465548 ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.country? [Section titled “CarRentalBookingData.reservation\_details.drop\_off.location.country?”](#carrentalbookingdatareservation_detailsdrop_offlocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-209) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-190) ```ts Brazil ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.postal\_code? [Section titled “CarRentalBookingData.reservation\_details.drop\_off.location.postal\_code?”](#carrentalbookingdatareservation_detailsdrop_offlocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-210) The postal code of the given address. ###### Example [Section titled “Example”](#example-191) ```ts 21941-900 ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.timezone? [Section titled “CarRentalBookingData.reservation\_details.drop\_off.location.timezone?”](#carrentalbookingdatareservation_detailsdrop_offlocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-211) The timezone in the given address. ###### Example [Section titled “Example”](#example-192) ```ts America/Sao_Paulo ``` ##### CarRentalBookingData.reservation\_details.drop\_off.time [Section titled “CarRentalBookingData.reservation\_details.drop\_off.time”](#carrentalbookingdatareservation_detailsdrop_offtime) > **time**: `object` ##### CarRentalBookingData.reservation\_details.drop\_off.time.local\_time [Section titled “CarRentalBookingData.reservation\_details.drop\_off.time.local\_time”](#carrentalbookingdatareservation_detailsdrop_offtimelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-212) The local time in the relevant location in the ISO 8601 format. ##### CarRentalBookingData.reservation\_details.drop\_off.time.timestamp? [Section titled “CarRentalBookingData.reservation\_details.drop\_off.time.timestamp?”](#carrentalbookingdatareservation_detailsdrop_offtimetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-213) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-193) ```ts 2017-12-27T15:42:30Z ``` ##### CarRentalBookingData.reservation\_details.pickup [Section titled “CarRentalBookingData.reservation\_details.pickup”](#carrentalbookingdatareservation_detailspickup) > **pickup**: `object` ##### CarRentalBookingData.reservation\_details.pickup.location [Section titled “CarRentalBookingData.reservation\_details.pickup.location”](#carrentalbookingdatareservation_detailspickuplocation) > **location**: `object` ##### CarRentalBookingData.reservation\_details.pickup.location.address\_line\_1? [Section titled “CarRentalBookingData.reservation\_details.pickup.location.address\_line\_1?”](#carrentalbookingdatareservation_detailspickuplocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-214) The first line of the address. ###### Example [Section titled “Example”](#example-194) ```ts Av. Vinte de Janeiro, S/N ``` ##### CarRentalBookingData.reservation\_details.pickup.location.address\_line\_2? [Section titled “CarRentalBookingData.reservation\_details.pickup.location.address\_line\_2?”](#carrentalbookingdatareservation_detailspickuplocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-215) The second line of the address. ###### Example [Section titled “Example”](#example-195) ```ts Ilha do Governador ``` ##### CarRentalBookingData.reservation\_details.pickup.location.administrative\_area? [Section titled “CarRentalBookingData.reservation\_details.pickup.location.administrative\_area?”](#carrentalbookingdatareservation_detailspickuplocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-216) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-196) ```ts RJ ``` ##### CarRentalBookingData.reservation\_details.pickup.location.city? [Section titled “CarRentalBookingData.reservation\_details.pickup.location.city?”](#carrentalbookingdatareservation_detailspickuplocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-217) The city where the address is located. ###### Example [Section titled “Example”](#example-197) ```ts Rio de Janeiro ``` ##### CarRentalBookingData.reservation\_details.pickup.location.coordinates? [Section titled “CarRentalBookingData.reservation\_details.pickup.location.coordinates?”](#carrentalbookingdatareservation_detailspickuplocationcoordinates) > `optional` **coordinates?**: `object` ##### CarRentalBookingData.reservation\_details.pickup.location.coordinates.latitude [Section titled “CarRentalBookingData.reservation\_details.pickup.location.coordinates.latitude”](#carrentalbookingdatareservation_detailspickuplocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-198) ```ts -22.8145373 ``` ##### CarRentalBookingData.reservation\_details.pickup.location.coordinates.longitude [Section titled “CarRentalBookingData.reservation\_details.pickup.location.coordinates.longitude”](#carrentalbookingdatareservation_detailspickuplocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-199) ```ts -43.2465548 ``` ##### CarRentalBookingData.reservation\_details.pickup.location.country? [Section titled “CarRentalBookingData.reservation\_details.pickup.location.country?”](#carrentalbookingdatareservation_detailspickuplocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-218) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-200) ```ts Brazil ``` ##### CarRentalBookingData.reservation\_details.pickup.location.postal\_code? [Section titled “CarRentalBookingData.reservation\_details.pickup.location.postal\_code?”](#carrentalbookingdatareservation_detailspickuplocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-219) The postal code of the given address. ###### Example [Section titled “Example”](#example-201) ```ts 21941-900 ``` ##### CarRentalBookingData.reservation\_details.pickup.location.timezone? [Section titled “CarRentalBookingData.reservation\_details.pickup.location.timezone?”](#carrentalbookingdatareservation_detailspickuplocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-220) The timezone in the given address. ###### Example [Section titled “Example”](#example-202) ```ts America/Sao_Paulo ``` ##### CarRentalBookingData.reservation\_details.pickup.time [Section titled “CarRentalBookingData.reservation\_details.pickup.time”](#carrentalbookingdatareservation_detailspickuptime) > **time**: `object` ##### CarRentalBookingData.reservation\_details.pickup.time.local\_time [Section titled “CarRentalBookingData.reservation\_details.pickup.time.local\_time”](#carrentalbookingdatareservation_detailspickuptimelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-221) The local time in the relevant location in the ISO 8601 format. ##### CarRentalBookingData.reservation\_details.pickup.time.timestamp? [Section titled “CarRentalBookingData.reservation\_details.pickup.time.timestamp?”](#carrentalbookingdatareservation_detailspickuptimetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-222) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-203) ```ts 2017-12-27T15:42:30Z ``` ##### CarRentalBookingData.reservation\_details.rental\_company? [Section titled “CarRentalBookingData.reservation\_details.rental\_company?”](#carrentalbookingdatareservation_detailsrental_company) > `optional` **rental\_company?**: `string` | `null` ###### Description [Section titled “Description”](#description-223) Name of car rental company. ###### Example [Section titled “Example”](#example-204) ```ts Catch-A-Ride ``` ##### CarRentalBookingData.type [Section titled “CarRentalBookingData.type”](#carrentalbookingdatatype) > **type**: `"CAR_RENTAL"` ###### Description [Section titled “Description”](#description-224) discriminator enum property added by openapi-typescript ##### CarRentalBookingData.CarClass [Section titled “CarRentalBookingData.CarClass”](#carrentalbookingdatacarclass) > **CarRentalBookingData.CarClass**: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"` ###### Description [Section titled “Description”](#description-225) The kind of car. ###### Example [Section titled “Example”](#example-205) ```ts INTERMEDIATE @enum {string} ``` ##### CarRentalBookingData.CarDetails [Section titled “CarRentalBookingData.CarDetails”](#carrentalbookingdatacardetails) > **CarRentalBookingData.CarDetails**: `object` ###### Description [Section titled “Description”](#description-226) Information on a rental car. ##### CarRentalBookingData.CarDetails.car\_class? [Section titled “CarRentalBookingData.CarDetails.car\_class?”](#carrentalbookingdatacardetailscar_class) > `optional` **car\_class?**: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"` ##### CarRentalBookingData.CarDetails.display\_name [Section titled “CarRentalBookingData.CarDetails.display\_name”](#carrentalbookingdatacardetailsdisplay_name) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-227) The name of the car as displayed to the user. ###### Example [Section titled “Example”](#example-206) ```ts Intermediate car ``` ##### CarRentalBookingData.RentalEndpoint [Section titled “CarRentalBookingData.RentalEndpoint”](#carrentalbookingdatarentalendpoint) > **CarRentalBookingData.RentalEndpoint**: `object` ###### Description [Section titled “Description”](#description-228) Information about the car pickup or drop-off. ##### CarRentalBookingData.RentalEndpoint.location [Section titled “CarRentalBookingData.RentalEndpoint.location”](#carrentalbookingdatarentalendpointlocation) > **location**: `object` ##### CarRentalBookingData.RentalEndpoint.location.address\_line\_1? [Section titled “CarRentalBookingData.RentalEndpoint.location.address\_line\_1?”](#carrentalbookingdatarentalendpointlocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-229) The first line of the address. ###### Example [Section titled “Example”](#example-207) ```ts Av. Vinte de Janeiro, S/N ``` ##### CarRentalBookingData.RentalEndpoint.location.address\_line\_2? [Section titled “CarRentalBookingData.RentalEndpoint.location.address\_line\_2?”](#carrentalbookingdatarentalendpointlocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-230) The second line of the address. ###### Example [Section titled “Example”](#example-208) ```ts Ilha do Governador ``` ##### CarRentalBookingData.RentalEndpoint.location.administrative\_area? [Section titled “CarRentalBookingData.RentalEndpoint.location.administrative\_area?”](#carrentalbookingdatarentalendpointlocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-231) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-209) ```ts RJ ``` ##### CarRentalBookingData.RentalEndpoint.location.city? [Section titled “CarRentalBookingData.RentalEndpoint.location.city?”](#carrentalbookingdatarentalendpointlocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-232) The city where the address is located. ###### Example [Section titled “Example”](#example-210) ```ts Rio de Janeiro ``` ##### CarRentalBookingData.RentalEndpoint.location.coordinates? [Section titled “CarRentalBookingData.RentalEndpoint.location.coordinates?”](#carrentalbookingdatarentalendpointlocationcoordinates) > `optional` **coordinates?**: `object` ##### CarRentalBookingData.RentalEndpoint.location.coordinates.latitude [Section titled “CarRentalBookingData.RentalEndpoint.location.coordinates.latitude”](#carrentalbookingdatarentalendpointlocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-211) ```ts -22.8145373 ``` ##### CarRentalBookingData.RentalEndpoint.location.coordinates.longitude [Section titled “CarRentalBookingData.RentalEndpoint.location.coordinates.longitude”](#carrentalbookingdatarentalendpointlocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-212) ```ts -43.2465548 ``` ##### CarRentalBookingData.RentalEndpoint.location.country? [Section titled “CarRentalBookingData.RentalEndpoint.location.country?”](#carrentalbookingdatarentalendpointlocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-233) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-213) ```ts Brazil ``` ##### CarRentalBookingData.RentalEndpoint.location.postal\_code? [Section titled “CarRentalBookingData.RentalEndpoint.location.postal\_code?”](#carrentalbookingdatarentalendpointlocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-234) The postal code of the given address. ###### Example [Section titled “Example”](#example-214) ```ts 21941-900 ``` ##### CarRentalBookingData.RentalEndpoint.location.timezone? [Section titled “CarRentalBookingData.RentalEndpoint.location.timezone?”](#carrentalbookingdatarentalendpointlocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-235) The timezone in the given address. ###### Example [Section titled “Example”](#example-215) ```ts America/Sao_Paulo ``` ##### CarRentalBookingData.RentalEndpoint.time [Section titled “CarRentalBookingData.RentalEndpoint.time”](#carrentalbookingdatarentalendpointtime) > **time**: `object` ##### CarRentalBookingData.RentalEndpoint.time.local\_time [Section titled “CarRentalBookingData.RentalEndpoint.time.local\_time”](#carrentalbookingdatarentalendpointtimelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-236) The local time in the relevant location in the ISO 8601 format. ##### CarRentalBookingData.RentalEndpoint.time.timestamp? [Section titled “CarRentalBookingData.RentalEndpoint.time.timestamp?”](#carrentalbookingdatarentalendpointtimetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-237) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-216) ```ts 2017-12-27T15:42:30Z ``` ##### CarRentalBookingData.ReservationDetails [Section titled “CarRentalBookingData.ReservationDetails”](#carrentalbookingdatareservationdetails) > **CarRentalBookingData.ReservationDetails**: `object` ###### Description [Section titled “Description”](#description-238) Information on a car reservation such as pickup, drop-off, etc. ##### CarRentalBookingData.ReservationDetails.confirmation\_code? [Section titled “CarRentalBookingData.ReservationDetails.confirmation\_code?”](#carrentalbookingdatareservationdetailsconfirmation_code) > `optional` **confirmation\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-239) The confirmation code given by the vendor. ###### Example [Section titled “Example”](#example-217) ```ts 7003XBQ504 ``` ##### CarRentalBookingData.ReservationDetails.drop\_off [Section titled “CarRentalBookingData.ReservationDetails.drop\_off”](#carrentalbookingdatareservationdetailsdrop_off) > **drop\_off**: `object` ##### CarRentalBookingData.ReservationDetails.drop\_off.location [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.location”](#carrentalbookingdatareservationdetailsdrop_offlocation) > **location**: `object` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.address\_line\_1? [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.location.address\_line\_1?”](#carrentalbookingdatareservationdetailsdrop_offlocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-240) The first line of the address. ###### Example [Section titled “Example”](#example-218) ```ts Av. Vinte de Janeiro, S/N ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.address\_line\_2? [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.location.address\_line\_2?”](#carrentalbookingdatareservationdetailsdrop_offlocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-241) The second line of the address. ###### Example [Section titled “Example”](#example-219) ```ts Ilha do Governador ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.administrative\_area? [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.location.administrative\_area?”](#carrentalbookingdatareservationdetailsdrop_offlocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-242) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-220) ```ts RJ ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.city? [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.location.city?”](#carrentalbookingdatareservationdetailsdrop_offlocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-243) The city where the address is located. ###### Example [Section titled “Example”](#example-221) ```ts Rio de Janeiro ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.coordinates? [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.location.coordinates?”](#carrentalbookingdatareservationdetailsdrop_offlocationcoordinates) > `optional` **coordinates?**: `object` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.coordinates.latitude [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.location.coordinates.latitude”](#carrentalbookingdatareservationdetailsdrop_offlocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-222) ```ts -22.8145373 ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.coordinates.longitude [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.location.coordinates.longitude”](#carrentalbookingdatareservationdetailsdrop_offlocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-223) ```ts -43.2465548 ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.country? [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.location.country?”](#carrentalbookingdatareservationdetailsdrop_offlocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-244) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-224) ```ts Brazil ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.postal\_code? [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.location.postal\_code?”](#carrentalbookingdatareservationdetailsdrop_offlocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-245) The postal code of the given address. ###### Example [Section titled “Example”](#example-225) ```ts 21941-900 ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.timezone? [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.location.timezone?”](#carrentalbookingdatareservationdetailsdrop_offlocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-246) The timezone in the given address. ###### Example [Section titled “Example”](#example-226) ```ts America/Sao_Paulo ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.time [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.time”](#carrentalbookingdatareservationdetailsdrop_offtime) > **time**: `object` ##### CarRentalBookingData.ReservationDetails.drop\_off.time.local\_time [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.time.local\_time”](#carrentalbookingdatareservationdetailsdrop_offtimelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-247) The local time in the relevant location in the ISO 8601 format. ##### CarRentalBookingData.ReservationDetails.drop\_off.time.timestamp? [Section titled “CarRentalBookingData.ReservationDetails.drop\_off.time.timestamp?”](#carrentalbookingdatareservationdetailsdrop_offtimetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-248) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-227) ```ts 2017-12-27T15:42:30Z ``` ##### CarRentalBookingData.ReservationDetails.pickup [Section titled “CarRentalBookingData.ReservationDetails.pickup”](#carrentalbookingdatareservationdetailspickup) > **pickup**: `object` ##### CarRentalBookingData.ReservationDetails.pickup.location [Section titled “CarRentalBookingData.ReservationDetails.pickup.location”](#carrentalbookingdatareservationdetailspickuplocation) > **location**: `object` ##### CarRentalBookingData.ReservationDetails.pickup.location.address\_line\_1? [Section titled “CarRentalBookingData.ReservationDetails.pickup.location.address\_line\_1?”](#carrentalbookingdatareservationdetailspickuplocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-249) The first line of the address. ###### Example [Section titled “Example”](#example-228) ```ts Av. Vinte de Janeiro, S/N ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.address\_line\_2? [Section titled “CarRentalBookingData.ReservationDetails.pickup.location.address\_line\_2?”](#carrentalbookingdatareservationdetailspickuplocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-250) The second line of the address. ###### Example [Section titled “Example”](#example-229) ```ts Ilha do Governador ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.administrative\_area? [Section titled “CarRentalBookingData.ReservationDetails.pickup.location.administrative\_area?”](#carrentalbookingdatareservationdetailspickuplocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-251) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-230) ```ts RJ ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.city? [Section titled “CarRentalBookingData.ReservationDetails.pickup.location.city?”](#carrentalbookingdatareservationdetailspickuplocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-252) The city where the address is located. ###### Example [Section titled “Example”](#example-231) ```ts Rio de Janeiro ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.coordinates? [Section titled “CarRentalBookingData.ReservationDetails.pickup.location.coordinates?”](#carrentalbookingdatareservationdetailspickuplocationcoordinates) > `optional` **coordinates?**: `object` ##### CarRentalBookingData.ReservationDetails.pickup.location.coordinates.latitude [Section titled “CarRentalBookingData.ReservationDetails.pickup.location.coordinates.latitude”](#carrentalbookingdatareservationdetailspickuplocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-232) ```ts -22.8145373 ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.coordinates.longitude [Section titled “CarRentalBookingData.ReservationDetails.pickup.location.coordinates.longitude”](#carrentalbookingdatareservationdetailspickuplocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-233) ```ts -43.2465548 ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.country? [Section titled “CarRentalBookingData.ReservationDetails.pickup.location.country?”](#carrentalbookingdatareservationdetailspickuplocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-253) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-234) ```ts Brazil ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.postal\_code? [Section titled “CarRentalBookingData.ReservationDetails.pickup.location.postal\_code?”](#carrentalbookingdatareservationdetailspickuplocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-254) The postal code of the given address. ###### Example [Section titled “Example”](#example-235) ```ts 21941-900 ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.timezone? [Section titled “CarRentalBookingData.ReservationDetails.pickup.location.timezone?”](#carrentalbookingdatareservationdetailspickuplocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-255) The timezone in the given address. ###### Example [Section titled “Example”](#example-236) ```ts America/Sao_Paulo ``` ##### CarRentalBookingData.ReservationDetails.pickup.time [Section titled “CarRentalBookingData.ReservationDetails.pickup.time”](#carrentalbookingdatareservationdetailspickuptime) > **time**: `object` ##### CarRentalBookingData.ReservationDetails.pickup.time.local\_time [Section titled “CarRentalBookingData.ReservationDetails.pickup.time.local\_time”](#carrentalbookingdatareservationdetailspickuptimelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-256) The local time in the relevant location in the ISO 8601 format. ##### CarRentalBookingData.ReservationDetails.pickup.time.timestamp? [Section titled “CarRentalBookingData.ReservationDetails.pickup.time.timestamp?”](#carrentalbookingdatareservationdetailspickuptimetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-257) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-237) ```ts 2017-12-27T15:42:30Z ``` ##### CarRentalBookingData.ReservationDetails.rental\_company? [Section titled “CarRentalBookingData.ReservationDetails.rental\_company?”](#carrentalbookingdatareservationdetailsrental_company) > `optional` **rental\_company?**: `string` | `null` ###### Description [Section titled “Description”](#description-258) Name of car rental company. ###### Example [Section titled “Example”](#example-238) ```ts Catch-A-Ride ``` #### LodgingBookingData [Section titled “LodgingBookingData”](#lodgingbookingdata) > **LodgingBookingData**: `object` ##### Description [Section titled “Description”](#description-259) Lodging-specific booking information. ##### LodgingBookingData.lodging\_details [Section titled “LodgingBookingData.lodging\_details”](#lodgingbookingdatalodging_details) > **lodging\_details**: `object` ##### LodgingBookingData.lodging\_details.brand\_name? [Section titled “LodgingBookingData.lodging\_details.brand\_name?”](#lodgingbookingdatalodging_detailsbrand_name) > `optional` **brand\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-260) The brand name of the hotel. ###### Example [Section titled “Example”](#example-239) ```ts Marriott Hotels ``` ##### LodgingBookingData.lodging\_details.chain\_name? [Section titled “LodgingBookingData.lodging\_details.chain\_name?”](#lodgingbookingdatalodging_detailschain_name) > `optional` **chain\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-261) The name of the hotel chain. ###### Example [Section titled “Example”](#example-240) ```ts Accor Hotels ``` ##### LodgingBookingData.lodging\_details.contact\_information? [Section titled “LodgingBookingData.lodging\_details.contact\_information?”](#lodgingbookingdatalodging_detailscontact_information) > `optional` **contact\_information?**: `object` ##### LodgingBookingData.lodging\_details.contact\_information.email? [Section titled “LodgingBookingData.lodging\_details.contact\_information.email?”](#lodgingbookingdatalodging_detailscontact_informationemail) > `optional` **email?**: `string` | `null` ###### Description [Section titled “Description”](#description-262) The email address of the venue. ###### Example [Section titled “Example”](#example-241) ```ts city@hotelchain.com ``` ##### LodgingBookingData.lodging\_details.contact\_information.fax? [Section titled “LodgingBookingData.lodging\_details.contact\_information.fax?”](#lodgingbookingdatalodging_detailscontact_informationfax) > `optional` **fax?**: `string` | `null` ###### Description [Section titled “Description”](#description-263) The fax number of the venue. ###### Example [Section titled “Example”](#example-242) ```ts 12345554321 ``` ##### LodgingBookingData.lodging\_details.contact\_information.phone? [Section titled “LodgingBookingData.lodging\_details.contact\_information.phone?”](#lodgingbookingdatalodging_detailscontact_informationphone) > `optional` **phone?**: `string` | `null` ###### Description [Section titled “Description”](#description-264) The phone number of the venue. ###### Example [Section titled “Example”](#example-243) ```ts 12345554321 ``` ##### LodgingBookingData.lodging\_details.display\_name [Section titled “LodgingBookingData.lodging\_details.display\_name”](#lodgingbookingdatalodging_detailsdisplay_name) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-265) The name of the venue as displayed to the user. ###### Example [Section titled “Example”](#example-244) ```ts Fancy Hotel ``` ##### LodgingBookingData.lodging\_details.location? [Section titled “LodgingBookingData.lodging\_details.location?”](#lodgingbookingdatalodging_detailslocation) > `optional` **location?**: `object` ##### LodgingBookingData.lodging\_details.location.address\_line\_1? [Section titled “LodgingBookingData.lodging\_details.location.address\_line\_1?”](#lodgingbookingdatalodging_detailslocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-266) The first line of the address. ###### Example [Section titled “Example”](#example-245) ```ts Av. Vinte de Janeiro, S/N ``` ##### LodgingBookingData.lodging\_details.location.address\_line\_2? [Section titled “LodgingBookingData.lodging\_details.location.address\_line\_2?”](#lodgingbookingdatalodging_detailslocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-267) The second line of the address. ###### Example [Section titled “Example”](#example-246) ```ts Ilha do Governador ``` ##### LodgingBookingData.lodging\_details.location.administrative\_area? [Section titled “LodgingBookingData.lodging\_details.location.administrative\_area?”](#lodgingbookingdatalodging_detailslocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-268) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-247) ```ts RJ ``` ##### LodgingBookingData.lodging\_details.location.city? [Section titled “LodgingBookingData.lodging\_details.location.city?”](#lodgingbookingdatalodging_detailslocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-269) The city where the address is located. ###### Example [Section titled “Example”](#example-248) ```ts Rio de Janeiro ``` ##### LodgingBookingData.lodging\_details.location.coordinates? [Section titled “LodgingBookingData.lodging\_details.location.coordinates?”](#lodgingbookingdatalodging_detailslocationcoordinates) > `optional` **coordinates?**: `object` ##### LodgingBookingData.lodging\_details.location.coordinates.latitude [Section titled “LodgingBookingData.lodging\_details.location.coordinates.latitude”](#lodgingbookingdatalodging_detailslocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-249) ```ts -22.8145373 ``` ##### LodgingBookingData.lodging\_details.location.coordinates.longitude [Section titled “LodgingBookingData.lodging\_details.location.coordinates.longitude”](#lodgingbookingdatalodging_detailslocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-250) ```ts -43.2465548 ``` ##### LodgingBookingData.lodging\_details.location.country? [Section titled “LodgingBookingData.lodging\_details.location.country?”](#lodgingbookingdatalodging_detailslocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-270) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-251) ```ts Brazil ``` ##### LodgingBookingData.lodging\_details.location.postal\_code? [Section titled “LodgingBookingData.lodging\_details.location.postal\_code?”](#lodgingbookingdatalodging_detailslocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-271) The postal code of the given address. ###### Example [Section titled “Example”](#example-252) ```ts 21941-900 ``` ##### LodgingBookingData.lodging\_details.location.timezone? [Section titled “LodgingBookingData.lodging\_details.location.timezone?”](#lodgingbookingdatalodging_detailslocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-272) The timezone in the given address. ###### Example [Section titled “Example”](#example-253) ```ts America/Sao_Paulo ``` ##### LodgingBookingData.lodging\_details.star\_rating? [Section titled “LodgingBookingData.lodging\_details.star\_rating?”](#lodgingbookingdatalodging_detailsstar_rating) > `optional` **star\_rating?**: `number` | `null` Format: float ###### Description [Section titled “Description”](#description-273) The star rating of the hotel. Some hotels have half stars. ###### Example [Section titled “Example”](#example-254) ```ts 3.5 ``` ##### LodgingBookingData.reservation\_details [Section titled “LodgingBookingData.reservation\_details”](#lodgingbookingdatareservation_details) > **reservation\_details**: `object` ##### LodgingBookingData.reservation\_details.check\_in\_time [Section titled “LodgingBookingData.reservation\_details.check\_in\_time”](#lodgingbookingdatareservation_detailscheck_in_time) > **check\_in\_time**: `object` ##### LodgingBookingData.reservation\_details.check\_in\_time.local\_time [Section titled “LodgingBookingData.reservation\_details.check\_in\_time.local\_time”](#lodgingbookingdatareservation_detailscheck_in_timelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-274) The local time in the relevant location in the ISO 8601 format. ##### LodgingBookingData.reservation\_details.check\_in\_time.timestamp? [Section titled “LodgingBookingData.reservation\_details.check\_in\_time.timestamp?”](#lodgingbookingdatareservation_detailscheck_in_timetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-275) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-255) ```ts 2017-12-27T15:42:30Z ``` ##### LodgingBookingData.reservation\_details.checkout\_time [Section titled “LodgingBookingData.reservation\_details.checkout\_time”](#lodgingbookingdatareservation_detailscheckout_time) > **checkout\_time**: `object` ##### LodgingBookingData.reservation\_details.checkout\_time.local\_time [Section titled “LodgingBookingData.reservation\_details.checkout\_time.local\_time”](#lodgingbookingdatareservation_detailscheckout_timelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-276) The local time in the relevant location in the ISO 8601 format. ##### LodgingBookingData.reservation\_details.checkout\_time.timestamp? [Section titled “LodgingBookingData.reservation\_details.checkout\_time.timestamp?”](#lodgingbookingdatareservation_detailscheckout_timetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-277) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-256) ```ts 2017-12-27T15:42:30Z ``` ##### LodgingBookingData.reservation\_details.confirmation\_code? [Section titled “LodgingBookingData.reservation\_details.confirmation\_code?”](#lodgingbookingdatareservation_detailsconfirmation_code) > `optional` **confirmation\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-278) Confirmation code provided by the vendor. ###### Example [Section titled “Example”](#example-257) ```ts 7003XBQ504 ``` ##### LodgingBookingData.reservation\_details.room? [Section titled “LodgingBookingData.reservation\_details.room?”](#lodgingbookingdatareservation_detailsroom) > `optional` **room?**: `object` ##### LodgingBookingData.reservation\_details.room.bed\_count? [Section titled “LodgingBookingData.reservation\_details.room.bed\_count?”](#lodgingbookingdatareservation_detailsroombed_count) > `optional` **bed\_count?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-279) The number of beds. ###### Example [Section titled “Example”](#example-258) ```ts 1 ``` ##### LodgingBookingData.reservation\_details.room.bed\_type? [Section titled “LodgingBookingData.reservation\_details.room.bed\_type?”](#lodgingbookingdatareservation_detailsroombed_type) > `optional` **bed\_type?**: `string` | `null` ###### Description [Section titled “Description”](#description-280) The kind of bed. ###### Example [Section titled “Example”](#example-259) ```ts DOUBLE ``` ##### LodgingBookingData.reservation\_details.room.description? [Section titled “LodgingBookingData.reservation\_details.room.description?”](#lodgingbookingdatareservation_detailsroomdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-281) A description of the room. ###### Example [Section titled “Example”](#example-260) ```ts Superior room ``` ##### LodgingBookingData.reservation\_details.room.display\_name? [Section titled “LodgingBookingData.reservation\_details.room.display\_name?”](#lodgingbookingdatareservation_detailsroomdisplay_name) > `optional` **display\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-282) The name of the room as displayed to the user. ###### Example [Section titled “Example”](#example-261) ```ts Standard room ``` ##### LodgingBookingData.type [Section titled “LodgingBookingData.type”](#lodgingbookingdatatype) > **type**: `"LODGING"` ###### Description [Section titled “Description”](#description-283) discriminator enum property added by openapi-typescript ##### LodgingBookingData.ContactInfo [Section titled “LodgingBookingData.ContactInfo”](#lodgingbookingdatacontactinfo) > **LodgingBookingData.ContactInfo**: `object` ###### Description [Section titled “Description”](#description-284) Contact information of a venue. ##### LodgingBookingData.ContactInfo.email? [Section titled “LodgingBookingData.ContactInfo.email?”](#lodgingbookingdatacontactinfoemail) > `optional` **email?**: `string` | `null` ###### Description [Section titled “Description”](#description-285) The email address of the venue. ###### Example [Section titled “Example”](#example-262) ```ts city@hotelchain.com ``` ##### LodgingBookingData.ContactInfo.fax? [Section titled “LodgingBookingData.ContactInfo.fax?”](#lodgingbookingdatacontactinfofax) > `optional` **fax?**: `string` | `null` ###### Description [Section titled “Description”](#description-286) The fax number of the venue. ###### Example [Section titled “Example”](#example-263) ```ts 12345554321 ``` ##### LodgingBookingData.ContactInfo.phone? [Section titled “LodgingBookingData.ContactInfo.phone?”](#lodgingbookingdatacontactinfophone) > `optional` **phone?**: `string` | `null` ###### Description [Section titled “Description”](#description-287) The phone number of the venue. ###### Example [Section titled “Example”](#example-264) ```ts 12345554321 ``` ##### LodgingBookingData.LodgingDetails [Section titled “LodgingBookingData.LodgingDetails”](#lodgingbookingdatalodgingdetails) > **LodgingBookingData.LodgingDetails**: `object` ###### Description [Section titled “Description”](#description-288) Information on a lodging venue. ##### LodgingBookingData.LodgingDetails.brand\_name? [Section titled “LodgingBookingData.LodgingDetails.brand\_name?”](#lodgingbookingdatalodgingdetailsbrand_name) > `optional` **brand\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-289) The brand name of the hotel. ###### Example [Section titled “Example”](#example-265) ```ts Marriott Hotels ``` ##### LodgingBookingData.LodgingDetails.chain\_name? [Section titled “LodgingBookingData.LodgingDetails.chain\_name?”](#lodgingbookingdatalodgingdetailschain_name) > `optional` **chain\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-290) The name of the hotel chain. ###### Example [Section titled “Example”](#example-266) ```ts Accor Hotels ``` ##### LodgingBookingData.LodgingDetails.contact\_information? [Section titled “LodgingBookingData.LodgingDetails.contact\_information?”](#lodgingbookingdatalodgingdetailscontact_information) > `optional` **contact\_information?**: `object` ##### LodgingBookingData.LodgingDetails.contact\_information.email? [Section titled “LodgingBookingData.LodgingDetails.contact\_information.email?”](#lodgingbookingdatalodgingdetailscontact_informationemail) > `optional` **email?**: `string` | `null` ###### Description [Section titled “Description”](#description-291) The email address of the venue. ###### Example [Section titled “Example”](#example-267) ```ts city@hotelchain.com ``` ##### LodgingBookingData.LodgingDetails.contact\_information.fax? [Section titled “LodgingBookingData.LodgingDetails.contact\_information.fax?”](#lodgingbookingdatalodgingdetailscontact_informationfax) > `optional` **fax?**: `string` | `null` ###### Description [Section titled “Description”](#description-292) The fax number of the venue. ###### Example [Section titled “Example”](#example-268) ```ts 12345554321 ``` ##### LodgingBookingData.LodgingDetails.contact\_information.phone? [Section titled “LodgingBookingData.LodgingDetails.contact\_information.phone?”](#lodgingbookingdatalodgingdetailscontact_informationphone) > `optional` **phone?**: `string` | `null` ###### Description [Section titled “Description”](#description-293) The phone number of the venue. ###### Example [Section titled “Example”](#example-269) ```ts 12345554321 ``` ##### LodgingBookingData.LodgingDetails.display\_name [Section titled “LodgingBookingData.LodgingDetails.display\_name”](#lodgingbookingdatalodgingdetailsdisplay_name) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-294) The name of the venue as displayed to the user. ###### Example [Section titled “Example”](#example-270) ```ts Fancy Hotel ``` ##### LodgingBookingData.LodgingDetails.location? [Section titled “LodgingBookingData.LodgingDetails.location?”](#lodgingbookingdatalodgingdetailslocation) > `optional` **location?**: `object` ##### LodgingBookingData.LodgingDetails.location.address\_line\_1? [Section titled “LodgingBookingData.LodgingDetails.location.address\_line\_1?”](#lodgingbookingdatalodgingdetailslocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-295) The first line of the address. ###### Example [Section titled “Example”](#example-271) ```ts Av. Vinte de Janeiro, S/N ``` ##### LodgingBookingData.LodgingDetails.location.address\_line\_2? [Section titled “LodgingBookingData.LodgingDetails.location.address\_line\_2?”](#lodgingbookingdatalodgingdetailslocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-296) The second line of the address. ###### Example [Section titled “Example”](#example-272) ```ts Ilha do Governador ``` ##### LodgingBookingData.LodgingDetails.location.administrative\_area? [Section titled “LodgingBookingData.LodgingDetails.location.administrative\_area?”](#lodgingbookingdatalodgingdetailslocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-297) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-273) ```ts RJ ``` ##### LodgingBookingData.LodgingDetails.location.city? [Section titled “LodgingBookingData.LodgingDetails.location.city?”](#lodgingbookingdatalodgingdetailslocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-298) The city where the address is located. ###### Example [Section titled “Example”](#example-274) ```ts Rio de Janeiro ``` ##### LodgingBookingData.LodgingDetails.location.coordinates? [Section titled “LodgingBookingData.LodgingDetails.location.coordinates?”](#lodgingbookingdatalodgingdetailslocationcoordinates) > `optional` **coordinates?**: `object` ##### LodgingBookingData.LodgingDetails.location.coordinates.latitude [Section titled “LodgingBookingData.LodgingDetails.location.coordinates.latitude”](#lodgingbookingdatalodgingdetailslocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-275) ```ts -22.8145373 ``` ##### LodgingBookingData.LodgingDetails.location.coordinates.longitude [Section titled “LodgingBookingData.LodgingDetails.location.coordinates.longitude”](#lodgingbookingdatalodgingdetailslocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-276) ```ts -43.2465548 ``` ##### LodgingBookingData.LodgingDetails.location.country? [Section titled “LodgingBookingData.LodgingDetails.location.country?”](#lodgingbookingdatalodgingdetailslocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-299) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-277) ```ts Brazil ``` ##### LodgingBookingData.LodgingDetails.location.postal\_code? [Section titled “LodgingBookingData.LodgingDetails.location.postal\_code?”](#lodgingbookingdatalodgingdetailslocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-300) The postal code of the given address. ###### Example [Section titled “Example”](#example-278) ```ts 21941-900 ``` ##### LodgingBookingData.LodgingDetails.location.timezone? [Section titled “LodgingBookingData.LodgingDetails.location.timezone?”](#lodgingbookingdatalodgingdetailslocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-301) The timezone in the given address. ###### Example [Section titled “Example”](#example-279) ```ts America/Sao_Paulo ``` ##### LodgingBookingData.LodgingDetails.star\_rating? [Section titled “LodgingBookingData.LodgingDetails.star\_rating?”](#lodgingbookingdatalodgingdetailsstar_rating) > `optional` **star\_rating?**: `number` | `null` Format: float ###### Description [Section titled “Description”](#description-302) The star rating of the hotel. Some hotels have half stars. ###### Example [Section titled “Example”](#example-280) ```ts 3.5 ``` ##### LodgingBookingData.ReservationDetails [Section titled “LodgingBookingData.ReservationDetails”](#lodgingbookingdatareservationdetails) > **LodgingBookingData.ReservationDetails**: `object` ###### Description [Section titled “Description”](#description-303) Information on a reservation such as check-in, checkout, etc. ##### LodgingBookingData.ReservationDetails.check\_in\_time [Section titled “LodgingBookingData.ReservationDetails.check\_in\_time”](#lodgingbookingdatareservationdetailscheck_in_time) > **check\_in\_time**: `object` ##### LodgingBookingData.ReservationDetails.check\_in\_time.local\_time [Section titled “LodgingBookingData.ReservationDetails.check\_in\_time.local\_time”](#lodgingbookingdatareservationdetailscheck_in_timelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-304) The local time in the relevant location in the ISO 8601 format. ##### LodgingBookingData.ReservationDetails.check\_in\_time.timestamp? [Section titled “LodgingBookingData.ReservationDetails.check\_in\_time.timestamp?”](#lodgingbookingdatareservationdetailscheck_in_timetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-305) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-281) ```ts 2017-12-27T15:42:30Z ``` ##### LodgingBookingData.ReservationDetails.checkout\_time [Section titled “LodgingBookingData.ReservationDetails.checkout\_time”](#lodgingbookingdatareservationdetailscheckout_time) > **checkout\_time**: `object` ##### LodgingBookingData.ReservationDetails.checkout\_time.local\_time [Section titled “LodgingBookingData.ReservationDetails.checkout\_time.local\_time”](#lodgingbookingdatareservationdetailscheckout_timelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-306) The local time in the relevant location in the ISO 8601 format. ##### LodgingBookingData.ReservationDetails.checkout\_time.timestamp? [Section titled “LodgingBookingData.ReservationDetails.checkout\_time.timestamp?”](#lodgingbookingdatareservationdetailscheckout_timetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-307) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-282) ```ts 2017-12-27T15:42:30Z ``` ##### LodgingBookingData.ReservationDetails.confirmation\_code? [Section titled “LodgingBookingData.ReservationDetails.confirmation\_code?”](#lodgingbookingdatareservationdetailsconfirmation_code) > `optional` **confirmation\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-308) Confirmation code provided by the vendor. ###### Example [Section titled “Example”](#example-283) ```ts 7003XBQ504 ``` ##### LodgingBookingData.ReservationDetails.room? [Section titled “LodgingBookingData.ReservationDetails.room?”](#lodgingbookingdatareservationdetailsroom) > `optional` **room?**: `object` ##### LodgingBookingData.ReservationDetails.room.bed\_count? [Section titled “LodgingBookingData.ReservationDetails.room.bed\_count?”](#lodgingbookingdatareservationdetailsroombed_count) > `optional` **bed\_count?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-309) The number of beds. ###### Example [Section titled “Example”](#example-284) ```ts 1 ``` ##### LodgingBookingData.ReservationDetails.room.bed\_type? [Section titled “LodgingBookingData.ReservationDetails.room.bed\_type?”](#lodgingbookingdatareservationdetailsroombed_type) > `optional` **bed\_type?**: `string` | `null` ###### Description [Section titled “Description”](#description-310) The kind of bed. ###### Example [Section titled “Example”](#example-285) ```ts DOUBLE ``` ##### LodgingBookingData.ReservationDetails.room.description? [Section titled “LodgingBookingData.ReservationDetails.room.description?”](#lodgingbookingdatareservationdetailsroomdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-311) A description of the room. ###### Example [Section titled “Example”](#example-286) ```ts Superior room ``` ##### LodgingBookingData.ReservationDetails.room.display\_name? [Section titled “LodgingBookingData.ReservationDetails.room.display\_name?”](#lodgingbookingdatareservationdetailsroomdisplay_name) > `optional` **display\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-312) The name of the room as displayed to the user. ###### Example [Section titled “Example”](#example-287) ```ts Standard room ``` ##### LodgingBookingData.Room [Section titled “LodgingBookingData.Room”](#lodgingbookingdataroom) > **LodgingBookingData.Room**: `object` ###### Description [Section titled “Description”](#description-313) Information on a room that was booked. ##### LodgingBookingData.Room.bed\_count? [Section titled “LodgingBookingData.Room.bed\_count?”](#lodgingbookingdataroombed_count) > `optional` **bed\_count?**: `number` | `null` Format: int32 ###### Description [Section titled “Description”](#description-314) The number of beds. ###### Example [Section titled “Example”](#example-288) ```ts 1 ``` ##### LodgingBookingData.Room.bed\_type? [Section titled “LodgingBookingData.Room.bed\_type?”](#lodgingbookingdataroombed_type) > `optional` **bed\_type?**: `string` | `null` ###### Description [Section titled “Description”](#description-315) The kind of bed. ###### Example [Section titled “Example”](#example-289) ```ts DOUBLE ``` ##### LodgingBookingData.Room.description? [Section titled “LodgingBookingData.Room.description?”](#lodgingbookingdataroomdescription) > `optional` **description?**: `string` | `null` ###### Description [Section titled “Description”](#description-316) A description of the room. ###### Example [Section titled “Example”](#example-290) ```ts Superior room ``` ##### LodgingBookingData.Room.display\_name? [Section titled “LodgingBookingData.Room.display\_name?”](#lodgingbookingdataroomdisplay_name) > `optional` **display\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-317) The name of the room as displayed to the user. ###### Example [Section titled “Example”](#example-291) ```ts Standard room ``` #### Page\_Booking\_ [Section titled “Page\_Booking\_”](#page_booking_) > **Page\_Booking\_**: `object` ##### Page\_Booking\_.items [Section titled “Page\_Booking\_.items”](#page_booking_items) > **items**: `object`\[] ##### Page\_Booking\_.next\_cursor? [Section titled “Page\_Booking\_.next\_cursor?”](#page_booking_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_Trip\_ [Section titled “Page\_Trip\_”](#page_trip_) > **Page\_Trip\_**: `object` ##### Page\_Trip\_.items [Section titled “Page\_Trip\_.items”](#page_trip_items) > **items**: `object`\[] ##### Page\_Trip\_.next\_cursor? [Section titled “Page\_Trip\_.next\_cursor?”](#page_trip_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### RailBookingData [Section titled “RailBookingData”](#railbookingdata) > **RailBookingData**: `object` ##### Description [Section titled “Description”](#description-318) Rail-specific booking information. ##### RailBookingData.journeys [Section titled “RailBookingData.journeys”](#railbookingdatajourneys) > **journeys**: `object`\[] ###### Description [Section titled “Description”](#description-319) The journeys that make up this booking. ##### RailBookingData.type [Section titled “RailBookingData.type”](#railbookingdatatype) > **type**: `"RAIL"` ###### Description [Section titled “Description”](#description-320) discriminator enum property added by openapi-typescript ##### RailBookingData.RailClass [Section titled “RailBookingData.RailClass”](#railbookingdatarailclass) > **RailBookingData.RailClass**: `"EXECUTIVE"` | `"BUSINESS"` | `"FIRST"` | `"STANDARD"` | `"SLEEPER"` | `"STANDARD_PREMIUM"` | `"BUSINESS_PREMIUM"` | `"COACH"` | `"ROOM"` ###### Description [Section titled “Description”](#description-321) The class of travel for a rail leg. ###### Example [Section titled “Example”](#example-292) ```ts SLEEPER @enum {string} ``` ##### RailBookingData.RailJourney [Section titled “RailBookingData.RailJourney”](#railbookingdatarailjourney) > **RailBookingData.RailJourney**: `object` ###### Description [Section titled “Description”](#description-322) A journey is composed of the legs that take a passenger from an origin to a final destination. E.g. if a traveler is going from Aberdeen to London, but they need to change trains in Edinburgh, the booking will contain 1 journey composed of 2 legs. The first leg is Aberdeen to Edinburgh, and the second is Edinburgh to London. ##### RailBookingData.RailJourney.legs [Section titled “RailBookingData.RailJourney.legs”](#railbookingdatarailjourneylegs) > **legs**: `object`\[] ###### Description [Section titled “Description”](#description-323) The legs that make up this journey. ##### RailBookingData.RailLeg [Section titled “RailBookingData.RailLeg”](#railbookingdatarailleg) > **RailBookingData.RailLeg**: `object` ###### Description [Section titled “Description”](#description-324) A leg is a portion of the journey between two consecutive stops. ##### RailBookingData.RailLeg.arrival\_time [Section titled “RailBookingData.RailLeg.arrival\_time”](#railbookingdataraillegarrival_time) > **arrival\_time**: `object` ##### RailBookingData.RailLeg.arrival\_time.local\_time [Section titled “RailBookingData.RailLeg.arrival\_time.local\_time”](#railbookingdataraillegarrival_timelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-325) The local time in the relevant location in the ISO 8601 format. ##### RailBookingData.RailLeg.arrival\_time.timestamp? [Section titled “RailBookingData.RailLeg.arrival\_time.timestamp?”](#railbookingdataraillegarrival_timetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-326) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-293) ```ts 2017-12-27T15:42:30Z ``` ##### RailBookingData.RailLeg.departure\_time [Section titled “RailBookingData.RailLeg.departure\_time”](#railbookingdataraillegdeparture_time) > **departure\_time**: `object` ##### RailBookingData.RailLeg.departure\_time.local\_time [Section titled “RailBookingData.RailLeg.departure\_time.local\_time”](#railbookingdataraillegdeparture_timelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-327) The local time in the relevant location in the ISO 8601 format. ##### RailBookingData.RailLeg.departure\_time.timestamp? [Section titled “RailBookingData.RailLeg.departure\_time.timestamp?”](#railbookingdataraillegdeparture_timetimestamp) > `optional` **timestamp?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-328) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-294) ```ts 2017-12-27T15:42:30Z ``` ##### RailBookingData.RailLeg.destination [Section titled “RailBookingData.RailLeg.destination”](#railbookingdataraillegdestination) > **destination**: `object` ##### RailBookingData.RailLeg.destination.location? [Section titled “RailBookingData.RailLeg.destination.location?”](#railbookingdataraillegdestinationlocation) > `optional` **location?**: `object` ##### RailBookingData.RailLeg.destination.location.address\_line\_1? [Section titled “RailBookingData.RailLeg.destination.location.address\_line\_1?”](#railbookingdataraillegdestinationlocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-329) The first line of the address. ###### Example [Section titled “Example”](#example-295) ```ts Av. Vinte de Janeiro, S/N ``` ##### RailBookingData.RailLeg.destination.location.address\_line\_2? [Section titled “RailBookingData.RailLeg.destination.location.address\_line\_2?”](#railbookingdataraillegdestinationlocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-330) The second line of the address. ###### Example [Section titled “Example”](#example-296) ```ts Ilha do Governador ``` ##### RailBookingData.RailLeg.destination.location.administrative\_area? [Section titled “RailBookingData.RailLeg.destination.location.administrative\_area?”](#railbookingdataraillegdestinationlocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-331) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-297) ```ts RJ ``` ##### RailBookingData.RailLeg.destination.location.city? [Section titled “RailBookingData.RailLeg.destination.location.city?”](#railbookingdataraillegdestinationlocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-332) The city where the address is located. ###### Example [Section titled “Example”](#example-298) ```ts Rio de Janeiro ``` ##### RailBookingData.RailLeg.destination.location.coordinates? [Section titled “RailBookingData.RailLeg.destination.location.coordinates?”](#railbookingdataraillegdestinationlocationcoordinates) > `optional` **coordinates?**: `object` ##### RailBookingData.RailLeg.destination.location.coordinates.latitude [Section titled “RailBookingData.RailLeg.destination.location.coordinates.latitude”](#railbookingdataraillegdestinationlocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-299) ```ts -22.8145373 ``` ##### RailBookingData.RailLeg.destination.location.coordinates.longitude [Section titled “RailBookingData.RailLeg.destination.location.coordinates.longitude”](#railbookingdataraillegdestinationlocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-300) ```ts -43.2465548 ``` ##### RailBookingData.RailLeg.destination.location.country? [Section titled “RailBookingData.RailLeg.destination.location.country?”](#railbookingdataraillegdestinationlocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-333) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-301) ```ts Brazil ``` ##### RailBookingData.RailLeg.destination.location.postal\_code? [Section titled “RailBookingData.RailLeg.destination.location.postal\_code?”](#railbookingdataraillegdestinationlocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-334) The postal code of the given address. ###### Example [Section titled “Example”](#example-302) ```ts 21941-900 ``` ##### RailBookingData.RailLeg.destination.location.timezone? [Section titled “RailBookingData.RailLeg.destination.location.timezone?”](#railbookingdataraillegdestinationlocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-335) The timezone in the given address. ###### Example [Section titled “Example”](#example-303) ```ts America/Sao_Paulo ``` ##### RailBookingData.RailLeg.destination.name? [Section titled “RailBookingData.RailLeg.destination.name?”](#railbookingdataraillegdestinationname) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-336) The name of the station. ###### Example [Section titled “Example”](#example-304) ```ts London - King's Cross ``` ##### RailBookingData.RailLeg.destination.type? [Section titled “RailBookingData.RailLeg.destination.type?”](#railbookingdataraillegdestinationtype) > `optional` **type?**: `"INDIVIDUAL"` | `"GROUP"` | `"METRO"` | `"BUS_STOP"` | `"FERRY_TERMINAL"` ##### RailBookingData.RailLeg.duration? [Section titled “RailBookingData.RailLeg.duration?”](#railbookingdataraillegduration) > `optional` **duration?**: `string` | `null` ###### Description [Section titled “Description”](#description-337) PT4h20M ###### Example [Section titled “Example”](#example-305) ```ts PT4h20M ``` ##### RailBookingData.RailLeg.origin [Section titled “RailBookingData.RailLeg.origin”](#railbookingdataraillegorigin) > **origin**: `object` ##### RailBookingData.RailLeg.origin.location? [Section titled “RailBookingData.RailLeg.origin.location?”](#railbookingdataraillegoriginlocation) > `optional` **location?**: `object` ##### RailBookingData.RailLeg.origin.location.address\_line\_1? [Section titled “RailBookingData.RailLeg.origin.location.address\_line\_1?”](#railbookingdataraillegoriginlocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-338) The first line of the address. ###### Example [Section titled “Example”](#example-306) ```ts Av. Vinte de Janeiro, S/N ``` ##### RailBookingData.RailLeg.origin.location.address\_line\_2? [Section titled “RailBookingData.RailLeg.origin.location.address\_line\_2?”](#railbookingdataraillegoriginlocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-339) The second line of the address. ###### Example [Section titled “Example”](#example-307) ```ts Ilha do Governador ``` ##### RailBookingData.RailLeg.origin.location.administrative\_area? [Section titled “RailBookingData.RailLeg.origin.location.administrative\_area?”](#railbookingdataraillegoriginlocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-340) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-308) ```ts RJ ``` ##### RailBookingData.RailLeg.origin.location.city? [Section titled “RailBookingData.RailLeg.origin.location.city?”](#railbookingdataraillegoriginlocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-341) The city where the address is located. ###### Example [Section titled “Example”](#example-309) ```ts Rio de Janeiro ``` ##### RailBookingData.RailLeg.origin.location.coordinates? [Section titled “RailBookingData.RailLeg.origin.location.coordinates?”](#railbookingdataraillegoriginlocationcoordinates) > `optional` **coordinates?**: `object` ##### RailBookingData.RailLeg.origin.location.coordinates.latitude [Section titled “RailBookingData.RailLeg.origin.location.coordinates.latitude”](#railbookingdataraillegoriginlocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-310) ```ts -22.8145373 ``` ##### RailBookingData.RailLeg.origin.location.coordinates.longitude [Section titled “RailBookingData.RailLeg.origin.location.coordinates.longitude”](#railbookingdataraillegoriginlocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-311) ```ts -43.2465548 ``` ##### RailBookingData.RailLeg.origin.location.country? [Section titled “RailBookingData.RailLeg.origin.location.country?”](#railbookingdataraillegoriginlocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-342) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-312) ```ts Brazil ``` ##### RailBookingData.RailLeg.origin.location.postal\_code? [Section titled “RailBookingData.RailLeg.origin.location.postal\_code?”](#railbookingdataraillegoriginlocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-343) The postal code of the given address. ###### Example [Section titled “Example”](#example-313) ```ts 21941-900 ``` ##### RailBookingData.RailLeg.origin.location.timezone? [Section titled “RailBookingData.RailLeg.origin.location.timezone?”](#railbookingdataraillegoriginlocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-344) The timezone in the given address. ###### Example [Section titled “Example”](#example-314) ```ts America/Sao_Paulo ``` ##### RailBookingData.RailLeg.origin.name? [Section titled “RailBookingData.RailLeg.origin.name?”](#railbookingdataraillegoriginname) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-345) The name of the station. ###### Example [Section titled “Example”](#example-315) ```ts London - King's Cross ``` ##### RailBookingData.RailLeg.origin.type? [Section titled “RailBookingData.RailLeg.origin.type?”](#railbookingdataraillegorigintype) > `optional` **type?**: `"INDIVIDUAL"` | `"GROUP"` | `"METRO"` | `"BUS_STOP"` | `"FERRY_TERMINAL"` ##### RailBookingData.RailLeg.rail\_class? [Section titled “RailBookingData.RailLeg.rail\_class?”](#railbookingdataraillegrail_class) > `optional` **rail\_class?**: `"EXECUTIVE"` | `"BUSINESS"` | `"FIRST"` | `"STANDARD"` | `"SLEEPER"` | `"STANDARD_PREMIUM"` | `"BUSINESS_PREMIUM"` | `"COACH"` | `"ROOM"` ##### RailBookingData.RailLeg.seat? [Section titled “RailBookingData.RailLeg.seat?”](#railbookingdataraillegseat) > `optional` **seat?**: `object` ##### RailBookingData.RailLeg.seat.coach\_number? [Section titled “RailBookingData.RailLeg.seat.coach\_number?”](#railbookingdataraillegseatcoach_number) > `optional` **coach\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-346) The number of the coach. ###### Example [Section titled “Example”](#example-316) ```ts 12 ``` ##### RailBookingData.RailLeg.seat.seat\_number? [Section titled “RailBookingData.RailLeg.seat.seat\_number?”](#railbookingdataraillegseatseat_number) > `optional` **seat\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-347) The number of the seat. ###### Example [Section titled “Example”](#example-317) ```ts 41 ``` ##### RailBookingData.RailLeg.vehicle? [Section titled “RailBookingData.RailLeg.vehicle?”](#railbookingdataraillegvehicle) > `optional` **vehicle?**: `object` ##### RailBookingData.RailLeg.vehicle.carrier? [Section titled “RailBookingData.RailLeg.vehicle.carrier?”](#railbookingdataraillegvehiclecarrier) > `optional` **carrier?**: `string` | `null` ###### Description [Section titled “Description”](#description-348) The carrier that operates this leg. E.g. Amtrak, Thameslink. ###### Example [Section titled “Example”](#example-318) ```ts Amtrak ``` ##### RailBookingData.RailLeg.vehicle.timetable\_id? [Section titled “RailBookingData.RailLeg.vehicle.timetable\_id?”](#railbookingdataraillegvehicletimetable_id) > `optional` **timetable\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-349) The timetable ID for the vehicle. The concept is similar to a flight number. ###### Example [Section titled “Example”](#example-319) ```ts L79727 ``` ##### RailBookingData.RailLeg.vehicle.type? [Section titled “RailBookingData.RailLeg.vehicle.type?”](#railbookingdataraillegvehicletype) > `optional` **type?**: `"METRO"` | `"TRAIN"` | `"BUS"` | `"FERRY"` | `"WALK"` | `"TAXI"` | `"TRAM"` | `"TUBE"` ##### RailBookingData.RailSeat [Section titled “RailBookingData.RailSeat”](#railbookingdatarailseat) > **RailBookingData.RailSeat**: `object` ###### Description [Section titled “Description”](#description-350) A seat in a train leg. ##### RailBookingData.RailSeat.coach\_number? [Section titled “RailBookingData.RailSeat.coach\_number?”](#railbookingdatarailseatcoach_number) > `optional` **coach\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-351) The number of the coach. ###### Example [Section titled “Example”](#example-320) ```ts 12 ``` ##### RailBookingData.RailSeat.seat\_number? [Section titled “RailBookingData.RailSeat.seat\_number?”](#railbookingdatarailseatseat_number) > `optional` **seat\_number?**: `string` | `null` ###### Description [Section titled “Description”](#description-352) The number of the seat. ###### Example [Section titled “Example”](#example-321) ```ts 41 ``` ##### RailBookingData.RailStation [Section titled “RailBookingData.RailStation”](#railbookingdatarailstation) > **RailBookingData.RailStation**: `object` ###### Description [Section titled “Description”](#description-353) An endpoint in a rail leg. ##### RailBookingData.RailStation.location? [Section titled “RailBookingData.RailStation.location?”](#railbookingdatarailstationlocation) > `optional` **location?**: `object` ##### RailBookingData.RailStation.location.address\_line\_1? [Section titled “RailBookingData.RailStation.location.address\_line\_1?”](#railbookingdatarailstationlocationaddress_line_1) > `optional` **address\_line\_1?**: `string` | `null` ###### Description [Section titled “Description”](#description-354) The first line of the address. ###### Example [Section titled “Example”](#example-322) ```ts Av. Vinte de Janeiro, S/N ``` ##### RailBookingData.RailStation.location.address\_line\_2? [Section titled “RailBookingData.RailStation.location.address\_line\_2?”](#railbookingdatarailstationlocationaddress_line_2) > `optional` **address\_line\_2?**: `string` | `null` ###### Description [Section titled “Description”](#description-355) The second line of the address. ###### Example [Section titled “Example”](#example-323) ```ts Ilha do Governador ``` ##### RailBookingData.RailStation.location.administrative\_area? [Section titled “RailBookingData.RailStation.location.administrative\_area?”](#railbookingdatarailstationlocationadministrative_area) > `optional` **administrative\_area?**: `string` | `null` ###### Description [Section titled “Description”](#description-356) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-324) ```ts RJ ``` ##### RailBookingData.RailStation.location.city? [Section titled “RailBookingData.RailStation.location.city?”](#railbookingdatarailstationlocationcity) > `optional` **city?**: `string` | `null` ###### Description [Section titled “Description”](#description-357) The city where the address is located. ###### Example [Section titled “Example”](#example-325) ```ts Rio de Janeiro ``` ##### RailBookingData.RailStation.location.coordinates? [Section titled “RailBookingData.RailStation.location.coordinates?”](#railbookingdatarailstationlocationcoordinates) > `optional` **coordinates?**: `object` ##### RailBookingData.RailStation.location.coordinates.latitude [Section titled “RailBookingData.RailStation.location.coordinates.latitude”](#railbookingdatarailstationlocationcoordinateslatitude) > **latitude**: `number` Format: double ###### Example [Section titled “Example”](#example-326) ```ts -22.8145373 ``` ##### RailBookingData.RailStation.location.coordinates.longitude [Section titled “RailBookingData.RailStation.location.coordinates.longitude”](#railbookingdatarailstationlocationcoordinateslongitude) > **longitude**: `number` Format: double ###### Example [Section titled “Example”](#example-327) ```ts -43.2465548 ``` ##### RailBookingData.RailStation.location.country? [Section titled “RailBookingData.RailStation.location.country?”](#railbookingdatarailstationlocationcountry) > `optional` **country?**: `string` | `null` ###### Description [Section titled “Description”](#description-358) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-328) ```ts Brazil ``` ##### RailBookingData.RailStation.location.postal\_code? [Section titled “RailBookingData.RailStation.location.postal\_code?”](#railbookingdatarailstationlocationpostal_code) > `optional` **postal\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-359) The postal code of the given address. ###### Example [Section titled “Example”](#example-329) ```ts 21941-900 ``` ##### RailBookingData.RailStation.location.timezone? [Section titled “RailBookingData.RailStation.location.timezone?”](#railbookingdatarailstationlocationtimezone) > `optional` **timezone?**: `string` | `null` ###### Description [Section titled “Description”](#description-360) The timezone in the given address. ###### Example [Section titled “Example”](#example-330) ```ts America/Sao_Paulo ``` ##### RailBookingData.RailStation.name? [Section titled “RailBookingData.RailStation.name?”](#railbookingdatarailstationname) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-361) The name of the station. ###### Example [Section titled “Example”](#example-331) ```ts London - King's Cross ``` ##### RailBookingData.RailStation.type? [Section titled “RailBookingData.RailStation.type?”](#railbookingdatarailstationtype) > `optional` **type?**: `"INDIVIDUAL"` | `"GROUP"` | `"METRO"` | `"BUS_STOP"` | `"FERRY_TERMINAL"` ##### RailBookingData.RailStationType [Section titled “RailBookingData.RailStationType”](#railbookingdatarailstationtype-1) > **RailBookingData.RailStationType**: `"INDIVIDUAL"` | `"GROUP"` | `"METRO"` | `"BUS_STOP"` | `"FERRY_TERMINAL"` ###### Description [Section titled “Description”](#description-362) The kind of station. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey. \* `INDIVIDUAL` - A regular train station. \* `GROUP` - Stations grouped together, usually in a major European city. E.g. “London, Any”. \* `METRO` - A metro/subway station. \* `BUS_STOP` - A bus stop. \* `FERRY_TERMINAL` - A ferry terminal. ###### Example [Section titled “Example”](#example-332) ```ts INDIVIDUAL @enum {string} ``` ##### RailBookingData.Vehicle [Section titled “RailBookingData.Vehicle”](#railbookingdatavehicle) > **RailBookingData.Vehicle**: `object` ###### Description [Section titled “Description”](#description-363) A vehicle used in a train leg. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey. ##### RailBookingData.Vehicle.carrier? [Section titled “RailBookingData.Vehicle.carrier?”](#railbookingdatavehiclecarrier) > `optional` **carrier?**: `string` | `null` ###### Description [Section titled “Description”](#description-364) The carrier that operates this leg. E.g. Amtrak, Thameslink. ###### Example [Section titled “Example”](#example-333) ```ts Amtrak ``` ##### RailBookingData.Vehicle.timetable\_id? [Section titled “RailBookingData.Vehicle.timetable\_id?”](#railbookingdatavehicletimetable_id) > `optional` **timetable\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-365) The timetable ID for the vehicle. The concept is similar to a flight number. ###### Example [Section titled “Example”](#example-334) ```ts L79727 ``` ##### RailBookingData.Vehicle.type? [Section titled “RailBookingData.Vehicle.type?”](#railbookingdatavehicletype) > `optional` **type?**: `"METRO"` | `"TRAIN"` | `"BUS"` | `"FERRY"` | `"WALK"` | `"TAXI"` | `"TRAM"` | `"TUBE"` ##### RailBookingData.VehicleType [Section titled “RailBookingData.VehicleType”](#railbookingdatavehicletype-1) > **RailBookingData.VehicleType**: `"METRO"` | `"TRAIN"` | `"BUS"` | `"FERRY"` | `"WALK"` | `"TAXI"` | `"TRAM"` | `"TUBE"` ###### Description [Section titled “Description”](#description-366) The kind of vehicle to be used in a leg. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey. \* `TRAIN` - A regular train. \* `BUS` - A bus. \* `FERRY` - A ferry. \* `WALK`- Walking between stations. \* `TAXI` - A taxi between stations. \* `TRAM` - Tram/light rail. \* `METRO` - Metro/subway. \* `TUBE` - London underground. ###### Example [Section titled “Example”](#example-335) ```ts TRAIN @enum {string} ``` #### Traveler [Section titled “Traveler”](#traveler) > **Traveler**: `object` ##### Description [Section titled “Description”](#description-367) Information on the person who will be traveling. ##### Traveler.guest\_email? [Section titled “Traveler.guest\_email?”](#travelerguest_email) > `optional` **guest\_email?**: `string` | `null` ###### Description [Section titled “Description”](#description-368) If the traveler is a guest, this is their email. ###### Example [Section titled “Example”](#example-336) ```ts guest@gmail.com ``` ##### Traveler.name? [Section titled “Traveler.name?”](#travelername) > `optional` **name?**: `object` ##### Traveler.name.first\_name? [Section titled “Traveler.name.first\_name?”](#travelernamefirst_name) > `optional` **first\_name?**: `string` ###### Description [Section titled “Description”](#description-369) The traveler’s first name. ###### Example [Section titled “Example”](#example-337) ```ts John ``` ##### Traveler.name.last\_name? [Section titled “Traveler.name.last\_name?”](#travelernamelast_name) > `optional` **last\_name?**: `string` ###### Description [Section titled “Description”](#description-370) The traveler’s last name. ###### Example [Section titled “Example”](#example-338) ```ts Doe ``` ##### Traveler.name.middle\_name? [Section titled “Traveler.name.middle\_name?”](#travelernamemiddle_name) > `optional` **middle\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-371) The traveler’s middle name. ###### Example [Section titled “Example”](#example-339) ```ts Paul ``` ##### Traveler.name.suffix? [Section titled “Traveler.name.suffix?”](#travelernamesuffix) > `optional` **suffix?**: `string` | `null` ###### Description [Section titled “Description”](#description-372) The suffix in the traveler’s name. ###### Example [Section titled “Example”](#example-340) ```ts Jr. ``` ##### Traveler.type [Section titled “Traveler.type”](#travelertype) > **type**: `"EMPLOYEE"` | `"GUEST"` ##### Traveler.user\_id? [Section titled “Traveler.user\_id?”](#traveleruser_id) > `optional` **user\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-373) If the traveler is an employee, this is their user ID. ###### Example [Section titled “Example”](#example-341) ```ts cuuser_cky0xs54b004h01pidi0pcuz1 ``` ##### Traveler.Name [Section titled “Traveler.Name”](#travelername-1) > **Traveler.Name**: `object` ###### Description [Section titled “Description”](#description-374) The name of the traveler. ##### Traveler.Name.first\_name? [Section titled “Traveler.Name.first\_name?”](#travelernamefirst_name-1) > `optional` **first\_name?**: `string` ###### Description [Section titled “Description”](#description-375) The traveler’s first name. ###### Example [Section titled “Example”](#example-342) ```ts John ``` ##### Traveler.Name.last\_name? [Section titled “Traveler.Name.last\_name?”](#travelernamelast_name-1) > `optional` **last\_name?**: `string` ###### Description [Section titled “Description”](#description-376) The traveler’s last name. ###### Example [Section titled “Example”](#example-343) ```ts Doe ``` ##### Traveler.Name.middle\_name? [Section titled “Traveler.Name.middle\_name?”](#travelernamemiddle_name-1) > `optional` **middle\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-377) The traveler’s middle name. ###### Example [Section titled “Example”](#example-344) ```ts Paul ``` ##### Traveler.Name.suffix? [Section titled “Traveler.Name.suffix?”](#travelernamesuffix-1) > `optional` **suffix?**: `string` | `null` ###### Description [Section titled “Description”](#description-378) The suffix in the traveler’s name. ###### Example [Section titled “Example”](#example-345) ```ts Jr. ``` ##### Traveler.Type [Section titled “Traveler.Type”](#travelertype-1) > **Traveler.Type**: `"EMPLOYEE"` | `"GUEST"` ###### Description [Section titled “Description”](#description-379) Whether the trip is for an employee or a guest. ###### Example [Section titled “Example”](#example-346) ```ts EMPLOYEE @enum {string} ``` #### Trip [Section titled “Trip”](#trip) > **Trip**: `object` ##### Description [Section titled “Description”](#description-380) A trip representation. ##### Trip.billable\_at? [Section titled “Trip.billable\_at?”](#tripbillable_at) > `optional` **billable\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-381) The time when the trip became billable. If absent, the trip is currently not billable. ###### Example [Section titled “Example”](#example-347) ```ts 2017-12-27T15:42:30Z ``` ##### Trip.booker\_user\_id [Section titled “Trip.booker\_user\_id”](#tripbooker_user_id) > **booker\_user\_id**: `string` ###### Description [Section titled “Description”](#description-382) The ID of the user who booked the trip. If the trip was created on copilot mode, this will be the ID of the user on behalf of whom the trip was booked. ###### Example [Section titled “Example”](#example-348) ```ts cuuser_cky0xs54b004h01pidi0pcuz1 ``` ##### Trip.created\_at [Section titled “Trip.created\_at”](#tripcreated_at) > **created\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-383) The time when the trip was created. ###### Example [Section titled “Example”](#example-349) ```ts 2017-12-27T15:42:30Z ``` ##### Trip.ends\_at? [Section titled “Trip.ends\_at?”](#tripends_at) > `optional` **ends\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-384) The time when the last booking in the trip ends. ###### Example [Section titled “Example”](#example-350) ```ts 2017-12-27T15:42:30Z ``` ##### Trip.id [Section titled “Trip.id”](#tripid) > **id**: `string` ###### Description [Section titled “Description”](#description-385) The ID of the trip. ###### Example [Section titled “Example”](#example-351) ```ts trip_cl9rh1n8g001e0j84w6fb4fd1 ``` ##### Trip.name? [Section titled “Trip.name?”](#tripname) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-386) The name of the trip as seen in the dashboard. ###### Example [Section titled “Example”](#example-352) ```ts Trip to Rio de Janeiro ``` ##### Trip.starts\_at? [Section titled “Trip.starts\_at?”](#tripstarts_at) > `optional` **starts\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-387) The time when the first booking in the trip starts. ###### Example [Section titled “Example”](#example-353) ```ts 2017-12-27T15:42:30Z ``` ##### Trip.status [Section titled “Trip.status”](#tripstatus) > **status**: `"DELETED"` | `"INVITED"` | `"PROCESSING"` | `"CANCELED"` | `"REFUNDED"` | `"DRAFT"` | `"IN_PROGRESS"` | `"APPROVAL_DENIED"` | `"PENDING"` | `"HOLD"` | `"COMPLETED"` | `"VOIDED"` | `"UNCONFIRMED"` | `"AIRLINE_CONTROL"` | `"PAYMENT_DECLINED"` | `"SCHEDULE_CHANGE"` | `"APPROVAL_REQUESTED"` | `"CANCELLATION_IN_PROGRESS"` | `"UPCOMING"` ##### Trip.traveler? [Section titled “Trip.traveler?”](#triptraveler) > `optional` **traveler?**: `object` ##### Trip.traveler.guest\_email? [Section titled “Trip.traveler.guest\_email?”](#triptravelerguest_email) > `optional` **guest\_email?**: `string` | `null` ###### Description [Section titled “Description”](#description-388) If the traveler is a guest, this is their email. ###### Example [Section titled “Example”](#example-354) ```ts guest@gmail.com ``` ##### Trip.traveler.name? [Section titled “Trip.traveler.name?”](#triptravelername) > `optional` **name?**: `object` ##### Trip.traveler.name.first\_name? [Section titled “Trip.traveler.name.first\_name?”](#triptravelernamefirst_name) > `optional` **first\_name?**: `string` ###### Description [Section titled “Description”](#description-389) The traveler’s first name. ###### Example [Section titled “Example”](#example-355) ```ts John ``` ##### Trip.traveler.name.last\_name? [Section titled “Trip.traveler.name.last\_name?”](#triptravelernamelast_name) > `optional` **last\_name?**: `string` ###### Description [Section titled “Description”](#description-390) The traveler’s last name. ###### Example [Section titled “Example”](#example-356) ```ts Doe ``` ##### Trip.traveler.name.middle\_name? [Section titled “Trip.traveler.name.middle\_name?”](#triptravelernamemiddle_name) > `optional` **middle\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-391) The traveler’s middle name. ###### Example [Section titled “Example”](#example-357) ```ts Paul ``` ##### Trip.traveler.name.suffix? [Section titled “Trip.traveler.name.suffix?”](#triptravelernamesuffix) > `optional` **suffix?**: `string` | `null` ###### Description [Section titled “Description”](#description-392) The suffix in the traveler’s name. ###### Example [Section titled “Example”](#example-358) ```ts Jr. ``` ##### Trip.traveler.type [Section titled “Trip.traveler.type”](#triptravelertype) > **type**: `"EMPLOYEE"` | `"GUEST"` ##### Trip.traveler.user\_id? [Section titled “Trip.traveler.user\_id?”](#triptraveleruser_id) > `optional` **user\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-393) If the traveler is an employee, this is their user ID. ###### Example [Section titled “Example”](#example-359) ```ts cuuser_cky0xs54b004h01pidi0pcuz1 ``` ##### Trip.updated\_at [Section titled “Trip.updated\_at”](#tripupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-394) The time when the latest trip update happened. ###### Example [Section titled “Example”](#example-360) ```ts 2017-12-27T15:42:30Z ``` ##### Trip.version [Section titled “Trip.version”](#tripversion) > **version**: `number` Format: int32 ###### Description [Section titled “Description”](#description-395) The current version of the trip. ###### Example [Section titled “Example”](#example-361) ```ts 2 ``` ##### Trip.Status [Section titled “Trip.Status”](#tripstatus-1) > **Trip.Status**: `"DELETED"` | `"INVITED"` | `"PROCESSING"` | `"CANCELED"` | `"REFUNDED"` | `"DRAFT"` | `"IN_PROGRESS"` | `"APPROVAL_DENIED"` | `"PENDING"` | `"HOLD"` | `"COMPLETED"` | `"VOIDED"` | `"UNCONFIRMED"` | `"AIRLINE_CONTROL"` | `"PAYMENT_DECLINED"` | `"SCHEDULE_CHANGE"` | `"APPROVAL_REQUESTED"` | `"CANCELLATION_IN_PROGRESS"` | `"UPCOMING"` ###### Description [Section titled “Description”](#description-396) The current status of a trip. ###### Example [Section titled “Example”](#example-362) ```ts UPCOMING @enum {string} ``` # TravelPaths Defined in: [src/travel/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L2) ## Properties [Section titled “Properties”](#properties) ### /v1/trips [Section titled “/v1/trips”](#v1trips) > **/v1/trips**: `object` Defined in: [src/travel/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L3) #### delete? [Section titled “delete?”](#delete) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get) > **get**: `object` List trips ##### Description [Section titled “Description”](#description) Lists trips according to the filters passed in the query string. ##### get.parameters [Section titled “get.parameters”](#getparameters) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.last\_updated\_after? [Section titled “get.parameters.query.last\_updated\_after?”](#getparametersquerylast_updated_after) > `optional` **last\_updated\_after?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit) > `optional` **limit?**: `number` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-1) A page with a list of trips. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-2) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-1) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-3) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-2) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-4) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-3) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500) > **500**: `object` ###### Description [Section titled “Description”](#description-5) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-4) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace) > `optional` **trace?**: `undefined` *** ### /v1/trips/{trip\_id} [Section titled “/v1/trips/{trip\_id}”](#v1tripstrip_id) > **/v1/trips/{trip\_id}**: `object` Defined in: [src/travel/types.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L23) #### delete? [Section titled “delete?”](#delete-1) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-1) > **get**: `object` Get trip ##### Description [Section titled “Description”](#description-6) Retrieves a trip by ID. ##### get.parameters [Section titled “get.parameters”](#getparameters-1) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-1) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-1) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-1) > **path**: `object` ##### get.parameters.path.trip\_id [Section titled “get.parameters.path.trip\_id”](#getparameterspathtrip_id) > **trip\_id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-1) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-1) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-1) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-7) The trip that was retrieved. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-1) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-1) > **application/json**: `object` ##### get.responses.200.content.application/json.billable\_at? [Section titled “get.responses.200.content.application/json.billable\_at?”](#getresponses200contentapplicationjsonbillable_at) > `optional` **billable\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-8) The time when the trip became billable. If absent, the trip is currently not billable. ###### Example [Section titled “Example”](#example) ```ts 2017-12-27T15:42:30Z ``` ##### get.responses.200.content.application/json.booker\_user\_id [Section titled “get.responses.200.content.application/json.booker\_user\_id”](#getresponses200contentapplicationjsonbooker_user_id) > **booker\_user\_id**: `string` ###### Description [Section titled “Description”](#description-9) The ID of the user who booked the trip. If the trip was created on copilot mode, this will be the ID of the user on behalf of whom the trip was booked. ###### Example [Section titled “Example”](#example-1) ```ts cuuser_cky0xs54b004h01pidi0pcuz1 ``` ##### get.responses.200.content.application/json.created\_at [Section titled “get.responses.200.content.application/json.created\_at”](#getresponses200contentapplicationjsoncreated_at) > **created\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-10) The time when the trip was created. ###### Example [Section titled “Example”](#example-2) ```ts 2017-12-27T15:42:30Z ``` ##### get.responses.200.content.application/json.ends\_at? [Section titled “get.responses.200.content.application/json.ends\_at?”](#getresponses200contentapplicationjsonends_at) > `optional` **ends\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-11) The time when the last booking in the trip ends. ###### Example [Section titled “Example”](#example-3) ```ts 2017-12-27T15:42:30Z ``` ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-12) The ID of the trip. ###### Example [Section titled “Example”](#example-4) ```ts trip_cl9rh1n8g001e0j84w6fb4fd1 ``` ##### get.responses.200.content.application/json.name? [Section titled “get.responses.200.content.application/json.name?”](#getresponses200contentapplicationjsonname) > `optional` **name?**: `string` | `null` ###### Description [Section titled “Description”](#description-13) The name of the trip as seen in the dashboard. ###### Example [Section titled “Example”](#example-5) ```ts Trip to Rio de Janeiro ``` ##### get.responses.200.content.application/json.starts\_at? [Section titled “get.responses.200.content.application/json.starts\_at?”](#getresponses200contentapplicationjsonstarts_at) > `optional` **starts\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-14) The time when the first booking in the trip starts. ###### Example [Section titled “Example”](#example-6) ```ts 2017-12-27T15:42:30Z ``` ##### get.responses.200.content.application/json.status [Section titled “get.responses.200.content.application/json.status”](#getresponses200contentapplicationjsonstatus) > **status**: `"DELETED"` | `"INVITED"` | `"PROCESSING"` | `"CANCELED"` | `"REFUNDED"` | `"DRAFT"` | `"IN_PROGRESS"` | `"APPROVAL_DENIED"` | `"PENDING"` | `"HOLD"` | `"COMPLETED"` | `"VOIDED"` | `"UNCONFIRMED"` | `"AIRLINE_CONTROL"` | `"PAYMENT_DECLINED"` | `"SCHEDULE_CHANGE"` | `"APPROVAL_REQUESTED"` | `"CANCELLATION_IN_PROGRESS"` | `"UPCOMING"` ##### get.responses.200.content.application/json.traveler? [Section titled “get.responses.200.content.application/json.traveler?”](#getresponses200contentapplicationjsontraveler) > `optional` **traveler?**: `object` ##### get.responses.200.content.application/json.traveler.guest\_email? [Section titled “get.responses.200.content.application/json.traveler.guest\_email?”](#getresponses200contentapplicationjsontravelerguest_email) > `optional` **guest\_email?**: `string` | `null` ###### Description [Section titled “Description”](#description-15) If the traveler is a guest, this is their email. ###### Example [Section titled “Example”](#example-7) ```ts guest@gmail.com ``` ##### get.responses.200.content.application/json.traveler.name? [Section titled “get.responses.200.content.application/json.traveler.name?”](#getresponses200contentapplicationjsontravelername) > `optional` **name?**: `object` ##### get.responses.200.content.application/json.traveler.name.first\_name? [Section titled “get.responses.200.content.application/json.traveler.name.first\_name?”](#getresponses200contentapplicationjsontravelernamefirst_name) > `optional` **first\_name?**: … | … ###### Description [Section titled “Description”](#description-16) The traveler’s first name. ###### Example [Section titled “Example”](#example-8) ```ts John ``` ##### get.responses.200.content.application/json.traveler.name.last\_name? [Section titled “get.responses.200.content.application/json.traveler.name.last\_name?”](#getresponses200contentapplicationjsontravelernamelast_name) > `optional` **last\_name?**: … | … ###### Description [Section titled “Description”](#description-17) The traveler’s last name. ###### Example [Section titled “Example”](#example-9) ```ts Doe ``` ##### get.responses.200.content.application/json.traveler.name.middle\_name? [Section titled “get.responses.200.content.application/json.traveler.name.middle\_name?”](#getresponses200contentapplicationjsontravelernamemiddle_name) > `optional` **middle\_name?**: … | … | … ###### Description [Section titled “Description”](#description-18) The traveler’s middle name. ###### Example [Section titled “Example”](#example-10) ```ts Paul ``` ##### get.responses.200.content.application/json.traveler.name.suffix? [Section titled “get.responses.200.content.application/json.traveler.name.suffix?”](#getresponses200contentapplicationjsontravelernamesuffix) > `optional` **suffix?**: … | … | … ###### Description [Section titled “Description”](#description-19) The suffix in the traveler’s name. ###### Example [Section titled “Example”](#example-11) ```ts Jr. ``` ##### get.responses.200.content.application/json.traveler.type [Section titled “get.responses.200.content.application/json.traveler.type”](#getresponses200contentapplicationjsontravelertype) > **type**: `"EMPLOYEE"` | `"GUEST"` ##### get.responses.200.content.application/json.traveler.user\_id? [Section titled “get.responses.200.content.application/json.traveler.user\_id?”](#getresponses200contentapplicationjsontraveleruser_id) > `optional` **user\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-20) If the traveler is an employee, this is their user ID. ###### Example [Section titled “Example”](#example-12) ```ts cuuser_cky0xs54b004h01pidi0pcuz1 ``` ##### get.responses.200.content.application/json.updated\_at [Section titled “get.responses.200.content.application/json.updated\_at”](#getresponses200contentapplicationjsonupdated_at) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-21) The time when the latest trip update happened. ###### Example [Section titled “Example”](#example-13) ```ts 2017-12-27T15:42:30Z ``` ##### get.responses.200.content.application/json.version [Section titled “get.responses.200.content.application/json.version”](#getresponses200contentapplicationjsonversion) > **version**: `number` Format: int32 ###### Description [Section titled “Description”](#description-22) The current version of the trip. ###### Example [Section titled “Example”](#example-14) ```ts 2 ``` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-5) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-23) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-1) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-6) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-24) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-1) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-7) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-25) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-1) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-8) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404) > **404**: `object` ###### Description [Section titled “Description”](#description-26) Not Found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-9) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-1) > **500**: `object` ###### Description [Section titled “Description”](#description-27) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-1) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-10) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-1) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-1) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-1) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-1) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-1) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-1) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-1) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-1) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-1) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-1) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-1) > `optional` **trace?**: `undefined` *** ### /v1/trips/{trip\_id}/bookings [Section titled “/v1/trips/{trip\_id}/bookings”](#v1tripstrip_idbookings) > **/v1/trips/{trip\_id}/bookings**: `object` Defined in: [src/travel/types.gen.ts:43](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L43) #### delete? [Section titled “delete?”](#delete-2) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-2) > **get**: `object` List trip bookings ##### Description [Section titled “Description”](#description-28) Lists the bookings within a trip. ##### get.parameters [Section titled “get.parameters”](#getparameters-2) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-2) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-2) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-2) > **path**: `object` ##### get.parameters.path.trip\_id [Section titled “get.parameters.path.trip\_id”](#getparameterspathtrip_id-1) > **trip\_id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-2) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-1) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-1) > `optional` **limit?**: `number` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-2) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-2) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-29) A page with a list of bookings. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-2) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-2) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-1) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-1) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-11) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-2) > **400**: `object` ###### Description [Section titled “Description”](#description-30) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-2) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-12) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-2) > **401**: `object` ###### Description [Section titled “Description”](#description-31) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-2) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-13) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-2) > **403**: `object` ###### Description [Section titled “Description”](#description-32) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-2) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-14) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404-1) > **404**: `object` ###### Description [Section titled “Description”](#description-33) Not Found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content-1) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-15) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-2) > **500**: `object` ###### Description [Section titled “Description”](#description-34) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-2) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-16) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-2) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-2) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-2) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-2) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-2) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-2) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-2) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-2) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-2) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-2) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-2) > `optional` **trace?**: `undefined` *** ### /v1/trips/{trip\_id}/bookings/{booking\_id} [Section titled “/v1/trips/{trip\_id}/bookings/{booking\_id}”](#v1tripstrip_idbookingsbooking_id) > **/v1/trips/{trip\_id}/bookings/{booking\_id}**: `object` Defined in: [src/travel/types.gen.ts:63](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L63) #### delete? [Section titled “delete?”](#delete-3) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-3) > **get**: `object` Get booking ##### Description [Section titled “Description”](#description-35) Retrieves a booking by trip and booking ID. ##### get.parameters [Section titled “get.parameters”](#getparameters-3) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-3) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-3) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-3) > **path**: `object` ##### get.parameters.path.booking\_id [Section titled “get.parameters.path.booking\_id”](#getparameterspathbooking_id) > **booking\_id**: `string` ##### get.parameters.path.trip\_id [Section titled “get.parameters.path.trip\_id”](#getparameterspathtrip_id-2) > **trip\_id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-3) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-3) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-3) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-3) > **200**: `object` ###### Description [Section titled “Description”](#description-36) The booking that was retrieved. ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-3) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-3) > **application/json**: `object` ##### get.responses.200.content.application/json.booking\_data [Section titled “get.responses.200.content.application/json.booking\_data”](#getresponses200contentapplicationjsonbooking_data) > **booking\_data**: { `journeys`: `object`\[]; `known_traveler_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `redress_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `tickets`: `object`\[]; `type`: `"AIR"`; } | { `car_details`: { `car_class?`: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"`; `display_name`: `string`; }; `reservation_details`: { `confirmation_code?`: `string` | `null`; `drop_off`: { `location`: { `address_line_1?`: …; `address_line_2?`: …; `administrative_area?`: …; `city?`: …; `coordinates?`: …; `country?`: …; `postal_code?`: …; `timezone?`: …; }; `time`: { `local_time`: …; `timestamp?`: …; }; }; `pickup`: { `location`: { `address_line_1?`: …; `address_line_2?`: …; `administrative_area?`: …; `city?`: …; `coordinates?`: …; `country?`: …; `postal_code?`: …; `timezone?`: …; }; `time`: { `local_time`: …; `timestamp?`: …; }; }; `rental_company?`: `string` | `null`; }; `type`: `"CAR_RENTAL"`; } | { `lodging_details`: { `brand_name?`: `string` | `null`; `chain_name?`: `string` | `null`; `contact_information?`: { `email?`: …; `fax?`: …; `phone?`: …; }; `display_name`: `string`; `location?`: { `address_line_1?`: …; `address_line_2?`: …; `administrative_area?`: …; `city?`: …; `coordinates?`: …; `country?`: …; `postal_code?`: …; `timezone?`: …; }; `star_rating?`: `number` | `null`; }; `reservation_details`: { `check_in_time`: { `local_time`: `string`; `timestamp?`: … | … | …; }; `checkout_time`: { `local_time`: `string`; `timestamp?`: … | … | …; }; `confirmation_code?`: `string` | `null`; `room?`: { `bed_count?`: …; `bed_type?`: …; `description?`: …; `display_name?`: …; }; }; `type`: `"LODGING"`; } | { `journeys`: `object`\[]; `type`: `"RAIL"`; } ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `journeys`: `object`\[]; `known_traveler_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `redress_number?`: { `document_number`: `string`; `issuing_country`: `string`; }; `tickets`: `object`\[]; `type`: `"AIR"`; } ###### journeys [Section titled “journeys”](#journeys) > **journeys**: `object`\[] ###### Description [Section titled “Description”](#description-37) The journeys that make up this booking. ###### known\_traveler\_number? [Section titled “known\_traveler\_number?”](#known_traveler_number) > `optional` **known\_traveler\_number?**: `object` ###### known\_traveler\_number.document\_number [Section titled “known\_traveler\_number.document\_number”](#known_traveler_numberdocument_number) > **document\_number**: `string` ###### Description [Section titled “Description”](#description-38) The actual document number. ###### Example [Section titled “Example”](#example-15) ```ts 1231231 ``` ###### known\_traveler\_number.issuing\_country [Section titled “known\_traveler\_number.issuing\_country”](#known_traveler_numberissuing_country) > **issuing\_country**: `string` ###### Description [Section titled “Description”](#description-39) The country that issued this document. ###### Example [Section titled “Example”](#example-16) ```ts BR ``` ###### redress\_number? [Section titled “redress\_number?”](#redress_number) > `optional` **redress\_number?**: `object` ###### redress\_number.document\_number [Section titled “redress\_number.document\_number”](#redress_numberdocument_number) > **document\_number**: `string` ###### Description [Section titled “Description”](#description-40) The actual document number. ###### Example [Section titled “Example”](#example-17) ```ts 1231231 ``` ###### redress\_number.issuing\_country [Section titled “redress\_number.issuing\_country”](#redress_numberissuing_country) > **issuing\_country**: `string` ###### Description [Section titled “Description”](#description-41) The country that issued this document. ###### Example [Section titled “Example”](#example-18) ```ts BR ``` ###### tickets [Section titled “tickets”](#tickets) > **tickets**: `object`\[] ###### Description [Section titled “Description”](#description-42) The flight tickets in this booking. ###### type [Section titled “type”](#type) > **type**: `"AIR"` ###### Description [Section titled “Description”](#description-43) discriminator enum property added by openapi-typescript *** ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `car_details`: { `car_class?`: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"`; `display_name`: `string`; }; `reservation_details`: { `confirmation_code?`: `string` | `null`; `drop_off`: { `location`: { `address_line_1?`: …; `address_line_2?`: …; `administrative_area?`: …; `city?`: …; `coordinates?`: …; `country?`: …; `postal_code?`: …; `timezone?`: …; }; `time`: { `local_time`: …; `timestamp?`: …; }; }; `pickup`: { `location`: { `address_line_1?`: …; `address_line_2?`: …; `administrative_area?`: …; `city?`: …; `coordinates?`: …; `country?`: …; `postal_code?`: …; `timezone?`: …; }; `time`: { `local_time`: …; `timestamp?`: …; }; }; `rental_company?`: `string` | `null`; }; `type`: `"CAR_RENTAL"`; } ###### car\_details [Section titled “car\_details”](#car_details) > **car\_details**: `object` ###### car\_details.car\_class? [Section titled “car\_details.car\_class?”](#car_detailscar_class) > `optional` **car\_class?**: `"OTHER"` | `"ECONOMY"` | `"COMPACT"` | `"INTERMEDIATE"` | `"PREMIUM"` | `"LUXURY"` | `"CONVERTIBLE"` | `"COMPACT_SUV"` | `"INTERMEDIATE_SUV"` | `"PREMIUM_SUV"` | `"LUXURY_SUV"` | `"MINI_VAN"` | `"PASSENGER_VAN"` | `"PICKUP_TRUCK"` | `"HYBRID"` | `"ELECTRIC"` | `"MINI"` | `"STANDARD"` | `"FULL_SIZE"` | `"SUV"` | `"SPORTS"` | `"SPECIAL"` | `"RECREATIONAL_VEHICLE"` ###### car\_details.display\_name [Section titled “car\_details.display\_name”](#car_detailsdisplay_name) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-44) The name of the car as displayed to the user. ###### Example [Section titled “Example”](#example-19) ```ts Intermediate car ``` ###### reservation\_details [Section titled “reservation\_details”](#reservation_details) > **reservation\_details**: `object` ###### reservation\_details.confirmation\_code? [Section titled “reservation\_details.confirmation\_code?”](#reservation_detailsconfirmation_code) > `optional` **confirmation\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-45) The confirmation code given by the vendor. ###### Example [Section titled “Example”](#example-20) ```ts 7003XBQ504 ``` ###### reservation\_details.drop\_off [Section titled “reservation\_details.drop\_off”](#reservation_detailsdrop_off) > **drop\_off**: `object` ###### reservation\_details.drop\_off.location [Section titled “reservation\_details.drop\_off.location”](#reservation_detailsdrop_offlocation) > **location**: `object` ###### reservation\_details.drop\_off.location.address\_line\_1? [Section titled “reservation\_details.drop\_off.location.address\_line\_1?”](#reservation_detailsdrop_offlocationaddress_line_1) > `optional` **address\_line\_1?**: … ###### Description [Section titled “Description”](#description-46) The first line of the address. ###### Example [Section titled “Example”](#example-21) ```ts Av. Vinte de Janeiro, S/N ``` ###### reservation\_details.drop\_off.location.address\_line\_2? [Section titled “reservation\_details.drop\_off.location.address\_line\_2?”](#reservation_detailsdrop_offlocationaddress_line_2) > `optional` **address\_line\_2?**: … ###### Description [Section titled “Description”](#description-47) The second line of the address. ###### Example [Section titled “Example”](#example-22) ```ts Ilha do Governador ``` ###### reservation\_details.drop\_off.location.administrative\_area? [Section titled “reservation\_details.drop\_off.location.administrative\_area?”](#reservation_detailsdrop_offlocationadministrative_area) > `optional` **administrative\_area?**: … ###### Description [Section titled “Description”](#description-48) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-23) ```ts RJ ``` ###### reservation\_details.drop\_off.location.city? [Section titled “reservation\_details.drop\_off.location.city?”](#reservation_detailsdrop_offlocationcity) > `optional` **city?**: … ###### Description [Section titled “Description”](#description-49) The city where the address is located. ###### Example [Section titled “Example”](#example-24) ```ts Rio de Janeiro ``` ###### reservation\_details.drop\_off.location.coordinates? [Section titled “reservation\_details.drop\_off.location.coordinates?”](#reservation_detailsdrop_offlocationcoordinates) > `optional` **coordinates?**: … ###### reservation\_details.drop\_off.location.country? [Section titled “reservation\_details.drop\_off.location.country?”](#reservation_detailsdrop_offlocationcountry) > `optional` **country?**: … ###### Description [Section titled “Description”](#description-50) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-25) ```ts Brazil ``` ###### reservation\_details.drop\_off.location.postal\_code? [Section titled “reservation\_details.drop\_off.location.postal\_code?”](#reservation_detailsdrop_offlocationpostal_code) > `optional` **postal\_code?**: … ###### Description [Section titled “Description”](#description-51) The postal code of the given address. ###### Example [Section titled “Example”](#example-26) ```ts 21941-900 ``` ###### reservation\_details.drop\_off.location.timezone? [Section titled “reservation\_details.drop\_off.location.timezone?”](#reservation_detailsdrop_offlocationtimezone) > `optional` **timezone?**: … ###### Description [Section titled “Description”](#description-52) The timezone in the given address. ###### Example [Section titled “Example”](#example-27) ```ts America/Sao_Paulo ``` ###### reservation\_details.drop\_off.time [Section titled “reservation\_details.drop\_off.time”](#reservation_detailsdrop_offtime) > **time**: `object` ###### reservation\_details.drop\_off.time.local\_time [Section titled “reservation\_details.drop\_off.time.local\_time”](#reservation_detailsdrop_offtimelocal_time) > **local\_time**: … Format: date-time ###### Description [Section titled “Description”](#description-53) The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.drop\_off.time.timestamp? [Section titled “reservation\_details.drop\_off.time.timestamp?”](#reservation_detailsdrop_offtimetimestamp) > `optional` **timestamp?**: … Format: date-time ###### Description [Section titled “Description”](#description-54) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-28) ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.pickup [Section titled “reservation\_details.pickup”](#reservation_detailspickup) > **pickup**: `object` ###### reservation\_details.pickup.location [Section titled “reservation\_details.pickup.location”](#reservation_detailspickuplocation) > **location**: `object` ###### reservation\_details.pickup.location.address\_line\_1? [Section titled “reservation\_details.pickup.location.address\_line\_1?”](#reservation_detailspickuplocationaddress_line_1) > `optional` **address\_line\_1?**: … ###### Description [Section titled “Description”](#description-55) The first line of the address. ###### Example [Section titled “Example”](#example-29) ```ts Av. Vinte de Janeiro, S/N ``` ###### reservation\_details.pickup.location.address\_line\_2? [Section titled “reservation\_details.pickup.location.address\_line\_2?”](#reservation_detailspickuplocationaddress_line_2) > `optional` **address\_line\_2?**: … ###### Description [Section titled “Description”](#description-56) The second line of the address. ###### Example [Section titled “Example”](#example-30) ```ts Ilha do Governador ``` ###### reservation\_details.pickup.location.administrative\_area? [Section titled “reservation\_details.pickup.location.administrative\_area?”](#reservation_detailspickuplocationadministrative_area) > `optional` **administrative\_area?**: … ###### Description [Section titled “Description”](#description-57) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-31) ```ts RJ ``` ###### reservation\_details.pickup.location.city? [Section titled “reservation\_details.pickup.location.city?”](#reservation_detailspickuplocationcity) > `optional` **city?**: … ###### Description [Section titled “Description”](#description-58) The city where the address is located. ###### Example [Section titled “Example”](#example-32) ```ts Rio de Janeiro ``` ###### reservation\_details.pickup.location.coordinates? [Section titled “reservation\_details.pickup.location.coordinates?”](#reservation_detailspickuplocationcoordinates) > `optional` **coordinates?**: … ###### reservation\_details.pickup.location.country? [Section titled “reservation\_details.pickup.location.country?”](#reservation_detailspickuplocationcountry) > `optional` **country?**: … ###### Description [Section titled “Description”](#description-59) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-33) ```ts Brazil ``` ###### reservation\_details.pickup.location.postal\_code? [Section titled “reservation\_details.pickup.location.postal\_code?”](#reservation_detailspickuplocationpostal_code) > `optional` **postal\_code?**: … ###### Description [Section titled “Description”](#description-60) The postal code of the given address. ###### Example [Section titled “Example”](#example-34) ```ts 21941-900 ``` ###### reservation\_details.pickup.location.timezone? [Section titled “reservation\_details.pickup.location.timezone?”](#reservation_detailspickuplocationtimezone) > `optional` **timezone?**: … ###### Description [Section titled “Description”](#description-61) The timezone in the given address. ###### Example [Section titled “Example”](#example-35) ```ts America/Sao_Paulo ``` ###### reservation\_details.pickup.time [Section titled “reservation\_details.pickup.time”](#reservation_detailspickuptime) > **time**: `object` ###### reservation\_details.pickup.time.local\_time [Section titled “reservation\_details.pickup.time.local\_time”](#reservation_detailspickuptimelocal_time) > **local\_time**: … Format: date-time ###### Description [Section titled “Description”](#description-62) The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.pickup.time.timestamp? [Section titled “reservation\_details.pickup.time.timestamp?”](#reservation_detailspickuptimetimestamp) > `optional` **timestamp?**: … Format: date-time ###### Description [Section titled “Description”](#description-63) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-36) ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.rental\_company? [Section titled “reservation\_details.rental\_company?”](#reservation_detailsrental_company) > `optional` **rental\_company?**: `string` | `null` ###### Description [Section titled “Description”](#description-64) Name of car rental company. ###### Example [Section titled “Example”](#example-37) ```ts Catch-A-Ride ``` ###### type [Section titled “type”](#type-1) > **type**: `"CAR_RENTAL"` ###### Description [Section titled “Description”](#description-65) discriminator enum property added by openapi-typescript *** ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `lodging_details`: { `brand_name?`: `string` | `null`; `chain_name?`: `string` | `null`; `contact_information?`: { `email?`: …; `fax?`: …; `phone?`: …; }; `display_name`: `string`; `location?`: { `address_line_1?`: …; `address_line_2?`: …; `administrative_area?`: …; `city?`: …; `coordinates?`: …; `country?`: …; `postal_code?`: …; `timezone?`: …; }; `star_rating?`: `number` | `null`; }; `reservation_details`: { `check_in_time`: { `local_time`: `string`; `timestamp?`: … | … | …; }; `checkout_time`: { `local_time`: `string`; `timestamp?`: … | … | …; }; `confirmation_code?`: `string` | `null`; `room?`: { `bed_count?`: …; `bed_type?`: …; `description?`: …; `display_name?`: …; }; }; `type`: `"LODGING"`; } ###### lodging\_details [Section titled “lodging\_details”](#lodging_details) > **lodging\_details**: `object` ###### lodging\_details.brand\_name? [Section titled “lodging\_details.brand\_name?”](#lodging_detailsbrand_name) > `optional` **brand\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-66) The brand name of the hotel. ###### Example [Section titled “Example”](#example-38) ```ts Marriott Hotels ``` ###### lodging\_details.chain\_name? [Section titled “lodging\_details.chain\_name?”](#lodging_detailschain_name) > `optional` **chain\_name?**: `string` | `null` ###### Description [Section titled “Description”](#description-67) The name of the hotel chain. ###### Example [Section titled “Example”](#example-39) ```ts Accor Hotels ``` ###### lodging\_details.contact\_information? [Section titled “lodging\_details.contact\_information?”](#lodging_detailscontact_information) > `optional` **contact\_information?**: `object` ###### lodging\_details.contact\_information.email? [Section titled “lodging\_details.contact\_information.email?”](#lodging_detailscontact_informationemail) > `optional` **email?**: … ###### Description [Section titled “Description”](#description-68) The email address of the venue. ###### Example [Section titled “Example”](#example-40) ```ts city@hotelchain.com ``` ###### lodging\_details.contact\_information.fax? [Section titled “lodging\_details.contact\_information.fax?”](#lodging_detailscontact_informationfax) > `optional` **fax?**: … ###### Description [Section titled “Description”](#description-69) The fax number of the venue. ###### Example [Section titled “Example”](#example-41) ```ts 12345554321 ``` ###### lodging\_details.contact\_information.phone? [Section titled “lodging\_details.contact\_information.phone?”](#lodging_detailscontact_informationphone) > `optional` **phone?**: … ###### Description [Section titled “Description”](#description-70) The phone number of the venue. ###### Example [Section titled “Example”](#example-42) ```ts 12345554321 ``` ###### lodging\_details.display\_name [Section titled “lodging\_details.display\_name”](#lodging_detailsdisplay_name) > **display\_name**: `string` ###### Description [Section titled “Description”](#description-71) The name of the venue as displayed to the user. ###### Example [Section titled “Example”](#example-43) ```ts Fancy Hotel ``` ###### lodging\_details.location? [Section titled “lodging\_details.location?”](#lodging_detailslocation) > `optional` **location?**: `object` ###### lodging\_details.location.address\_line\_1? [Section titled “lodging\_details.location.address\_line\_1?”](#lodging_detailslocationaddress_line_1) > `optional` **address\_line\_1?**: … ###### Description [Section titled “Description”](#description-72) The first line of the address. ###### Example [Section titled “Example”](#example-44) ```ts Av. Vinte de Janeiro, S/N ``` ###### lodging\_details.location.address\_line\_2? [Section titled “lodging\_details.location.address\_line\_2?”](#lodging_detailslocationaddress_line_2) > `optional` **address\_line\_2?**: … ###### Description [Section titled “Description”](#description-73) The second line of the address. ###### Example [Section titled “Example”](#example-45) ```ts Ilha do Governador ``` ###### lodging\_details.location.administrative\_area? [Section titled “lodging\_details.location.administrative\_area?”](#lodging_detailslocationadministrative_area) > `optional` **administrative\_area?**: … ###### Description [Section titled “Description”](#description-74) Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example [Section titled “Example”](#example-46) ```ts RJ ``` ###### lodging\_details.location.city? [Section titled “lodging\_details.location.city?”](#lodging_detailslocationcity) > `optional` **city?**: … ###### Description [Section titled “Description”](#description-75) The city where the address is located. ###### Example [Section titled “Example”](#example-47) ```ts Rio de Janeiro ``` ###### lodging\_details.location.coordinates? [Section titled “lodging\_details.location.coordinates?”](#lodging_detailslocationcoordinates) > `optional` **coordinates?**: … ###### lodging\_details.location.country? [Section titled “lodging\_details.location.country?”](#lodging_detailslocationcountry) > `optional` **country?**: … ###### Description [Section titled “Description”](#description-76) The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example [Section titled “Example”](#example-48) ```ts Brazil ``` ###### lodging\_details.location.postal\_code? [Section titled “lodging\_details.location.postal\_code?”](#lodging_detailslocationpostal_code) > `optional` **postal\_code?**: … ###### Description [Section titled “Description”](#description-77) The postal code of the given address. ###### Example [Section titled “Example”](#example-49) ```ts 21941-900 ``` ###### lodging\_details.location.timezone? [Section titled “lodging\_details.location.timezone?”](#lodging_detailslocationtimezone) > `optional` **timezone?**: … ###### Description [Section titled “Description”](#description-78) The timezone in the given address. ###### Example [Section titled “Example”](#example-50) ```ts America/Sao_Paulo ``` ###### lodging\_details.star\_rating? [Section titled “lodging\_details.star\_rating?”](#lodging_detailsstar_rating) > `optional` **star\_rating?**: `number` | `null` Format: float ###### Description [Section titled “Description”](#description-79) The star rating of the hotel. Some hotels have half stars. ###### Example [Section titled “Example”](#example-51) ```ts 3.5 ``` ###### reservation\_details [Section titled “reservation\_details”](#reservation_details-1) > **reservation\_details**: `object` ###### reservation\_details.check\_in\_time [Section titled “reservation\_details.check\_in\_time”](#reservation_detailscheck_in_time) > **check\_in\_time**: `object` ###### reservation\_details.check\_in\_time.local\_time [Section titled “reservation\_details.check\_in\_time.local\_time”](#reservation_detailscheck_in_timelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-80) The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.check\_in\_time.timestamp? [Section titled “reservation\_details.check\_in\_time.timestamp?”](#reservation_detailscheck_in_timetimestamp) > `optional` **timestamp?**: … | … | … Format: date-time ###### Description [Section titled “Description”](#description-81) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-52) ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.checkout\_time [Section titled “reservation\_details.checkout\_time”](#reservation_detailscheckout_time) > **checkout\_time**: `object` ###### reservation\_details.checkout\_time.local\_time [Section titled “reservation\_details.checkout\_time.local\_time”](#reservation_detailscheckout_timelocal_time) > **local\_time**: `string` Format: date-time ###### Description [Section titled “Description”](#description-82) The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.checkout\_time.timestamp? [Section titled “reservation\_details.checkout\_time.timestamp?”](#reservation_detailscheckout_timetimestamp) > `optional` **timestamp?**: … | … | … Format: date-time ###### Description [Section titled “Description”](#description-83) An ISO 8601 timestamp. ###### Example [Section titled “Example”](#example-53) ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.confirmation\_code? [Section titled “reservation\_details.confirmation\_code?”](#reservation_detailsconfirmation_code-1) > `optional` **confirmation\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-84) Confirmation code provided by the vendor. ###### Example [Section titled “Example”](#example-54) ```ts 7003XBQ504 ``` ###### reservation\_details.room? [Section titled “reservation\_details.room?”](#reservation_detailsroom) > `optional` **room?**: `object` ###### reservation\_details.room.bed\_count? [Section titled “reservation\_details.room.bed\_count?”](#reservation_detailsroombed_count) > `optional` **bed\_count?**: … Format: int32 ###### Description [Section titled “Description”](#description-85) The number of beds. ###### Example [Section titled “Example”](#example-55) ```ts 1 ``` ###### reservation\_details.room.bed\_type? [Section titled “reservation\_details.room.bed\_type?”](#reservation_detailsroombed_type) > `optional` **bed\_type?**: … ###### Description [Section titled “Description”](#description-86) The kind of bed. ###### Example [Section titled “Example”](#example-56) ```ts DOUBLE ``` ###### reservation\_details.room.description? [Section titled “reservation\_details.room.description?”](#reservation_detailsroomdescription) > `optional` **description?**: … ###### Description [Section titled “Description”](#description-87) A description of the room. ###### Example [Section titled “Example”](#example-57) ```ts Superior room ``` ###### reservation\_details.room.display\_name? [Section titled “reservation\_details.room.display\_name?”](#reservation_detailsroomdisplay_name) > `optional` **display\_name?**: … ###### Description [Section titled “Description”](#description-88) The name of the room as displayed to the user. ###### Example [Section titled “Example”](#example-58) ```ts Standard room ``` ###### type [Section titled “type”](#type-2) > **type**: `"LODGING"` ###### Description [Section titled “Description”](#description-89) discriminator enum property added by openapi-typescript *** ###### Type Literal [Section titled “Type Literal”](#type-literal-3) { `journeys`: `object`\[]; `type`: `"RAIL"`; } ###### journeys [Section titled “journeys”](#journeys-1) > **journeys**: `object`\[] ###### Description [Section titled “Description”](#description-90) The journeys that make up this booking. ###### type [Section titled “type”](#type-3) > **type**: `"RAIL"` ###### Description [Section titled “Description”](#description-91) discriminator enum property added by openapi-typescript ##### get.responses.200.content.application/json.created\_at [Section titled “get.responses.200.content.application/json.created\_at”](#getresponses200contentapplicationjsoncreated_at-1) > **created\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-92) The time when the booking was created. ###### Example [Section titled “Example”](#example-59) ```ts 2017-12-27T15:42:30Z ``` ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-93) The ID of the booking. ###### Example [Section titled “Example”](#example-60) ```ts booking_cl9t5dnu800040m3071dandeq ``` ##### get.responses.200.content.application/json.source [Section titled “get.responses.200.content.application/json.source”](#getresponses200contentapplicationjsonsource) > **source**: `"BREX_TRAVEL"` | `"EXTERNAL"` ##### get.responses.200.content.application/json.status [Section titled “get.responses.200.content.application/json.status”](#getresponses200contentapplicationjsonstatus-1) > **status**: `"PROCESSING"` | `"CANCELED"` | `"REFUNDED"` | `"IN_PROGRESS"` | `"APPROVAL_DENIED"` | `"PENDING"` | `"CONFIRMED"` | `"HOLD"` | `"COMPLETED"` | `"VOIDED"` | `"UNCONFIRMED"` | `"AIRLINE_CONTROL"` | `"PAYMENT_DECLINED"` | `"SCHEDULE_CHANGE"` | `"APPROVAL_REQUESTED"` | `"CANCELLATION_IN_PROGRESS"` ##### get.responses.200.content.application/json.trip\_id [Section titled “get.responses.200.content.application/json.trip\_id”](#getresponses200contentapplicationjsontrip_id) > **trip\_id**: `string` ###### Description [Section titled “Description”](#description-94) The ID of the trip to which this booking belongs. ###### Example [Section titled “Example”](#example-61) ```ts trip_cl9rh1n8g001e0j84w6fb4fd1 ``` ##### get.responses.200.content.application/json.type [Section titled “get.responses.200.content.application/json.type”](#getresponses200contentapplicationjsontype) > **type**: `"CAR_RENTAL"` | `"LODGING"` | `"AIR"` | `"RAIL"` ##### get.responses.200.content.application/json.updated\_at [Section titled “get.responses.200.content.application/json.updated\_at”](#getresponses200contentapplicationjsonupdated_at-1) > **updated\_at**: `string` Format: date-time ###### Description [Section titled “Description”](#description-95) The time when the booking was last updated. ###### Example [Section titled “Example”](#example-62) ```ts 2017-12-27T15:42:30Z ``` ##### get.responses.200.content.application/json.version [Section titled “get.responses.200.content.application/json.version”](#getresponses200contentapplicationjsonversion-1) > **version**: `number` Format: int32 ###### Description [Section titled “Description”](#description-96) The current version of the booking. ###### Example [Section titled “Example”](#example-63) ```ts 2 ``` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-17) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-3) > **400**: `object` ###### Description [Section titled “Description”](#description-97) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-3) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-18) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-3) > **401**: `object` ###### Description [Section titled “Description”](#description-98) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-3) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-19) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-3) > **403**: `object` ###### Description [Section titled “Description”](#description-99) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-3) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-20) \[`name`: `string`]: `unknown` ##### get.responses.404 [Section titled “get.responses.404”](#getresponses404-2) > **404**: `object` ###### Description [Section titled “Description”](#description-100) Not Found ##### get.responses.404.content? [Section titled “get.responses.404.content?”](#getresponses404content-2) > `optional` **content?**: `undefined` ##### get.responses.404.headers [Section titled “get.responses.404.headers”](#getresponses404headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-21) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-3) > **500**: `object` ###### Description [Section titled “Description”](#description-101) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-3) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-22) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-3) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-3) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-3) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-3) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-3) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-3) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-3) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-3) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-3) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-3) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-3) > `optional` **trace?**: `undefined` # Address > **Address** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Address"`] Defined in: [src/travel/schemas.gen.ts:5](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L5) # Address_GeoCoordinates > **Address\_GeoCoordinates** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Address.GeoCoordinates"`] Defined in: [src/travel/schemas.gen.ts:6](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L6) # AirBookingData > **AirBookingData** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"AirBookingData"`] Defined in: [src/travel/schemas.gen.ts:7](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L7) # AirBookingData_CabinClass > **AirBookingData\_CabinClass** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"AirBookingData.CabinClass"`] Defined in: [src/travel/schemas.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L8) # AirBookingData_DocumentNumber > **AirBookingData\_DocumentNumber** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"AirBookingData.DocumentNumber"`] Defined in: [src/travel/schemas.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L9) # AirBookingData_Flight > **AirBookingData\_Flight** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"AirBookingData.Flight"`] Defined in: [src/travel/schemas.gen.ts:10](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L10) # AirBookingData_FlightEndpoint > **AirBookingData\_FlightEndpoint** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"AirBookingData.FlightEndpoint"`] Defined in: [src/travel/schemas.gen.ts:11](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L11) # AirBookingData_FlightNumber > **AirBookingData\_FlightNumber** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"AirBookingData.FlightNumber"`] Defined in: [src/travel/schemas.gen.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L12) # AirBookingData_FlightSeat > **AirBookingData\_FlightSeat** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"AirBookingData.FlightSeat"`] Defined in: [src/travel/schemas.gen.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L13) # AirBookingData_FlightSeatStatus > **AirBookingData\_FlightSeatStatus** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"AirBookingData.FlightSeatStatus"`] Defined in: [src/travel/schemas.gen.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L14) # AirBookingData_FlightTicket > **AirBookingData\_FlightTicket** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"AirBookingData.FlightTicket"`] Defined in: [src/travel/schemas.gen.ts:16](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L16) # AirBookingData_Journey > **AirBookingData\_Journey** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"AirBookingData.Journey"`] Defined in: [src/travel/schemas.gen.ts:17](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L17) # Booking > **Booking** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Booking"`] Defined in: [src/travel/schemas.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L18) # Booking_Data > **Booking\_Data** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Booking.Data"`] Defined in: [src/travel/schemas.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L19) # Booking_Source > **Booking\_Source** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Booking.Source"`] Defined in: [src/travel/schemas.gen.ts:20](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L20) # Booking_Time > **Booking\_Time** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Booking.Time"`] Defined in: [src/travel/schemas.gen.ts:21](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L21) # Booking_Type > **Booking\_Type** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Booking.Type"`] Defined in: [src/travel/schemas.gen.ts:22](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L22) # BookingStatus > **BookingStatus** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"BookingStatus"`] Defined in: [src/travel/schemas.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L23) # CarRentalBookingData > **CarRentalBookingData** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"CarRentalBookingData"`] Defined in: [src/travel/schemas.gen.ts:24](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L24) # CarRentalBookingData_CarClass > **CarRentalBookingData\_CarClass** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"CarRentalBookingData.CarClass"`] Defined in: [src/travel/schemas.gen.ts:25](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L25) # CarRentalBookingData_CarDetails > **CarRentalBookingData\_CarDetails** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"CarRentalBookingData.CarDetails"`] Defined in: [src/travel/schemas.gen.ts:26](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L26) # CarRentalBookingData_RentalEndpoint > **CarRentalBookingData\_RentalEndpoint** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"CarRentalBookingData.RentalEndpoint"`] Defined in: [src/travel/schemas.gen.ts:28](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L28) # CarRentalBookingData_ReservationDetails > **CarRentalBookingData\_ReservationDetails** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"CarRentalBookingData.ReservationDetails"`] Defined in: [src/travel/schemas.gen.ts:30](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L30) # LodgingBookingData > **LodgingBookingData** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"LodgingBookingData"`] Defined in: [src/travel/schemas.gen.ts:32](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L32) # LodgingBookingData_ContactInfo > **LodgingBookingData\_ContactInfo** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"LodgingBookingData.ContactInfo"`] Defined in: [src/travel/schemas.gen.ts:33](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L33) # LodgingBookingData_LodgingDetails > **LodgingBookingData\_LodgingDetails** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"LodgingBookingData.LodgingDetails"`] Defined in: [src/travel/schemas.gen.ts:35](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L35) # LodgingBookingData_ReservationDetails > **LodgingBookingData\_ReservationDetails** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"LodgingBookingData.ReservationDetails"`] Defined in: [src/travel/schemas.gen.ts:37](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L37) # LodgingBookingData_Room > **LodgingBookingData\_Room** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"LodgingBookingData.Room"`] Defined in: [src/travel/schemas.gen.ts:39](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L39) # Page_Booking_ > **Page\_Booking\_** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Page_Booking_"`] Defined in: [src/travel/schemas.gen.ts:40](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L40) # Page_Trip_ > **Page\_Trip\_** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Page_Trip_"`] Defined in: [src/travel/schemas.gen.ts:41](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L41) # RailBookingData > **RailBookingData** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"RailBookingData"`] Defined in: [src/travel/schemas.gen.ts:42](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L42) # RailBookingData_RailClass > **RailBookingData\_RailClass** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"RailBookingData.RailClass"`] Defined in: [src/travel/schemas.gen.ts:43](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L43) # RailBookingData_RailJourney > **RailBookingData\_RailJourney** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"RailBookingData.RailJourney"`] Defined in: [src/travel/schemas.gen.ts:44](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L44) # RailBookingData_RailLeg > **RailBookingData\_RailLeg** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"RailBookingData.RailLeg"`] Defined in: [src/travel/schemas.gen.ts:45](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L45) # RailBookingData_RailSeat > **RailBookingData\_RailSeat** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"RailBookingData.RailSeat"`] Defined in: [src/travel/schemas.gen.ts:46](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L46) # RailBookingData_RailStation > **RailBookingData\_RailStation** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"RailBookingData.RailStation"`] Defined in: [src/travel/schemas.gen.ts:47](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L47) # RailBookingData_RailStationType > **RailBookingData\_RailStationType** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"RailBookingData.RailStationType"`] Defined in: [src/travel/schemas.gen.ts:48](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L48) # RailBookingData_Vehicle > **RailBookingData\_Vehicle** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"RailBookingData.Vehicle"`] Defined in: [src/travel/schemas.gen.ts:50](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L50) # RailBookingData_VehicleType > **RailBookingData\_VehicleType** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"RailBookingData.VehicleType"`] Defined in: [src/travel/schemas.gen.ts:51](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L51) # Traveler > **Traveler** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Traveler"`] Defined in: [src/travel/schemas.gen.ts:52](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L52) # Traveler_Name > **Traveler\_Name** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Traveler.Name"`] Defined in: [src/travel/schemas.gen.ts:53](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L53) # Traveler_Type > **Traveler\_Type** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Traveler.Type"`] Defined in: [src/travel/schemas.gen.ts:54](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L54) # Trip > **Trip** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Trip"`] Defined in: [src/travel/schemas.gen.ts:55](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L55) # Trip_Status > **Trip\_Status** = [`TravelComponents`](/brex/api/travel/interfaces/travelcomponents/)\[`"schemas"`]\[`"Trip.Status"`] Defined in: [src/travel/schemas.gen.ts:56](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/schemas.gen.ts#L56) # BrexWebhooks Defined in: [src/webhooks/client.gen.ts:267](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L267) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new BrexWebhooks**(`core`): `BrexWebhooks` Defined in: [src/webhooks/client.gen.ts:270](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L270) #### Parameters [Section titled “Parameters”](#parameters) ##### core [Section titled “core”](#core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `BrexWebhooks` ## Properties [Section titled “Properties”](#properties) ### webhookGroups [Section titled “webhookGroups”](#webhookgroups) > `readonly` **webhookGroups**: [`WebhookGroups`](/brex/api/webhooks/classes/webhookgroups/) Defined in: [src/webhooks/client.gen.ts:268](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L268) *** ### webhooks [Section titled “webhooks”](#webhooks) > `readonly` **webhooks**: [`Webhooks`](/brex/api/webhooks/classes/webhooks/) Defined in: [src/webhooks/client.gen.ts:269](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L269) # WebhookGroups Defined in: [src/webhooks/client.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L8) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new WebhookGroups**(`_core`): `WebhookGroups` Defined in: [src/webhooks/client.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L9) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `WebhookGroups` ## Methods [Section titled “Methods”](#methods) ### addMembers() [Section titled “addMembers()”](#addmembers) > **addMembers**(`id`, `body`, `options?`): `Promise`<`void`> Defined in: [src/webhooks/client.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L18) Add Webhook Group Members Adds members to webhook groups. `POST /v1/webhooks/groups/{id}/add_members` #### Parameters [Section titled “Parameters”](#parameters-1) ##### id [Section titled “id”](#id) `string` ##### body [Section titled “body”](#body) ###### members [Section titled “members”](#members) `object`\[] **Description** The list of webhook group members to add to the group. ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<`void`> *** ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `id`: `string`; `name`: `string`; }> Defined in: [src/webhooks/client.gen.ts:40](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L40) Create Webhook Group Creates a webhook group. `POST /v1/webhooks/groups` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-2) ##### body [Section titled “body”](#body-1) ###### name [Section titled “name”](#name) `string` **Description** The name for the webhook group. **Example** ```ts Some Webhook Group ``` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<{ `id`: `string`; `name`: `string`; }> *** ### delete() [Section titled “delete()”](#delete) > **delete**(`id`, `options?`): `Promise`<`void`> Defined in: [src/webhooks/client.gen.ts:60](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L60) Delete Webhook Group Deletes a webhook group and all its members. `DELETE /v1/webhooks/groups/{id}` #### Parameters [Section titled “Parameters”](#parameters-3) ##### id [Section titled “id”](#id-1) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<`void`> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `id`: `string`; `name`: `string`; }> Defined in: [src/webhooks/client.gen.ts:76](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L76) Get Webhook Group Gets a webhook group. `GET /v1/webhooks/groups/{id}` #### Parameters [Section titled “Parameters”](#parameters-4) ##### id [Section titled “id”](#id-2) `string` ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) `Promise`<{ `id`: `string`; `name`: `string`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/webhooks/client.gen.ts:95](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L95) List Webhook Groups Lists webhook groups. `GET /v1/webhooks/groups` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-5) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` **Description** Cursor for pagination. ###### limit? [Section titled “limit?”](#limit) `number` **Description** Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000. ##### options? [Section titled “options?”](#options-4) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-5) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### listMembers() [Section titled “listMembers()”](#listmembers) > **listMembers**(`id`, `query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/webhooks/client.gen.ts:114](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L114) List Webhook Group Members Lists the members currently in the specified webhook group. `GET /v1/webhooks/groups/{id}/members` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-6) ##### id [Section titled “id”](#id-3) `string` ##### query? [Section titled “query?”](#query-1) ###### cursor? [Section titled “cursor?”](#cursor-1) `string` | `null` **Description** Cursor for pagination. ###### limit? [Section titled “limit?”](#limit-1) `number` **Description** Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000. ##### options? [Section titled “options?”](#options-5) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-6) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### removeMembers() [Section titled “removeMembers()”](#removemembers) > **removeMembers**(`id`, `body`, `options?`): `Promise`<`void`> Defined in: [src/webhooks/client.gen.ts:133](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L133) Remove Webhook Group Members Removes members from webhook groups. `POST /v1/webhooks/groups/{id}/remove_members` #### Parameters [Section titled “Parameters”](#parameters-7) ##### id [Section titled “id”](#id-4) `string` ##### body [Section titled “body”](#body-2) ###### members [Section titled “members”](#members-1) `object`\[] **Description** The list of webhook group members to remove from the group. ##### options? [Section titled “options?”](#options-6) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-7) `Promise`<`void`> # Webhooks Defined in: [src/webhooks/client.gen.ts:148](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L148) ## Constructors [Section titled “Constructors”](#constructors) ### Constructor [Section titled “Constructor”](#constructor) > **new Webhooks**(`_core`): `Webhooks` Defined in: [src/webhooks/client.gen.ts:149](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L149) #### Parameters [Section titled “Parameters”](#parameters) ##### \_core [Section titled “\_core”](#_core) [`BrexCore`](/brex/api/index/classes/brexcore/) #### Returns [Section titled “Returns”](#returns) `Webhooks` ## Methods [Section titled “Methods”](#methods) ### create() [Section titled “create()”](#create) > **create**(`body`, `options?`): `Promise`<{ `event_types`: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[]; `group_id?`: `string` | `null`; `id`: `string`; `status`: `"ACTIVE"` | `"INACTIVE"`; `url`: `string`; }> Defined in: [src/webhooks/client.gen.ts:159](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L159) Register Webhook Register an endpoint to start receiving selected webhook events `POST /v1/webhooks` Sends an `Idempotency-Key` header: `options.idempotencyKey`, or an auto-generated UUID. #### Parameters [Section titled “Parameters”](#parameters-1) ##### body [Section titled “body”](#body) ###### event\_types [Section titled “event\_types”](#event_types) (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[] **Description** A list of the webhook event types this subscription will listen to. ###### group\_id? [Section titled “group\_id?”](#group_id) `string` | `null` **Description** ID of the webhook group to which this subscription applies, if any. This is only available for partners. **Example** ```ts wg_123 ``` ###### url [Section titled “url”](#url) `string` **Description** The URL to which webhook events will be sent. Must be a valid HTTPS URL. **Example** ```ts https://example.com/webhook ``` ##### options? [Section titled “options?”](#options) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-1) `Promise`<{ `event_types`: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[]; `group_id?`: `string` | `null`; `id`: `string`; `status`: `"ACTIVE"` | `"INACTIVE"`; `url`: `string`; }> *** ### delete() [Section titled “delete()”](#delete) > **delete**(`id`, `options?`): `Promise`<`void`> Defined in: [src/webhooks/client.gen.ts:177](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L177) Unregister Webhook Unregister a webhook if you want to stop receiving webhook events `DELETE /v1/webhooks/{id}` #### Parameters [Section titled “Parameters”](#parameters-2) ##### id [Section titled “id”](#id) `string` ##### options? [Section titled “options?”](#options-1) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-2) `Promise`<`void`> *** ### get() [Section titled “get()”](#get) > **get**(`id`, `options?`): `Promise`<{ `event_types`: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[]; `group_id?`: `string` | `null`; `id`: `string`; `status`: `"ACTIVE"` | `"INACTIVE"`; `url`: `string`; }> Defined in: [src/webhooks/client.gen.ts:193](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L193) Get Webhook Get details of a webhook `GET /v1/webhooks/{id}` #### Parameters [Section titled “Parameters”](#parameters-3) ##### id [Section titled “id”](#id-1) `string` ##### options? [Section titled “options?”](#options-2) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-3) `Promise`<{ `event_types`: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[]; `group_id?`: `string` | `null`; `id`: `string`; `status`: `"ACTIVE"` | `"INACTIVE"`; `url`: `string`; }> *** ### list() [Section titled “list()”](#list) > **list**(`query?`, `options?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> Defined in: [src/webhooks/client.gen.ts:212](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L212) List Webhooks List the webhooks you have registered `GET /v1/webhooks` Await for a single page, or `for await` to iterate items across all pages. #### Parameters [Section titled “Parameters”](#parameters-4) ##### query? [Section titled “query?”](#query) ###### cursor? [Section titled “cursor?”](#cursor) `string` | `null` ###### limit? [Section titled “limit?”](#limit) `number` | `null` ##### options? [Section titled “options?”](#options-3) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-4) [`PagePromise`](/brex/api/index/classes/pagepromise/)<{ `items`: `object`\[]; `next_cursor?`: `string` | `null`; }> *** ### listSecrets() [Section titled “listSecrets()”](#listsecrets) > **listSecrets**(`options?`): `Promise`<`object`\[]> Defined in: [src/webhooks/client.gen.ts:234](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L234) List Webhook Secrets This endpoint returns a set of webhook signing secrets used to validate the webhook. Usually only one key will be returned in the response. After key rotation, this endpoint will return two keys: the new key, and the key that will be revoked soon. There will also be two signatures in the ‘Webhook-Signature’ request header. Your application should use all keys available to validate the webhook request. If validation passes for any of the keys returned, the webhook payload is valid. `GET /v1/webhooks/secrets` #### Parameters [Section titled “Parameters”](#parameters-5) ##### options? [Section titled “options?”](#options-4) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-5) `Promise`<`object`\[]> *** ### update() [Section titled “update()”](#update) > **update**(`id`, `body`, `options?`): `Promise`<{ `event_types`: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[]; `group_id?`: `string` | `null`; `id`: `string`; `status`: `"ACTIVE"` | `"INACTIVE"`; `url`: `string`; }> Defined in: [src/webhooks/client.gen.ts:252](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/client.gen.ts#L252) Update Webhook Update a webhook. You can update the endpoint url, event types that the endpoint receives, or temporarily deactivate the webhook. `PUT /v1/webhooks/{id}` #### Parameters [Section titled “Parameters”](#parameters-6) ##### id [Section titled “id”](#id-2) `string` ##### body [Section titled “body”](#body-1) ###### event\_types [Section titled “event\_types”](#event_types-1) (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[] **Description** A list of the webhook event types this subscription will listen to. ###### group\_id? [Section titled “group\_id?”](#group_id-1) `string` | `null` **Description** ID of the webhook group to which this subscription applies, if any. This is only available for partners. **Example** ```ts wg_123 ``` ###### status [Section titled “status”](#status) `"ACTIVE"` | `"INACTIVE"` ###### url [Section titled “url”](#url-1) `string` **Description** The URL to which webhook events will be sent. Must be a valid HTTPS URL. **Example** ```ts https://example.com/webhook ``` ##### options? [Section titled “options?”](#options-5) [`RequestOptions`](/brex/api/index/interfaces/requestoptions/) #### Returns [Section titled “Returns”](#returns-6) `Promise`<{ `event_types`: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[]; `group_id?`: `string` | `null`; `id`: `string`; `status`: `"ACTIVE"` | `"INACTIVE"`; `url`: `string`; }> # createWebhooksClient > **createWebhooksClient**(`options`): [`BrexWebhooks`](/brex/api/webhooks/classes/brexwebhooks/) Defined in: [src/webhooks/index.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/index.ts#L13) Standalone client for the Brex Webhooks API. ## Parameters [Section titled “Parameters”](#parameters) ### options [Section titled “options”](#options) [`BrexOptions`](/brex/api/index/interfaces/brexoptions/) ## Returns [Section titled “Returns”](#returns) [`BrexWebhooks`](/brex/api/webhooks/classes/brexwebhooks/) # WebhooksComponents Defined in: [src/webhooks/types.gen.ts:190](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L190) ## Properties [Section titled “Properties”](#properties) ### headers [Section titled “headers”](#headers) > **headers**: `never` Defined in: [src/webhooks/types.gen.ts:596](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L596) *** ### parameters [Section titled “parameters”](#parameters) > **parameters**: `never` Defined in: [src/webhooks/types.gen.ts:594](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L594) *** ### pathItems [Section titled “pathItems”](#pathitems) > **pathItems**: `never` Defined in: [src/webhooks/types.gen.ts:597](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L597) *** ### requestBodies [Section titled “requestBodies”](#requestbodies) > **requestBodies**: `never` Defined in: [src/webhooks/types.gen.ts:595](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L595) *** ### responses [Section titled “responses”](#responses) > **responses**: `never` Defined in: [src/webhooks/types.gen.ts:593](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L593) *** ### schemas [Section titled “schemas”](#schemas) > **schemas**: `object` Defined in: [src/webhooks/types.gen.ts:191](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L191) #### AccountingRecordReadyForExport [Section titled “AccountingRecordReadyForExport”](#accountingrecordreadyforexport) > **AccountingRecordReadyForExport**: `object` & `Record`<`string`, `never`> ##### Type Declaration [Section titled “Type Declaration”](#type-declaration) ###### accountingRecordIds [Section titled “accountingRecordIds”](#accountingrecordids) > **accountingRecordIds**: `string`\[] ###### Description [Section titled “Description”](#description) List of accounting record IDs ready for export. ###### companyId [Section titled “companyId”](#companyid) > **companyId**: `string` ###### Description [Section titled “Description”](#description-1) This is the `id` returned in the [Get Company](/openapi/team_api/#operation/getCompany) endpoint. You can use the `company_id` to determine which access token to use when you get the details from our API endpoints. ###### event\_type [Section titled “event\_type”](#event_type) > **event\_type**: `"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"` ##### Description [Section titled “Description”](#description-2) A list of accounting records are ready for export. #### AddWebhookGroupMembersRequest [Section titled “AddWebhookGroupMembersRequest”](#addwebhookgroupmembersrequest) > **AddWebhookGroupMembersRequest**: `object` ##### AddWebhookGroupMembersRequest.members [Section titled “AddWebhookGroupMembersRequest.members”](#addwebhookgroupmembersrequestmembers) > **members**: `object`\[] ###### Description [Section titled “Description”](#description-3) The list of webhook group members to add to the group. #### ApplicationStatus [Section titled “ApplicationStatus”](#applicationstatus) > **ApplicationStatus**: `"ACTIVE"` | `"PROCESSING"` | `"REJECTED"` | `"NO_ACCOUNT"` | `"NOT_SUBMITTED"` | `"INFORMATION_PENDING"` | `"MANUAL_REVIEW"` | `"CLOSED"` ##### Description [Section titled “Description”](#description-4) Application status of a product. ```plaintext `NO_ACCOUNT` - There is no active application, and the product account is not provisioned. `ACTIVE` - The application is approved, and the product account is provisioned. `NOT_SUBMITTED` - The application is started but not yet submitted. `INFORMATION_PENDING` - The application is submitted and additional information is requested. `MANUAL_REVIEW` - The application is under manual review. `PROCESSING` - The application is submitted and is under review. `REJECTED` - The application is rejected. `CLOSED` - The product account is closed. ``` #### CreateWebhookGroupRequest [Section titled “CreateWebhookGroupRequest”](#createwebhookgrouprequest) > **CreateWebhookGroupRequest**: `object` ##### CreateWebhookGroupRequest.name [Section titled “CreateWebhookGroupRequest.name”](#createwebhookgrouprequestname) > **name**: `string` ###### Description [Section titled “Description”](#description-5) The name for the webhook group. ###### Example [Section titled “Example”](#example) ```ts Some Webhook Group ``` #### CreateWebhookSubscriptionRequest [Section titled “CreateWebhookSubscriptionRequest”](#createwebhooksubscriptionrequest) > **CreateWebhookSubscriptionRequest**: `object` ##### CreateWebhookSubscriptionRequest.event\_types [Section titled “CreateWebhookSubscriptionRequest.event\_types”](#createwebhooksubscriptionrequestevent_types) > **event\_types**: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[] ###### Description [Section titled “Description”](#description-6) A list of the webhook event types this subscription will listen to. ##### CreateWebhookSubscriptionRequest.group\_id? [Section titled “CreateWebhookSubscriptionRequest.group\_id?”](#createwebhooksubscriptionrequestgroup_id) > `optional` **group\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-7) ID of the webhook group to which this subscription applies, if any. This is only available for partners. ###### Example [Section titled “Example”](#example-1) ```ts wg_123 ``` ##### CreateWebhookSubscriptionRequest.url [Section titled “CreateWebhookSubscriptionRequest.url”](#createwebhooksubscriptionrequesturl) > **url**: `string` ###### Description [Section titled “Description”](#description-8) The URL to which webhook events will be sent. Must be a valid HTTPS URL. ###### Example [Section titled “Example”](#example-2) ```ts https://example.com/webhook ``` #### EventWrapper [Section titled “EventWrapper”](#eventwrapper) > **EventWrapper**: `Record`<`string`, `never`> #### ExpensePaymentStatus [Section titled “ExpensePaymentStatus”](#expensepaymentstatus) > **ExpensePaymentStatus**: `"DECLINED"` | `"PENDING"` ##### Description [Section titled “Description”](#description-9) `PENDING`:The transaction is yet to be captured. It may be approved, yet to be approved, or yet to be declined. ```plaintext `DECLINED`: The transaction was declined. ``` #### ExpensePaymentType [Section titled “ExpensePaymentType”](#expensepaymenttype) > **ExpensePaymentType**: `"DECLINED"` | `"PURCHASE"` | `"REFUND"` | `"WITHDRAWAL"` ##### Description [Section titled “Description”](#description-10) `PURCHASE`: A pending transaction for making a purchase. ```plaintext `REFUND`: A pending transaction for a refund. `WITHDRAWAL`: A pending transaction for a withdrawal. `DECLINED`: A pending transaction that was declined and will not be completed. ``` #### ExpensePaymentUpdated [Section titled “ExpensePaymentUpdated”](#expensepaymentupdated) > **ExpensePaymentUpdated**: `object` & `Record`<`string`, `never`> ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-1) ###### amount? [Section titled “amount?”](#amount) > `optional` **amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members) ###### Type Literal [Section titled “Type Literal”](#type-literal) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-1) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-11) 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 [Section titled “Example”](#example-3) ```ts 700 ``` ###### currency [Section titled “currency”](#currency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-12) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default) ```ts USD ``` ###### Example [Section titled “Example”](#example-4) ```ts USD ``` *** `null` ###### billing\_amount? [Section titled “billing\_amount?”](#billing_amount) > `optional` **billing\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-1) ###### Type Literal [Section titled “Type Literal”](#type-literal-1) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-2) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-13) 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 [Section titled “Example”](#example-5) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-1) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-14) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-1) ```ts USD ``` ###### Example [Section titled “Example”](#example-6) ```ts USD ``` *** `null` ###### card\_id [Section titled “card\_id”](#card_id) > **card\_id**: `string` ###### Description [Section titled “Description”](#description-15) The ID of the card that is associated with the expense. ###### company\_id [Section titled “company\_id”](#company_id) > **company\_id**: `string` ###### Description [Section titled “Description”](#description-16) This is the `id` returned in the [Get Company](/openapi/team_api/#operation/getCompany) endpoint. You can use the `company_id` to determine which access token to use when you get the details from our API endpoints. ###### event\_type [Section titled “event\_type”](#event_type-1) > **event\_type**: `"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"` ###### expense\_id [Section titled “expense\_id”](#expense_id) > **expense\_id**: `string` ###### Description [Section titled “Description”](#description-17) Unique ID associated with the expense. ###### merchant [Section titled “merchant”](#merchant) > **merchant**: `object` ###### merchant.country [Section titled “merchant.country”](#merchantcountry) > **country**: `string` ###### Description [Section titled “Description”](#description-18) Merchant’s country, in ISO 3166-1 alpha-3 format. ###### merchant.mcc [Section titled “merchant.mcc”](#merchantmcc) > **mcc**: `string` ###### Description [Section titled “Description”](#description-19) A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to for more details. ###### merchant.raw\_descriptor [Section titled “merchant.raw\_descriptor”](#merchantraw_descriptor) > **raw\_descriptor**: `string` ###### Description [Section titled “Description”](#description-20) Merchant descriptor, it can be the merchant name. ###### original\_amount? [Section titled “original\_amount?”](#original_amount) > `optional` **original\_amount?**: { `amount`: `number`; `currency`: `string` | `null`; } | `null` ###### Union Members [Section titled “Union Members”](#union-members-2) ###### Type Literal [Section titled “Type Literal”](#type-literal-2) { `amount`: `number`; `currency`: `string` | `null`; } ###### amount [Section titled “amount”](#amount-3) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-21) 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 [Section titled “Example”](#example-7) ```ts 700 ``` ###### currency [Section titled “currency”](#currency-2) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-22) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-2) ```ts USD ``` ###### Example [Section titled “Example”](#example-8) ```ts USD ``` *** `null` ###### payment\_authorization\_code? [Section titled “payment\_authorization\_code?”](#payment_authorization_code) > `optional` **payment\_authorization\_code?**: `string` | `null` ###### Description [Section titled “Description”](#description-23) The authorization code of the associated card expense. ###### ~~payment\_description~~ [Section titled “payment\_description”](#payment_description) > **payment\_description**: `string` Deprecated This API is no longer supported and may be removed in a future release. ###### Description [Section titled “Description”](#description-24) Succeeded by the merchant::raw\_descriptor field. ###### payment\_status [Section titled “payment\_status”](#payment_status) > **payment\_status**: `"DECLINED"` | `"PENDING"` ###### payment\_status\_reason [Section titled “payment\_status\_reason”](#payment_status_reason) > **payment\_status\_reason**: `"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"` ###### payment\_type [Section titled “payment\_type”](#payment_type) > **payment\_type**: `"DECLINED"` | `"PURCHASE"` | `"REFUND"` | `"WITHDRAWAL"` ###### purchased\_at? [Section titled “purchased\_at?”](#purchased_at) > `optional` **purchased\_at?**: `string` | `null` Format: date-time ###### Description [Section titled “Description”](#description-25) The time the purchase was made. ###### version [Section titled “version”](#version) > **version**: `number` Format: int32 ###### Description [Section titled “Description”](#description-26) Version of this expense. This value starts at 1 and is incremented by 1 with every update. ###### Example [Section titled “Example”](#example-9) ```ts 1 ``` ##### Description [Section titled “Description”](#description-27) The webhook will be sent when an expense payment changes status. Subscription must be registered with a user with the CARD\_ADMIN role. #### Merchant [Section titled “Merchant”](#merchant-1) > **Merchant**: `object` ##### Merchant.country [Section titled “Merchant.country”](#merchantcountry-1) > **country**: `string` ###### Description [Section titled “Description”](#description-28) Merchant’s country, in ISO 3166-1 alpha-3 format. ##### Merchant.mcc [Section titled “Merchant.mcc”](#merchantmcc-1) > **mcc**: `string` ###### Description [Section titled “Description”](#description-29) A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to for more details. ##### Merchant.raw\_descriptor [Section titled “Merchant.raw\_descriptor”](#merchantraw_descriptor-1) > **raw\_descriptor**: `string` ###### Description [Section titled “Description”](#description-30) Merchant descriptor, it can be the merchant name. #### Money [Section titled “Money”](#money) > **Money**: `object` ##### Description [Section titled “Description”](#description-31) Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700. ##### Money.amount [Section titled “Money.amount”](#moneyamount) > **amount**: `number` Format: int64 ###### Description [Section titled “Description”](#description-32) 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 [Section titled “Example”](#example-10) ```ts 700 ``` ##### Money.currency [Section titled “Money.currency”](#moneycurrency) > **currency**: `string` | `null` ###### Description [Section titled “Description”](#description-33) The type of currency, in ISO 4217 format. ###### Default [Section titled “Default”](#default-3) ```ts USD ``` ###### Example [Section titled “Example”](#example-11) ```ts USD ``` #### Page\_WebhookGroup\_ [Section titled “Page\_WebhookGroup\_”](#page_webhookgroup_) > **Page\_WebhookGroup\_**: `object` ##### Page\_WebhookGroup\_.items [Section titled “Page\_WebhookGroup\_.items”](#page_webhookgroup_items) > **items**: `object`\[] ##### Page\_WebhookGroup\_.next\_cursor? [Section titled “Page\_WebhookGroup\_.next\_cursor?”](#page_webhookgroup_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_WebhookGroupMember\_ [Section titled “Page\_WebhookGroupMember\_”](#page_webhookgroupmember_) > **Page\_WebhookGroupMember\_**: `object` ##### Page\_WebhookGroupMember\_.items [Section titled “Page\_WebhookGroupMember\_.items”](#page_webhookgroupmember_items) > **items**: `object`\[] ##### Page\_WebhookGroupMember\_.next\_cursor? [Section titled “Page\_WebhookGroupMember\_.next\_cursor?”](#page_webhookgroupmember_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### Page\_WebhookSubscription\_ [Section titled “Page\_WebhookSubscription\_”](#page_webhooksubscription_) > **Page\_WebhookSubscription\_**: `object` ##### Page\_WebhookSubscription\_.items [Section titled “Page\_WebhookSubscription\_.items”](#page_webhooksubscription_items) > **items**: `object`\[] ##### Page\_WebhookSubscription\_.next\_cursor? [Section titled “Page\_WebhookSubscription\_.next\_cursor?”](#page_webhooksubscription_next_cursor) > `optional` **next\_cursor?**: `string` | `null` #### PaymentStatusReason [Section titled “PaymentStatusReason”](#paymentstatusreason) > **PaymentStatusReason**: `"APPROVED"` | `"OTHER"` | `"EXCEEDED_BUDGET_LIMIT"` | `"BUDGET_EXPIRED"` | `"NO_BUDGET"` | `"BUDGET_NOT_YET_STARTED"` | `"BUDGET_CATEGORY_RESTRICTION"` | `"BUDGET_MERCHANT_RESTRICTION"` | `"SUSPECTED_FRAUD"` | `"EXCEEDED_GLOBAL_LIMIT"` | `"EXCEEDED_USER_LIMIT"` | `"EXCEEDED_CARD_LIMIT"` | `"INVALID_EXPIRATION_DATE"` | `"CARD_NOT_ACTIVE"` | `"INVALID_CARD_CREDENTIALS"` | `"INVALID_BILLING_ADDRESS"` | `"CARD_SUSPENDED"` | `"CARD_TERMINATED"` | `"CARD_EXPIRED"` | `"MCC_BLOCKED"` | `"USER_SUSPENDED"` | `"INVALID_PIN"` | `"INVALID_CVV"` | `"EXCEEDED_PIN_ATTEMPTS"` | `"INSIDE_SANCTIONED_COUNTRY"` | `"SOFT_EXPIRATION"` | `"TRANSFERRED_CARD_NEW_MERCHANT"` | `"EXCEEDED_ANCESTOR_BUDGET_LIMIT"` | `"EXCEEDED_BUDGET_TRANSACTION_LIMIT"` | `"TOS_BLOCKED"` | `"COMPLIANCE_BLOCKED"` ##### Description [Section titled “Description”](#description-34) The reason for the payment’s status. #### PaymentType [Section titled “PaymentType”](#paymenttype) > **PaymentType**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"` | `"ACH_RETURN"` | `"WIRE_RETURN"` | `"CHEQUE_RETURN"` ##### Description [Section titled “Description”](#description-35) Only ACH, DOMESTIC\_WIRE, CHEQUE, INTERNATIONAL\_WIRE, BOOK\_TRANSFER, and STABLECOIN details can be retrieved from the Payments API. #### ProductApplication [Section titled “ProductApplication”](#productapplication) > **ProductApplication**: `object` ##### Description [Section titled “Description”](#description-36) The product application details for the referral. ##### ProductApplication.cash [Section titled “ProductApplication.cash”](#productapplicationcash) > **cash**: `"ACTIVE"` | `"PROCESSING"` | `"REJECTED"` | `"NO_ACCOUNT"` | `"NOT_SUBMITTED"` | `"INFORMATION_PENDING"` | `"MANUAL_REVIEW"` | `"CLOSED"` #### ReferralActivated [Section titled “ReferralActivated”](#referralactivated) > **ReferralActivated**: `object` & `Record`<`string`, `never`> ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-2) ###### event\_type [Section titled “event\_type”](#event_type-2) > **event\_type**: `"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"` ###### referral\_id [Section titled “referral\_id”](#referral_id) > **referral\_id**: `string` ###### Description [Section titled “Description”](#description-37) The referral ID ##### Description [Section titled “Description”](#description-38) The webhook will be sent when a user signs up with the referral link. #### ReferralApplicationStatusChanged [Section titled “ReferralApplicationStatusChanged”](#referralapplicationstatuschanged) > **ReferralApplicationStatusChanged**: `object` & `Record`<`string`, `never`> ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-3) ###### application [Section titled “application”](#application) > **application**: `object` ###### application.cash [Section titled “application.cash”](#applicationcash) > **cash**: `"ACTIVE"` | `"PROCESSING"` | `"REJECTED"` | `"NO_ACCOUNT"` | `"NOT_SUBMITTED"` | `"INFORMATION_PENDING"` | `"MANUAL_REVIEW"` | `"CLOSED"` ###### event\_type [Section titled “event\_type”](#event_type-3) > **event\_type**: `"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"` ###### referral\_id [Section titled “referral\_id”](#referral_id-1) > **referral\_id**: `string` ###### Description [Section titled “Description”](#description-39) The referral ID ##### Description [Section titled “Description”](#description-40) The webhook will be sent when the application status is changed. #### ReferralCreated [Section titled “ReferralCreated”](#referralcreated) > **ReferralCreated**: `object` & `Record`<`string`, `never`> ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-4) ###### event\_type [Section titled “event\_type”](#event_type-4) > **event\_type**: `"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"` ###### referral\_id [Section titled “referral\_id”](#referral_id-2) > **referral\_id**: `string` ###### Description [Section titled “Description”](#description-41) The referral ID ##### Description [Section titled “Description”](#description-42) The webhook will be sent when a referral is created. #### RemoveWebhookGroupMembersRequest [Section titled “RemoveWebhookGroupMembersRequest”](#removewebhookgroupmembersrequest) > **RemoveWebhookGroupMembersRequest**: `object` ##### RemoveWebhookGroupMembersRequest.members [Section titled “RemoveWebhookGroupMembersRequest.members”](#removewebhookgroupmembersrequestmembers) > **members**: `object`\[] ###### Description [Section titled “Description”](#description-43) The list of webhook group members to remove from the group. #### TransferFailed [Section titled “TransferFailed”](#transferfailed) > **TransferFailed**: `object` & `Record`<`string`, `never`> ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-5) ###### company\_id [Section titled “company\_id”](#company_id-1) > **company\_id**: `string` ###### Description [Section titled “Description”](#description-44) This is the `id` returned in the [Get Company](/openapi/team_api/#operation/getCompany) endpoint. You can use the `company_id` to determine which access token to use when you get the details from our API endpoints. ###### event\_type [Section titled “event\_type”](#event_type-5) > **event\_type**: `"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"` ###### payment\_type [Section titled “payment\_type”](#payment_type-1) > **payment\_type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"` | `"ACH_RETURN"` | `"WIRE_RETURN"` | `"CHEQUE_RETURN"` ###### return\_for\_id? [Section titled “return\_for\_id?”](#return_for_id) > `optional` **return\_for\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-45) The original transaction ID that is returned when the payment type is ACH\_RETURN, WIRE\_RETURN and CHEQUE\_RETURN. ###### transfer\_id [Section titled “transfer\_id”](#transfer_id) > **transfer\_id**: `string` ###### Description [Section titled “Description”](#description-46) The transfer ID ##### Description [Section titled “Description”](#description-47) The webhook will be sent when a transfer failed. #### TransferProcessed [Section titled “TransferProcessed”](#transferprocessed) > **TransferProcessed**: `object` & `Record`<`string`, `never`> ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-6) ###### company\_id [Section titled “company\_id”](#company_id-2) > **company\_id**: `string` ###### Description [Section titled “Description”](#description-48) This is the `id` returned in the [Get Company](/openapi/team_api/#operation/getCompany) endpoint. You can use the `company_id` to determine which access token to use when you get the details from our API endpoints. ###### event\_type [Section titled “event\_type”](#event_type-6) > **event\_type**: `"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"` ###### payment\_type [Section titled “payment\_type”](#payment_type-2) > **payment\_type**: `"ACH"` | `"DOMESTIC_WIRE"` | `"CHEQUE"` | `"INTERNATIONAL_WIRE"` | `"BOOK_TRANSFER"` | `"STABLECOIN"` | `"ACH_RETURN"` | `"WIRE_RETURN"` | `"CHEQUE_RETURN"` ###### return\_for\_id? [Section titled “return\_for\_id?”](#return_for_id-1) > `optional` **return\_for\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-49) The original transaction ID that is returned when the payment type is ACH\_RETURN, WIRE\_RETURN and CHEQUE\_RETURN. ###### transfer\_id [Section titled “transfer\_id”](#transfer_id-1) > **transfer\_id**: `string` ###### Description [Section titled “Description”](#description-50) The transfer ID ##### Description [Section titled “Description”](#description-51) The webhook will be sent when a transfer is processed. #### UpdateWebhookSubscriptionRequest [Section titled “UpdateWebhookSubscriptionRequest”](#updatewebhooksubscriptionrequest) > **UpdateWebhookSubscriptionRequest**: `object` ##### UpdateWebhookSubscriptionRequest.event\_types [Section titled “UpdateWebhookSubscriptionRequest.event\_types”](#updatewebhooksubscriptionrequestevent_types) > **event\_types**: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[] ###### Description [Section titled “Description”](#description-52) A list of the webhook event types this subscription will listen to. ##### UpdateWebhookSubscriptionRequest.group\_id? [Section titled “UpdateWebhookSubscriptionRequest.group\_id?”](#updatewebhooksubscriptionrequestgroup_id) > `optional` **group\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-53) ID of the webhook group to which this subscription applies, if any. This is only available for partners. ###### Example [Section titled “Example”](#example-12) ```ts wg_123 ``` ##### UpdateWebhookSubscriptionRequest.status [Section titled “UpdateWebhookSubscriptionRequest.status”](#updatewebhooksubscriptionrequeststatus) > **status**: `"ACTIVE"` | `"INACTIVE"` ##### UpdateWebhookSubscriptionRequest.url [Section titled “UpdateWebhookSubscriptionRequest.url”](#updatewebhooksubscriptionrequesturl) > **url**: `string` ###### Description [Section titled “Description”](#description-54) The URL to which webhook events will be sent. Must be a valid HTTPS URL. ###### Example [Section titled “Example”](#example-13) ```ts https://example.com/webhook ``` #### UserAttributes [Section titled “UserAttributes”](#userattributes) > **UserAttributes**: `"STATUS"` | `"MANAGER_ID"` | `"DEPARTMENT_ID"` | `"LOCATION_ID"` #### UserUpdated [Section titled “UserUpdated”](#userupdated) > **UserUpdated**: `object` & `Record`<`string`, `never`> ##### Type Declaration [Section titled “Type Declaration”](#type-declaration-7) ###### company\_id [Section titled “company\_id”](#company_id-3) > **company\_id**: `string` ###### event\_type [Section titled “event\_type”](#event_type-7) > **event\_type**: `"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"` ###### updated\_attributes [Section titled “updated\_attributes”](#updated_attributes) > **updated\_attributes**: (`"STATUS"` | `"MANAGER_ID"` | `"DEPARTMENT_ID"` | `"LOCATION_ID"`)\[] ###### user\_id [Section titled “user\_id”](#user_id) > **user\_id**: `string` ##### Description [Section titled “Description”](#description-55) The webhook will be sent when a user is updated. #### WebhookEventType [Section titled “WebhookEventType”](#webhookeventtype) > **WebhookEventType**: `"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"` #### WebhookGroup [Section titled “WebhookGroup”](#webhookgroup) > **WebhookGroup**: `object` Webhook Group ##### Description [Section titled “Description”](#description-56) A webhook group, which can be used by webhook subscriptions to target only the webhook group members. When an event occurs and it belongs to a member of the group, the webhooks will be sent only to the subscriptions that are associated with the group. If there is no group associated with the event, then the webhook will be sent to all subscriptions that are not associated with any group. Webhook groups are only available for partners. ##### WebhookGroup.id [Section titled “WebhookGroup.id”](#webhookgroupid) > **id**: `string` ###### Description [Section titled “Description”](#description-57) The ID of the webhook group. ###### Example [Section titled “Example”](#example-14) ```ts wg_123 ``` ##### WebhookGroup.name [Section titled “WebhookGroup.name”](#webhookgroupname) > **name**: `string` ###### Description [Section titled “Description”](#description-58) The name for the webhook group. ###### Example [Section titled “Example”](#example-15) ```ts Some Webhook Group ``` #### WebhookGroupMember [Section titled “WebhookGroupMember”](#webhookgroupmember) > **WebhookGroupMember**: `object` Webhook Group Member ##### Description [Section titled “Description”](#description-59) A member of a webhook group. ##### WebhookGroupMember.group\_id [Section titled “WebhookGroupMember.group\_id”](#webhookgroupmembergroup_id) > **group\_id**: `string` ###### Description [Section titled “Description”](#description-60) The ID of the webhook group this member belongs to. ###### Example [Section titled “Example”](#example-16) ```ts wg_123 ``` ##### WebhookGroupMember.member\_id [Section titled “WebhookGroupMember.member\_id”](#webhookgroupmembermember_id) > **member\_id**: `string` ###### Description [Section titled “Description”](#description-61) The ID of the webhook group member. ###### Example [Section titled “Example”](#example-17) ```ts cuacc_123 ``` ##### WebhookGroupMember.member\_type [Section titled “WebhookGroupMember.member\_type”](#webhookgroupmembermember_type) > **member\_type**: `"ACCOUNT"` #### WebhookGroupMemberInput [Section titled “WebhookGroupMemberInput”](#webhookgroupmemberinput) > **WebhookGroupMemberInput**: `object` ##### WebhookGroupMemberInput.member\_id [Section titled “WebhookGroupMemberInput.member\_id”](#webhookgroupmemberinputmember_id) > **member\_id**: `string` ###### Description [Section titled “Description”](#description-62) The ID of the webhook group member. ##### WebhookGroupMemberInput.member\_type [Section titled “WebhookGroupMemberInput.member\_type”](#webhookgroupmemberinputmember_type) > **member\_type**: `"ACCOUNT"` #### WebhookGroupMemberType [Section titled “WebhookGroupMemberType”](#webhookgroupmembertype) > **WebhookGroupMemberType**: `"ACCOUNT"` ##### Description [Section titled “Description”](#description-63) The type of a webhook group member. #### WebhookSecret [Section titled “WebhookSecret”](#webhooksecret) > **WebhookSecret**: `object` Webhook Secret ##### Description [Section titled “Description”](#description-64) A webhook secret, which can be used to validate that incoming webhook messages were sent by Brex. ##### WebhookSecret.secret [Section titled “WebhookSecret.secret”](#webhooksecretsecret) > **secret**: `string` ###### Description [Section titled “Description”](#description-65) The payload of the secret to be used for webhook validation. ###### Example [Section titled “Example”](#example-18) ```ts whsec_123 ``` ##### WebhookSecret.status [Section titled “WebhookSecret.status”](#webhooksecretstatus) > **status**: `"ACTIVE"` | `"PENDING_REVOKE"` | `"REVOKED"` #### WebhookSecretStatus [Section titled “WebhookSecretStatus”](#webhooksecretstatus-1) > **WebhookSecretStatus**: `"ACTIVE"` | `"PENDING_REVOKE"` | `"REVOKED"` ##### Description [Section titled “Description”](#description-66) The status of a webhook secret. #### WebhookSubscription [Section titled “WebhookSubscription”](#webhooksubscription) > **WebhookSubscription**: `object` Webhook Subscription ##### Description [Section titled “Description”](#description-67) A webhook subscription. When events of the specified event types occur, they will be sent to the given URL. If the subscription applies to a webhook group, then only events that apply to the members of that group will be sent. If it does not apply to any group, then only events that don’t apply to any specific group will be sent. Webhook groups are only available for partners. ##### WebhookSubscription.event\_types [Section titled “WebhookSubscription.event\_types”](#webhooksubscriptionevent_types) > **event\_types**: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[] ###### Description [Section titled “Description”](#description-68) List of event types that this webhook subscription listens to. ###### Example [Section titled “Example”](#example-19) ```ts ["EXPENSE_PAYMENT_UPDATED"] ``` ##### WebhookSubscription.group\_id? [Section titled “WebhookSubscription.group\_id?”](#webhooksubscriptiongroup_id) > `optional` **group\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-69) ID of the webhook group to which this subscription applies, if any. ###### Example [Section titled “Example”](#example-20) ```ts wg_123 ``` ##### WebhookSubscription.id [Section titled “WebhookSubscription.id”](#webhooksubscriptionid) > **id**: `string` ###### Description [Section titled “Description”](#description-70) ID of the webhook subscription. ###### Example [Section titled “Example”](#example-21) ```ts wsub_123 ``` ##### WebhookSubscription.status [Section titled “WebhookSubscription.status”](#webhooksubscriptionstatus) > **status**: `"ACTIVE"` | `"INACTIVE"` ##### WebhookSubscription.url [Section titled “WebhookSubscription.url”](#webhooksubscriptionurl) > **url**: `string` ###### Description [Section titled “Description”](#description-71) The URL to which webhook events will be sent. Must be a valid HTTPS URL. ###### Example [Section titled “Example”](#example-22) ```ts https://example.com/webhook ``` #### WebhookSubscriptionStatus [Section titled “WebhookSubscriptionStatus”](#webhooksubscriptionstatus-1) > **WebhookSubscriptionStatus**: `"ACTIVE"` | `"INACTIVE"` ##### Description [Section titled “Description”](#description-72) The status of a webhook subscription. # WebhooksPaths Defined in: [src/webhooks/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L2) ## Properties [Section titled “Properties”](#properties) ### /v1/webhooks [Section titled “/v1/webhooks”](#v1webhooks) > **/v1/webhooks**: `object` Defined in: [src/webhooks/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L3) #### delete? [Section titled “delete?”](#delete) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get) > **get**: `object` List Webhooks ##### Description [Section titled “Description”](#description) List the webhooks you have registered ##### get.parameters [Section titled “get.parameters”](#getparameters) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor) > `optional` **cursor?**: `string` | `null` ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit) > `optional` **limit?**: `number` | `null` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-1) Success ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-2) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-1) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-3) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-2) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-4) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-3) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500) > **500**: `object` ###### Description [Section titled “Description”](#description-5) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-4) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post) > **post**: `object` Register Webhook ##### Description [Section titled “Description”](#description-6) Register an endpoint to start receiving selected webhook events ##### post.parameters [Section titled “post.parameters”](#postparameters) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie) > `optional` **cookie?**: `undefined` ##### post.parameters.header [Section titled “post.parameters.header”](#postparametersheader) > **header**: `object` ##### post.parameters.header.Idempotency-Key [Section titled “post.parameters.header.Idempotency-Key”](#postparametersheaderidempotency-key) > **Idempotency-Key**: `string` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson) > **application/json**: `object` ##### post.requestBody.content.application/json.event\_types [Section titled “post.requestBody.content.application/json.event\_types”](#postrequestbodycontentapplicationjsonevent_types) > **event\_types**: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[] ###### Description [Section titled “Description”](#description-7) A list of the webhook event types this subscription will listen to. ##### post.requestBody.content.application/json.group\_id? [Section titled “post.requestBody.content.application/json.group\_id?”](#postrequestbodycontentapplicationjsongroup_id) > `optional` **group\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-8) ID of the webhook group to which this subscription applies, if any. This is only available for partners. ###### Example [Section titled “Example”](#example) ```ts wg_123 ``` ##### post.requestBody.content.application/json.url [Section titled “post.requestBody.content.application/json.url”](#postrequestbodycontentapplicationjsonurl) > **url**: `string` ###### Description [Section titled “Description”](#description-9) The URL to which webhook events will be sent. Must be a valid HTTPS URL. ###### Example [Section titled “Example”](#example-1) ```ts https://example.com/webhook ``` ##### post.responses [Section titled “post.responses”](#postresponses) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-10) Success ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson) > **application/json**: `object` ##### post.responses.200.content.application/json.event\_types [Section titled “post.responses.200.content.application/json.event\_types”](#postresponses200contentapplicationjsonevent_types) > **event\_types**: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[] ###### Description [Section titled “Description”](#description-11) List of event types that this webhook subscription listens to. ###### Example [Section titled “Example”](#example-2) ```ts ["EXPENSE_PAYMENT_UPDATED"] ``` ##### post.responses.200.content.application/json.group\_id? [Section titled “post.responses.200.content.application/json.group\_id?”](#postresponses200contentapplicationjsongroup_id) > `optional` **group\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-12) ID of the webhook group to which this subscription applies, if any. ###### Example [Section titled “Example”](#example-3) ```ts wg_123 ``` ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-13) ID of the webhook subscription. ###### Example [Section titled “Example”](#example-4) ```ts wsub_123 ``` ##### post.responses.200.content.application/json.status [Section titled “post.responses.200.content.application/json.status”](#postresponses200contentapplicationjsonstatus) > **status**: `"ACTIVE"` | `"INACTIVE"` ##### post.responses.200.content.application/json.url [Section titled “post.responses.200.content.application/json.url”](#postresponses200contentapplicationjsonurl) > **url**: `string` ###### Description [Section titled “Description”](#description-14) The URL to which webhook events will be sent. Must be a valid HTTPS URL. ###### Example [Section titled “Example”](#example-5) ```ts https://example.com/webhook ``` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-5) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-15) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-6) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-16) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-7) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-17) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-8) \[`name`: `string`]: `unknown` ##### post.responses.500 [Section titled “post.responses.500”](#postresponses500) > **500**: `object` ###### Description [Section titled “Description”](#description-18) Internal server error ##### post.responses.500.content? [Section titled “post.responses.500.content?”](#postresponses500content) > `optional` **content?**: `undefined` ##### post.responses.500.headers [Section titled “post.responses.500.headers”](#postresponses500headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-9) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace) > `optional` **trace?**: `undefined` *** ### /v1/webhooks/{id} [Section titled “/v1/webhooks/{id}”](#v1webhooksid) > **/v1/webhooks/{id}**: `object` Defined in: [src/webhooks/types.gen.ts:27](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L27) #### delete [Section titled “delete”](#delete-1) > **delete**: `object` Unregister Webhook ##### Description [Section titled “Description”](#description-19) Unregister a webhook if you want to stop receiving webhook events ##### delete.parameters [Section titled “delete.parameters”](#deleteparameters) > **parameters**: `object` ##### delete.parameters.cookie? [Section titled “delete.parameters.cookie?”](#deleteparameterscookie) > `optional` **cookie?**: `undefined` ##### delete.parameters.header? [Section titled “delete.parameters.header?”](#deleteparametersheader) > `optional` **header?**: `undefined` ##### delete.parameters.path [Section titled “delete.parameters.path”](#deleteparameterspath) > **path**: `object` ##### delete.parameters.path.id [Section titled “delete.parameters.path.id”](#deleteparameterspathid) > **id**: `string` ##### delete.parameters.query? [Section titled “delete.parameters.query?”](#deleteparametersquery) > `optional` **query?**: `undefined` ##### delete.requestBody? [Section titled “delete.requestBody?”](#deleterequestbody) > `optional` **requestBody?**: `undefined` ##### delete.responses [Section titled “delete.responses”](#deleteresponses) > **responses**: `object` ##### delete.responses.200 [Section titled “delete.responses.200”](#deleteresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-20) Success ##### delete.responses.200.content? [Section titled “delete.responses.200.content?”](#deleteresponses200content) > `optional` **content?**: `undefined` ##### delete.responses.200.headers [Section titled “delete.responses.200.headers”](#deleteresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-10) \[`name`: `string`]: `unknown` ##### delete.responses.400 [Section titled “delete.responses.400”](#deleteresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-21) Bad request ##### delete.responses.400.content? [Section titled “delete.responses.400.content?”](#deleteresponses400content) > `optional` **content?**: `undefined` ##### delete.responses.400.headers [Section titled “delete.responses.400.headers”](#deleteresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-11) \[`name`: `string`]: `unknown` ##### delete.responses.401 [Section titled “delete.responses.401”](#deleteresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-22) Unauthorized ##### delete.responses.401.content? [Section titled “delete.responses.401.content?”](#deleteresponses401content) > `optional` **content?**: `undefined` ##### delete.responses.401.headers [Section titled “delete.responses.401.headers”](#deleteresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-12) \[`name`: `string`]: `unknown` ##### delete.responses.403 [Section titled “delete.responses.403”](#deleteresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-23) Forbidden ##### delete.responses.403.content? [Section titled “delete.responses.403.content?”](#deleteresponses403content) > `optional` **content?**: `undefined` ##### delete.responses.403.headers [Section titled “delete.responses.403.headers”](#deleteresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-13) \[`name`: `string`]: `unknown` ##### delete.responses.500 [Section titled “delete.responses.500”](#deleteresponses500) > **500**: `object` ###### Description [Section titled “Description”](#description-24) Internal server error ##### delete.responses.500.content? [Section titled “delete.responses.500.content?”](#deleteresponses500content) > `optional` **content?**: `undefined` ##### delete.responses.500.headers [Section titled “delete.responses.500.headers”](#deleteresponses500headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-14) \[`name`: `string`]: `unknown` #### get [Section titled “get”](#get-1) > **get**: `object` Get Webhook ##### Description [Section titled “Description”](#description-25) Get details of a webhook ##### get.parameters [Section titled “get.parameters”](#getparameters-1) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-1) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-1) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-1) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid) > **id**: `string` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-1) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-1) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-1) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-26) Success ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-1) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-1) > **application/json**: `object` ##### get.responses.200.content.application/json.event\_types [Section titled “get.responses.200.content.application/json.event\_types”](#getresponses200contentapplicationjsonevent_types) > **event\_types**: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[] ###### Description [Section titled “Description”](#description-27) List of event types that this webhook subscription listens to. ###### Example [Section titled “Example”](#example-6) ```ts ["EXPENSE_PAYMENT_UPDATED"] ``` ##### get.responses.200.content.application/json.group\_id? [Section titled “get.responses.200.content.application/json.group\_id?”](#getresponses200contentapplicationjsongroup_id) > `optional` **group\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-28) ID of the webhook group to which this subscription applies, if any. ###### Example [Section titled “Example”](#example-7) ```ts wg_123 ``` ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-29) ID of the webhook subscription. ###### Example [Section titled “Example”](#example-8) ```ts wsub_123 ``` ##### get.responses.200.content.application/json.status [Section titled “get.responses.200.content.application/json.status”](#getresponses200contentapplicationjsonstatus) > **status**: `"ACTIVE"` | `"INACTIVE"` ##### get.responses.200.content.application/json.url [Section titled “get.responses.200.content.application/json.url”](#getresponses200contentapplicationjsonurl) > **url**: `string` ###### Description [Section titled “Description”](#description-30) The URL to which webhook events will be sent. Must be a valid HTTPS URL. ###### Example [Section titled “Example”](#example-9) ```ts https://example.com/webhook ``` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-15) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-31) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-1) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-16) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-32) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-1) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-17) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-33) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-1) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-18) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-1) > **500**: `object` ###### Description [Section titled “Description”](#description-34) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-1) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-19) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-1) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-1) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-1) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-1) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-1) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-1) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-1) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-1) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-1) > `optional` **post?**: `undefined` #### put [Section titled “put”](#put-1) > **put**: `object` Update Webhook ##### Description [Section titled “Description”](#description-35) Update a webhook. You can update the endpoint url, event types that the endpoint receives, or temporarily deactivate the webhook. ##### put.parameters [Section titled “put.parameters”](#putparameters) > **parameters**: `object` ##### put.parameters.cookie? [Section titled “put.parameters.cookie?”](#putparameterscookie) > `optional` **cookie?**: `undefined` ##### put.parameters.header? [Section titled “put.parameters.header?”](#putparametersheader) > `optional` **header?**: `undefined` ##### put.parameters.path [Section titled “put.parameters.path”](#putparameterspath) > **path**: `object` ##### put.parameters.path.id [Section titled “put.parameters.path.id”](#putparameterspathid) > **id**: `string` ##### put.parameters.query? [Section titled “put.parameters.query?”](#putparametersquery) > `optional` **query?**: `undefined` ##### put.requestBody [Section titled “put.requestBody”](#putrequestbody) > **requestBody**: `object` ##### put.requestBody.content [Section titled “put.requestBody.content”](#putrequestbodycontent) > **content**: `object` ##### put.requestBody.content.application/json [Section titled “put.requestBody.content.application/json”](#putrequestbodycontentapplicationjson) > **application/json**: `object` ##### put.requestBody.content.application/json.event\_types [Section titled “put.requestBody.content.application/json.event\_types”](#putrequestbodycontentapplicationjsonevent_types) > **event\_types**: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[] ###### Description [Section titled “Description”](#description-36) A list of the webhook event types this subscription will listen to. ##### put.requestBody.content.application/json.group\_id? [Section titled “put.requestBody.content.application/json.group\_id?”](#putrequestbodycontentapplicationjsongroup_id) > `optional` **group\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-37) ID of the webhook group to which this subscription applies, if any. This is only available for partners. ###### Example [Section titled “Example”](#example-10) ```ts wg_123 ``` ##### put.requestBody.content.application/json.status [Section titled “put.requestBody.content.application/json.status”](#putrequestbodycontentapplicationjsonstatus) > **status**: `"ACTIVE"` | `"INACTIVE"` ##### put.requestBody.content.application/json.url [Section titled “put.requestBody.content.application/json.url”](#putrequestbodycontentapplicationjsonurl) > **url**: `string` ###### Description [Section titled “Description”](#description-38) The URL to which webhook events will be sent. Must be a valid HTTPS URL. ###### Example [Section titled “Example”](#example-11) ```ts https://example.com/webhook ``` ##### put.responses [Section titled “put.responses”](#putresponses) > **responses**: `object` ##### put.responses.200 [Section titled “put.responses.200”](#putresponses200) > **200**: `object` ###### Description [Section titled “Description”](#description-39) Success ##### put.responses.200.content [Section titled “put.responses.200.content”](#putresponses200content) > **content**: `object` ##### put.responses.200.content.application/json [Section titled “put.responses.200.content.application/json”](#putresponses200contentapplicationjson) > **application/json**: `object` ##### put.responses.200.content.application/json.event\_types [Section titled “put.responses.200.content.application/json.event\_types”](#putresponses200contentapplicationjsonevent_types) > **event\_types**: (`"REFERRAL_CREATED"` | `"REFERRAL_ACTIVATED"` | `"REFERRAL_APPLICATION_STATUS_CHANGED"` | `"TRANSFER_PROCESSED"` | `"TRANSFER_FAILED"` | `"EXPENSE_PAYMENT_UPDATED"` | `"USER_UPDATED"` | `"EMBEDDED_CARD_TRANSACTION_UPDATED"` | `"EMBEDDED_CARD_UPDATED"` | `"EMBEDDED_ACCOUNT_UPDATED"` | `"EMBEDDED_CARD_SHIPPING_UPDATED"` | `"EMBEDDED_DISPUTE_UPDATED"` | `"PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED"` | `"EMBEDDED_CARD_AUTHORIZATION"` | `"EMBEDDED_FRAUD_ALERT"` | `"EMBEDDED_BILLING_GROUP_UPDATED"` | `"EMBEDDED_LEGAL_ENTITY_UPDATED"` | `"EMBEDDED_BILLING_STATEMENT_UPDATED"` | `"EMBEDDED_USER_STATUS_UPDATED"` | `"ACCOUNTING_RECORD_READY_FOR_EXPORT"`)\[] ###### Description [Section titled “Description”](#description-40) List of event types that this webhook subscription listens to. ###### Example [Section titled “Example”](#example-12) ```ts ["EXPENSE_PAYMENT_UPDATED"] ``` ##### put.responses.200.content.application/json.group\_id? [Section titled “put.responses.200.content.application/json.group\_id?”](#putresponses200contentapplicationjsongroup_id) > `optional` **group\_id?**: `string` | `null` ###### Description [Section titled “Description”](#description-41) ID of the webhook group to which this subscription applies, if any. ###### Example [Section titled “Example”](#example-13) ```ts wg_123 ``` ##### put.responses.200.content.application/json.id [Section titled “put.responses.200.content.application/json.id”](#putresponses200contentapplicationjsonid) > **id**: `string` ###### Description [Section titled “Description”](#description-42) ID of the webhook subscription. ###### Example [Section titled “Example”](#example-14) ```ts wsub_123 ``` ##### put.responses.200.content.application/json.status [Section titled “put.responses.200.content.application/json.status”](#putresponses200contentapplicationjsonstatus) > **status**: `"ACTIVE"` | `"INACTIVE"` ##### put.responses.200.content.application/json.url [Section titled “put.responses.200.content.application/json.url”](#putresponses200contentapplicationjsonurl) > **url**: `string` ###### Description [Section titled “Description”](#description-43) The URL to which webhook events will be sent. Must be a valid HTTPS URL. ###### Example [Section titled “Example”](#example-15) ```ts https://example.com/webhook ``` ##### put.responses.200.headers [Section titled “put.responses.200.headers”](#putresponses200headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-20) \[`name`: `string`]: `unknown` ##### put.responses.400 [Section titled “put.responses.400”](#putresponses400) > **400**: `object` ###### Description [Section titled “Description”](#description-44) Bad request ##### put.responses.400.content? [Section titled “put.responses.400.content?”](#putresponses400content) > `optional` **content?**: `undefined` ##### put.responses.400.headers [Section titled “put.responses.400.headers”](#putresponses400headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-21) \[`name`: `string`]: `unknown` ##### put.responses.401 [Section titled “put.responses.401”](#putresponses401) > **401**: `object` ###### Description [Section titled “Description”](#description-45) Unauthorized ##### put.responses.401.content? [Section titled “put.responses.401.content?”](#putresponses401content) > `optional` **content?**: `undefined` ##### put.responses.401.headers [Section titled “put.responses.401.headers”](#putresponses401headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-22) \[`name`: `string`]: `unknown` ##### put.responses.403 [Section titled “put.responses.403”](#putresponses403) > **403**: `object` ###### Description [Section titled “Description”](#description-46) Forbidden ##### put.responses.403.content? [Section titled “put.responses.403.content?”](#putresponses403content) > `optional` **content?**: `undefined` ##### put.responses.403.headers [Section titled “put.responses.403.headers”](#putresponses403headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-23) \[`name`: `string`]: `unknown` ##### put.responses.500 [Section titled “put.responses.500”](#putresponses500) > **500**: `object` ###### Description [Section titled “Description”](#description-47) Internal server error ##### put.responses.500.content? [Section titled “put.responses.500.content?”](#putresponses500content) > `optional` **content?**: `undefined` ##### put.responses.500.headers [Section titled “put.responses.500.headers”](#putresponses500headers) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-24) \[`name`: `string`]: `unknown` #### trace? [Section titled “trace?”](#trace-1) > `optional` **trace?**: `undefined` *** ### /v1/webhooks/groups [Section titled “/v1/webhooks/groups”](#v1webhooksgroups) > **/v1/webhooks/groups**: `object` Defined in: [src/webhooks/types.gen.ts:56](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L56) #### delete? [Section titled “delete?”](#delete-2) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-2) > **get**: `object` List Webhook Groups ##### Description [Section titled “Description”](#description-48) Lists webhook groups. ##### get.parameters [Section titled “get.parameters”](#getparameters-2) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-2) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-2) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-2) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-2) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-1) > `optional` **cursor?**: `string` | `null` ###### Description [Section titled “Description”](#description-49) Cursor for pagination. ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-1) > `optional` **limit?**: `number` ###### Description [Section titled “Description”](#description-50) Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000. ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-2) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-2) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-51) Success ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-2) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-2) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-1) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-1) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-25) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-2) > **400**: `object` ###### Description [Section titled “Description”](#description-52) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-2) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-26) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-2) > **401**: `object` ###### Description [Section titled “Description”](#description-53) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-2) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-27) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-2) > **403**: `object` ###### Description [Section titled “Description”](#description-54) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-2) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-28) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-2) > **500**: `object` ###### Description [Section titled “Description”](#description-55) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-2) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-29) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-2) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-2) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-2) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-2) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-2) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-2) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-2) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-2) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-2) > **post**: `object` Create Webhook Group ##### Description [Section titled “Description”](#description-56) Creates a webhook group. ##### post.parameters [Section titled “post.parameters”](#postparameters-1) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-1) > `optional` **cookie?**: `undefined` ##### post.parameters.header [Section titled “post.parameters.header”](#postparametersheader-1) > **header**: `object` ##### post.parameters.header.Idempotency-Key [Section titled “post.parameters.header.Idempotency-Key”](#postparametersheaderidempotency-key-1) > **Idempotency-Key**: `string` ##### post.parameters.path? [Section titled “post.parameters.path?”](#postparameterspath-1) > `optional` **path?**: `undefined` ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-1) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-1) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-1) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-1) > **application/json**: `object` ##### post.requestBody.content.application/json.name [Section titled “post.requestBody.content.application/json.name”](#postrequestbodycontentapplicationjsonname) > **name**: `string` ###### Description [Section titled “Description”](#description-57) The name for the webhook group. ###### Example [Section titled “Example”](#example-16) ```ts Some Webhook Group ``` ##### post.responses [Section titled “post.responses”](#postresponses-1) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-58) Success ##### post.responses.200.content [Section titled “post.responses.200.content”](#postresponses200content-1) > **content**: `object` ##### post.responses.200.content.application/json [Section titled “post.responses.200.content.application/json”](#postresponses200contentapplicationjson-1) > **application/json**: `object` ##### post.responses.200.content.application/json.id [Section titled “post.responses.200.content.application/json.id”](#postresponses200contentapplicationjsonid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-59) The ID of the webhook group. ###### Example [Section titled “Example”](#example-17) ```ts wg_123 ``` ##### post.responses.200.content.application/json.name [Section titled “post.responses.200.content.application/json.name”](#postresponses200contentapplicationjsonname) > **name**: `string` ###### Description [Section titled “Description”](#description-60) The name for the webhook group. ###### Example [Section titled “Example”](#example-18) ```ts Some Webhook Group ``` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-30) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-61) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content-1) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-31) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-62) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content-1) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-32) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-63) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content-1) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-33) \[`name`: `string`]: `unknown` ##### post.responses.500 [Section titled “post.responses.500”](#postresponses500-1) > **500**: `object` ###### Description [Section titled “Description”](#description-64) Internal server error ##### post.responses.500.content? [Section titled “post.responses.500.content?”](#postresponses500content-1) > `optional` **content?**: `undefined` ##### post.responses.500.headers [Section titled “post.responses.500.headers”](#postresponses500headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-34) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-2) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-2) > `optional` **trace?**: `undefined` *** ### /v1/webhooks/groups/{id} [Section titled “/v1/webhooks/groups/{id}”](#v1webhooksgroupsid) > **/v1/webhooks/groups/{id}**: `object` Defined in: [src/webhooks/types.gen.ts:80](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L80) #### delete [Section titled “delete”](#delete-3) > **delete**: `object` Delete Webhook Group ##### Description [Section titled “Description”](#description-65) Deletes a webhook group and all its members. ##### delete.parameters [Section titled “delete.parameters”](#deleteparameters-1) > **parameters**: `object` ##### delete.parameters.cookie? [Section titled “delete.parameters.cookie?”](#deleteparameterscookie-1) > `optional` **cookie?**: `undefined` ##### delete.parameters.header? [Section titled “delete.parameters.header?”](#deleteparametersheader-1) > `optional` **header?**: `undefined` ##### delete.parameters.path [Section titled “delete.parameters.path”](#deleteparameterspath-1) > **path**: `object` ##### delete.parameters.path.id [Section titled “delete.parameters.path.id”](#deleteparameterspathid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-66) The ID of the webhook group to delete. ##### delete.parameters.query? [Section titled “delete.parameters.query?”](#deleteparametersquery-1) > `optional` **query?**: `undefined` ##### delete.requestBody? [Section titled “delete.requestBody?”](#deleterequestbody-1) > `optional` **requestBody?**: `undefined` ##### delete.responses [Section titled “delete.responses”](#deleteresponses-1) > **responses**: `object` ##### delete.responses.200 [Section titled “delete.responses.200”](#deleteresponses200-1) > **200**: `object` ###### Description [Section titled “Description”](#description-67) Success ##### delete.responses.200.content? [Section titled “delete.responses.200.content?”](#deleteresponses200content-1) > `optional` **content?**: `undefined` ##### delete.responses.200.headers [Section titled “delete.responses.200.headers”](#deleteresponses200headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-35) \[`name`: `string`]: `unknown` ##### delete.responses.400 [Section titled “delete.responses.400”](#deleteresponses400-1) > **400**: `object` ###### Description [Section titled “Description”](#description-68) Bad request ##### delete.responses.400.content? [Section titled “delete.responses.400.content?”](#deleteresponses400content-1) > `optional` **content?**: `undefined` ##### delete.responses.400.headers [Section titled “delete.responses.400.headers”](#deleteresponses400headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-36) \[`name`: `string`]: `unknown` ##### delete.responses.401 [Section titled “delete.responses.401”](#deleteresponses401-1) > **401**: `object` ###### Description [Section titled “Description”](#description-69) Unauthorized ##### delete.responses.401.content? [Section titled “delete.responses.401.content?”](#deleteresponses401content-1) > `optional` **content?**: `undefined` ##### delete.responses.401.headers [Section titled “delete.responses.401.headers”](#deleteresponses401headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-37) \[`name`: `string`]: `unknown` ##### delete.responses.403 [Section titled “delete.responses.403”](#deleteresponses403-1) > **403**: `object` ###### Description [Section titled “Description”](#description-70) Forbidden ##### delete.responses.403.content? [Section titled “delete.responses.403.content?”](#deleteresponses403content-1) > `optional` **content?**: `undefined` ##### delete.responses.403.headers [Section titled “delete.responses.403.headers”](#deleteresponses403headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-38) \[`name`: `string`]: `unknown` ##### delete.responses.500 [Section titled “delete.responses.500”](#deleteresponses500-1) > **500**: `object` ###### Description [Section titled “Description”](#description-71) Internal server error ##### delete.responses.500.content? [Section titled “delete.responses.500.content?”](#deleteresponses500content-1) > `optional` **content?**: `undefined` ##### delete.responses.500.headers [Section titled “delete.responses.500.headers”](#deleteresponses500headers-1) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-39) \[`name`: `string`]: `unknown` #### get [Section titled “get”](#get-3) > **get**: `object` Get Webhook Group ##### Description [Section titled “Description”](#description-72) Gets a webhook group. ##### get.parameters [Section titled “get.parameters”](#getparameters-3) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-3) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-3) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-3) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-73) The ID of the webhook group to retrieve. ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-3) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-3) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-3) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-3) > **200**: `object` ###### Description [Section titled “Description”](#description-74) Success ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-3) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-3) > **application/json**: `object` ##### get.responses.200.content.application/json.id [Section titled “get.responses.200.content.application/json.id”](#getresponses200contentapplicationjsonid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-75) The ID of the webhook group. ###### Example [Section titled “Example”](#example-19) ```ts wg_123 ``` ##### get.responses.200.content.application/json.name [Section titled “get.responses.200.content.application/json.name”](#getresponses200contentapplicationjsonname) > **name**: `string` ###### Description [Section titled “Description”](#description-76) The name for the webhook group. ###### Example [Section titled “Example”](#example-20) ```ts Some Webhook Group ``` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-40) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-3) > **400**: `object` ###### Description [Section titled “Description”](#description-77) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-3) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-41) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-3) > **401**: `object` ###### Description [Section titled “Description”](#description-78) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-3) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-42) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-3) > **403**: `object` ###### Description [Section titled “Description”](#description-79) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-3) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-43) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-3) > **500**: `object` ###### Description [Section titled “Description”](#description-80) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-3) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-44) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-3) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-3) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-3) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-3) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-3) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-3) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-3) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-3) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-3) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-3) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-3) > `optional` **trace?**: `undefined` *** ### /v1/webhooks/groups/{id}/add\_members [Section titled “/v1/webhooks/groups/{id}/add\_members”](#v1webhooksgroupsidadd_members) > **/v1/webhooks/groups/{id}/add\_members**: `object` Defined in: [src/webhooks/types.gen.ts:104](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L104) #### delete? [Section titled “delete?”](#delete-4) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-4) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-4) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-4) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-4) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-4) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-4) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-4) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-4) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-4) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-4) > **post**: `object` Add Webhook Group Members ##### Description [Section titled “Description”](#description-81) Adds members to webhook groups. ##### post.parameters [Section titled “post.parameters”](#postparameters-2) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-2) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-2) > `optional` **header?**: `undefined` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-2) > **path**: `object` ##### post.parameters.path.id [Section titled “post.parameters.path.id”](#postparameterspathid) > **id**: `string` ###### Description [Section titled “Description”](#description-82) The ID of the webhook group to add members to. ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-2) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-2) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-2) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-2) > **application/json**: `object` ##### post.requestBody.content.application/json.members [Section titled “post.requestBody.content.application/json.members”](#postrequestbodycontentapplicationjsonmembers) > **members**: `object`\[] ###### Description [Section titled “Description”](#description-83) The list of webhook group members to add to the group. ##### post.responses [Section titled “post.responses”](#postresponses-2) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-2) > **200**: `object` ###### Description [Section titled “Description”](#description-84) Success ##### post.responses.200.content? [Section titled “post.responses.200.content?”](#postresponses200content-2) > `optional` **content?**: `undefined` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-45) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400-2) > **400**: `object` ###### Description [Section titled “Description”](#description-85) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content-2) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-46) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-2) > **401**: `object` ###### Description [Section titled “Description”](#description-86) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content-2) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-47) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403-2) > **403**: `object` ###### Description [Section titled “Description”](#description-87) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content-2) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-48) \[`name`: `string`]: `unknown` ##### post.responses.500 [Section titled “post.responses.500”](#postresponses500-2) > **500**: `object` ###### Description [Section titled “Description”](#description-88) Internal server error ##### post.responses.500.content? [Section titled “post.responses.500.content?”](#postresponses500content-2) > `optional` **content?**: `undefined` ##### post.responses.500.headers [Section titled “post.responses.500.headers”](#postresponses500headers-2) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-49) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-4) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-4) > `optional` **trace?**: `undefined` *** ### /v1/webhooks/groups/{id}/members [Section titled “/v1/webhooks/groups/{id}/members”](#v1webhooksgroupsidmembers) > **/v1/webhooks/groups/{id}/members**: `object` Defined in: [src/webhooks/types.gen.ts:124](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L124) #### delete? [Section titled “delete?”](#delete-5) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-5) > **get**: `object` List Webhook Group Members ##### Description [Section titled “Description”](#description-89) Lists the members currently in the specified webhook group. ##### get.parameters [Section titled “get.parameters”](#getparameters-4) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-4) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-4) > `optional` **header?**: `undefined` ##### get.parameters.path [Section titled “get.parameters.path”](#getparameterspath-4) > **path**: `object` ##### get.parameters.path.id [Section titled “get.parameters.path.id”](#getparameterspathid-2) > **id**: `string` ###### Description [Section titled “Description”](#description-90) The ID of the webhook group to retrieve members for. ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-4) > `optional` **query?**: `object` ##### get.parameters.query.cursor? [Section titled “get.parameters.query.cursor?”](#getparametersquerycursor-2) > `optional` **cursor?**: `string` | `null` ###### Description [Section titled “Description”](#description-91) Cursor for pagination. ##### get.parameters.query.limit? [Section titled “get.parameters.query.limit?”](#getparametersquerylimit-2) > `optional` **limit?**: `number` ###### Description [Section titled “Description”](#description-92) Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000. ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-4) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-4) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-4) > **200**: `object` ###### Description [Section titled “Description”](#description-93) Success ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-4) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-4) > **application/json**: `object` ##### get.responses.200.content.application/json.items [Section titled “get.responses.200.content.application/json.items”](#getresponses200contentapplicationjsonitems-2) > **items**: `object`\[] ##### get.responses.200.content.application/json.next\_cursor? [Section titled “get.responses.200.content.application/json.next\_cursor?”](#getresponses200contentapplicationjsonnext_cursor-2) > `optional` **next\_cursor?**: `string` | `null` ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-50) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-4) > **400**: `object` ###### Description [Section titled “Description”](#description-94) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-4) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-51) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-4) > **401**: `object` ###### Description [Section titled “Description”](#description-95) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-4) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-52) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-4) > **403**: `object` ###### Description [Section titled “Description”](#description-96) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-4) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-53) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-4) > **500**: `object` ###### Description [Section titled “Description”](#description-97) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-4) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-4) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-54) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-5) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-5) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-5) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-5) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-5) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-5) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-5) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-5) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-5) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-5) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-5) > `optional` **trace?**: `undefined` *** ### /v1/webhooks/groups/{id}/remove\_members [Section titled “/v1/webhooks/groups/{id}/remove\_members”](#v1webhooksgroupsidremove_members) > **/v1/webhooks/groups/{id}/remove\_members**: `object` Defined in: [src/webhooks/types.gen.ts:144](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L144) #### delete? [Section titled “delete?”](#delete-6) > `optional` **delete?**: `undefined` #### get? [Section titled “get?”](#get-6) > `optional` **get?**: `undefined` #### head? [Section titled “head?”](#head-6) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-6) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-6) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-6) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-6) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-6) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-6) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-6) > `optional` **patch?**: `undefined` #### post [Section titled “post”](#post-6) > **post**: `object` Remove Webhook Group Members ##### Description [Section titled “Description”](#description-98) Removes members from webhook groups. ##### post.parameters [Section titled “post.parameters”](#postparameters-3) > **parameters**: `object` ##### post.parameters.cookie? [Section titled “post.parameters.cookie?”](#postparameterscookie-3) > `optional` **cookie?**: `undefined` ##### post.parameters.header? [Section titled “post.parameters.header?”](#postparametersheader-3) > `optional` **header?**: `undefined` ##### post.parameters.path [Section titled “post.parameters.path”](#postparameterspath-3) > **path**: `object` ##### post.parameters.path.id [Section titled “post.parameters.path.id”](#postparameterspathid-1) > **id**: `string` ###### Description [Section titled “Description”](#description-99) The ID of the webhook group to remove members from. ##### post.parameters.query? [Section titled “post.parameters.query?”](#postparametersquery-3) > `optional` **query?**: `undefined` ##### post.requestBody [Section titled “post.requestBody”](#postrequestbody-3) > **requestBody**: `object` ##### post.requestBody.content [Section titled “post.requestBody.content”](#postrequestbodycontent-3) > **content**: `object` ##### post.requestBody.content.application/json [Section titled “post.requestBody.content.application/json”](#postrequestbodycontentapplicationjson-3) > **application/json**: `object` ##### post.requestBody.content.application/json.members [Section titled “post.requestBody.content.application/json.members”](#postrequestbodycontentapplicationjsonmembers-1) > **members**: `object`\[] ###### Description [Section titled “Description”](#description-100) The list of webhook group members to remove from the group. ##### post.responses [Section titled “post.responses”](#postresponses-3) > **responses**: `object` ##### post.responses.200 [Section titled “post.responses.200”](#postresponses200-3) > **200**: `object` ###### Description [Section titled “Description”](#description-101) Success ##### post.responses.200.content? [Section titled “post.responses.200.content?”](#postresponses200content-3) > `optional` **content?**: `undefined` ##### post.responses.200.headers [Section titled “post.responses.200.headers”](#postresponses200headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-55) \[`name`: `string`]: `unknown` ##### post.responses.400 [Section titled “post.responses.400”](#postresponses400-3) > **400**: `object` ###### Description [Section titled “Description”](#description-102) Bad request ##### post.responses.400.content? [Section titled “post.responses.400.content?”](#postresponses400content-3) > `optional` **content?**: `undefined` ##### post.responses.400.headers [Section titled “post.responses.400.headers”](#postresponses400headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-56) \[`name`: `string`]: `unknown` ##### post.responses.401 [Section titled “post.responses.401”](#postresponses401-3) > **401**: `object` ###### Description [Section titled “Description”](#description-103) Unauthorized ##### post.responses.401.content? [Section titled “post.responses.401.content?”](#postresponses401content-3) > `optional` **content?**: `undefined` ##### post.responses.401.headers [Section titled “post.responses.401.headers”](#postresponses401headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-57) \[`name`: `string`]: `unknown` ##### post.responses.403 [Section titled “post.responses.403”](#postresponses403-3) > **403**: `object` ###### Description [Section titled “Description”](#description-104) Forbidden ##### post.responses.403.content? [Section titled “post.responses.403.content?”](#postresponses403content-3) > `optional` **content?**: `undefined` ##### post.responses.403.headers [Section titled “post.responses.403.headers”](#postresponses403headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-58) \[`name`: `string`]: `unknown` ##### post.responses.500 [Section titled “post.responses.500”](#postresponses500-3) > **500**: `object` ###### Description [Section titled “Description”](#description-105) Internal server error ##### post.responses.500.content? [Section titled “post.responses.500.content?”](#postresponses500content-3) > `optional` **content?**: `undefined` ##### post.responses.500.headers [Section titled “post.responses.500.headers”](#postresponses500headers-3) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-59) \[`name`: `string`]: `unknown` #### put? [Section titled “put?”](#put-6) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-6) > `optional` **trace?**: `undefined` *** ### /v1/webhooks/secrets [Section titled “/v1/webhooks/secrets”](#v1webhookssecrets) > **/v1/webhooks/secrets**: `object` Defined in: [src/webhooks/types.gen.ts:164](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L164) #### delete? [Section titled “delete?”](#delete-7) > `optional` **delete?**: `undefined` #### get [Section titled “get”](#get-7) > **get**: `object` List Webhook Secrets ##### Description [Section titled “Description”](#description-106) This endpoint returns a set of webhook signing secrets used to validate the webhook. Usually only one key will be returned in the response. After key rotation, this endpoint will return two keys: the new key, and the key that will be revoked soon. There will also be two signatures in the ‘Webhook-Signature’ request header. Your application should use all keys available to validate the webhook request. If validation passes for any of the keys returned, the webhook payload is valid. ##### get.parameters [Section titled “get.parameters”](#getparameters-5) > **parameters**: `object` ##### get.parameters.cookie? [Section titled “get.parameters.cookie?”](#getparameterscookie-5) > `optional` **cookie?**: `undefined` ##### get.parameters.header? [Section titled “get.parameters.header?”](#getparametersheader-5) > `optional` **header?**: `undefined` ##### get.parameters.path? [Section titled “get.parameters.path?”](#getparameterspath-5) > `optional` **path?**: `undefined` ##### get.parameters.query? [Section titled “get.parameters.query?”](#getparametersquery-5) > `optional` **query?**: `undefined` ##### get.requestBody? [Section titled “get.requestBody?”](#getrequestbody-5) > `optional` **requestBody?**: `undefined` ##### get.responses [Section titled “get.responses”](#getresponses-5) > **responses**: `object` ##### get.responses.200 [Section titled “get.responses.200”](#getresponses200-5) > **200**: `object` ###### Description [Section titled “Description”](#description-107) Success ##### get.responses.200.content [Section titled “get.responses.200.content”](#getresponses200content-5) > **content**: `object` ##### get.responses.200.content.application/json [Section titled “get.responses.200.content.application/json”](#getresponses200contentapplicationjson-5) > **application/json**: `object`\[] ##### get.responses.200.headers [Section titled “get.responses.200.headers”](#getresponses200headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-60) \[`name`: `string`]: `unknown` ##### get.responses.400 [Section titled “get.responses.400”](#getresponses400-5) > **400**: `object` ###### Description [Section titled “Description”](#description-108) Bad request ##### get.responses.400.content? [Section titled “get.responses.400.content?”](#getresponses400content-5) > `optional` **content?**: `undefined` ##### get.responses.400.headers [Section titled “get.responses.400.headers”](#getresponses400headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-61) \[`name`: `string`]: `unknown` ##### get.responses.401 [Section titled “get.responses.401”](#getresponses401-5) > **401**: `object` ###### Description [Section titled “Description”](#description-109) Unauthorized ##### get.responses.401.content? [Section titled “get.responses.401.content?”](#getresponses401content-5) > `optional` **content?**: `undefined` ##### get.responses.401.headers [Section titled “get.responses.401.headers”](#getresponses401headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-62) \[`name`: `string`]: `unknown` ##### get.responses.403 [Section titled “get.responses.403”](#getresponses403-5) > **403**: `object` ###### Description [Section titled “Description”](#description-110) Forbidden ##### get.responses.403.content? [Section titled “get.responses.403.content?”](#getresponses403content-5) > `optional` **content?**: `undefined` ##### get.responses.403.headers [Section titled “get.responses.403.headers”](#getresponses403headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-63) \[`name`: `string`]: `unknown` ##### get.responses.500 [Section titled “get.responses.500”](#getresponses500-5) > **500**: `object` ###### Description [Section titled “Description”](#description-111) Internal server error ##### get.responses.500.content? [Section titled “get.responses.500.content?”](#getresponses500content-5) > `optional` **content?**: `undefined` ##### get.responses.500.headers [Section titled “get.responses.500.headers”](#getresponses500headers-5) > **headers**: `object` ###### Index Signature [Section titled “Index Signature”](#index-signature-64) \[`name`: `string`]: `unknown` #### head? [Section titled “head?”](#head-7) > `optional` **head?**: `undefined` #### options? [Section titled “options?”](#options-7) > `optional` **options?**: `undefined` #### parameters [Section titled “parameters”](#parameters-7) > **parameters**: `object` ##### parameters.cookie? [Section titled “parameters.cookie?”](#parameterscookie-7) > `optional` **cookie?**: `undefined` ##### parameters.header? [Section titled “parameters.header?”](#parametersheader-7) > `optional` **header?**: `undefined` ##### parameters.path? [Section titled “parameters.path?”](#parameterspath-7) > `optional` **path?**: `undefined` ##### parameters.query? [Section titled “parameters.query?”](#parametersquery-7) > `optional` **query?**: `undefined` #### patch? [Section titled “patch?”](#patch-7) > `optional` **patch?**: `undefined` #### post? [Section titled “post?”](#post-7) > `optional` **post?**: `undefined` #### put? [Section titled “put?”](#put-7) > `optional` **put?**: `undefined` #### trace? [Section titled “trace?”](#trace-7) > `optional` **trace?**: `undefined` # AccountingRecordReadyForExport > **AccountingRecordReadyForExport** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"AccountingRecordReadyForExport"`] Defined in: [src/webhooks/schemas.gen.ts:5](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L5) # AddWebhookGroupMembersRequest > **AddWebhookGroupMembersRequest** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"AddWebhookGroupMembersRequest"`] Defined in: [src/webhooks/schemas.gen.ts:7](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L7) # ApplicationStatus > **ApplicationStatus** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"ApplicationStatus"`] Defined in: [src/webhooks/schemas.gen.ts:8](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L8) # CreateWebhookGroupRequest > **CreateWebhookGroupRequest** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"CreateWebhookGroupRequest"`] Defined in: [src/webhooks/schemas.gen.ts:9](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L9) # CreateWebhookSubscriptionRequest > **CreateWebhookSubscriptionRequest** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"CreateWebhookSubscriptionRequest"`] Defined in: [src/webhooks/schemas.gen.ts:10](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L10) # EventWrapper > **EventWrapper** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"EventWrapper"`] Defined in: [src/webhooks/schemas.gen.ts:12](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L12) # ExpensePaymentStatus > **ExpensePaymentStatus** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"ExpensePaymentStatus"`] Defined in: [src/webhooks/schemas.gen.ts:13](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L13) # ExpensePaymentType > **ExpensePaymentType** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"ExpensePaymentType"`] Defined in: [src/webhooks/schemas.gen.ts:14](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L14) # ExpensePaymentUpdated > **ExpensePaymentUpdated** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"ExpensePaymentUpdated"`] Defined in: [src/webhooks/schemas.gen.ts:15](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L15) # Merchant > **Merchant** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"Merchant"`] Defined in: [src/webhooks/schemas.gen.ts:16](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L16) # Money > **Money** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"Money"`] Defined in: [src/webhooks/schemas.gen.ts:17](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L17) # Page_WebhookGroup_ > **Page\_WebhookGroup\_** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"Page_WebhookGroup_"`] Defined in: [src/webhooks/schemas.gen.ts:19](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L19) # Page_WebhookGroupMember_ > **Page\_WebhookGroupMember\_** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"Page_WebhookGroupMember_"`] Defined in: [src/webhooks/schemas.gen.ts:18](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L18) # Page_WebhookSubscription_ > **Page\_WebhookSubscription\_** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"Page_WebhookSubscription_"`] Defined in: [src/webhooks/schemas.gen.ts:20](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L20) # PaymentStatusReason > **PaymentStatusReason** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"PaymentStatusReason"`] Defined in: [src/webhooks/schemas.gen.ts:21](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L21) # PaymentType > **PaymentType** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"PaymentType"`] Defined in: [src/webhooks/schemas.gen.ts:22](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L22) # ProductApplication > **ProductApplication** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"ProductApplication"`] Defined in: [src/webhooks/schemas.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L23) # ReferralActivated > **ReferralActivated** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"ReferralActivated"`] Defined in: [src/webhooks/schemas.gen.ts:24](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L24) # ReferralApplicationStatusChanged > **ReferralApplicationStatusChanged** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"ReferralApplicationStatusChanged"`] Defined in: [src/webhooks/schemas.gen.ts:25](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L25) # ReferralCreated > **ReferralCreated** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"ReferralCreated"`] Defined in: [src/webhooks/schemas.gen.ts:27](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L27) # RemoveWebhookGroupMembersRequest > **RemoveWebhookGroupMembersRequest** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"RemoveWebhookGroupMembersRequest"`] Defined in: [src/webhooks/schemas.gen.ts:28](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L28) # TransferFailed > **TransferFailed** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"TransferFailed"`] Defined in: [src/webhooks/schemas.gen.ts:30](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L30) # TransferProcessed > **TransferProcessed** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"TransferProcessed"`] Defined in: [src/webhooks/schemas.gen.ts:31](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L31) # UpdateWebhookSubscriptionRequest > **UpdateWebhookSubscriptionRequest** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"UpdateWebhookSubscriptionRequest"`] Defined in: [src/webhooks/schemas.gen.ts:32](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L32) # UserAttributes > **UserAttributes** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"UserAttributes"`] Defined in: [src/webhooks/schemas.gen.ts:34](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L34) # UserUpdated > **UserUpdated** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"UserUpdated"`] Defined in: [src/webhooks/schemas.gen.ts:35](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L35) # WebhookEventType > **WebhookEventType** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"WebhookEventType"`] Defined in: [src/webhooks/schemas.gen.ts:36](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L36) # WebhookGroup > **WebhookGroup** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"WebhookGroup"`] Defined in: [src/webhooks/schemas.gen.ts:37](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L37) # WebhookGroupMember > **WebhookGroupMember** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"WebhookGroupMember"`] Defined in: [src/webhooks/schemas.gen.ts:38](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L38) # WebhookGroupMemberInput > **WebhookGroupMemberInput** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"WebhookGroupMemberInput"`] Defined in: [src/webhooks/schemas.gen.ts:39](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L39) # WebhookGroupMemberType > **WebhookGroupMemberType** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"WebhookGroupMemberType"`] Defined in: [src/webhooks/schemas.gen.ts:40](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L40) # WebhookSecret > **WebhookSecret** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"WebhookSecret"`] Defined in: [src/webhooks/schemas.gen.ts:41](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L41) # WebhookSecretStatus > **WebhookSecretStatus** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"WebhookSecretStatus"`] Defined in: [src/webhooks/schemas.gen.ts:42](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L42) # WebhookSubscription > **WebhookSubscription** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"WebhookSubscription"`] Defined in: [src/webhooks/schemas.gen.ts:43](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L43) # WebhookSubscriptionStatus > **WebhookSubscriptionStatus** = [`WebhooksComponents`](/brex/api/webhooks/interfaces/webhookscomponents/)\[`"schemas"`]\[`"WebhookSubscriptionStatus"`] Defined in: [src/webhooks/schemas.gen.ts:44](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/schemas.gen.ts#L44) # Installation > Install the brex SDK and check your runtime requirements. * bun ```sh bun add brex ``` * npm ```sh npm install brex ``` * pnpm ```sh pnpm add brex ``` * yarn ```sh yarn add brex ``` ## Runtime requirements [Section titled “Runtime requirements”](#runtime-requirements) * **Node ≥ 20.19**, or any modern runtime with a global `fetch` (Bun, Deno, browsers, edge runtimes). * The package is **ESM-only**. On Node ≥ 20.19, `require("brex")` works too, thanks to `require(esm)` support. * **Zero runtime dependencies.** ## What you get [Section titled “What you get”](#what-you-get) The package ships 11 entry points: the root `brex` client plus one subpath per Brex API (`brex/payments`, `brex/expenses`, and so on). Each entry point carries its own types and, for the subpaths, a lightweight client factory. See [Tree-shakeable imports](/brex/guides/subpath-imports/) for when to use which. Next: head to the [Quickstart](/brex/getting-started/quickstart/). # Quickstart > Create a Brex client and make your first typed, paginated requests. Create a client with a token, then call typed methods. The root `Brex` class wires up all ten Brex APIs behind a single object. ```ts import { Brex } from 'brex'; const brex = new Brex({ token: process.env.BREX_TOKEN! }); // Typed responses const me = await brex.users.getMe(); // Create with an auto-generated Idempotency-Key const vendor = await brex.vendors.create({ company_name: 'Acme Inc' }); // One page… const page = await brex.expenses.list({ limit: 100 }); // …or every item across all pages for await (const expense of brex.expenses.list({ 'expand[]': ['merchant'] })) { console.log(expense.id); } ``` Generate a user token in your Brex dashboard, or obtain one via OAuth. See [Authentication](/brex/guides/authentication/) for token providers and OAuth refresh. ## Where to go next [Section titled “Where to go next”](#where-to-go-next) * [Tree-shakeable imports](/brex/guides/subpath-imports/) — import only the APIs you use. * [Pagination](/brex/guides/pagination/) — pages vs. items vs. cursors. * [Client & request options](/brex/guides/options/) — base URL, custom `fetch`, per-request headers, idempotency, and abort signals. * [Error handling](/brex/guides/error-handling/) — the `BrexError` shape. * [API reference](/brex/api/readme/) — every namespace, method, and type. # Authentication > Pass a static token or a per-request provider function for OAuth refresh. Pass a static token, or a provider function (called per request — useful for OAuth token refresh). ```ts import { Brex } from 'brex'; // Static token const brex = new Brex({ token: process.env.BREX_TOKEN! }); // Provider function — called on every request const brexOAuth = new Brex({ token: async () => getFreshAccessToken(), }); ``` The provider form is awaited before each request, so you can return a cached token and refresh it out of band, or fetch a fresh one on demand. Generate a user token in your Brex dashboard, or obtain one via OAuth. Note Keep tokens out of source control and client bundles. Most Brex API usage involves highly sensitive financial data — you are responsible for securing it. # Error handling > Non-2xx responses throw a typed BrexError with status, body, requestId, and headers. Non-2xx responses throw a `BrexError`: ```ts import { Brex, BrexError } from 'brex'; try { await brex.vendors.get('vendor_id'); } catch (error) { if (error instanceof BrexError) { error.status; // HTTP status code error.body; // parsed JSON error body (or raw text) error.requestId; // x-request-id header, if present error.headers; // full response Headers } } ``` ## `BrexError` fields [Section titled “BrexError fields”](#brexerror-fields) | Field | Type | Description | | ----------- | --------------------- | -------------------------------------------------------------------------- | | `status` | `number` | The HTTP status code of the failed response. | | `body` | `unknown` | The parsed JSON error body, or the raw text if it wasn’t JSON. | | `requestId` | `string \| undefined` | The `x-request-id` header, if present — quote it in Brex support requests. | | `headers` | `Headers` | The full response `Headers`. | Anything that isn’t a `BrexError` (network failures, aborts) propagates as its native error type, so you can distinguish transport problems from API errors. # How generation works > The SDK is a pure function of vendored OpenAPI specs, overrides, and pinned tools. ```plaintext specs/*.yaml ──bun run generate──▶ src//{types,schemas,client}.gen.ts + entries ``` * The 10 OpenAPI specs are **vendored byte-for-byte** in the repo and re-fetched only by a human running `bun run sync-specs`. * `bun run generate` is a **pure function** of the specs, the overrides file, and exactly-pinned tool versions. Running it twice produces byte-identical output. * CI regenerates on every PR and **fails on drift**, so the published SDK can never silently diverge from the specs it claims to implement. * Types come from [openapi-typescript](https://openapi-ts.dev); the thin client layer (a small hand-written runtime) is generated with method names cleaned from operationIds (`createVendor` → `vendors.create`). ## Where the docs come from [Section titled “Where the docs come from”](#where-the-docs-come-from) This documentation site is part of the same story. The [API reference](/brex/api/readme/) is generated with [TypeDoc](https://typedoc.org) from the SDK’s source — and that source carries a JSDoc comment on every method, built from each operation’s OpenAPI **summary and full description**. So the reference you read here, the hover-docs in your editor, and the SDK itself all trace back to the same vendored specs. To pick up upstream API changes, a maintainer runs `bun run sync-specs && bun run generate`, reviews the diff, and commits both. # Migrating from v1 > v2 is a ground-up rewrite — here's how the old surface maps to the new one. v2 is a ground-up rewrite; v1’s hand-written wrapper is gone. | v1 | v2 | | ---------------------------------------- | ----------------------------------------------- | | `new Brex(token)` | `new Brex({ token })` | | `brex.request({ endpoint, method, … })` | Typed methods, e.g. `brex.vendors.list()` | | `brex.vendors.list()` (partial coverage) | Full coverage of all 10 published APIs | | `isomorphic-unfetch` polyfill | Native `fetch`, zero dependencies | | CommonJS + ESM | ESM-only (Node ≥ 20.19 `require()` still works) | ## What to change [Section titled “What to change”](#what-to-change) 1. **Construct with an options object** — `new Brex({ token })` instead of `new Brex(token)`. 2. **Replace raw `request(...)` calls** with the typed namespace methods. Browse the [API reference](/brex/api/readme/) to find the method that maps to your old endpoint. 3. **Drop the fetch polyfill** — v2 uses the runtime’s native `fetch`. If you’re on a runtime without one, inject a `fetch` via the [client options](/brex/guides/options/). 4. **Expect ESM** — the package is ESM-only. `require("brex")` still works on Node ≥ 20.19 via `require(esm)`. # Client & request options > Configure base URL, a custom fetch, default headers, idempotency, and abort signals. ## Client options [Section titled “Client options”](#client-options) ```ts const brex = new Brex({ token: '…', baseUrl: 'staging', // "production" (default), "staging", or any URL fetch: myCustomFetch, // inject for proxies, retries, or tests defaultHeaders: { 'x-app': 'my-app' }, }); ``` * **`baseUrl`** — `"production"` (default), `"staging"`, or any absolute URL. * **`fetch`** — inject your own `fetch` implementation for proxies, retries, logging, or tests. The SDK only relies on the web-standard `fetch` signature. * **`defaultHeaders`** — merged into every request. ## Per-request options [Section titled “Per-request options”](#per-request-options) Per-request options are the last argument of every method: ```ts await brex.vendors.create( { company_name: 'Acme Inc' }, { idempotencyKey: 'order-1234', // else a UUID is auto-generated where required signal: AbortSignal.timeout(10_000), // abort / timeout headers: { 'x-trace-id': 'abc' }, }, ); ``` * **`idempotencyKey`** — sets the `Idempotency-Key` header. Where Brex requires one and you don’t provide it, a UUID is generated automatically. * **`signal`** — an `AbortSignal` for cancellation or timeouts. * **`headers`** — per-request header overrides. Note Retries are intentionally out of scope — wrap the injected `fetch` if you need them. # Pagination > Await a page, iterate items, or step through pages with PagePromise. Every list endpoint returns a `PagePromise` — await it for a single page, iterate it for items, or step through pages. ```ts // Single page (respects your `cursor`/`limit` params) const page = await brex.transactions.listPrimaryCard({ limit: 50 }); // All items, across pages — follows next_cursor automatically for await (const tx of brex.transactions.listPrimaryCard()) { /* … */ } // Page-by-page for await (const p of brex.transactions.listPrimaryCard().pages()) { /* … */ } ``` ## How it works [Section titled “How it works”](#how-it-works) A `PagePromise` is both a `Promise` (resolving to the first page) and an async iterable. When you `for await` over it directly, it yields individual items and transparently follows each response’s `next_cursor` until the results are exhausted. When you call `.pages()`, it yields whole page objects instead. Because it is a real promise, you can `await` it anywhere you’d await a normal request — nothing extra to import or configure. # Tree-shakeable imports > Import only the Brex APIs you use via per-API subpaths. The root `Brex` class wires up all ten Brex APIs. If bundle size matters (browsers, edge functions), import only what you use — each subpath is an independent module graph, so the other nine APIs never enter your bundle (about 3.5 kB min for a single API). ```ts import { createPaymentsClient } from 'brex/payments'; const payments = createPaymentsClient({ token: process.env.BREX_TOKEN! }); const vendors = await payments.vendors.list({ name: 'Acme' }); ``` Every subpath also exports its resource classes (for composing with a shared `BrexCore`) and all of its schema types: ```ts import type { VendorResponse, CreateVendorRequest } from 'brex/payments'; import type { ExpandableExpense } from 'brex/expenses'; ``` ## Available subpaths [Section titled “Available subpaths”](#available-subpaths) Each subpath maps to one vendored OpenAPI spec: | Subpath | Client factory | | ------------------- | -------------------------- | | `brex/accounting` | `createAccountingClient` | | `brex/budgets` | `createBudgetsClient` | | `brex/expenses` | `createExpensesClient` | | `brex/fields` | `createFieldsClient` | | `brex/onboarding` | `createOnboardingClient` | | `brex/payments` | `createPaymentsClient` | | `brex/team` | `createTeamClient` | | `brex/transactions` | `createTransactionsClient` | | `brex/travel` | `createTravelClient` | | `brex/webhooks` | `createWebhooksClient` | For the exact namespaces and methods under each, see the [API reference](/brex/api/readme/).