ExpensesPaths
Defined in: src/expenses/types.gen.ts:2
Properties
Section titled “Properties”/v1/expenses
Section titled “/v1/expenses”/v1/expenses:
object
Defined in: src/expenses/types.gen.ts:3
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List expenses
Description
Section titled “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”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.budget_id[]?
Section titled “get.parameters.query.budget_id[]?”
optionalbudget_id[]?:string[] |null
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
Description
Section titled “Description”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[]?”
optionalexpand[]?:string[] |null
Description
Section titled “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
Section titled “Example”?expand[]=merchant&expand[]=locationget.parameters.query.expense_type[]?
Section titled “get.parameters.query.expense_type[]?”
optionalexpense_type[]?: ("CARD"|"REIMBURSEMENT"|"BILLPAY"|"CLAWBACK"|"UNSET")[] |null
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
Description
Section titled “Description”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?”
optionalload_custom_fields?:boolean|null
Description
Section titled “Description”Load custom fields for the expenses.
get.parameters.query.parent_expense_id[]?
Section titled “get.parameters.query.parent_expense_id[]?”
optionalparent_expense_id[]?:string[] |null
Description
Section titled “Description”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?”
optionalpayment_posted_at_end?:string|null
Description
Section titled “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, e.g. 2022-11-12T23:59:59.999
Example
Section titled “Example”2023-01-10T23:59:59.999get.parameters.query.payment_posted_at_start?
Section titled “get.parameters.query.payment_posted_at_start?”
optionalpayment_posted_at_start?:string|null
Description
Section titled “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, e.g. 2022-11-12T23:59:59.999
Example
Section titled “Example”2023-01-01T23:59:59.999get.parameters.query.payment_status[]?
Section titled “get.parameters.query.payment_status[]?”
optionalpayment_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?”
optionalpurchased_at_end?:string|null
Description
Section titled “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, e.g. 2022-11-12T23:59:59.999
Example
Section titled “Example”2023-01-10T23:59:59.999get.parameters.query.purchased_at_start?
Section titled “get.parameters.query.purchased_at_start?”
optionalpurchased_at_start?:string|null
Description
Section titled “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, e.g. 2022-11-12T23:59:59.999
Example
Section titled “Example”2023-01-01T23:59:59.999get.parameters.query.spending_entity_id[]?
Section titled “get.parameters.query.spending_entity_id[]?”
optionalspending_entity_id[]?:string[] |null
get.parameters.query.status[]?
Section titled “get.parameters.query.status[]?”
optionalstatus[]?: ("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?”
optionalupdated_at_end?:string|null
Description
Section titled “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, e.g. 2022-11-12T23:59:59.999
Example
Section titled “Example”2023-01-10T23:59:59.999get.parameters.query.updated_at_start?
Section titled “get.parameters.query.updated_at_start?”
optionalupdated_at_start?:string|null
Description
Section titled “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, e.g. 2022-11-12T23:59:59.999
Example
Section titled “Example”2023-01-01T23:59:59.999get.parameters.query.user_id[]?
Section titled “get.parameters.query.user_id[]?”
optionaluser_id[]?:string[] |null
Description
Section titled “Description”Get expenses belong to provided user(s).
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”List expenses response.
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/expenses/{id}
Section titled “/v1/expenses/{id}”/v1/expenses/{id}:
object
Defined in: src/expenses/types.gen.ts:23
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get an expense
Description
Section titled “Description”Get an expense by its ID.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.expand[]?
Section titled “get.parameters.query.expand[]?”
optionalexpand[]?:string[] |null
Description
Section titled “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
Section titled “Example”?expand[]=merchant&expand[]=locationget.parameters.query.load_custom_fields?
Section titled “get.parameters.query.load_custom_fields?”
optionalload_custom_fields?:boolean|null
Description
Section titled “Description”Load custom fields for the expense.
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”Get an expense response.
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.address?
Section titled “get.responses.200.content.application/json.address?”
optionaladdress?: {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”Type Literal
Section titled “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; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
coordinates?
Section titled “coordinates?”
optionalcoordinates?: {latitude:number;longitude:number; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ latitude: number; longitude: number; }
latitude
Section titled “latitude”latitude:
number
Format: double
longitude
Section titled “longitude”longitude:
number
Format: double
null
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
timezone?
Section titled “timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”Timezone.
null
get.responses.200.content.application/json.approved_at?
Section titled “get.responses.200.content.application/json.approved_at?”
optionalapproved_at?:string|null
Format: date-time
Description
Section titled “Description”The time the expense is approved.
get.responses.200.content.application/json.billing_amount?
Section titled “get.responses.200.content.application/json.billing_amount?”
optionalbilling_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
get.responses.200.content.application/json.billing_entity_id?
Section titled “get.responses.200.content.application/json.billing_entity_id?”
optionalbilling_entity_id?:string|null
Description
Section titled “Description”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?”
optionalbooking_id?:string|null
Description
Section titled “Description”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?”
optionalbudget?: {id:string;name:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ id: string; name: string; }
id:
string
Description
Section titled “Description”Unique ID for the Budget.
name:
string
Description
Section titled “Description”Name for the Budget.
null
get.responses.200.content.application/json.budget_amount?
Section titled “get.responses.200.content.application/json.budget_amount?”
optionalbudget_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
get.responses.200.content.application/json.budget_id?
Section titled “get.responses.200.content.application/json.budget_id?”
optionalbudget_id?:string|null
get.responses.200.content.application/json.category?
Section titled “get.responses.200.content.application/json.category?”
optionalcategory?:"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?”
optionalcompletion_date?:string|null
Format: date-time
Description
Section titled “Description”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?”
optionalcustom_fields?:object[] |null
Description
Section titled “Description”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”dashboard_url:
string
Description
Section titled “Description”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?”
optionaldepartment?: {id:string;name:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ id: string; name: string; }
id:
string
Description
Section titled “Description”The unique identifier for the department.
name:
string
Description
Section titled “Description”The name of the department.
null
get.responses.200.content.application/json.department_id?
Section titled “get.responses.200.content.application/json.department_id?”
optionaldepartment_id?:string|null
get.responses.200.content.application/json.expense_line_items?
Section titled “get.responses.200.content.application/json.expense_line_items?”
optionalexpense_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”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?”
optionalexpense_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?”
optionalexported_at?:string|null
Format: date-time
Description
Section titled “Description”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”id:
string
Description
Section titled “Description”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?”
optionalintegration_billing_entity_id?:string|null
Description
Section titled “Description”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?”
optionalintegration_spending_entity_id?:string|null
Description
Section titled “Description”ID of the spending entity in accounting.
get.responses.200.content.application/json.location?
Section titled “get.responses.200.content.application/json.location?”
optionallocation?: {id:string;name:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ id: string; name: string; }
id:
string
Description
Section titled “Description”The unique identifier for the location.
name:
string
Description
Section titled “Description”The name of the location.
null
get.responses.200.content.application/json.location_id?
Section titled “get.responses.200.content.application/json.location_id?”
optionallocation_id?:string|null
get.responses.200.content.application/json.memo?
Section titled “get.responses.200.content.application/json.memo?”
optionalmemo?:string|null
Description
Section titled “Description”The memo of the expense.
get.responses.200.content.application/json.merchant?
Section titled “get.responses.200.content.application/json.merchant?”
optionalmerchant?: {country:string;mcc:string;raw_descriptor:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ country: string; mcc: string; raw_descriptor: string; }
country
Section titled “country”country:
string
Description
Section titled “Description”Merchant’s country, in ISO 3166-1 alpha-3 format.
mcc:
string
Description
Section titled “Description”A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to https://en.wikipedia.org/wiki/Merchant_category_code for more details.
raw_descriptor
Section titled “raw_descriptor”raw_descriptor:
string
Description
Section titled “Description”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?”
optionalmerchant_id?:string|null
get.responses.200.content.application/json.original_amount?
Section titled “get.responses.200.content.application/json.original_amount?”
optionaloriginal_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
get.responses.200.content.application/json.payment?
Section titled “get.responses.200.content.application/json.payment?”
optionalpayment?: {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”Type Literal
Section titled “Type Literal”{ id: string; paymentInstrument: Omit<object & object & object, "type">; statusReason: "APPROVED" | "OTHER" | "EXCEEDED_BUDGET_LIMIT" | "BUDGET_EXPIRED" | "NO_BUDGET" | "BUDGET_NOT_YET_STARTED" | "BUDGET_CATEGORY_RESTRICTION" | "BUDGET_MERCHANT_RESTRICTION" | "SUSPECTED_FRAUD" | "EXCEEDED_GLOBAL_LIMIT" | "EXCEEDED_USER_LIMIT" | "EXCEEDED_CARD_LIMIT" | "INVALID_EXPIRATION_DATE" | "CARD_NOT_ACTIVE" | "INVALID_CARD_CREDENTIALS" | "INVALID_BILLING_ADDRESS" | "CARD_SUSPENDED" | "CARD_TERMINATED" | "CARD_EXPIRED" | "MCC_BLOCKED" | "USER_SUSPENDED" | "INVALID_PIN" | "INVALID_CVV" | "EXCEEDED_PIN_ATTEMPTS" | "INSIDE_SANCTIONED_COUNTRY" | "SOFT_EXPIRATION" | "TRANSFERRED_CARD_NEW_MERCHANT" | "EXCEEDED_ANCESTOR_BUDGET_LIMIT" | "EXCEEDED_BUDGET_TRANSACTION_LIMIT" | "TOS_BLOCKED" | "COMPLIANCE_BLOCKED"; }
id:
string
Description
Section titled “Description”Unique ID for the payment.
paymentInstrument
Section titled “paymentInstrument”paymentInstrument:
Omit<object&object&object,"type">
statusReason
Section titled “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?”
optionalpayment_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?”
optionalpayment_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?”
optionalpolicy?: {id:string;name:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ id: string; name: string; }
id:
string
Description
Section titled “Description”The unique identifier for the policy.
name:
string
Description
Section titled “Description”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?”
optionalpurchased_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
get.responses.200.content.application/json.purchased_at?
Section titled “get.responses.200.content.application/json.purchased_at?”
optionalpurchased_at?:string|null
Format: date-time
Description
Section titled “Description”The time the purchase was made.
get.responses.200.content.application/json.receipts?
Section titled “get.responses.200.content.application/json.receipts?”
optionalreceipts?:object[] |null
Description
Section titled “Description”A list of receipts associated with the expense.
get.responses.200.content.application/json.repayment?
Section titled “get.responses.200.content.application/json.repayment?”
optionalrepayment?: {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”Type Literal
Section titled “Type Literal”{ repayment_initiated_by?: { department_id?: … | … | …; first_name: string; id: string; last_name: string; location_id?: … | … | …; } | null; repayment_initiation_date?: string | null; }
repayment_initiated_by?
Section titled “repayment_initiated_by?”
optionalrepayment_initiated_by?: {department_id?: … | … | …;first_name:string;id:string;last_name:string;location_id?: … | … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ department_id?: … | … | …; first_name: string; id: string; last_name: string; location_id?: … | … | …; }
department_id?
Section titled “department_id?”
optionaldepartment_id?: … | … | …
first_name
Section titled “first_name”first_name:
string
Description
Section titled “Description”First name of the User.
id:
string
Description
Section titled “Description”Unique ID for the User.
last_name
Section titled “last_name”last_name:
string
Description
Section titled “Description”Last name of the User.
location_id?
Section titled “location_id?”
optionallocation_id?: … | … | …
null
repayment_initiation_date?
Section titled “repayment_initiation_date?”
optionalrepayment_initiation_date?:string|null
Format: date-time
null
get.responses.200.content.application/json.review?
Section titled “get.responses.200.content.application/json.review?”
optionalreview?: {approval_steps:object[] |null;compliance_status:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ approval_steps: object[] | null; compliance_status: string | null; }
approval_steps
Section titled “approval_steps”approval_steps:
object[] |null
Description
Section titled “Description”Information for each approval step of the expense
compliance_status
Section titled “compliance_status”compliance_status:
string|null
Description
Section titled “Description”Compliance status of the expense
null
get.responses.200.content.application/json.spending_entity?
Section titled “get.responses.200.content.application/json.spending_entity?”
optionalspending_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”Type Literal
Section titled “Type Literal”{ billing_address: { city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }; created_at: string; display_name: string; id: string; is_default?: boolean; status: "UNSUBMITTED" | "UNVERIFIED" | "IN_PROGRESS" | "VERIFIED" | "REJECTED"; }
billing_address
Section titled “billing_address”billing_address:
object
billing_address.city?
Section titled “billing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
billing_address.country?
Section titled “billing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
billing_address.line1?
Section titled “billing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
billing_address.line2?
Section titled “billing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
billing_address.phone_number?
Section titled “billing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
billing_address.postal_code?
Section titled “billing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
billing_address.state?
Section titled “billing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
created_at
Section titled “created_at”created_at:
string
Format: date-time
Description
Section titled “Description”Timestamp, in UTC, when this legal entity was created.
display_name
Section titled “display_name”display_name:
string
Description
Section titled “Description”The display name of this legal entity.
id:
string
Description
Section titled “Description”The ID of this legal entity.
is_default?
Section titled “is_default?”
optionalis_default?:boolean
Description
Section titled “Description”Whether this is the default entity of the account.
status
Section titled “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?”
optionalspending_entity_id?:string|null
Description
Section titled “Description”The spending entity ID associated with the expense.
get.responses.200.content.application/json.status?
Section titled “get.responses.200.content.application/json.status?”
optionalstatus?:"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?”
optionalsubmitted_at?:string|null
Format: date-time
Description
Section titled “Description”The time the expense is submitted,
get.responses.200.content.application/json.trip_id?
Section titled “get.responses.200.content.application/json.trip_id?”
optionaltrip_id?:string|null
Description
Section titled “Description”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”updated_at:
string
Format: date-time
Description
Section titled “Description”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?”
optionalusd_equivalent_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
get.responses.200.content.application/json.user?
Section titled “get.responses.200.content.application/json.user?”
optionaluser?: {department_id?:string|null;first_name:string;id:string;last_name:string;location_id?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; }
department_id?
Section titled “department_id?”
optionaldepartment_id?:string|null
first_name
Section titled “first_name”first_name:
string
Description
Section titled “Description”First name of the User.
id:
string
Description
Section titled “Description”Unique ID for the User.
last_name
Section titled “last_name”last_name:
string
Description
Section titled “Description”Last name of the User.
location_id?
Section titled “location_id?”
optionallocation_id?:string|null
null
get.responses.200.content.application/json.user_id?
Section titled “get.responses.200.content.application/json.user_id?”
optionaluser_id?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.404
Section titled “get.responses.404”404:
object
Description
Section titled “Description”Not found
get.responses.404.content?
Section titled “get.responses.404.content?”
optionalcontent?:undefined
get.responses.404.headers
Section titled “get.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/expenses/card
Section titled “/v1/expenses/card”/v1/expenses/card:
object
Defined in: src/expenses/types.gen.ts:43
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List card expenses
Description
Section titled “Description”This endpoint is deprecated. Use the “List expenses” (GET /v1/expenses) endpoint instead.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.budget_id[]?
Section titled “get.parameters.query.budget_id[]?”
optionalbudget_id[]?:string[] |null
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
Description
Section titled “Description”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[]?”
optionalexpand[]?:string[] |null
Description
Section titled “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
Section titled “Example”?expand[]=merchant&expand[]=locationget.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
Description
Section titled “Description”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?”
optionalload_custom_fields?:boolean|null
Description
Section titled “Description”Load custom fields for the expenses.
get.parameters.query.parent_expense_id[]?
Section titled “get.parameters.query.parent_expense_id[]?”
optionalparent_expense_id[]?:string[] |null
Description
Section titled “Description”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?”
optionalpayment_posted_at_end?:string|null
Description
Section titled “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, e.g. 2022-11-12T23:59:59.999
Example
Section titled “Example”2023-01-10T23:59:59.999get.parameters.query.payment_posted_at_start?
Section titled “get.parameters.query.payment_posted_at_start?”
optionalpayment_posted_at_start?:string|null
Description
Section titled “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, e.g. 2022-11-12T23:59:59.999
Example
Section titled “Example”2023-01-01T23:59:59.999get.parameters.query.payment_status[]?
Section titled “get.parameters.query.payment_status[]?”
optionalpayment_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?”
optionalpurchased_at_end?:string|null
Description
Section titled “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, e.g. 2022-11-12T23:59:59.999
Example
Section titled “Example”2023-01-10T23:59:59.999get.parameters.query.purchased_at_start?
Section titled “get.parameters.query.purchased_at_start?”
optionalpurchased_at_start?:string|null
Description
Section titled “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, e.g. 2022-11-12T23:59:59.999
Example
Section titled “Example”2023-01-01T23:59:59.999get.parameters.query.spending_entity_id[]?
Section titled “get.parameters.query.spending_entity_id[]?”
optionalspending_entity_id[]?:string[] |null
get.parameters.query.status[]?
Section titled “get.parameters.query.status[]?”
optionalstatus[]?: ("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?”
optionalupdated_at_end?:string|null
Description
Section titled “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, e.g. 2022-11-12T23:59:59.999
Example
Section titled “Example”2023-01-10T23:59:59.999get.parameters.query.updated_at_start?
Section titled “get.parameters.query.updated_at_start?”
optionalupdated_at_start?:string|null
Description
Section titled “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, e.g. 2022-11-12T23:59:59.999
Example
Section titled “Example”2023-01-01T23:59:59.999get.parameters.query.user_id[]?
Section titled “get.parameters.query.user_id[]?”
optionaluser_id[]?:string[] |null
Description
Section titled “Description”Get expenses belong to provided user(s).
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”List expenses response.
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/expenses/card/{expense_id}
Section titled “/v1/expenses/card/{expense_id}”/v1/expenses/card/{expense_id}:
object
Defined in: src/expenses/types.gen.ts:64
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get a card expense
Description
Section titled “Description”This endpoint is deprecated. Use the “Get an expense” (GET /v1/expenses/{id}) endpoint instead.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.expense_id
Section titled “get.parameters.path.expense_id”expense_id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.expand[]?
Section titled “get.parameters.query.expand[]?”
optionalexpand[]?:string[] |null
Description
Section titled “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
Section titled “Example”?expand[]=merchant&expand[]=locationget.parameters.query.load_custom_fields?
Section titled “get.parameters.query.load_custom_fields?”
optionalload_custom_fields?:boolean|null
Description
Section titled “Description”Load custom fields for the expense.
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”Get an expense response.
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.address?
Section titled “get.responses.200.content.application/json.address?”
optionaladdress?: {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”Type Literal
Section titled “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; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
coordinates?
Section titled “coordinates?”
optionalcoordinates?: {latitude:number;longitude:number; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ latitude: number; longitude: number; }
latitude
Section titled “latitude”latitude:
number
Format: double
longitude
Section titled “longitude”longitude:
number
Format: double
null
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
timezone?
Section titled “timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”Timezone.
null
get.responses.200.content.application/json.approved_at?
Section titled “get.responses.200.content.application/json.approved_at?”
optionalapproved_at?:string|null
Format: date-time
Description
Section titled “Description”The time the expense is approved.
get.responses.200.content.application/json.billing_amount?
Section titled “get.responses.200.content.application/json.billing_amount?”
optionalbilling_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
get.responses.200.content.application/json.billing_entity_id?
Section titled “get.responses.200.content.application/json.billing_entity_id?”
optionalbilling_entity_id?:string|null
Description
Section titled “Description”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?”
optionalbooking_id?:string|null
Description
Section titled “Description”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?”
optionalbudget?: {id:string;name:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ id: string; name: string; }
id:
string
Description
Section titled “Description”Unique ID for the Budget.
name:
string
Description
Section titled “Description”Name for the Budget.
null
get.responses.200.content.application/json.budget_amount?
Section titled “get.responses.200.content.application/json.budget_amount?”
optionalbudget_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
get.responses.200.content.application/json.budget_id?
Section titled “get.responses.200.content.application/json.budget_id?”
optionalbudget_id?:string|null
get.responses.200.content.application/json.category?
Section titled “get.responses.200.content.application/json.category?”
optionalcategory?:"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?”
optionalcompletion_date?:string|null
Format: date-time
Description
Section titled “Description”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?”
optionalcustom_fields?:object[] |null
Description
Section titled “Description”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”dashboard_url:
string
Description
Section titled “Description”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?”
optionaldepartment?: {id:string;name:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ id: string; name: string; }
id:
string
Description
Section titled “Description”The unique identifier for the department.
name:
string
Description
Section titled “Description”The name of the department.
null
get.responses.200.content.application/json.department_id?
Section titled “get.responses.200.content.application/json.department_id?”
optionaldepartment_id?:string|null
get.responses.200.content.application/json.expense_line_items?
Section titled “get.responses.200.content.application/json.expense_line_items?”
optionalexpense_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”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?”
optionalexpense_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?”
optionalexported_at?:string|null
Format: date-time
Description
Section titled “Description”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”id:
string
Description
Section titled “Description”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?”
optionalintegration_billing_entity_id?:string|null
Description
Section titled “Description”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?”
optionalintegration_spending_entity_id?:string|null
Description
Section titled “Description”ID of the spending entity in accounting.
get.responses.200.content.application/json.location?
Section titled “get.responses.200.content.application/json.location?”
optionallocation?: {id:string;name:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ id: string; name: string; }
id:
string
Description
Section titled “Description”The unique identifier for the location.
name:
string
Description
Section titled “Description”The name of the location.
null
get.responses.200.content.application/json.location_id?
Section titled “get.responses.200.content.application/json.location_id?”
optionallocation_id?:string|null
get.responses.200.content.application/json.memo?
Section titled “get.responses.200.content.application/json.memo?”
optionalmemo?:string|null
Description
Section titled “Description”The memo of the expense.
get.responses.200.content.application/json.merchant?
Section titled “get.responses.200.content.application/json.merchant?”
optionalmerchant?: {country:string;mcc:string;raw_descriptor:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ country: string; mcc: string; raw_descriptor: string; }
country
Section titled “country”country:
string
Description
Section titled “Description”Merchant’s country, in ISO 3166-1 alpha-3 format.
mcc:
string
Description
Section titled “Description”A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to https://en.wikipedia.org/wiki/Merchant_category_code for more details.
raw_descriptor
Section titled “raw_descriptor”raw_descriptor:
string
Description
Section titled “Description”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?”
optionalmerchant_id?:string|null
get.responses.200.content.application/json.original_amount?
Section titled “get.responses.200.content.application/json.original_amount?”
optionaloriginal_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
get.responses.200.content.application/json.payment?
Section titled “get.responses.200.content.application/json.payment?”
optionalpayment?: {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”Type Literal
Section titled “Type Literal”{ id: string; paymentInstrument: Omit<object & object & object, "type">; statusReason: "APPROVED" | "OTHER" | "EXCEEDED_BUDGET_LIMIT" | "BUDGET_EXPIRED" | "NO_BUDGET" | "BUDGET_NOT_YET_STARTED" | "BUDGET_CATEGORY_RESTRICTION" | "BUDGET_MERCHANT_RESTRICTION" | "SUSPECTED_FRAUD" | "EXCEEDED_GLOBAL_LIMIT" | "EXCEEDED_USER_LIMIT" | "EXCEEDED_CARD_LIMIT" | "INVALID_EXPIRATION_DATE" | "CARD_NOT_ACTIVE" | "INVALID_CARD_CREDENTIALS" | "INVALID_BILLING_ADDRESS" | "CARD_SUSPENDED" | "CARD_TERMINATED" | "CARD_EXPIRED" | "MCC_BLOCKED" | "USER_SUSPENDED" | "INVALID_PIN" | "INVALID_CVV" | "EXCEEDED_PIN_ATTEMPTS" | "INSIDE_SANCTIONED_COUNTRY" | "SOFT_EXPIRATION" | "TRANSFERRED_CARD_NEW_MERCHANT" | "EXCEEDED_ANCESTOR_BUDGET_LIMIT" | "EXCEEDED_BUDGET_TRANSACTION_LIMIT" | "TOS_BLOCKED" | "COMPLIANCE_BLOCKED"; }
id:
string
Description
Section titled “Description”Unique ID for the payment.
paymentInstrument
Section titled “paymentInstrument”paymentInstrument:
Omit<object&object&object,"type">
statusReason
Section titled “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?”
optionalpayment_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?”
optionalpayment_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?”
optionalpolicy?: {id:string;name:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ id: string; name: string; }
id:
string
Description
Section titled “Description”The unique identifier for the policy.
name:
string
Description
Section titled “Description”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?”
optionalpurchased_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
get.responses.200.content.application/json.purchased_at?
Section titled “get.responses.200.content.application/json.purchased_at?”
optionalpurchased_at?:string|null
Format: date-time
Description
Section titled “Description”The time the purchase was made.
get.responses.200.content.application/json.receipts?
Section titled “get.responses.200.content.application/json.receipts?”
optionalreceipts?:object[] |null
Description
Section titled “Description”A list of receipts associated with the expense.
get.responses.200.content.application/json.repayment?
Section titled “get.responses.200.content.application/json.repayment?”
optionalrepayment?: {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”Type Literal
Section titled “Type Literal”{ repayment_initiated_by?: { department_id?: … | … | …; first_name: string; id: string; last_name: string; location_id?: … | … | …; } | null; repayment_initiation_date?: string | null; }
repayment_initiated_by?
Section titled “repayment_initiated_by?”
optionalrepayment_initiated_by?: {department_id?: … | … | …;first_name:string;id:string;last_name:string;location_id?: … | … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ department_id?: … | … | …; first_name: string; id: string; last_name: string; location_id?: … | … | …; }
department_id?
Section titled “department_id?”
optionaldepartment_id?: … | … | …
first_name
Section titled “first_name”first_name:
string
Description
Section titled “Description”First name of the User.
id:
string
Description
Section titled “Description”Unique ID for the User.
last_name
Section titled “last_name”last_name:
string
Description
Section titled “Description”Last name of the User.
location_id?
Section titled “location_id?”
optionallocation_id?: … | … | …
null
repayment_initiation_date?
Section titled “repayment_initiation_date?”
optionalrepayment_initiation_date?:string|null
Format: date-time
null
get.responses.200.content.application/json.review?
Section titled “get.responses.200.content.application/json.review?”
optionalreview?: {approval_steps:object[] |null;compliance_status:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ approval_steps: object[] | null; compliance_status: string | null; }
approval_steps
Section titled “approval_steps”approval_steps:
object[] |null
Description
Section titled “Description”Information for each approval step of the expense
compliance_status
Section titled “compliance_status”compliance_status:
string|null
Description
Section titled “Description”Compliance status of the expense
null
get.responses.200.content.application/json.spending_entity?
Section titled “get.responses.200.content.application/json.spending_entity?”
optionalspending_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”Type Literal
Section titled “Type Literal”{ billing_address: { city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }; created_at: string; display_name: string; id: string; is_default?: boolean; status: "UNSUBMITTED" | "UNVERIFIED" | "IN_PROGRESS" | "VERIFIED" | "REJECTED"; }
billing_address
Section titled “billing_address”billing_address:
object
billing_address.city?
Section titled “billing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
billing_address.country?
Section titled “billing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
billing_address.line1?
Section titled “billing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
billing_address.line2?
Section titled “billing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
billing_address.phone_number?
Section titled “billing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
billing_address.postal_code?
Section titled “billing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
billing_address.state?
Section titled “billing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
created_at
Section titled “created_at”created_at:
string
Format: date-time
Description
Section titled “Description”Timestamp, in UTC, when this legal entity was created.
display_name
Section titled “display_name”display_name:
string
Description
Section titled “Description”The display name of this legal entity.
id:
string
Description
Section titled “Description”The ID of this legal entity.
is_default?
Section titled “is_default?”
optionalis_default?:boolean
Description
Section titled “Description”Whether this is the default entity of the account.
status
Section titled “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?”
optionalspending_entity_id?:string|null
Description
Section titled “Description”The spending entity ID associated with the expense.
get.responses.200.content.application/json.status?
Section titled “get.responses.200.content.application/json.status?”
optionalstatus?:"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?”
optionalsubmitted_at?:string|null
Format: date-time
Description
Section titled “Description”The time the expense is submitted,
get.responses.200.content.application/json.trip_id?
Section titled “get.responses.200.content.application/json.trip_id?”
optionaltrip_id?:string|null
Description
Section titled “Description”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”updated_at:
string
Format: date-time
Description
Section titled “Description”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?”
optionalusd_equivalent_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
get.responses.200.content.application/json.user?
Section titled “get.responses.200.content.application/json.user?”
optionaluser?: {department_id?:string|null;first_name:string;id:string;last_name:string;location_id?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ department_id?: string | null; first_name: string; id: string; last_name: string; location_id?: string | null; }
department_id?
Section titled “department_id?”
optionaldepartment_id?:string|null
first_name
Section titled “first_name”first_name:
string
Description
Section titled “Description”First name of the User.
id:
string
Description
Section titled “Description”Unique ID for the User.
last_name
Section titled “last_name”last_name:
string
Description
Section titled “Description”Last name of the User.
location_id?
Section titled “location_id?”
optionallocation_id?:string|null
null
get.responses.200.content.application/json.user_id?
Section titled “get.responses.200.content.application/json.user_id?”
optionaluser_id?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.404
Section titled “get.responses.404”404:
object
Description
Section titled “Description”Not found
get.responses.404.content?
Section titled “get.responses.404.content?”
optionalcontent?:undefined
get.responses.404.headers
Section titled “get.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
put:
object
Update an expense
Description
Section titled “Description”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”parameters:
object
put.parameters.cookie?
Section titled “put.parameters.cookie?”
optionalcookie?:undefined
put.parameters.header?
Section titled “put.parameters.header?”
optionalheader?:undefined
put.parameters.path
Section titled “put.parameters.path”path:
object
put.parameters.path.expense_id
Section titled “put.parameters.path.expense_id”expense_id:
string
put.parameters.query?
Section titled “put.parameters.query?”
optionalquery?:undefined
put.requestBody
Section titled “put.requestBody”requestBody:
object
put.requestBody.content
Section titled “put.requestBody.content”content:
object
put.requestBody.content.application/json
Section titled “put.requestBody.content.application/json”application/json:
object
put.requestBody.content.application/json.memo?
Section titled “put.requestBody.content.application/json.memo?”
optionalmemo?:string|null
Description
Section titled “Description”Expense memo.
put.responses
Section titled “put.responses”responses:
object
put.responses.200
Section titled “put.responses.200”200:
object
Description
Section titled “Description”Update an expense response.
put.responses.200.content
Section titled “put.responses.200.content”content:
object
put.responses.200.content.application/json
Section titled “put.responses.200.content.application/json”application/json:
object
put.responses.200.content.application/json.billing_amount?
Section titled “put.responses.200.content.application/json.billing_amount?”
optionalbilling_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
put.responses.200.content.application/json.budget_id?
Section titled “put.responses.200.content.application/json.budget_id?”
optionalbudget_id?:string|null
put.responses.200.content.application/json.category?
Section titled “put.responses.200.content.application/json.category?”
optionalcategory?:"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?”
optionaldepartment_id?:string|null
put.responses.200.content.application/json.id
Section titled “put.responses.200.content.application/json.id”id:
string
Description
Section titled “Description”Unique ID associated with the expense.
put.responses.200.content.application/json.location_id?
Section titled “put.responses.200.content.application/json.location_id?”
optionallocation_id?:string|null
put.responses.200.content.application/json.memo?
Section titled “put.responses.200.content.application/json.memo?”
optionalmemo?:string|null
Description
Section titled “Description”The memo of the expense.
put.responses.200.content.application/json.merchant_id?
Section titled “put.responses.200.content.application/json.merchant_id?”
optionalmerchant_id?:string|null
put.responses.200.content.application/json.original_amount?
Section titled “put.responses.200.content.application/json.original_amount?”
optionaloriginal_amount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “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”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
put.responses.200.content.application/json.payment_status?
Section titled “put.responses.200.content.application/json.payment_status?”
optionalpayment_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?”
optionalpurchased_at?:string|null
Format: date-time
Description
Section titled “Description”The time the purchase was made.
put.responses.200.content.application/json.status?
Section titled “put.responses.200.content.application/json.status?”
optionalstatus?:"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”updated_at:
string
Format: date-time
Description
Section titled “Description”The last time the expense was updated.
put.responses.200.headers
Section titled “put.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.400
Section titled “put.responses.400”400:
object
Description
Section titled “Description”Bad request
put.responses.400.content?
Section titled “put.responses.400.content?”
optionalcontent?:undefined
put.responses.400.headers
Section titled “put.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.401
Section titled “put.responses.401”401:
object
Description
Section titled “Description”Unauthorized
put.responses.401.content?
Section titled “put.responses.401.content?”
optionalcontent?:undefined
put.responses.401.headers
Section titled “put.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.403
Section titled “put.responses.403”403:
object
Description
Section titled “Description”Forbidden
put.responses.403.content?
Section titled “put.responses.403.content?”
optionalcontent?:undefined
put.responses.403.headers
Section titled “put.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.404
Section titled “put.responses.404”404:
object
Description
Section titled “Description”Not found
put.responses.404.content?
Section titled “put.responses.404.content?”
optionalcontent?:undefined
put.responses.404.headers
Section titled “put.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/expenses/card/{expense_id}/receipt_upload
Section titled “/v1/expenses/card/{expense_id}/receipt_upload”/v1/expenses/card/{expense_id}/receipt_upload:
object
Defined in: src/expenses/types.gen.ts:89
delete?
Section titled “delete?”
optionaldelete?:undefined
optionalget?:undefined
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Create a new receipt upload
Description
Section titled “Description”The uri will be a pre-signed S3 URL allowing you to upload the receipt securely. This URL can only be used for a PUT operation and expires 30 minutes after its creation. Once your upload is complete, we will try to match the receipt with existing expenses.
Refer to these [docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/PresignedUrlUploadObject.html) on how to upload to this pre-signed S3 URL. We highly recommend using one of AWS SDKs if they're available for your language to upload these files.post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:undefined
post.parameters.path
Section titled “post.parameters.path”path:
object
post.parameters.path.expense_id
Section titled “post.parameters.path.expense_id”expense_id:
string
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.receipt_name
Section titled “post.requestBody.content.application/json.receipt_name”receipt_name:
string
Description
Section titled “Description”The name of the receipt (with the file extension).
post.responses
Section titled “post.responses”responses:
object
post.responses.201
Section titled “post.responses.201”201:
object
Description
Section titled “Description”Upload a new receipt response.
post.responses.201.content
Section titled “post.responses.201.content”content:
object
post.responses.201.content.application/json
Section titled “post.responses.201.content.application/json”application/json:
object
post.responses.201.content.application/json.id
Section titled “post.responses.201.content.application/json.id”id:
string
Description
Section titled “Description”The unique identifier for the request.
post.responses.201.content.application/json.uri
Section titled “post.responses.201.content.application/json.uri”uri:
string
Description
Section titled “Description”The pre-signed S3 link that should be used to upload the file. The maximum size accepted for this document is 50 MB.
post.responses.201.headers
Section titled “post.responses.201.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.400
Section titled “post.responses.400”400:
object
Description
Section titled “Description”Bad request
post.responses.400.content?
Section titled “post.responses.400.content?”
optionalcontent?:undefined
post.responses.400.headers
Section titled “post.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.401
Section titled “post.responses.401”401:
object
Description
Section titled “Description”Unauthorized
post.responses.401.content?
Section titled “post.responses.401.content?”
optionalcontent?:undefined
post.responses.401.headers
Section titled “post.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.403
Section titled “post.responses.403”403:
object
Description
Section titled “Description”Forbidden
post.responses.403.content?
Section titled “post.responses.403.content?”
optionalcontent?:undefined
post.responses.403.headers
Section titled “post.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.404
Section titled “post.responses.404”404:
object
Description
Section titled “Description”Not found
post.responses.404.content?
Section titled “post.responses.404.content?”
optionalcontent?:undefined
post.responses.404.headers
Section titled “post.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/expenses/card/receipt_match
Section titled “/v1/expenses/card/receipt_match”/v1/expenses/card/receipt_match:
object
Defined in: src/expenses/types.gen.ts:111
delete?
Section titled “delete?”
optionaldelete?:undefined
optionalget?:undefined
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Create a new receipt match
Description
Section titled “Description”The uri will be a pre-signed S3 URL allowing you to upload the receipt securely. This URL can only be used for a PUT operation and expires 30 minutes after its creation. Once your upload is complete, we will try to match the receipt with existing expenses.
Refer to these [docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/PresignedUrlUploadObject.html) on how to upload to this pre-signed S3 URL. We highly recommend using one of AWS SDKs if they're available for your language to upload these files.post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:undefined
post.parameters.path?
Section titled “post.parameters.path?”
optionalpath?:undefined
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.receipt_name
Section titled “post.requestBody.content.application/json.receipt_name”receipt_name:
string
Description
Section titled “Description”The name of the receipt (with the file extension). It will be used in the matching result email.
post.responses
Section titled “post.responses”responses:
object
post.responses.201
Section titled “post.responses.201”201:
object
Description
Section titled “Description”Create a new receipt match response.
post.responses.201.content
Section titled “post.responses.201.content”content:
object
post.responses.201.content.application/json
Section titled “post.responses.201.content.application/json”application/json:
object
post.responses.201.content.application/json.id
Section titled “post.responses.201.content.application/json.id”id:
string
Description
Section titled “Description”The unique identifier for the request.
post.responses.201.content.application/json.uri
Section titled “post.responses.201.content.application/json.uri”uri:
string
Description
Section titled “Description”The pre-signed S3 link that should be used to upload the file. The maximum size accepted for this document is 50 MB.
post.responses.201.headers
Section titled “post.responses.201.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.400
Section titled “post.responses.400”400:
object
Description
Section titled “Description”Bad request
post.responses.400.content?
Section titled “post.responses.400.content?”
optionalcontent?:undefined
post.responses.400.headers
Section titled “post.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.401
Section titled “post.responses.401”401:
object
Description
Section titled “Description”Unauthorized
post.responses.401.content?
Section titled “post.responses.401.content?”
optionalcontent?:undefined
post.responses.401.headers
Section titled “post.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined