AccountingPaths

Defined in: src/accounting/types.gen.ts:2

Properties

/v3/accounting/integration

/v3/accounting/integration: object

Defined in: src/accounting/types.gen.ts:3

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Create accounting integration

Description

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.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody

requestBody: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: object

post.requestBody.content.application/json.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

ERP_A

post.requestBody.content.application/json.vendor_account_id

vendor_account_id: string

Description

The vendor account ID to tie this integration to

Example

vendor_account_id

post.responses

responses: object

post.responses.200

200: object

Description

Integration created successfully

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

post.responses.200.content.application/json.created_at

created_at: string

Format: date-time

Description

Timestamp when the integration was created

Example

2025-08-15T10:00:00Z

post.responses.200.content.application/json.integration_id

integration_id: string

Description

Unique identifier for the integration

Example

int_abc123

post.responses.200.content.application/json.status

status: "ACTIVE" | "DISABLED"

Description

Current status of the integration

Example

ACTIVE
@enum {string}

post.responses.200.content.application/json.vendor

vendor: string

Description

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

vendor_account_id: string

Description

The vendor account ID this integration is tied to

Example

customer_account_id

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.400

400: object

Description

Bad request

post.responses.400.content

content: object

post.responses.400.content.application/json

application/json: object

post.responses.400.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.400.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.400.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.401

401: object

Description

Unauthorized

post.responses.401.content

content: object

post.responses.401.content.application/json

application/json: object

post.responses.401.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.401.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.401.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.403

403: object

Description

Forbidden

post.responses.403.content

content: object

post.responses.403.content.application/json

application/json: object

post.responses.403.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.403.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.403.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.409

409: object

Description

Active integration exists with different vendor or different vendor account ID

post.responses.409.content

content: object

post.responses.409.content.application/json

application/json: object

post.responses.409.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.409.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.409.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.409.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.500

500: object

Description

Internal server error

post.responses.500.content

content: object

post.responses.500.content.application/json

application/json: object

post.responses.500.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.500.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.500.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.500.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/v3/accounting/integration/{integration_id}/disconnect

/v3/accounting/integration/{integration_id}/disconnect: object

Defined in: src/accounting/types.gen.ts:30

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Disconnect accounting integration

Description

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.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path

path: object

post.parameters.path.integration_id

integration_id: string

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: undefined

post.responses

responses: object

post.responses.200

200: object

Description

Integration disconnected successfully

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

post.responses.200.content.application/json.created_at

created_at: string

Format: date-time

Description

Timestamp when the integration was created

Example

2025-08-15T10:00:00Z

post.responses.200.content.application/json.integration_id

integration_id: string

Description

Unique identifier for the integration

Example

int_abc123

post.responses.200.content.application/json.status

status: "ACTIVE" | "DISABLED"

Description

Current status of the integration

Example

ACTIVE
@enum {string}

post.responses.200.content.application/json.vendor

vendor: string

Description

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

vendor_account_id: string

Description

The vendor account ID this integration is tied to

Example

customer_account_id

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.401

401: object

Description

Unauthorized

post.responses.401.content

content: object

post.responses.401.content.application/json

application/json: object

post.responses.401.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.401.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.401.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.403

403: object

Description

Forbidden

post.responses.403.content

content: object

post.responses.403.content.application/json

application/json: object

post.responses.403.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.403.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.403.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.404

404: object

Description

Integration not found

post.responses.404.content

content: object

post.responses.404.content.application/json

application/json: object

post.responses.404.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.404.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.404.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.409

409: object

Description

Integration is not active

post.responses.409.content

content: object

post.responses.409.content.application/json

application/json: object

post.responses.409.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.409.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.409.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.409.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.500

500: object

Description

Internal server error

post.responses.500.content

content: object

post.responses.500.content.application/json

application/json: object

post.responses.500.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.500.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.500.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.500.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/v3/accounting/integration/{integration_id}/reactivate

/v3/accounting/integration/{integration_id}/reactivate: object

Defined in: src/accounting/types.gen.ts:54

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Reactivate accounting integration

Description

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.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path

path: object

post.parameters.path.integration_id

integration_id: string

post.parameters.query?

optional query?: undefined

post.requestBody?

optional requestBody?: undefined

post.responses

responses: object

post.responses.200

200: object

Description

Integration reactivated successfully

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

post.responses.200.content.application/json.created_at

created_at: string

Format: date-time

Description

Timestamp when the integration was created

Example

2025-08-15T10:00:00Z

post.responses.200.content.application/json.integration_id

integration_id: string

Description

Unique identifier for the integration

Example

int_abc123

post.responses.200.content.application/json.status

status: "ACTIVE" | "DISABLED"

Description

Current status of the integration

Example

ACTIVE
@enum {string}

post.responses.200.content.application/json.vendor

vendor: string

Description

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

vendor_account_id: string

Description

The vendor account ID this integration is tied to

Example

customer_account_id

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.401

401: object

Description

Unauthorized

post.responses.401.content

content: object

post.responses.401.content.application/json

application/json: object

post.responses.401.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.401.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.401.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.403

403: object

Description

Forbidden

post.responses.403.content

content: object

post.responses.403.content.application/json

application/json: object

post.responses.403.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.403.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.403.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.404

404: object

Description

Integration not found

post.responses.404.content

content: object

post.responses.404.content.application/json

application/json: object

post.responses.404.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.404.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.404.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.409

409: object

Description

Active integration already exists

post.responses.409.content

content: object

post.responses.409.content.application/json

application/json: object

post.responses.409.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.409.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.409.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.409.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.500

500: object

Description

Internal server error

post.responses.500.content

content: object

post.responses.500.content.application/json

application/json: object

post.responses.500.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.500.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.500.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.500.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/v3/accounting/records

/v3/accounting/records: object

Defined in: src/accounting/types.gen.ts:78

delete?

optional delete?: undefined

get

get: object

Query accounting records

Description

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.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.cursor?

optional cursor?: string

Description

Cursor for pagination

get.parameters.query.ids?

optional ids?: string[]

Description

Filter by accounting record IDs. ID size is limited to 500. Example: ids=accr_xxx&ids=accr_yyy

get.parameters.query.limit?

optional 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.

get.parameters.query.review_status?

optional 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).

get.parameters.query.single_entry?

optional 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.

get.parameters.query.source_type?

optional 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

get.parameters.query.updated_at?

optional updated_at?: object

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

get.parameters.query.updated_at.gt?

optional gt?: string

Format: date-time

Description

Minimum value to filter by (exclusive) - ISO 8601 format

Example

2025-01-01T00:00:00Z

get.parameters.query.updated_at.gte?

optional gte?: string

Format: date-time

Description

Minimum value to filter by (inclusive) - ISO 8601 format

Example

2025-01-01T00:00:00Z

get.parameters.query.updated_at.lt?

optional lt?: string

Format: date-time

Description

Maximum value to filter by (exclusive) - ISO 8601 format

Example

2025-01-01T00:00:00Z

get.parameters.query.updated_at.lte?

optional lte?: string

Format: date-time

Description

Maximum value to filter by (inclusive) - ISO 8601 format

Example

2025-01-01T23:59:59.999Z

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Query accounting records response

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

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

has_next_page: boolean

Description

Whether there are more results available

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

items: object[]

Description

List of accounting records

get.responses.200.content.application/json.next_cursor?

optional next_cursor?: string | null

Description

Cursor for the next page of results

get.responses.200.content.application/json.total_count?

optional total_count?: number | null

Format: int32

Description

Total count of records matching the query

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content

content: object

get.responses.400.content.application/json

application/json: object

get.responses.400.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

get.responses.400.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

get.responses.400.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content

content: object

get.responses.401.content.application/json

application/json: object

get.responses.401.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

get.responses.401.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

get.responses.401.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content

content: object

get.responses.403.content.application/json

application/json: object

get.responses.403.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

get.responses.403.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

get.responses.403.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.500

500: object

Description

Internal server error

get.responses.500.content

content: object

get.responses.500.content.application/json

application/json: object

get.responses.500.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

get.responses.500.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

get.responses.500.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

get.responses.500.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/v3/accounting/records/{record_id}

/v3/accounting/records/{record_id}: object

Defined in: src/accounting/types.gen.ts:107

delete?

optional delete?: undefined

get

get: object

Get accounting record by ID

Description

Retrieve a single accounting record by its unique identifier

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.record_id

record_id: string

get.parameters.query?

optional query?: object

get.parameters.query.single_entry?

optional 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.

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Accounting record retrieved successfully

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

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

amount: object

Description

Amount of the accounting record

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

amount: number

Description

The amount

Example

100

get.responses.200.content.application/json.amount.currency

currency: string

Description

The currency

Example

USD

get.responses.200.content.application/json.due_at?

optional due_at?: string | null

Format: date-time

Description

Source due at in UTC timezone. For bills only

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

erp_posting_date: string

Format: date-time

Description

ERP impact date in UTC timezone

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

id: string

Description

Unique identifier for the accounting record

Example

accr_abc123

get.responses.200.content.application/json.invoice_number?

optional invoice_number?: string | null

Description

Invoice number. For bills only

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

line_items: object[]

Description

Line items for double-entry bookkeeping

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

optional memo?: string | null

Description

Memo/description

get.responses.200.content.application/json.original_amount?

optional original_amount?: { amount: number; currency: string; } | null

Union Members

Type Literal

{ amount: number; currency: string; }

amount

amount: number

Description

The amount

Example

100

currency

currency: string

Description

The currency

Example

USD

---

null

Description

Original amount if different from current

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

posted_at: string

Format: date-time

Description

Source posted date in UTC timezone

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

optional receipts?: object[] | null

Description

Associated receipts

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

review_status: "PREPARE" | "REVIEW" | "READY_FOR_EXPORT" | "EXPORTED"

Description

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?

optional source_id?: string | null

Description

Source transaction ID

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

source_type: "CARD" | "REIMBURSEMENT" | "BILL"

Description

Source type

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

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

Types of accounting records representing different financial transactions:

**Card-related transactions:**

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

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

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

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

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

- `REWARD_REDEMPTION`: Records when a reward is redeemed

**Bill-related transactions:**

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

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

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

**Reimbursement-related transactions:**

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

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

- `REIMBURSEMENT_EXPENSE_REPAYMENT`: Records repayment of a reimbursement expense

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

- `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYOUT_REVERSAL`: Records reversal of payout

- `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_PAYIN`: Records payment from customer to Brex

- `REIMBURSEMENT_EXPENSE_MONEY_MOVEMENT_REFUND`: Records refund to customer's bank

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

updated_at: string

Format: date-time

Description

Last update timestamp in UTC timezone

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

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

Type Literal

{ 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?

optional department_id?: string

Description

The ID of the user’s department

Example

VXNlcjpjdXVzZXJfMTIzNA==

department_name?

optional department_name?: string

Description

The user’s department name

Example

Engineering

email

email: string

Description

The user’s email address

Example

john.doe@example.com

first_name

first_name: string

Description

The user’s first name

Example

John

id

id: string

Description

The ID of the user

Example

VXNlcjpjdXVzZXJfMTIzNA==

last_name

last_name: string

Description

The user’s last name

Example

Doe

location_id?

optional location_id?: string

Description

The ID of the user’s location

Example

VXNlcjpjdXVzZXJfMTIzNA==

location_name?

optional location_name?: string

Description

The user’s location name

Example

San Francisco

manager_first_name?

optional manager_first_name?: string

Description

The user’s manager first name

Example

Jane

manager_id?

optional manager_id?: string

Description

The ID of the user’s manager

Example

VXNlcjpjdXVzZXJfMTIzNA==

manager_last_name?

optional manager_last_name?: string

Description

The user’s manager last name

Example

Smith

manager_title_id?

optional manager_title_id?: string

Description

The user’s manager title ID

Example

VGl0bGU6dGl0bGVfMTIzNA==

manager_title_name?

optional manager_title_name?: string

Description

The user’s manager title display name

Example

Engineering Manager

role

role: "ACCOUNT_ADMIN" | "AP_CLERK" | "BOOKKEEPER" | "CARD_ADMIN" | "EMPLOYEE" | "EMPLOYEE_WITHOUT_CORP_CARDS" | "EXPENSE_ADMIN" | "SUPER_ADMIN" | "USER_MANAGEMENT_ADMIN"

Description

The user’s role in the system

Example

CARD_ADMIN
@enum {string}

status

status: "ACTIVE" | "DISABLED" | "ARCHIVED" | "DELETED" | "INACTIVE" | "INVITED" | "PENDING_ACTIVATION"

Description

The user’s status in the system

Example

ACTIVE
@enum {string}

title_id?

optional title_id?: string

Description

The user’s title ID

Example

VGl0bGU6dGl0bGVfMTIzNA==

title_name?

optional title_name?: string

Description

The user’s title display name

Example

Software Engineer

---

null

Description

User associated with the record

get.responses.200.content.application/json.vendor?

optional vendor?: { contact_name?: string | null; email?: string | null; id: string; name: string; phone?: string | null; website?: string | null; } | null

Union Members

Type Literal

{ contact_name?: string | null; email?: string | null; id: string; name: string; phone?: string | null; website?: string | null; }

contact_name?

optional contact_name?: string | null

Description

The name of the contact for the vendor

Example

Jane Smith

email?

optional email?: string | null

Description

The email for the vendor

Example

contact@acme.com

id

id: string

Description

The unique identifier for the vendor

Example

vendor_123

name

name: string

Description

The name of the vendor

Example

Acme Corp

phone?

optional phone?: string | null

Description

The phone number for the vendor

Example

+1-555-123-4567

website?

optional website?: string | null

Description

The website of the vendor

Example

https://acme.com

---

null

Description

Vendor information

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

version: number

Description

Version number

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content

content: object

get.responses.400.content.application/json

application/json: object

get.responses.400.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

get.responses.400.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

get.responses.400.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content

content: object

get.responses.401.content.application/json

application/json: object

get.responses.401.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

get.responses.401.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

get.responses.401.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content

content: object

get.responses.403.content.application/json

application/json: object

get.responses.403.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

get.responses.403.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

get.responses.403.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.404

404: object

Description

Record not found

get.responses.404.content

content: object

get.responses.404.content.application/json

application/json: object

get.responses.404.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

get.responses.404.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

get.responses.404.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

get.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.500

500: object

Description

Internal server error

get.responses.500.content

content: object

get.responses.500.content.application/json

application/json: object

get.responses.500.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

get.responses.500.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

get.responses.500.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

get.responses.500.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

---

/v3/accounting/records/export-results

/v3/accounting/records/export-results: object

Defined in: src/accounting/types.gen.ts:127

delete?

optional delete?: undefined

get?

optional get?: undefined

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post

post: object

Report accounting export results

Description

Report export success or failure for accounting records.

post.parameters

parameters: object

post.parameters.cookie?

optional cookie?: undefined

post.parameters.header?

optional header?: undefined

post.parameters.path?

optional path?: undefined

post.parameters.query?

optional query?: undefined

post.requestBody

requestBody: object

post.requestBody.content

content: object

post.requestBody.content.application/json

application/json: object

post.requestBody.content.application/json.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)

post.responses

responses: object

post.responses.200

200: object

Description

Export results processed successfully

post.responses.200.content

content: object

post.responses.200.content.application/json

application/json: object

post.responses.200.content.application/json.updated_accounting_record_ids

updated_accounting_record_ids: string[]

Description

Accounting record ids that were updated by the request

Example

[
      "accr_abc123",
      "accr_def456"
    ]

post.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.404

404: object

Description

Not found - Given accounting record id is not found

post.responses.404.content

content: object

post.responses.404.content.application/json

application/json: object

post.responses.404.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.404.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.404.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.404.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.422

422: object

Description

Validation failed (duplicate accounting record ids or records not READY_FOR_EXPORT)

post.responses.422.content

content: object

post.responses.422.content.application/json

application/json: object

post.responses.422.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.422.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.422.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.422.headers

headers: object

Index Signature

[name: string]: unknown

post.responses.500

500: object

Description

Internal server error

post.responses.500.content

content: object

post.responses.500.content.application/json

application/json: object

post.responses.500.content.application/json.details?

optional details?: object & object | null

Description

Additional error context

post.responses.500.content.application/json.error_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

Machine-readable error code

Example

INVALID_REQUEST
@enum {string}

post.responses.500.content.application/json.message

message: string

Description

Human-readable error message

Example

The request is malformed or contains invalid data.

post.responses.500.headers

headers: object

Index Signature

[name: string]: unknown

put?

optional put?: undefined

trace?

optional trace?: undefined