AccountingComponents
Defined in: src/accounting/types.gen.ts:149
Properties
Section titled “Properties”headers
Section titled “headers”headers:
never
Defined in: src/accounting/types.gen.ts:680
parameters
Section titled “parameters”parameters:
never
Defined in: src/accounting/types.gen.ts:678
pathItems
Section titled “pathItems”pathItems:
never
Defined in: src/accounting/types.gen.ts:681
requestBodies
Section titled “requestBodies”requestBodies:
never
Defined in: src/accounting/types.gen.ts:679
responses
Section titled “responses”responses:
never
Defined in: src/accounting/types.gen.ts:677
schemas
Section titled “schemas”schemas:
object
Defined in: src/accounting/types.gen.ts:150
AccountingErrorDetails
Section titled “AccountingErrorDetails”AccountingErrorDetails:
object
AccountingErrorDetails.current_status?
Section titled “AccountingErrorDetails.current_status?”
optionalcurrent_status?:string
Description
Section titled “Description”Current status of the integration when the error occurred
Example
Section titled “Example”DISABLEDAccountingErrorDetails.duplicate_accounting_record_ids?
Section titled “AccountingErrorDetails.duplicate_accounting_record_ids?”
optionalduplicate_accounting_record_ids?:string[]
Description
Section titled “Description”Accounting record IDs that triggered the error
Example
Section titled “Example”[ "accr_abc123", "accr_def456" ]AccountingErrorDetails.existing_integration_id?
Section titled “AccountingErrorDetails.existing_integration_id?”
optionalexisting_integration_id?:string
Description
Section titled “Description”ID of the existing active integration
Example
Section titled “Example”int_abc123AccountingErrorDetails.existing_vendor?
Section titled “AccountingErrorDetails.existing_vendor?”
optionalexisting_vendor?:string
Description
Section titled “Description”Vendor of the existing integration
Example
Section titled “Example”ERP_AAccountingErrorDetails.integration_id?
Section titled “AccountingErrorDetails.integration_id?”
optionalintegration_id?:string
Description
Section titled “Description”Integration ID associated with the error
Example
Section titled “Example”int_abc123AccountingErrorDetails.not_found_export_entry_source_ids?
Section titled “AccountingErrorDetails.not_found_export_entry_source_ids?”
optionalnot_found_export_entry_source_ids?:string[]
Description
Section titled “Description”Accounting record IDs that could not be found
Example
Section titled “Example”[ "accr_ghi789" ]AccountingErrorDetails.not_ready_for_export_accounting_record_ids?
Section titled “AccountingErrorDetails.not_ready_for_export_accounting_record_ids?”
optionalnot_ready_for_export_accounting_record_ids?:string[]
Description
Section titled “Description”Accounting record IDs that are not ready for export
Example
Section titled “Example”[ "accr_ghi789" ]AccountingErrorDetails.requested_vendor?
Section titled “AccountingErrorDetails.requested_vendor?”
optionalrequested_vendor?:string
Description
Section titled “Description”Vendor that was requested to be created
Example
Section titled “Example”ERP_BAccountingErrorResponse
Section titled “AccountingErrorResponse”AccountingErrorResponse:
object
AccountingErrorResponse.details?
Section titled “AccountingErrorResponse.details?”
optionaldetails?:object&object|null
Description
Section titled “Description”Additional error context
AccountingErrorResponse.error_code
Section titled “AccountingErrorResponse.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
Section titled “Description”Machine-readable error code
Example
Section titled “Example”INVALID_REQUEST@enum {string}AccountingErrorResponse.message
Section titled “AccountingErrorResponse.message”message:
string
Description
Section titled “Description”Human-readable error message
Example
Section titled “Example”The request is malformed or contains invalid data.AccountingFieldValue
Section titled “AccountingFieldValue”AccountingFieldValue:
object
AccountingFieldValue.brex_field_id
Section titled “AccountingFieldValue.brex_field_id”brex_field_id:
string
Description
Section titled “Description”Brex internal field identifier
Example
Section titled “Example”ef_123AccountingFieldValue.brex_field_value_id
Section titled “AccountingFieldValue.brex_field_value_id”brex_field_value_id:
string
Description
Section titled “Description”Brex internal field value identifier
Example
Section titled “Example”efo_123AccountingFieldValue.remote_field_id
Section titled “AccountingFieldValue.remote_field_id”remote_field_id:
string|null
Description
Section titled “Description”Remote system field identifier
Example
Section titled “Example”1AccountingFieldValue.remote_field_value_id
Section titled “AccountingFieldValue.remote_field_value_id”remote_field_value_id:
string|null
Description
Section titled “Description”Remote system field value identifier
Example
Section titled “Example”123AccountingRecordDetailed
Section titled “AccountingRecordDetailed”AccountingRecordDetailed:
object
AccountingRecordDetailed.amount
Section titled “AccountingRecordDetailed.amount”amount:
object
Description
Section titled “Description”Amount of the accounting record
AccountingRecordDetailed.amount.amount
Section titled “AccountingRecordDetailed.amount.amount”amount:
number
Description
Section titled “Description”The amount
Example
Section titled “Example”100AccountingRecordDetailed.amount.currency
Section titled “AccountingRecordDetailed.amount.currency”currency:
string
Description
Section titled “Description”The currency
Example
Section titled “Example”USDAccountingRecordDetailed.due_at?
Section titled “AccountingRecordDetailed.due_at?”
optionaldue_at?:string|null
Format: date-time
Description
Section titled “Description”Source due at in UTC timezone. For bills only
AccountingRecordDetailed.erp_posting_date
Section titled “AccountingRecordDetailed.erp_posting_date”erp_posting_date:
string
Format: date-time
Description
Section titled “Description”ERP impact date in UTC timezone
AccountingRecordDetailed.id
Section titled “AccountingRecordDetailed.id”id:
string
Description
Section titled “Description”Unique identifier for the accounting record
Example
Section titled “Example”accr_abc123AccountingRecordDetailed.invoice_number?
Section titled “AccountingRecordDetailed.invoice_number?”
optionalinvoice_number?:string|null
Description
Section titled “Description”Invoice number. For bills only
AccountingRecordDetailed.line_items
Section titled “AccountingRecordDetailed.line_items”line_items:
object[]
Description
Section titled “Description”Line items for double-entry bookkeeping
AccountingRecordDetailed.memo?
Section titled “AccountingRecordDetailed.memo?”
optionalmemo?:string|null
Description
Section titled “Description”Memo/description
AccountingRecordDetailed.original_amount?
Section titled “AccountingRecordDetailed.original_amount?”
optionaloriginal_amount?: {amount:number;currency:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string; }
amount
Section titled “amount”amount:
number
Description
Section titled “Description”The amount
Example
Section titled “Example”100currency
Section titled “currency”currency:
string
Description
Section titled “Description”The currency
Example
Section titled “Example”USDnull
Description
Section titled “Description”Original amount if different from current
AccountingRecordDetailed.posted_at
Section titled “AccountingRecordDetailed.posted_at”posted_at:
string
Format: date-time
Description
Section titled “Description”Source posted date in UTC timezone
AccountingRecordDetailed.receipts?
Section titled “AccountingRecordDetailed.receipts?”
optionalreceipts?:object[] |null
Description
Section titled “Description”Associated receipts
AccountingRecordDetailed.review_status
Section titled “AccountingRecordDetailed.review_status”review_status:
"PREPARE"|"REVIEW"|"READY_FOR_EXPORT"|"EXPORTED"
Description
Section titled “Description”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?”
optionalsource_id?:string|null
Description
Section titled “Description”Source transaction ID
AccountingRecordDetailed.source_type
Section titled “AccountingRecordDetailed.source_type”source_type:
"CARD"|"REIMBURSEMENT"|"BILL"
Description
Section titled “Description”Source type
AccountingRecordDetailed.type
Section titled “AccountingRecordDetailed.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
Section titled “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 bankAccountingRecordDetailed.updated_at
Section titled “AccountingRecordDetailed.updated_at”updated_at:
string
Format: date-time
Description
Section titled “Description”Last update timestamp in UTC timezone
AccountingRecordDetailed.user?
Section titled “AccountingRecordDetailed.user?”
optionaluser?: {department_id?:string;department_name?:string;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”Type Literal
Section titled “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?
Section titled “department_id?”
optionaldepartment_id?:string
Description
Section titled “Description”The ID of the user’s department
Example
Section titled “Example”VXNlcjpjdXVzZXJfMTIzNA==department_name?
Section titled “department_name?”
optionaldepartment_name?:string
Description
Section titled “Description”The user’s department name
Example
Section titled “Example”Engineeringemail:
string
Description
Section titled “Description”The user’s email address
Example
Section titled “Example”john.doe@example.comfirst_name
Section titled “first_name”first_name:
string
Description
Section titled “Description”The user’s first name
Example
Section titled “Example”Johnid:
string
Description
Section titled “Description”The ID of the user
Example
Section titled “Example”VXNlcjpjdXVzZXJfMTIzNA==last_name
Section titled “last_name”last_name:
string
Description
Section titled “Description”The user’s last name
Example
Section titled “Example”Doelocation_id?
Section titled “location_id?”
optionallocation_id?:string
Description
Section titled “Description”The ID of the user’s location
Example
Section titled “Example”VXNlcjpjdXVzZXJfMTIzNA==location_name?
Section titled “location_name?”
optionallocation_name?:string
Description
Section titled “Description”The user’s location name
Example
Section titled “Example”San Franciscomanager_first_name?
Section titled “manager_first_name?”
optionalmanager_first_name?:string
Description
Section titled “Description”The user’s manager first name
Example
Section titled “Example”Janemanager_id?
Section titled “manager_id?”
optionalmanager_id?:string
Description
Section titled “Description”The ID of the user’s manager
Example
Section titled “Example”VXNlcjpjdXVzZXJfMTIzNA==manager_last_name?
Section titled “manager_last_name?”
optionalmanager_last_name?:string
Description
Section titled “Description”The user’s manager last name
Example
Section titled “Example”Smithmanager_title_id?
Section titled “manager_title_id?”
optionalmanager_title_id?:string
Description
Section titled “Description”The user’s manager title ID
Example
Section titled “Example”VGl0bGU6dGl0bGVfMTIzNA==manager_title_name?
Section titled “manager_title_name?”
optionalmanager_title_name?:string
Description
Section titled “Description”The user’s manager title display name
Example
Section titled “Example”Engineering Managerrole:
"ACCOUNT_ADMIN"|"AP_CLERK"|"BOOKKEEPER"|"CARD_ADMIN"|"EMPLOYEE"|"EMPLOYEE_WITHOUT_CORP_CARDS"|"EXPENSE_ADMIN"|"SUPER_ADMIN"|"USER_MANAGEMENT_ADMIN"
Description
Section titled “Description”The user’s role in the system
Example
Section titled “Example”CARD_ADMIN@enum {string}status
Section titled “status”status:
"ACTIVE"|"DISABLED"|"ARCHIVED"|"DELETED"|"INACTIVE"|"INVITED"|"PENDING_ACTIVATION"
Description
Section titled “Description”The user’s status in the system
Example
Section titled “Example”ACTIVE@enum {string}title_id?
Section titled “title_id?”
optionaltitle_id?:string
Description
Section titled “Description”The user’s title ID
Example
Section titled “Example”VGl0bGU6dGl0bGVfMTIzNA==title_name?
Section titled “title_name?”
optionaltitle_name?:string
Description
Section titled “Description”The user’s title display name
Example
Section titled “Example”Software Engineernull
Description
Section titled “Description”User associated with the record
AccountingRecordDetailed.vendor?
Section titled “AccountingRecordDetailed.vendor?”
optionalvendor?: {contact_name?:string|null;email?:string|null;id:string;name:string;phone?:string|null;website?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ contact_name?: string | null; email?: string | null; id: string; name: string; phone?: string | null; website?: string | null; }
contact_name?
Section titled “contact_name?”
optionalcontact_name?:string|null
Description
Section titled “Description”The name of the contact for the vendor
Example
Section titled “Example”Jane Smithemail?
Section titled “email?”
optionalemail?:string|null
Description
Section titled “Description”The email for the vendor
Example
Section titled “Example”contact@acme.comid:
string
Description
Section titled “Description”The unique identifier for the vendor
Example
Section titled “Example”vendor_123name:
string
Description
Section titled “Description”The name of the vendor
Example
Section titled “Example”Acme Corpphone?
Section titled “phone?”
optionalphone?:string|null
Description
Section titled “Description”The phone number for the vendor
Example
Section titled “Example”+1-555-123-4567website?
Section titled “website?”
optionalwebsite?:string|null
Description
Section titled “Description”The website of the vendor
Example
Section titled “Example”https://acme.comnull
Description
Section titled “Description”Vendor information
AccountingRecordDetailed.version
Section titled “AccountingRecordDetailed.version”version:
number
Description
Section titled “Description”Version number
AccountingRecordLineItem
Section titled “AccountingRecordLineItem”AccountingRecordLineItem:
object
AccountingRecordLineItem.accounting_field_values
Section titled “AccountingRecordLineItem.accounting_field_values”accounting_field_values:
object[]
Description
Section titled “Description”Accounting field mappings
AccountingRecordLineItem.amount
Section titled “AccountingRecordLineItem.amount”amount:
object
Description
Section titled “Description”Amount for this line item. Amount is always positive for AccountingRecordLineItem.
AccountingRecordLineItem.amount.amount
Section titled “AccountingRecordLineItem.amount.amount”amount:
number
Description
Section titled “Description”The amount
Example
Section titled “Example”100AccountingRecordLineItem.amount.currency
Section titled “AccountingRecordLineItem.amount.currency”currency:
string
Description
Section titled “Description”The currency
Example
Section titled “Example”USDAccountingRecordLineItem.id
Section titled “AccountingRecordLineItem.id”id:
string
Description
Section titled “Description”Unique identifier for the line item
Example
Section titled “Example”arli_abc123AccountingRecordLineItem.memo?
Section titled “AccountingRecordLineItem.memo?”
optionalmemo?:string|null
Description
Section titled “Description”Memo/description
AccountingRecordLineItem.original_amount?
Section titled “AccountingRecordLineItem.original_amount?”
optionaloriginal_amount?: {amount:number;currency:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string; }
amount
Section titled “amount”amount:
number
Description
Section titled “Description”The amount
Example
Section titled “Example”100currency
Section titled “currency”currency:
string
Description
Section titled “Description”The currency
Example
Section titled “Example”USDnull
Description
Section titled “Description”Original amount for this line item. Amount is always positive for AccountingRecordLineItem.
AccountingRecordLineItem.type
Section titled “AccountingRecordLineItem.type”type:
"CREDIT"|"DEBIT"
Description
Section titled “Description”Type of line item
AccountingRecordsResponse
Section titled “AccountingRecordsResponse”AccountingRecordsResponse:
object
AccountingRecordsResponse.has_next_page
Section titled “AccountingRecordsResponse.has_next_page”has_next_page:
boolean
Description
Section titled “Description”Whether there are more results available
AccountingRecordsResponse.items
Section titled “AccountingRecordsResponse.items”items:
object[]
Description
Section titled “Description”List of accounting records
AccountingRecordsResponse.next_cursor?
Section titled “AccountingRecordsResponse.next_cursor?”
optionalnext_cursor?:string|null
Description
Section titled “Description”Cursor for the next page of results
AccountingRecordsResponse.total_count?
Section titled “AccountingRecordsResponse.total_count?”
optionaltotal_count?:number|null
Format: int32
Description
Section titled “Description”Total count of records matching the query
Amount
Section titled “Amount”Amount:
object
Amount.amount
Section titled “Amount.amount”amount:
number
Description
Section titled “Description”The amount
Example
Section titled “Example”100Amount.currency
Section titled “Amount.currency”currency:
string
Description
Section titled “Description”The currency
Example
Section titled “Example”USDCreateIntegrationRequest
Section titled “CreateIntegrationRequest”CreateIntegrationRequest:
object
CreateIntegrationRequest.vendor
Section titled “CreateIntegrationRequest.vendor”vendor:
string
Description
Section titled “Description”The accounting vendor/system. ERP partners must request Brex to create a vendor ID for them to use this field.
Example
Section titled “Example”ERP_ACreateIntegrationRequest.vendor_account_id
Section titled “CreateIntegrationRequest.vendor_account_id”vendor_account_id:
string
Description
Section titled “Description”The vendor account ID to tie this integration to
Example
Section titled “Example”vendor_account_idExportFailureDetails
Section titled “ExportFailureDetails”ExportFailureDetails:
object
ExportFailureDetails.error_message
Section titled “ExportFailureDetails.error_message”error_message:
string
Description
Section titled “Description”Human-readable explanation of the failure
Example
Section titled “Example”Invalid GL accountExportResultsResponse
Section titled “ExportResultsResponse”ExportResultsResponse:
object
ExportResultsResponse.updated_accounting_record_ids
Section titled “ExportResultsResponse.updated_accounting_record_ids”updated_accounting_record_ids:
string[]
Description
Section titled “Description”Accounting record ids that were updated by the request
Example
Section titled “Example”[ "accr_abc123", "accr_def456" ]ExportSuccessDetails
Section titled “ExportSuccessDetails”ExportSuccessDetails:
object
ExportSuccessDetails.deep_link_url?
Section titled “ExportSuccessDetails.deep_link_url?”
optionaldeep_link_url?:string
Description
Section titled “Description”URL pointing to the record in the external system
Example
Section titled “Example”https://erp.com/transactions/456789ExportSuccessDetails.reference_id?
Section titled “ExportSuccessDetails.reference_id?”
optionalreference_id?:string|null
Description
Section titled “Description”External system identifier assigned to the exported record
Example
Section titled “Example”erp_txn_456789FailedExportResult
Section titled “FailedExportResult”FailedExportResult:
object
FailedExportResult.accounting_record_id
Section titled “FailedExportResult.accounting_record_id”accounting_record_id:
string
Description
Section titled “Description”ID of the accounting record the export outcome applies to
Example
Section titled “Example”accr_abc123FailedExportResult.failure
Section titled “FailedExportResult.failure”failure:
object
Description
Section titled “Description”Details for a failed export
FailedExportResult.failure.error_message
Section titled “FailedExportResult.failure.error_message”error_message:
string
Description
Section titled “Description”Human-readable explanation of the failure
Example
Section titled “Example”Invalid GL accountIntegration
Section titled “Integration”Integration:
object
Integration.created_at
Section titled “Integration.created_at”created_at:
string
Format: date-time
Description
Section titled “Description”Timestamp when the integration was created
Example
Section titled “Example”2025-08-15T10:00:00ZIntegration.integration_id
Section titled “Integration.integration_id”integration_id:
string
Description
Section titled “Description”Unique identifier for the integration
Example
Section titled “Example”int_abc123Integration.status
Section titled “Integration.status”status:
"ACTIVE"|"DISABLED"
Description
Section titled “Description”Current status of the integration
Example
Section titled “Example”ACTIVE@enum {string}Integration.vendor
Section titled “Integration.vendor”vendor:
string
Description
Section titled “Description”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”vendor_account_id:
string
Description
Section titled “Description”The vendor account ID this integration is tied to
Example
Section titled “Example”customer_account_idReceipt
Section titled “Receipt”Receipt:
object
Receipt.download_uris?
Section titled “Receipt.download_uris?”
optionaldownload_uris?:string[] |null
Description
Section titled “Description”Presigned S3 URLs to download receipt files (expire in 15 minutes)
Receipt.id
Section titled “Receipt.id”id:
string
Description
Section titled “Description”Unique identifier for the receipt
ReportExportResultsRequest
Section titled “ReportExportResultsRequest”ReportExportResultsRequest:
object
ReportExportResultsRequest.results
Section titled “ReportExportResultsRequest.results”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”Array of export results (must contain at least one result)
SuccessfulExportResult
Section titled “SuccessfulExportResult”SuccessfulExportResult:
object
SuccessfulExportResult.accounting_record_id
Section titled “SuccessfulExportResult.accounting_record_id”accounting_record_id:
string
Description
Section titled “Description”ID of the accounting record the export outcome applies to
Example
Section titled “Example”accr_abc123SuccessfulExportResult.success
Section titled “SuccessfulExportResult.success”success:
object
Description
Section titled “Description”Details for a successful export
SuccessfulExportResult.success.deep_link_url?
Section titled “SuccessfulExportResult.success.deep_link_url?”
optionaldeep_link_url?:string
Description
Section titled “Description”URL pointing to the record in the external system
Example
Section titled “Example”https://erp.com/transactions/456789SuccessfulExportResult.success.reference_id?
Section titled “SuccessfulExportResult.success.reference_id?”
optionalreference_id?:string|null
Description
Section titled “Description”External system identifier assigned to the exported record
Example
Section titled “Example”erp_txn_456789UpdatedAtFilter
Section titled “UpdatedAtFilter”UpdatedAtFilter:
object
UpdatedAtFilter.gt?
Section titled “UpdatedAtFilter.gt?”
optionalgt?:string
Format: date-time
Description
Section titled “Description”Minimum value to filter by (exclusive) - ISO 8601 format
Example
Section titled “Example”2025-01-01T00:00:00ZUpdatedAtFilter.gte?
Section titled “UpdatedAtFilter.gte?”
optionalgte?:string
Format: date-time
Description
Section titled “Description”Minimum value to filter by (inclusive) - ISO 8601 format
Example
Section titled “Example”2025-01-01T00:00:00ZUpdatedAtFilter.lt?
Section titled “UpdatedAtFilter.lt?”
optionallt?:string
Format: date-time
Description
Section titled “Description”Maximum value to filter by (exclusive) - ISO 8601 format
Example
Section titled “Example”2025-01-01T00:00:00ZUpdatedAtFilter.lte?
Section titled “UpdatedAtFilter.lte?”
optionallte?:string
Format: date-time
Description
Section titled “Description”Maximum value to filter by (inclusive) - ISO 8601 format
Example
Section titled “Example”2025-01-01T23:59:59.999ZUser:
object
User.department_id?
Section titled “User.department_id?”
optionaldepartment_id?:string
Description
Section titled “Description”The ID of the user’s department
Example
Section titled “Example”VXNlcjpjdXVzZXJfMTIzNA==User.department_name?
Section titled “User.department_name?”
optionaldepartment_name?:string
Description
Section titled “Description”The user’s department name
Example
Section titled “Example”EngineeringUser.email
Section titled “User.email”email:
string
Description
Section titled “Description”The user’s email address
Example
Section titled “Example”john.doe@example.comUser.first_name
Section titled “User.first_name”first_name:
string
Description
Section titled “Description”The user’s first name
Example
Section titled “Example”JohnUser.id
Section titled “User.id”id:
string
Description
Section titled “Description”The ID of the user
Example
Section titled “Example”VXNlcjpjdXVzZXJfMTIzNA==User.last_name
Section titled “User.last_name”last_name:
string
Description
Section titled “Description”The user’s last name
Example
Section titled “Example”DoeUser.location_id?
Section titled “User.location_id?”
optionallocation_id?:string
Description
Section titled “Description”The ID of the user’s location
Example
Section titled “Example”VXNlcjpjdXVzZXJfMTIzNA==User.location_name?
Section titled “User.location_name?”
optionallocation_name?:string
Description
Section titled “Description”The user’s location name
Example
Section titled “Example”San FranciscoUser.manager_first_name?
Section titled “User.manager_first_name?”
optionalmanager_first_name?:string
Description
Section titled “Description”The user’s manager first name
Example
Section titled “Example”JaneUser.manager_id?
Section titled “User.manager_id?”
optionalmanager_id?:string
Description
Section titled “Description”The ID of the user’s manager
Example
Section titled “Example”VXNlcjpjdXVzZXJfMTIzNA==User.manager_last_name?
Section titled “User.manager_last_name?”
optionalmanager_last_name?:string
Description
Section titled “Description”The user’s manager last name
Example
Section titled “Example”SmithUser.manager_title_id?
Section titled “User.manager_title_id?”
optionalmanager_title_id?:string
Description
Section titled “Description”The user’s manager title ID
Example
Section titled “Example”VGl0bGU6dGl0bGVfMTIzNA==User.manager_title_name?
Section titled “User.manager_title_name?”
optionalmanager_title_name?:string
Description
Section titled “Description”The user’s manager title display name
Example
Section titled “Example”Engineering ManagerUser.role
Section titled “User.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”The user’s role in the system
Example
Section titled “Example”CARD_ADMIN@enum {string}User.status
Section titled “User.status”status:
"ACTIVE"|"DISABLED"|"ARCHIVED"|"DELETED"|"INACTIVE"|"INVITED"|"PENDING_ACTIVATION"
Description
Section titled “Description”The user’s status in the system
Example
Section titled “Example”ACTIVE@enum {string}User.title_id?
Section titled “User.title_id?”
optionaltitle_id?:string
Description
Section titled “Description”The user’s title ID
Example
Section titled “Example”VGl0bGU6dGl0bGVfMTIzNA==User.title_name?
Section titled “User.title_name?”
optionaltitle_name?:string
Description
Section titled “Description”The user’s title display name
Example
Section titled “Example”Software EngineerVendor
Section titled “Vendor”Vendor:
object
Vendor.contact_name?
Section titled “Vendor.contact_name?”
optionalcontact_name?:string|null
Description
Section titled “Description”The name of the contact for the vendor
Example
Section titled “Example”Jane SmithVendor.email?
Section titled “Vendor.email?”
optionalemail?:string|null
Description
Section titled “Description”The email for the vendor
Example
Section titled “Example”contact@acme.comVendor.id
Section titled “Vendor.id”id:
string
Description
Section titled “Description”The unique identifier for the vendor
Example
Section titled “Example”vendor_123Vendor.name
Section titled “Vendor.name”name:
string
Description
Section titled “Description”The name of the vendor
Example
Section titled “Example”Acme CorpVendor.phone?
Section titled “Vendor.phone?”
optionalphone?:string|null
Description
Section titled “Description”The phone number for the vendor
Example
Section titled “Example”+1-555-123-4567Vendor.website?
Section titled “Vendor.website?”
optionalwebsite?:string|null
Description
Section titled “Description”The website of the vendor
Example
Section titled “Example”https://acme.com